public final class Job extends GeneratedMessageV3 implements JobOrBuilder
The Cloud Batch Job description.
Protobuf type google.cloud.batch.v1alpha.Job
Static Fields
ALLOCATION_POLICY_FIELD_NUMBER
public static final int ALLOCATION_POLICY_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DEPENDENCIES_FIELD_NUMBER
public static final int DEPENDENCIES_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
LOGS_POLICY_FIELD_NUMBER
public static final int LOGS_POLICY_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
NOTIFICATIONS_FIELD_NUMBER
public static final int NOTIFICATIONS_FIELD_NUMBER
Field Value
NOTIFICATION_FIELD_NUMBER
public static final int NOTIFICATION_FIELD_NUMBER
Field Value
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
Field Value
SCHEDULING_POLICY_FIELD_NUMBER
public static final int SCHEDULING_POLICY_FIELD_NUMBER
Field Value
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Field Value
TASK_GROUPS_FIELD_NUMBER
public static final int TASK_GROUPS_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Job getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Job.Builder newBuilder()
Returns
newBuilder(Job prototype)
public static Job.Builder newBuilder(Job prototype)
Parameter
| Name |
Description |
| prototype |
Job
|
Returns
public static Job parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Job parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Job parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Job parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Job parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Job parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Job> parser()
Returns
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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAllocationPolicy()
public AllocationPolicy getAllocationPolicy()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
getAllocationPolicyOrBuilder()
public AllocationPolicyOrBuilder getAllocationPolicyOrBuilder()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1alpha.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];
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
getDependencies(int index)
public JobDependency getDependencies(int index)
At least one of the dependencies must be satisfied before the Job is
scheduled to run.
Only one JobDependency is supported now.
Not yet implemented.
repeated .google.cloud.batch.v1alpha.JobDependency dependencies = 6;
| Name |
Description |
| index |
int
|
Returns
getDependenciesCount()
public int getDependenciesCount()
At least one of the dependencies must be satisfied before the Job is
scheduled to run.
Only one JobDependency is supported now.
Not yet implemented.
repeated .google.cloud.batch.v1alpha.JobDependency dependencies = 6;
getDependenciesList()
public List<JobDependency> getDependenciesList()
At least one of the dependencies must be satisfied before the Job is
scheduled to run.
Only one JobDependency is supported now.
Not yet implemented.
repeated .google.cloud.batch.v1alpha.JobDependency dependencies = 6;
getDependenciesOrBuilder(int index)
public JobDependencyOrBuilder getDependenciesOrBuilder(int index)
At least one of the dependencies must be satisfied before the Job is
scheduled to run.
Only one JobDependency is supported now.
Not yet implemented.
repeated .google.cloud.batch.v1alpha.JobDependency dependencies = 6;
| Name |
Description |
| index |
int
|
Returns
getDependenciesOrBuilderList()
public List<? extends JobDependencyOrBuilder> getDependenciesOrBuilderList()
At least one of the dependencies must be satisfied before the Job is
scheduled to run.
Only one JobDependency is supported now.
Not yet implemented.
repeated .google.cloud.batch.v1alpha.JobDependency dependencies = 6;
| Type |
Description |
| List<? extends com.google.cloud.batch.v1alpha.JobDependencyOrBuilder> |
|
getLabels()
public Map<String,String> getLabels()
Returns
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;
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;
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;
getLogsPolicy()
public LogsPolicy getLogsPolicy()
Log preservation policy for the Job.
.google.cloud.batch.v1alpha.LogsPolicy logs_policy = 13;
getLogsPolicyOrBuilder()
public LogsPolicyOrBuilder getLogsPolicyOrBuilder()
Log preservation policy for the Job.
.google.cloud.batch.v1alpha.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];
| 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];
getNotification() (deprecated)
public JobNotification getNotification()
Deprecated. google.cloud.batch.v1alpha.Job.notification is deprecated. See
google/cloud/batch/v1alpha/job.proto;l=95
Job notification.
.google.cloud.batch.v1alpha.JobNotification notification = 10 [deprecated = true];
getNotificationOrBuilder()
public JobNotificationOrBuilder getNotificationOrBuilder()
Job notification.
.google.cloud.batch.v1alpha.JobNotification notification = 10 [deprecated = true];
getNotifications(int index)
public JobNotification getNotifications(int index)
Notification configurations.
repeated .google.cloud.batch.v1alpha.JobNotification notifications = 14;
| Name |
Description |
| index |
int
|
Returns
getNotificationsCount()
public int getNotificationsCount()
Notification configurations.
repeated .google.cloud.batch.v1alpha.JobNotification notifications = 14;
getNotificationsList()
public List<JobNotification> getNotificationsList()
Notification configurations.
repeated .google.cloud.batch.v1alpha.JobNotification notifications = 14;
getNotificationsOrBuilder(int index)
public JobNotificationOrBuilder getNotificationsOrBuilder(int index)
Notification configurations.
repeated .google.cloud.batch.v1alpha.JobNotification notifications = 14;
| Name |
Description |
| index |
int
|
Returns
getNotificationsOrBuilderList()
public List<? extends JobNotificationOrBuilder> getNotificationsOrBuilderList()
Notification configurations.
repeated .google.cloud.batch.v1alpha.JobNotification notifications = 14;
| Type |
Description |
| List<? extends com.google.cloud.batch.v1alpha.JobNotificationOrBuilder> |
|
getParserForType()
public Parser<Job> getParserForType()
Returns
Overrides
getPriority()
public long getPriority()
Priority of the Job.
The valid value range is [0, 100).
A job with higher priority value is more likely to run earlier if all other
requirements are satisfied.
int64 priority = 3;
| Type |
Description |
| long |
The priority.
|
getSchedulingPolicy()
public Job.SchedulingPolicy getSchedulingPolicy()
Scheduling policy for TaskGroups in the job.
.google.cloud.batch.v1alpha.Job.SchedulingPolicy scheduling_policy = 5;
getSchedulingPolicyValue()
public int getSchedulingPolicyValue()
Scheduling policy for TaskGroups in the job.
.google.cloud.batch.v1alpha.Job.SchedulingPolicy scheduling_policy = 5;
| Type |
Description |
| int |
The enum numeric value on the wire for schedulingPolicy.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStatus()
public JobStatus getStatus()
Output only. Job status. It is read only for users.
.google.cloud.batch.v1alpha.JobStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStatusOrBuilder()
public JobStatusOrBuilder getStatusOrBuilder()
Output only. Job status. It is read only for users.
.google.cloud.batch.v1alpha.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.v1alpha.TaskGroup task_groups = 4 [(.google.api.field_behavior) = REQUIRED];
| Name |
Description |
| index |
int
|
Returns
getTaskGroupsCount()
public int getTaskGroupsCount()
Required. TaskGroups in the Job. Only one TaskGroup is supported now.
repeated .google.cloud.batch.v1alpha.TaskGroup task_groups = 4 [(.google.api.field_behavior) = REQUIRED];
getTaskGroupsList()
public List<TaskGroup> getTaskGroupsList()
Required. TaskGroups in the Job. Only one TaskGroup is supported now.
repeated .google.cloud.batch.v1alpha.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.v1alpha.TaskGroup task_groups = 4 [(.google.api.field_behavior) = REQUIRED];
| Name |
Description |
| index |
int
|
Returns
getTaskGroupsOrBuilderList()
public List<? extends TaskGroupOrBuilder> getTaskGroupsOrBuilderList()
Required. TaskGroups in the Job. Only one TaskGroup is supported now.
repeated .google.cloud.batch.v1alpha.TaskGroup task_groups = 4 [(.google.api.field_behavior) = REQUIRED];
| Type |
Description |
| List<? extends com.google.cloud.batch.v1alpha.TaskGroupOrBuilder> |
|
getUid()
Output only. A system generated unique ID (in UUID4 format) for the Job.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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.v1alpha.AllocationPolicy allocation_policy = 7;
| 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];
| Type |
Description |
| boolean |
Whether the createTime field is set.
|
hasLogsPolicy()
public boolean hasLogsPolicy()
Log preservation policy for the Job.
.google.cloud.batch.v1alpha.LogsPolicy logs_policy = 13;
| Type |
Description |
| boolean |
Whether the logsPolicy field is set.
|
hasNotification() (deprecated)
public boolean hasNotification()
Deprecated. google.cloud.batch.v1alpha.Job.notification is deprecated. See
google/cloud/batch/v1alpha/job.proto;l=95
Job notification.
.google.cloud.batch.v1alpha.JobNotification notification = 10 [deprecated = true];
| Type |
Description |
| boolean |
Whether the notification field is set.
|
hasStatus()
public boolean hasStatus()
Output only. Job status. It is read only for users.
.google.cloud.batch.v1alpha.JobStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
| Type |
Description |
| boolean |
Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
| Name |
Description |
| number |
int
|
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Job.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Job.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Job.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
