Class: Google::Apis::JobsV4::BatchUpdateJobsRequest

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

Overview

Request to update a batch of jobs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BatchUpdateJobsRequest

Returns a new instance of BatchUpdateJobsRequest.



231
232
233
# File 'generated/google/apis/jobs_v4/classes.rb', line 231

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

Instance Attribute Details

#jobsArray<Google::Apis::JobsV4::Job>

Required. The jobs to be updated. A maximum of 200 jobs can be updated in a batch. Corresponds to the JSON property jobs

Returns:



217
218
219
# File 'generated/google/apis/jobs_v4/classes.rb', line 217

def jobs
  @jobs
end

#update_maskString

Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation. If update_mask is provided, only the specified fields in Job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported. If update_mask is provided, The Job inside JobResult will only contains fields that is updated, plus the Id of the Job. Otherwise, Job will include all fields, which can yield a very large response. Corresponds to the JSON property updateMask

Returns:

  • (String)


229
230
231
# File 'generated/google/apis/jobs_v4/classes.rb', line 229

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



236
237
238
239
# File 'generated/google/apis/jobs_v4/classes.rb', line 236

def update!(**args)
  @jobs = args[:jobs] if args.key?(:jobs)
  @update_mask = args[:update_mask] if args.key?(:update_mask)
end