Class: Google::Apis::JobsV4::BatchOperationMetadata

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

Overview

Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BatchOperationMetadata

Returns a new instance of BatchOperationMetadata.



192
193
194
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 192

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

Instance Attribute Details

#create_time ⇒ String

The time when the batch operation is created. Corresponds to the JSON property createTime

Returns:

  • (String) 


153
154
155
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 153

def create_time
  @create_time
end

#end_time ⇒ String

The time when the batch operation is finished and google.longrunning.Operation. done is set to true. Corresponds to the JSON property endTime

Returns:

  • (String) 


159
160
161
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 159

def end_time
  @end_time
end

#failure_count ⇒ Fixnum

Count of failed item(s) inside an operation. Corresponds to the JSON property failureCount

Returns:

  • (Fixnum) 


164
165
166
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 164

def failure_count
  @failure_count
end

#state ⇒ String

The state of a long running operation. Corresponds to the JSON property state

Returns:

  • (String) 


169
170
171
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 169

def state
  @state
end

#state_description ⇒ String

More detailed information about operation state. Corresponds to the JSON property stateDescription

Returns:

  • (String) 


174
175
176
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 174

def state_description
  @state_description
end

#success_count ⇒ Fixnum

Count of successful item(s) inside an operation. Corresponds to the JSON property successCount

Returns:

  • (Fixnum) 


179
180
181
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 179

def success_count
  @success_count
end

#total_count ⇒ Fixnum

Count of total item(s) inside an operation. Corresponds to the JSON property totalCount

Returns:

  • (Fixnum) 


184
185
186
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 184

def total_count
  @total_count
end

#update_time ⇒ String

The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned. Corresponds to the JSON property updateTime

Returns:

  • (String) 


190
191
192
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 190

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 197

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @end_time = args[:end_time] if args.key?(:end_time)
  @failure_count = args[:failure_count] if args.key?(:failure_count)
  @state = args[:state] if args.key?(:state)
  @state_description = args[:state_description] if args.key?(:state_description)
  @success_count = args[:success_count] if args.key?(:success_count)
  @total_count = args[:total_count] if args.key?(:total_count)
  @update_time = args[:update_time] if args.key?(:update_time)
end