Class: Google::Apis::BatchV1::OperationMetadata

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



1862
1863
1864
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1862

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) 


1826
1827
1828
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1826

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) 


1831
1832
1833
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1831

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) 


1836
1837
1838
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1836

def end_time
  @end_time
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) 


1844
1845
1846
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1844

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) 


1850
1851
1852
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1850

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) 


1855
1856
1857
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1855

def target
  @target
end

#verb ⇒ String

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

Returns:

  • (String) 


1860
1861
1862
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1860

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1867
1868
1869
1870
1871
1872
1873
1874
1875
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1867

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