Package com.google.cloud.batch.v1alpha
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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
containsLabels(String key)
Labels for the Job.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.JobDependency
getDependencies(int index)
At least one of the dependencies must be satisfied before the Job is scheduled to run.int
getDependenciesCount()
At least one of the dependencies must be satisfied before the Job is scheduled to run.List<JobDependency>
getDependenciesList()
At least one of the dependencies must be satisfied before the Job is scheduled to run.JobDependencyOrBuilder
getDependenciesOrBuilder(int index)
At least one of the dependencies must be satisfied before the Job is scheduled to run.List<? extends JobDependencyOrBuilder>
getDependenciesOrBuilderList()
At least one of the dependencies must be satisfied before the Job is scheduled to run.Map<String,String>
getLabels()
Deprecated.int
getLabelsCount()
Labels for the Job.Map<String,String>
getLabelsMap()
Labels for the Job.String
getLabelsOrDefault(String key, String defaultValue)
Labels for the Job.String
getLabelsOrThrow(String key)
Labels for the Job.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
getNotification()
Deprecated.google.cloud.batch.v1alpha.Job.notification is deprecated.JobNotificationOrBuilder
getNotificationOrBuilder()
Deprecated.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.Job.SchedulingPolicy
getSchedulingPolicy()
Scheduling policy for TaskGroups in the job.int
getSchedulingPolicyValue()
Scheduling policy for TaskGroups in 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
hasNotification()
Deprecated.google.cloud.batch.v1alpha.Job.notification is deprecated.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
-
-
-
-
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 (in UUID4 format) 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 (in UUID4 format) 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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.TaskGroup task_groups = 4 [(.google.api.field_behavior) = REQUIRED];
-
getSchedulingPolicyValue
int getSchedulingPolicyValue()
Scheduling policy for TaskGroups in the job.
.google.cloud.batch.v1alpha.Job.SchedulingPolicy scheduling_policy = 5;
- Returns:
- The enum numeric value on the wire for schedulingPolicy.
-
getSchedulingPolicy
Job.SchedulingPolicy getSchedulingPolicy()
Scheduling policy for TaskGroups in the job.
.google.cloud.batch.v1alpha.Job.SchedulingPolicy scheduling_policy = 5;
- Returns:
- The schedulingPolicy.
-
getDependenciesList
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;
-
getDependencies
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;
-
getDependenciesCount
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;
-
getDependenciesOrBuilderList
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;
-
getDependenciesOrBuilder
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;
-
hasAllocationPolicy
boolean hasAllocationPolicy()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1alpha.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.v1alpha.AllocationPolicy allocation_policy = 7;
- Returns:
- The allocationPolicy.
-
getAllocationPolicyOrBuilder
AllocationPolicyOrBuilder getAllocationPolicyOrBuilder()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1alpha.AllocationPolicy allocation_policy = 7;
-
getLabelsCount
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](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8;
-
containsLabels
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](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8;
-
getLabels
@Deprecated Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.
-
getLabelsMap
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](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8;
-
getLabelsOrDefault
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](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8;
-
getLabelsOrThrow
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](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
map<string, string> labels = 8;
-
hasStatus
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];
- Returns:
- Whether the status field is set.
-
getStatus
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];
- Returns:
- The status.
-
getStatusOrBuilder
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];
-
hasNotification
@Deprecated boolean hasNotification()
Deprecated.google.cloud.batch.v1alpha.Job.notification is deprecated. See google/cloud/batch/v1alpha/job.proto;l=96Deprecated: please use notifications instead.
.google.cloud.batch.v1alpha.JobNotification notification = 10 [deprecated = true];
- Returns:
- Whether the notification field is set.
-
getNotification
@Deprecated JobNotification getNotification()
Deprecated.google.cloud.batch.v1alpha.Job.notification is deprecated. See google/cloud/batch/v1alpha/job.proto;l=96Deprecated: please use notifications instead.
.google.cloud.batch.v1alpha.JobNotification notification = 10 [deprecated = true];
- Returns:
- The notification.
-
getNotificationOrBuilder
@Deprecated JobNotificationOrBuilder getNotificationOrBuilder()
Deprecated.Deprecated: please use notifications instead.
.google.cloud.batch.v1alpha.JobNotification notification = 10 [deprecated = true];
-
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.v1alpha.LogsPolicy logs_policy = 13;
- Returns:
- Whether the logsPolicy field is set.
-
getLogsPolicy
LogsPolicy getLogsPolicy()
Log preservation policy for the Job.
.google.cloud.batch.v1alpha.LogsPolicy logs_policy = 13;
- Returns:
- The logsPolicy.
-
getLogsPolicyOrBuilder
LogsPolicyOrBuilder getLogsPolicyOrBuilder()
Log preservation policy for the Job.
.google.cloud.batch.v1alpha.LogsPolicy logs_policy = 13;
-
getNotificationsList
List<JobNotification> getNotificationsList()
Notification configurations.
repeated .google.cloud.batch.v1alpha.JobNotification notifications = 14;
-
getNotifications
JobNotification getNotifications(int index)
Notification configurations.
repeated .google.cloud.batch.v1alpha.JobNotification notifications = 14;
-
getNotificationsCount
int getNotificationsCount()
Notification configurations.
repeated .google.cloud.batch.v1alpha.JobNotification notifications = 14;
-
getNotificationsOrBuilderList
List<? extends JobNotificationOrBuilder> getNotificationsOrBuilderList()
Notification configurations.
repeated .google.cloud.batch.v1alpha.JobNotification notifications = 14;
-
getNotificationsOrBuilder
JobNotificationOrBuilder getNotificationsOrBuilder(int index)
Notification configurations.
repeated .google.cloud.batch.v1alpha.JobNotification notifications = 14;
-
-