Job (proto-google-cloud-batch-v1 0.81.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.batch.v1.Job

All Implemented Interfaces:

JobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class Job
extends com.google.protobuf.GeneratedMessageV3
implements JobOrBuilder
```
```
 The Cloud Batch Job description.
 
```
Protobuf type google.cloud.batch.v1.Job
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Job.Builder
The Cloud Batch Job description.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`Job.Builder` The Cloud Batch Job description.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALLOCATION_POLICY_FIELD_NUMBER`
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`LOGS_POLICY_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`NOTIFICATIONS_FIELD_NUMBER`
`static int`	`PRIORITY_FIELD_NUMBER`
`static int`	`STATUS_FIELD_NUMBER`
`static int`	`TASK_GROUPS_FIELD_NUMBER`
`static int`	`UID_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates.
`boolean`	`equals(Object obj)`
`AllocationPolicy`	`getAllocationPolicy()` Compute resource allocation for all TaskGroups in the Job.
`AllocationPolicyOrBuilder`	`getAllocationPolicyOrBuilder()` Compute resource allocation for all TaskGroups in the Job.
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`static Job`	`getDefaultInstance()`
`Job`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates.
`Map<String,String>`	`getLabelsMap()` Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates.
`String`	`getLabelsOrThrow(String key)` Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates.
`LogsPolicy`	`getLogsPolicy()` Log preservation policy for the Job.
`LogsPolicyOrBuilder`	`getLogsPolicyOrBuilder()` Log preservation policy for the Job.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`JobNotification`	`getNotifications(int index)` Notification configurations.
`int`	`getNotificationsCount()` Notification configurations.
`List<JobNotification>`	`getNotificationsList()` Notification configurations.
`JobNotificationOrBuilder`	`getNotificationsOrBuilder(int index)` Notification configurations.
`List<? extends JobNotificationOrBuilder>`	`getNotificationsOrBuilderList()` Notification configurations.
`com.google.protobuf.Parser<Job>`	`getParserForType()`
`long`	`getPriority()` Priority of the Job.
`int`	`getSerializedSize()`
`JobStatus`	`getStatus()` Output only.
`JobStatusOrBuilder`	`getStatusOrBuilder()` Output only.
`TaskGroup`	`getTaskGroups(int index)` Required.
`int`	`getTaskGroupsCount()` Required.
`List<TaskGroup>`	`getTaskGroupsList()` Required.
`TaskGroupOrBuilder`	`getTaskGroupsOrBuilder(int index)` Required.
`List<? extends TaskGroupOrBuilder>`	`getTaskGroupsOrBuilderList()` Required.
`String`	`getUid()` Output only.
`com.google.protobuf.ByteString`	`getUidBytes()` Output only.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`boolean`	`hasAllocationPolicy()` Compute resource allocation for all TaskGroups in the Job.
`boolean`	`hasCreateTime()` Output only.
`int`	`hashCode()`
`boolean`	`hasLogsPolicy()` Log preservation policy for the Job.
`boolean`	`hasStatus()` Output only.
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static Job.Builder`	`newBuilder()`
`static Job.Builder`	`newBuilder(Job prototype)`
`Job.Builder`	`newBuilderForType()`
`protected Job.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Job`	`parseDelimitedFrom(InputStream input)`
`static Job`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Job`	`parseFrom(byte[] data)`
`static Job`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Job`	`parseFrom(ByteBuffer data)`
`static Job`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Job`	`parseFrom(com.google.protobuf.ByteString data)`
`static Job`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Job`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Job`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Job`	`parseFrom(InputStream input)`
`static Job`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Job>`	`parser()`
`Job.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UID_FIELD_NUMBER
```
public static final int UID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PRIORITY_FIELD_NUMBER
```
public static final int PRIORITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TASK_GROUPS_FIELD_NUMBER
```
public static final int TASK_GROUPS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALLOCATION_POLICY_FIELD_NUMBER
```
public static final int ALLOCATION_POLICY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATUS_FIELD_NUMBER
```
public static final int STATUS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LOGS_POLICY_FIELD_NUMBER
```
public static final int LOGS_POLICY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NOTIFICATIONS_FIELD_NUMBER
```
public static final int NOTIFICATIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName
```
public String getName()
```
```
 Output only. Job name.
 For example: "projects/123456/locations/us-central1/jobs/job01".
 
```
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getName in interface JobOrBuilder

Returns:

The name.

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Output only. Job name.
 For example: "projects/123456/locations/us-central1/jobs/job01".
 
```
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getNameBytes in interface JobOrBuilder

Returns:

The bytes for name.

getUid
```
public String getUid()
```
```
 Output only. A system generated unique ID for the Job.
 
```
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUid in interface JobOrBuilder

Returns:

The uid.

getUidBytes
```
public com.google.protobuf.ByteString getUidBytes()
```
```
 Output only. A system generated unique ID for the Job.
 
```
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUidBytes in interface JobOrBuilder

Returns:

The bytes for uid.

getPriority

public long getPriority()

 Priority of the Job.
 The valid value range is [0, 100). Default value is 0.
 Higher value indicates higher priority.
 A job with higher priority value is more likely to run earlier if all other
 requirements are satisfied.

int64 priority = 3;

Specified by:: getPriority in interface JobOrBuilder
Returns:: The priority.

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];
Specified by:

getTaskGroupsList in interface JobOrBuilder

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];
Specified by:

getTaskGroupsOrBuilderList in interface JobOrBuilder

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];
Specified by:

getTaskGroupsCount in interface JobOrBuilder

getTaskGroups
```
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];
Specified by:

getTaskGroups in interface JobOrBuilder

getTaskGroupsOrBuilder
```
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];
Specified by:

getTaskGroupsOrBuilder in interface JobOrBuilder

hasAllocationPolicy
```
public boolean hasAllocationPolicy()
```
```
 Compute resource allocation for all TaskGroups in the Job.
 
```
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
Specified by:

hasAllocationPolicy in interface JobOrBuilder

Returns:

Whether the allocationPolicy field is set.

getAllocationPolicy
```
public AllocationPolicy getAllocationPolicy()
```
```
 Compute resource allocation for all TaskGroups in the Job.
 
```
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
Specified by:

getAllocationPolicy in interface JobOrBuilder

Returns:

The allocationPolicy.

getAllocationPolicyOrBuilder
```
public AllocationPolicyOrBuilder getAllocationPolicyOrBuilder()
```
```
 Compute resource allocation for all TaskGroups in the Job.
 
```
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
Specified by:

getAllocationPolicyOrBuilder in interface JobOrBuilder