Class Job (0.1.0)

public final class Job extends GeneratedMessageV3 implements JobOrBuilder

The Cloud Batch Job description.

Protobuf type google.cloud.batch.v1.Job

Implements

JobOrBuilder

Static Fields

ALLOCATION_POLICY_FIELD_NUMBER

public static final int ALLOCATION_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LOGS_POLICY_FIELD_NUMBER

public static final int LOGS_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NOTIFICATIONS_FIELD_NUMBER

public static final int NOTIFICATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

TASK_GROUPS_FIELD_NUMBER

public static final int TASK_GROUPS_FIELD_NUMBER
Field Value
TypeDescription
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Job getDefaultInstance()
Returns
TypeDescription
Job

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Job.Builder newBuilder()
Returns
TypeDescription
Job.Builder

newBuilder(Job prototype)

public static Job.Builder newBuilder(Job prototype)
Parameter
NameDescription
prototypeJob
Returns
TypeDescription
Job.Builder

parseDelimitedFrom(InputStream input)

public static Job parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Job parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Job parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Job parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Job parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Job parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Job> parser()
Returns
TypeDescription
Parser<Job>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAllocationPolicy()

public AllocationPolicy getAllocationPolicy()

Compute resource allocation for all TaskGroups in the Job.

.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;

Returns
TypeDescription
AllocationPolicy

The allocationPolicy.

getAllocationPolicyOrBuilder()

public AllocationPolicyOrBuilder getAllocationPolicyOrBuilder()

Compute resource allocation for all TaskGroups in the Job.

.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;

Returns
TypeDescription
AllocationPolicyOrBuilder

getCreateTime()

public Timestamp getCreateTime()

When the Job was created.

.google.protobuf.Timestamp create_time = 11;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

When the Job was created.

.google.protobuf.Timestamp create_time = 11;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Job getDefaultInstanceForType()
Returns
TypeDescription
Job

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

map<string, string> labels = 8;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

map<string, string> labels = 8;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

map<string, string> labels = 8;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLogsPolicy()

public LogsPolicy getLogsPolicy()

Log preservation policy for the Job.

.google.cloud.batch.v1.LogsPolicy logs_policy = 13;

Returns
TypeDescription
LogsPolicy

The logsPolicy.

getLogsPolicyOrBuilder()

public LogsPolicyOrBuilder getLogsPolicyOrBuilder()

Log preservation policy for the Job.

.google.cloud.batch.v1.LogsPolicy logs_policy = 13;

Returns
TypeDescription
LogsPolicyOrBuilder

getName()

public String getName()

Job name. It must have the format of "projects/*/locations/*/jobs/*". For example: "projects/123456/locations/us-west1/jobs/job01".

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Job name. It must have the format of "projects/*/locations/*/jobs/*". For example: "projects/123456/locations/us-west1/jobs/job01".

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getNotifications(int index)

public JobNotification getNotifications(int index)

Notification configurations.

repeated .google.cloud.batch.v1.JobNotification notifications = 14;

Parameter
NameDescription
indexint
Returns
TypeDescription
JobNotification

getNotificationsCount()

public int getNotificationsCount()

Notification configurations.

repeated .google.cloud.batch.v1.JobNotification notifications = 14;

Returns
TypeDescription
int

getNotificationsList()

public List<JobNotification> getNotificationsList()

Notification configurations.

repeated .google.cloud.batch.v1.JobNotification notifications = 14;

Returns
TypeDescription
List<JobNotification>

getNotificationsOrBuilder(int index)

public JobNotificationOrBuilder getNotificationsOrBuilder(int index)

Notification configurations.

repeated .google.cloud.batch.v1.JobNotification notifications = 14;

Parameter
NameDescription
indexint
Returns
TypeDescription
JobNotificationOrBuilder

getNotificationsOrBuilderList()

public List<? extends JobNotificationOrBuilder> getNotificationsOrBuilderList()

Notification configurations.

repeated .google.cloud.batch.v1.JobNotification notifications = 14;

Returns
TypeDescription
List<? extends com.google.cloud.batch.v1.JobNotificationOrBuilder>

getParserForType()

public Parser<Job> getParserForType()
Returns
TypeDescription
Parser<Job>
Overrides

getPriority()

public long getPriority()

Priority of the Job. The valid value range is [0, 100). A job with higher priority value will be scheduled to run earlier.

int64 priority = 3;

Returns
TypeDescription
long

The priority.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStatus()

public JobStatus getStatus()

Output only. Job status. It is read only for users.

.google.cloud.batch.v1.JobStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
JobStatus

The status.

getStatusOrBuilder()

public JobStatusOrBuilder getStatusOrBuilder()

Output only. Job status. It is read only for users.

.google.cloud.batch.v1.JobStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
JobStatusOrBuilder

getTaskGroups(int index)

public TaskGroup getTaskGroups(int index)

Required. TaskGroups in the Job. Only one TaskGroup is supported now.

repeated .google.cloud.batch.v1.TaskGroup task_groups = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
TaskGroup

getTaskGroupsCount()

public int getTaskGroupsCount()

Required. TaskGroups in the Job. Only one TaskGroup is supported now.

repeated .google.cloud.batch.v1.TaskGroup task_groups = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getTaskGroupsList()

public List<TaskGroup> getTaskGroupsList()

Required. TaskGroups in the Job. Only one TaskGroup is supported now.

repeated .google.cloud.batch.v1.TaskGroup task_groups = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<TaskGroup>

getTaskGroupsOrBuilder(int index)

public TaskGroupOrBuilder getTaskGroupsOrBuilder(int index)

Required. TaskGroups in the Job. Only one TaskGroup is supported now.

repeated .google.cloud.batch.v1.TaskGroup task_groups = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
TaskGroupOrBuilder

getTaskGroupsOrBuilderList()

public List<? extends TaskGroupOrBuilder> getTaskGroupsOrBuilderList()

Required. TaskGroups in the Job. Only one TaskGroup is supported now.

repeated .google.cloud.batch.v1.TaskGroup task_groups = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.batch.v1.TaskGroupOrBuilder>

getUid()

public String getUid()

Output only. A system generated unique ID (in UUID4 format) for the Job.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. A system generated unique ID (in UUID4 format) for the Job.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for uid.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

The last time the Job was updated.

.google.protobuf.Timestamp update_time = 12;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The last time the Job was updated.

.google.protobuf.Timestamp update_time = 12;

Returns
TypeDescription
TimestampOrBuilder

hasAllocationPolicy()

public boolean hasAllocationPolicy()

Compute resource allocation for all TaskGroups in the Job.

.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;

Returns
TypeDescription
boolean

Whether the allocationPolicy field is set.

hasCreateTime()

public boolean hasCreateTime()

When the Job was created.

.google.protobuf.Timestamp create_time = 11;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasLogsPolicy()

public boolean hasLogsPolicy()

Log preservation policy for the Job.

.google.cloud.batch.v1.LogsPolicy logs_policy = 13;

Returns
TypeDescription
boolean

Whether the logsPolicy field is set.

hasStatus()

public boolean hasStatus()

Output only. Job status. It is read only for users.

.google.cloud.batch.v1.JobStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the status field is set.

hasUpdateTime()

public boolean hasUpdateTime()

The last time the Job was updated.

.google.protobuf.Timestamp update_time = 12;

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Job.Builder newBuilderForType()
Returns
TypeDescription
Job.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Job.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Job.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Job.Builder toBuilder()
Returns
TypeDescription
Job.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException