Batch V1 API - Class Google::Cloud::Batch::V1::CreateJobRequest (v0.3.0)

Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::CreateJobRequest.

CreateJob Request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#job

def job() -> ::Google::Cloud::Batch::V1::Job
Returns

#job=

def job=(value) -> ::Google::Cloud::Batch::V1::Job
Parameter
Returns

#job_id

def job_id() -> ::String
Returns
  • (::String) — ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters. Only alphanumeric characters or '-' 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}".

#job_id=

def job_id=(value) -> ::String
Parameter
  • value (::String) — ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters. Only alphanumeric characters or '-' 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}".

Returns
  • (::String) — ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters. Only alphanumeric characters or '-' 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}".

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}"

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}"
Returns
  • (::String) — Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}"

#request_id

def request_id() -> ::String
Returns
  • (::String) — 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 t he 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).

#request_id=

def request_id=(value) -> ::String
Parameter
  • value (::String) — 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 t he 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).

Returns
  • (::String) — 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 t he 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).