Interface JobOrBuilder (0.54.0)

Version 0.54.0

• 0.55.0 (latest)
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.2
• 0.2.2
• 0.1.1

public interface JobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

Returns
Type	Description
boolean

getAllocationPolicy()

public abstract AllocationPolicy getAllocationPolicy()

Compute resource allocation for all TaskGroups in the Job.

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

Returns
Type	Description
AllocationPolicy	The allocationPolicy.

getAllocationPolicyOrBuilder()

public abstract AllocationPolicyOrBuilder getAllocationPolicyOrBuilder()

Compute resource allocation for all TaskGroups in the Job.

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

Returns
Type	Description
AllocationPolicyOrBuilder

getCreateTime()

public abstract 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 abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. When the Job was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract 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 abstract LogsPolicy getLogsPolicy()

Log preservation policy for the Job.

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

Returns
Type	Description
LogsPolicy	The logsPolicy.

getLogsPolicyOrBuilder()

public abstract LogsPolicyOrBuilder getLogsPolicyOrBuilder()

Log preservation policy for the Job.

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

Returns
Type	Description
LogsPolicyOrBuilder

getName()

public abstract String 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 abstract 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 abstract JobNotification getNotifications(int index)

Notification configurations.

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

Parameter
Name	Description
index	int

Returns
Type	Description
JobNotification

getNotificationsCount()

public abstract int getNotificationsCount()

Notification configurations.

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

Returns
Type	Description
int

getNotificationsList()

public abstract List<JobNotification> getNotificationsList()

Notification configurations.

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

Returns
Type	Description
List<JobNotification>

getNotificationsOrBuilder(int index)

public abstract JobNotificationOrBuilder getNotificationsOrBuilder(int index)

Notification configurations.

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

Parameter
Name	Description
index	int

Returns
Type	Description
JobNotificationOrBuilder

getNotificationsOrBuilderList()

public abstract 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>

getPriority()

public abstract 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.

getStatus()

public abstract 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 abstract 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
Type	Description
JobStatusOrBuilder

getTaskGroups(int index)

public abstract 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

Returns
Type	Description
TaskGroup

getTaskGroupsCount()

public abstract 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 abstract 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
Type	Description
List<TaskGroup>

getTaskGroupsOrBuilder(int index)

public abstract 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

Returns
Type	Description
TaskGroupOrBuilder

getTaskGroupsOrBuilderList()

public abstract 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()

public abstract String getUid()

Output only. A system generated unique ID for the Job.

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

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. A system generated unique ID for the Job.

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

Returns
Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract 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 abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last time the Job was updated.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasAllocationPolicy()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.