com.google.cloud.batch.v1

Interface JobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Job, Job.Builder

public interface JobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

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.
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.
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.
long	getPriority() Priority of the Job.
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.
boolean	hasLogsPolicy() Log preservation policy for the Job.
boolean	hasStatus() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

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];

Returns:

The bytes for name.

getUid

String getUid()

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

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

Returns:

The uid.

getUidBytes

com.google.protobuf.ByteString getUidBytes()

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

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

Returns:

The bytes for uid.

getPriority

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:

The priority.

getTaskGroupsList

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];

getTaskGroups

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];

getTaskGroupsCount

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];

getTaskGroupsOrBuilderList

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];

getTaskGroupsOrBuilder

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];

hasAllocationPolicy

boolean hasAllocationPolicy()

 Compute resource allocation for all TaskGroups in the Job.
 

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

Returns:

Whether the allocationPolicy field is set.

getAllocationPolicy

AllocationPolicy getAllocationPolicy()

 Compute resource allocation for all TaskGroups in the Job.
 

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

Returns:

The allocationPolicy.

getAllocationPolicyOrBuilder

AllocationPolicyOrBuilder getAllocationPolicyOrBuilder()

 Compute resource allocation for all TaskGroups in the Job.
 

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

getLabelsCount

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.

 Use labels to group and describe the resources they are applied to. Batch
 automatically applies predefined labels and supports multiple `labels`
 fields for each job, which each let you apply custom labels to various
 resources. Label names that start with "goog-" or "google-" are
 reserved for predefined labels. For more information about labels with
 Batch, see
 [Organize resources using
 labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
 

map<string, string> labels = 8;

containsLabels

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.

 Use labels to group and describe the resources they are applied to. Batch
 automatically applies predefined labels and supports multiple `labels`
 fields for each job, which each let you apply custom labels to various
 resources. Label names that start with "goog-" or "google-" are
 reserved for predefined labels. For more information about labels with
 Batch, see
 [Organize resources using
 labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
 

map<string, string> labels = 8;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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.

 Use labels to group and describe the resources they are applied to. Batch
 automatically applies predefined labels and supports multiple `labels`
 fields for each job, which each let you apply custom labels to various
 resources. Label names that start with "goog-" or "google-" are
 reserved for predefined labels. For more information about labels with
 Batch, see
 [Organize resources using
 labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
 

map<string, string> labels = 8;

getLabelsOrDefault

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.

 Use labels to group and describe the resources they are applied to. Batch
 automatically applies predefined labels and supports multiple `labels`
 fields for each job, which each let you apply custom labels to various
 resources. Label names that start with "goog-" or "google-" are
 reserved for predefined labels. For more information about labels with
 Batch, see
 [Organize resources using
 labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
 

map<string, string> labels = 8;

getLabelsOrThrow

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.

 Use labels to group and describe the resources they are applied to. Batch
 automatically applies predefined labels and supports multiple `labels`
 fields for each job, which each let you apply custom labels to various
 resources. Label names that start with "goog-" or "google-" are
 reserved for predefined labels. For more information about labels with
 Batch, see
 [Organize resources using
 labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
 

map<string, string> labels = 8;

hasStatus

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:

Whether the status field is set.

getStatus

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:

The status.

getStatusOrBuilder

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];

hasCreateTime

boolean hasCreateTime()

 Output only. When the Job was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. When the Job was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. When the Job was created.
 

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

hasUpdateTime

boolean hasUpdateTime()

 Output only. The last time the Job was updated.
 

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

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. The last time the Job was updated.
 

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. The last time the Job was updated.
 

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

hasLogsPolicy

boolean hasLogsPolicy()

 Log preservation policy for the Job.
 

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

Returns:

Whether the logsPolicy field is set.

getLogsPolicy

LogsPolicy getLogsPolicy()

 Log preservation policy for the Job.
 

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

Returns:

The logsPolicy.

getLogsPolicyOrBuilder

LogsPolicyOrBuilder getLogsPolicyOrBuilder()

 Log preservation policy for the Job.
 

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

getNotificationsList

List<JobNotification> getNotificationsList()

 Notification configurations.
 

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

getNotifications

JobNotification getNotifications(int index)

 Notification configurations.
 

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

getNotificationsCount

int getNotificationsCount()

 Notification configurations.
 

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

getNotificationsOrBuilderList

List<? extends JobNotificationOrBuilder> getNotificationsOrBuilderList()

 Notification configurations.
 

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

getNotificationsOrBuilder

JobNotificationOrBuilder getNotificationsOrBuilder(int index)

 Notification configurations.
 

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