Class: Google::Apis::StoragebatchoperationsV1::OperationMetadata

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



1067
1068
1069
 
# File 'lib/google/apis/storagebatchoperations_v1/classes.rb', line 1067

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) 


1035
1036
1037
 
# File 'lib/google/apis/storagebatchoperations_v1/classes.rb', line 1035

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) 


1040
1041
1042
 
# File 'lib/google/apis/storagebatchoperations_v1/classes.rb', line 1040

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) 


1045
1046
1047
 
# File 'lib/google/apis/storagebatchoperations_v1/classes.rb', line 1045

def end_time
  @end_time
end

#job ⇒ Google::Apis::StoragebatchoperationsV1::Job

The storage batch operations job description. Corresponds to the JSON property job

Returns:



1050
1051
1052
 
# File 'lib/google/apis/storagebatchoperations_v1/classes.rb', line 1050

def job
  @job
end

#operation ⇒ String

Output only. The unique operation resource name. Format: projects/project_id/ locations/global/operations/operation. Corresponds to the JSON property operation

Returns:

  • (String) 


1056
1057
1058
 
# File 'lib/google/apis/storagebatchoperations_v1/classes.rb', line 1056

def operation
  @operation
end

#requested_cancellation ⇒ Boolean Also known as: requested_cancellation?

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

Returns:

  • (Boolean) 


1064
1065
1066
 
# File 'lib/google/apis/storagebatchoperations_v1/classes.rb', line 1064

def requested_cancellation
  @requested_cancellation
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/google/apis/storagebatchoperations_v1/classes.rb', line 1072

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)
  @job = args[:job] if args.key?(:job)
  @operation = args[:operation] if args.key?(:operation)
  @requested_cancellation = args[:requested_cancellation] if args.key?(:requested_cancellation)
end