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.



1480
1481
1482
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1480

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)


1431
1432
1433
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1431

def api_version
  @api_version
end

#create_timeString

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

Returns:

  • (String)


1436
1437
1438
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1436

def create_time
  @create_time
end

#end_timeString

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

Returns:

  • (String)


1441
1442
1443
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1441

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



1449
1450
1451
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1449

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)


1457
1458
1459
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1457

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)


1463
1464
1465
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1463

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)


1468
1469
1470
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1468

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


1473
1474
1475
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1473

def unreachable
  @unreachable
end

#verbString

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

Returns:

  • (String)


1478
1479
1480
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1478

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'lib/google/apis/gameservices_v1beta/classes.rb', line 1485

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