public final class Job extends GeneratedMessageV3 implements JobOrBuilder
The Cloud Batch Job description.
Protobuf type google.cloud.batch.v1.Job
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ALLOCATION_POLICY_FIELD_NUMBER
public static final int ALLOCATION_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOGS_POLICY_FIELD_NUMBER
public static final int LOGS_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NOTIFICATIONS_FIELD_NUMBER
public static final int NOTIFICATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TASK_GROUPS_FIELD_NUMBER
public static final int TASK_GROUPS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Job getDefaultInstance()
| Returns |
| Type |
Description |
Job |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Job.Builder newBuilder()
newBuilder(Job prototype)
public static Job.Builder newBuilder(Job prototype)
| Parameter |
| Name |
Description |
prototype |
Job
|
public static Job parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Job |
|
public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
parseFrom(byte[] data)
public static Job parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Job |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
parseFrom(ByteString data)
public static Job parseFrom(ByteString data)
| Returns |
| Type |
Description |
Job |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
public static Job parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Job |
|
public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
public static Job parseFrom(InputStream input)
| Returns |
| Type |
Description |
Job |
|
public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
parseFrom(ByteBuffer data)
public static Job parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Job |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
parser()
public static Parser<Job> parser()
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 |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAllocationPolicy()
public AllocationPolicy getAllocationPolicy()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
getAllocationPolicyOrBuilder()
public AllocationPolicyOrBuilder getAllocationPolicyOrBuilder()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
getCreateTime()
public Timestamp getCreateTime()
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Job getDefaultInstanceForType()
| Returns |
| Type |
Description |
Job |
|
getLabels()
public Map<String,String> getLabels()
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 |
| Type |
Description |
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;
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;
| Returns |
| Type |
Description |
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 |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getLogsPolicy()
public LogsPolicy getLogsPolicy()
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
| Returns |
| Type |
Description |
LogsPolicy |
The logsPolicy.
|
getLogsPolicyOrBuilder()
public LogsPolicyOrBuilder getLogsPolicyOrBuilder()
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
getName()
Output only. Job name.
For example: "projects/123456/locations/us-central1/jobs/job01".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. Job name.
For example: "projects/123456/locations/us-central1/jobs/job01".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getNotifications(int index)
public JobNotification getNotifications(int index)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
| Parameter |
| Name |
Description |
index |
int
|
getNotificationsCount()
public int getNotificationsCount()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
| Returns |
| Type |
Description |
int |
|
getNotificationsList()
public List<JobNotification> getNotificationsList()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
getNotificationsOrBuilder(int index)
public JobNotificationOrBuilder getNotificationsOrBuilder(int index)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
| Parameter |
| Name |
Description |
index |
int
|
getNotificationsOrBuilderList()
public List<? extends JobNotificationOrBuilder> getNotificationsOrBuilderList()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.batch.v1.JobNotificationOrBuilder> |
|
getParserForType()
public Parser<Job> getParserForType()
Overrides
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;
| Returns |
| Type |
Description |
long |
The priority.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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];
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 |
| Name |
Description |
index |
int
|
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 |
| Type |
Description |
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];
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 |
| Name |
Description |
index |
int
|
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 |
| Type |
Description |
List<? extends com.google.cloud.batch.v1.TaskGroupOrBuilder> |
|
getUid()
Output only. A system generated unique ID (in UUID4 format) for the Job.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for uid.
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The last time the Job was updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last time the Job was updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasAllocationPolicy()
public boolean hasAllocationPolicy()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
| Returns |
| Type |
Description |
boolean |
Whether the allocationPolicy field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
boolean |
Whether the status field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The last time the Job was updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Job.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Job.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Job.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
