Class CreateJobRequest (0.36.0)

public final class CreateJobRequest extends GeneratedMessageV3 implements CreateJobRequestOrBuilder

CreateJob Request.

Protobuf type google.cloud.batch.v1alpha.CreateJobRequest

Static Fields

JOB_FIELD_NUMBER

public static final int JOB_FIELD_NUMBER
Field Value
Type Description
int

JOB_ID_FIELD_NUMBER

public static final int JOB_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateJobRequest getDefaultInstance()
Returns
Type Description
CreateJobRequest

getDescriptor()

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

newBuilder()

public static CreateJobRequest.Builder newBuilder()
Returns
Type Description
CreateJobRequest.Builder

newBuilder(CreateJobRequest prototype)

public static CreateJobRequest.Builder newBuilder(CreateJobRequest prototype)
Parameter
Name Description
prototype CreateJobRequest
Returns
Type Description
CreateJobRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateJobRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateJobRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateJobRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateJobRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateJobRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateJobRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateJobRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateJobRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateJobRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateJobRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateJobRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateJobRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateJobRequest> parser()
Returns
Type Description
Parser<CreateJobRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CreateJobRequest getDefaultInstanceForType()
Returns
Type Description
CreateJobRequest

getJob()

public Job getJob()

Required. The Job to create.

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

Returns
Type Description
Job

The job.

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

getParserForType()

public Parser<CreateJobRequest> getParserForType()
Returns
Type Description
Parser<CreateJobRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasJob()

public boolean hasJob()

Required. The Job to create.

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

Returns
Type Description
boolean

Whether the job field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateJobRequest.Builder newBuilderForType()
Returns
Type Description
CreateJobRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateJobRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateJobRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateJobRequest.Builder toBuilder()
Returns
Type Description
CreateJobRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException