Class: Google::Apis::GameservicesV1::OperationMetadata

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

Overview

Represents the metadata of the long-running operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OperationMetadata

Returns a new instance of OperationMetadata.



1378
1379
1380
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1378

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

Instance Attribute Details

#api_version ⇒ String

Output only. API version used to start the operation. Corresponds to the JSON property apiVersion

Returns:

  • (String) 


1329
1330
1331
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1329

def api_version
  @api_version
end

#create_time ⇒ String

Output only. The time the operation was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1334
1335
1336
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1334

def create_time
  @create_time
end

#end_time ⇒ String

Output only. The time the operation finished running. Corresponds to the JSON property endTime

Returns:

  • (String) 


1339
1340
1341
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1339

def end_time
  @end_time
end

#operation_status ⇒ Hash<String,Google::Apis::GameservicesV1::OperationStatus>

Output only. Operation status for Game Services API operations. Operation status is in the form of key-value pairs where keys are resource IDs and the values show the status of the operation. In case of failures, the value includes an error code and error message. Corresponds to the JSON property operationStatus

Returns:



1347
1348
1349
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1347

def operation_status
  @operation_status
end

#requested_cancellation ⇒ Boolean Also known as: requested_cancellation?

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation. error value with a google.rpc.Status.code of 1, corresponding to Code. CANCELLED. Corresponds to the JSON property requestedCancellation

Returns:

  • (Boolean) 


1355
1356
1357
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1355

def requested_cancellation
  @requested_cancellation
end

#status_message ⇒ String

Output only. Human-readable status of the operation, if any. Corresponds to the JSON property statusMessage

Returns:

  • (String) 


1361
1362
1363
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1361

def status_message
  @status_message
end

#target ⇒ String

Output only. Server-defined resource path for the target of the operation. Corresponds to the JSON property target

Returns:

  • (String) 


1366
1367
1368
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1366

def target
  @target
end

#unreachable ⇒ Array<String>

Output only. List of Locations that could not be reached. Corresponds to the JSON property unreachable

Returns:

  • (Array<String>) 


1371
1372
1373
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1371

def unreachable
  @unreachable
end

#verb ⇒ String

Output only. Name of the verb executed by the operation. Corresponds to the JSON property verb

Returns:

  • (String) 


1376
1377
1378
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1376

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1383

def update!(**args)
  @api_version = args[:api_version] if args.key?(:api_version)
  @create_time = args[:create_time] if args.key?(:create_time)
  @end_time = args[:end_time] if args.key?(:end_time)
  @operation_status = args[:operation_status] if args.key?(:operation_status)
  @requested_cancellation = args[:requested_cancellation] if args.key?(:requested_cancellation)
  @status_message = args[:status_message] if args.key?(:status_message)
  @target = args[:target] if args.key?(:target)
  @unreachable = args[:unreachable] if args.key?(:unreachable)
  @verb = args[:verb] if args.key?(:verb)
end