Class: Google::Apis::SpannerV1::LocalizedString

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/spanner_v1/classes.rb,
lib/google/apis/spanner_v1/representations.rb,
lib/google/apis/spanner_v1/representations.rb
more...

Overview

A message representing a user-facing string whose value may need to be translated before being displayed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LocalizedString

Returns a new instance of LocalizedString.

[View source]

2582
2583
2584
# File 'lib/google/apis/spanner_v1/classes.rb', line 2582

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#argsHash<String,String>

A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values. Corresponds to the JSON property args

Returns:

  • (Hash<String,String>)

2567
2568
2569
# File 'lib/google/apis/spanner_v1/classes.rb', line 2567

def args
  @args
end

#messageString

The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is. Corresponds to the JSON property message

Returns:

  • (String)

2574
2575
2576
# File 'lib/google/apis/spanner_v1/classes.rb', line 2574

def message
  @message
end

#tokenString

The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service. Corresponds to the JSON property token

Returns:

  • (String)

2580
2581
2582
# File 'lib/google/apis/spanner_v1/classes.rb', line 2580

def token
  @token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

2587
2588
2589
2590
2591
# File 'lib/google/apis/spanner_v1/classes.rb', line 2587

def update!(**args)
  @args = args[:args] if args.key?(:args)
  @message = args[:message] if args.key?(:message)
  @token = args[:token] if args.key?(:token)
end