Class: Google::Apis::GameservicesV1beta::OperationMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gameservices_v1beta/classes.rb,
lib/google/apis/gameservices_v1beta/representations.rb,
lib/google/apis/gameservices_v1beta/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.



1419
1420
1421
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1419

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

Instance Attribute Details

#api_versionString

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

Returns:

  • (String)


1370
1371
1372
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1370

def api_version
  @api_version
end

#create_timeString

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

Returns:

  • (String)


1375
1376
1377
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1375

def create_time
  @create_time
end

#end_timeString

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

Returns:

  • (String)


1380
1381
1382
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1380

def end_time
  @end_time
end

#operation_statusHash<String,Google::Apis::GameservicesV1beta::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



1388
1389
1390
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1388

def operation_status
  @operation_status
end

#requested_cancellationBoolean 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)


1396
1397
1398
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1396

def requested_cancellation
  @requested_cancellation
end

#status_messageString

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

Returns:

  • (String)


1402
1403
1404
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1402

def status_message
  @status_message
end

#targetString

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

Returns:

  • (String)


1407
1408
1409
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1407

def target
  @target
end

#unreachableArray<String>

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

Returns:

  • (Array<String>)


1412
1413
1414
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1412

def unreachable
  @unreachable
end

#verbString

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

Returns:

  • (String)


1417
1418
1419
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1417

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1424

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