Package com.google.cloud.batch.v1alpha

Interface UpdateJobRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UpdateJobRequest, UpdateJobRequest.Builder
@Generated public interface UpdateJobRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Job
    getJob()
    Required.
    JobOrBuilder
    getJobOrBuilder()
    Required.
    String
    getRequestId()
    Optional.
    com.google.protobuf.ByteString
    getRequestIdBytes()
    Optional.
    com.google.protobuf.FieldMask
    getUpdateMask()
    Required.
    com.google.protobuf.FieldMaskOrBuilder
    getUpdateMaskOrBuilder()
    Required.
    boolean
    hasJob()
    Required.
    boolean
    hasUpdateMask()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasJob

      boolean hasJob()
       Required. The Job to update.
 Only fields specified in `updateMask` are updated.
      .google.cloud.batch.v1alpha.Job job = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the job field is set.

    • getJob

      Job getJob()
       Required. The Job to update.
 Only fields specified in `updateMask` are updated.
      .google.cloud.batch.v1alpha.Job job = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The job.

    • getJobOrBuilder

      JobOrBuilder getJobOrBuilder()
       Required. The Job to update.
 Only fields specified in `updateMask` are updated.
      .google.cloud.batch.v1alpha.Job job = 1 [(.google.api.field_behavior) = REQUIRED];

    • hasUpdateMask

      boolean hasUpdateMask()
       Required. Mask of fields to update.

 The `jobs.patch` method can only be used while a job is in the `QUEUED`,
 `SCHEDULED`, or `RUNNING` state and currently only supports increasing the
 value of the first `taskCount` field in the job's `taskGroups` field.
 Therefore, you must set the value of `updateMask` to `taskGroups`. Any
 other job fields in the update request will be ignored.

 For example, to update a job's `taskCount` to `2`, set `updateMask` to
 `taskGroups` and use the following request body:
 ```
 {
 "taskGroups":[{
 "taskCount": 2
 }]
 }
 ```
      .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the updateMask field is set.

    • getUpdateMask

      com.google.protobuf.FieldMask getUpdateMask()
       Required. Mask of fields to update.

 The `jobs.patch` method can only be used while a job is in the `QUEUED`,
 `SCHEDULED`, or `RUNNING` state and currently only supports increasing the
 value of the first `taskCount` field in the job's `taskGroups` field.
 Therefore, you must set the value of `updateMask` to `taskGroups`. Any
 other job fields in the update request will be ignored.

 For example, to update a job's `taskCount` to `2`, set `updateMask` to
 `taskGroups` and use the following request body:
 ```
 {
 "taskGroups":[{
 "taskCount": 2
 }]
 }
 ```
      .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The updateMask.

    • getUpdateMaskOrBuilder

      com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()
       Required. Mask of fields to update.

 The `jobs.patch` method can only be used while a job is in the `QUEUED`,
 `SCHEDULED`, or `RUNNING` state and currently only supports increasing the
 value of the first `taskCount` field in the job's `taskGroups` field.
 Therefore, you must set the value of `updateMask` to `taskGroups`. Any
 other job fields in the update request will be ignored.

 For example, to update a job's `taskCount` to `2`, set `updateMask` to
 `taskGroups` and use the following request body:
 ```
 {
 "taskGroups":[{
 "taskCount": 2
 }]
 }
 ```
      .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

    • getRequestId

      String getRequestId()
       Optional. An optional request ID to identify requests. Specify a unique
 request ID so that if you must retry your request, the server will know to
 ignore the request if it has already been completed. The server will
 guarantee that for at least 60 minutes after the first request.

 For example, consider a situation where you make an initial request and
 the request times out. If you make the request again with the same request
 ID, the server can check if original operation with the same request ID
 was received, and if so, will ignore the second request. This prevents
 clients from accidentally creating duplicate commitments.

 The request ID must be a valid UUID with the exception that zero UUID is
 not supported (00000000-0000-0000-0000-000000000000).
      string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
      Returns:
      The requestId.

    • getRequestIdBytes

      com.google.protobuf.ByteString getRequestIdBytes()
       Optional. An optional request ID to identify requests. Specify a unique
 request ID so that if you must retry your request, the server will know to
 ignore the request if it has already been completed. The server will
 guarantee that for at least 60 minutes after the first request.

 For example, consider a situation where you make an initial request and
 the request times out. If you make the request again with the same request
 ID, the server can check if original operation with the same request ID
 was received, and if so, will ignore the second request. This prevents
 clients from accidentally creating duplicate commitments.

 The request ID must be a valid UUID with the exception that zero UUID is
 not supported (00000000-0000-0000-0000-000000000000).
      string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
      Returns:
      The bytes for requestId.