Package com.google.cloud.batch.v1

Interface CreateJobRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CreateJobRequest, CreateJobRequest.Builder
    public interface CreateJobRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Job getJob()
      Required.
      String getJobId()
      ID used to uniquely identify the Job within its parent scope.
      com.google.protobuf.ByteString getJobIdBytes()
      ID used to uniquely identify the Job within its parent scope.
      JobOrBuilder getJobOrBuilder()
      Required.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      String getRequestId()
      Optional.
      com.google.protobuf.ByteString getRequestIdBytes()
      Optional.
      boolean hasJob()
      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 Detail

      • getParent

        String getParent()
         Required. The parent resource name where the Job will be created.
 Pattern: "projects/{project}/locations/{location}"
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The parent resource name where the Job will be created.
 Pattern: "projects/{project}/locations/{location}"
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • getJobId

        String getJobId()
         ID used to uniquely identify the Job within its parent scope.
 This field should contain at most 63 characters and must start with
 lowercase characters.
 Only lowercase characters, numbers and '-' are accepted.
 The '-' character cannot be the first or the last one.
 A system generated ID will be used if the field is not set.

 The job.name field in the request will be ignored and the created resource
 name of the Job will be "{parent}/jobs/{job_id}".
        string job_id = 2;
        Returns:
        The jobId.

      • getJobIdBytes

        com.google.protobuf.ByteString getJobIdBytes()
         ID used to uniquely identify the Job within its parent scope.
 This field should contain at most 63 characters and must start with
 lowercase characters.
 Only lowercase characters, numbers and '-' are accepted.
 The '-' character cannot be the first or the last one.
 A system generated ID will be used if the field is not set.

 The job.name field in the request will be ignored and the created resource
 name of the Job will be "{parent}/jobs/{job_id}".
        string job_id = 2;
        Returns:
        The bytes for jobId.

      • hasJob

        boolean hasJob()
         Required. The Job to create.
        .google.cloud.batch.v1.Job job = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the job field is set.

      • getJob

        Job getJob()
         Required. The Job to create.
        .google.cloud.batch.v1.Job job = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The job.

      • getJobOrBuilder

        JobOrBuilder getJobOrBuilder()
         Required. The Job to create.
        .google.cloud.batch.v1.Job job = 3 [(.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 since 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        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 since 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for requestId.