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

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.



2420
2421
2422
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2420

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

Instance Attribute Details

#args ⇒ Hash<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>) 


2405
2406
2407
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2405

def args
  @args
end

#message ⇒ String

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) 


2412
2413
2414
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2412

def message
  @message
end

#token ⇒ String

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) 


2418
2419
2420
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2418

def token
  @token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2425
2426
2427
2428
2429
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2425

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