Class CreateJobRequest.Builder (0.55.0) 

public static final class CreateJobRequest.Builder extends GeneratedMessageV3.Builder<CreateJobRequest.Builder> implements CreateJobRequestOrBuilder

CreateJob Request.

Protobuf type google.cloud.batch.v1.CreateJobRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateJobRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateJobRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateJobRequest.Builder
Overrides

build()

public CreateJobRequest build()
Returns
Type Description
CreateJobRequest

buildPartial()

public CreateJobRequest buildPartial()
Returns
Type Description
CreateJobRequest

clear()

public CreateJobRequest.Builder clear()
Returns
Type Description
CreateJobRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public CreateJobRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateJobRequest.Builder
Overrides

clearJob()

public CreateJobRequest.Builder clearJob()

Required. The Job to create.

.google.cloud.batch.v1.Job job = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateJobRequest.Builder

clearJobId()

public CreateJobRequest.Builder clearJobId()

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
Type Description
CreateJobRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateJobRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateJobRequest.Builder
Overrides

clearParent()

public CreateJobRequest.Builder clearParent()

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
Type Description
CreateJobRequest.Builder

This builder for chaining.

clearRequestId()

public CreateJobRequest.Builder clearRequestId()

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
Type Description
CreateJobRequest.Builder

This builder for chaining.

clone()

public CreateJobRequest.Builder clone()
Returns
Type Description
CreateJobRequest.Builder
Overrides

getDefaultInstanceForType()

public CreateJobRequest getDefaultInstanceForType()
Returns
Type Description
CreateJobRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getJob()

public Job getJob()

Required. The Job to create.

.google.cloud.batch.v1.Job job = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Job

The job.

getJobBuilder()

public Job.Builder getJobBuilder()

Required. The Job to create.

.google.cloud.batch.v1.Job job = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Job.Builder

getJobId()

public 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
Type Description
String

The jobId.

getJobIdBytes()

public 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
Type Description
ByteString

The bytes for jobId.

getJobOrBuilder()

public JobOrBuilder getJobOrBuilder()

Required. The Job to create.

.google.cloud.batch.v1.Job job = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
JobOrBuilder

getParent()

public 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
Type Description
String

The parent.

getParentBytes()

public 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
Type Description
ByteString

The bytes for parent.

getRequestId()

public 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
Type Description
String

The requestId.

getRequestIdBytes()

public 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
Type Description
ByteString

The bytes for requestId.

hasJob()

public boolean hasJob()

Required. The Job to create.

.google.cloud.batch.v1.Job job = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the job field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreateJobRequest other)

public CreateJobRequest.Builder mergeFrom(CreateJobRequest other)
Parameter
Name Description
other CreateJobRequest
Returns
Type Description
CreateJobRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateJobRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateJobRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateJobRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateJobRequest.Builder
Overrides

mergeJob(Job value)

public CreateJobRequest.Builder mergeJob(Job value)

Required. The Job to create.

.google.cloud.batch.v1.Job job = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Job
Returns
Type Description
CreateJobRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateJobRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateJobRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public CreateJobRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateJobRequest.Builder
Overrides

setJob(Job value)

public CreateJobRequest.Builder setJob(Job value)

Required. The Job to create.

.google.cloud.batch.v1.Job job = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Job
Returns
Type Description
CreateJobRequest.Builder

setJob(Job.Builder builderForValue)

public CreateJobRequest.Builder setJob(Job.Builder builderForValue)

Required. The Job to create.

.google.cloud.batch.v1.Job job = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Job.Builder
Returns
Type Description
CreateJobRequest.Builder

setJobId(String value)

public CreateJobRequest.Builder setJobId(String value)

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;

Parameter
Name Description
value String

The jobId to set.
Returns
Type Description
CreateJobRequest.Builder

This builder for chaining.

setJobIdBytes(ByteString value)

public CreateJobRequest.Builder setJobIdBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for jobId to set.
Returns
Type Description
CreateJobRequest.Builder

This builder for chaining.

setParent(String value)

public CreateJobRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
CreateJobRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateJobRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
CreateJobRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreateJobRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateJobRequest.Builder
Overrides

setRequestId(String value)

public CreateJobRequest.Builder setRequestId(String value)

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];

Parameter
Name Description
value String

The requestId to set.
Returns
Type Description
CreateJobRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public CreateJobRequest.Builder setRequestIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for requestId to set.
Returns
Type Description
CreateJobRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateJobRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateJobRequest.Builder
Overrides