Class: Google::Cloud::Batch::V1::CreateJobRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/batch/v1/batch.rb

Overview

CreateJob Request.

Instance Attribute Summary collapse

Instance Attribute Details

#job ⇒ ::Google::Cloud::Batch::V1::Job

Returns Required. The Job to create.

Returns:



58
59
60
61
 
# File 'proto_docs/google/cloud/batch/v1/batch.rb', line 58

class CreateJobRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#job_id ⇒ ::String

Returns 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}".

Returns:

  • (::String) —

    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}".



58
59
60
61
 
# File 'proto_docs/google/cloud/batch/v1/batch.rb', line 58

class CreateJobRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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}"



58
59
60
61
 
# File 'proto_docs/google/cloud/batch/v1/batch.rb', line 58

class CreateJobRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#request_id ⇒ ::String

Returns 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).

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 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).



58
59
60
61
 
# File 'proto_docs/google/cloud/batch/v1/batch.rb', line 58

class CreateJobRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end