- 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 static final class Job.Builder extends GeneratedMessageV3.Builder<Job.Builder> implements JobOrBuilder
The Cloud Batch Job description.
Protobuf type google.cloud.batch.v1.Job
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Job.BuilderImplements
JobOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllNotifications(Iterable<? extends JobNotification> values)
public Job.Builder addAllNotifications(Iterable<? extends JobNotification> values)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.batch.v1.JobNotification> |
Returns | |
---|---|
Type | Description |
Job.Builder |
addAllTaskGroups(Iterable<? extends TaskGroup> values)
public Job.Builder addAllTaskGroups(Iterable<? extends TaskGroup> values)
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 |
values |
Iterable<? extends com.google.cloud.batch.v1.TaskGroup> |
Returns | |
---|---|
Type | Description |
Job.Builder |
addNotifications(JobNotification value)
public Job.Builder addNotifications(JobNotification value)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameter | |
---|---|
Name | Description |
value |
JobNotification |
Returns | |
---|---|
Type | Description |
Job.Builder |
addNotifications(JobNotification.Builder builderForValue)
public Job.Builder addNotifications(JobNotification.Builder builderForValue)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameter | |
---|---|
Name | Description |
builderForValue |
JobNotification.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
addNotifications(int index, JobNotification value)
public Job.Builder addNotifications(int index, JobNotification value)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
JobNotification |
Returns | |
---|---|
Type | Description |
Job.Builder |
addNotifications(int index, JobNotification.Builder builderForValue)
public Job.Builder addNotifications(int index, JobNotification.Builder builderForValue)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
JobNotification.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
addNotificationsBuilder()
public JobNotification.Builder addNotificationsBuilder()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Returns | |
---|---|
Type | Description |
JobNotification.Builder |
addNotificationsBuilder(int index)
public JobNotification.Builder addNotificationsBuilder(int index)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
JobNotification.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Job.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Job.Builder |
addTaskGroups(TaskGroup value)
public Job.Builder addTaskGroups(TaskGroup value)
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 |
value |
TaskGroup |
Returns | |
---|---|
Type | Description |
Job.Builder |
addTaskGroups(TaskGroup.Builder builderForValue)
public Job.Builder addTaskGroups(TaskGroup.Builder builderForValue)
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 |
builderForValue |
TaskGroup.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
addTaskGroups(int index, TaskGroup value)
public Job.Builder addTaskGroups(int index, TaskGroup value)
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];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
TaskGroup |
Returns | |
---|---|
Type | Description |
Job.Builder |
addTaskGroups(int index, TaskGroup.Builder builderForValue)
public Job.Builder addTaskGroups(int index, TaskGroup.Builder builderForValue)
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];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
TaskGroup.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
addTaskGroupsBuilder()
public TaskGroup.Builder addTaskGroupsBuilder()
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 |
TaskGroup.Builder |
addTaskGroupsBuilder(int index)
public TaskGroup.Builder addTaskGroupsBuilder(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.Builder |
build()
public Job build()
Returns | |
---|---|
Type | Description |
Job |
buildPartial()
public Job buildPartial()
Returns | |
---|---|
Type | Description |
Job |
clear()
public Job.Builder clear()
Returns | |
---|---|
Type | Description |
Job.Builder |
clearAllocationPolicy()
public Job.Builder clearAllocationPolicy()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
Returns | |
---|---|
Type | Description |
Job.Builder |
clearCreateTime()
public Job.Builder clearCreateTime()
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Job.Builder |
clearField(Descriptors.FieldDescriptor field)
public Job.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Job.Builder |
clearLabels()
public Job.Builder clearLabels()
Returns | |
---|---|
Type | Description |
Job.Builder |
clearLogsPolicy()
public Job.Builder clearLogsPolicy()
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
Returns | |
---|---|
Type | Description |
Job.Builder |
clearName()
public Job.Builder clearName()
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 |
Job.Builder |
This builder for chaining. |
clearNotifications()
public Job.Builder clearNotifications()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Returns | |
---|---|
Type | Description |
Job.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public Job.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Job.Builder |
clearPriority()
public Job.Builder clearPriority()
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 |
Job.Builder |
This builder for chaining. |
clearStatus()
public Job.Builder clearStatus()
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 |
Job.Builder |
clearTaskGroups()
public Job.Builder clearTaskGroups()
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 |
Job.Builder |
clearUid()
public Job.Builder clearUid()
Output only. A system generated unique ID for the Job.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
clearUpdateTime()
public Job.Builder clearUpdateTime()
Output only. The last time the Job was updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Job.Builder |
clone()
public Job.Builder clone()
Returns | |
---|---|
Type | Description |
Job.Builder |
containsLabels(String key)
public boolean containsLabels(String key)
Custom labels to apply to the job and any Cloud Logging 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.
map<string, string> labels = 8;
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
getAllocationPolicy()
public 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. |
getAllocationPolicyBuilder()
public AllocationPolicy.Builder getAllocationPolicyBuilder()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
Returns | |
---|---|
Type | Description |
AllocationPolicy.Builder |
getAllocationPolicyOrBuilder()
public 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 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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public 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 |
getDefaultInstanceForType()
public Job getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Job |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getLabels() (deprecated)
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsCount()
public int getLabelsCount()
Custom labels to apply to the job and any Cloud Logging 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.
map<string, string> labels = 8;
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public Map<String,String> getLabelsMap()
Custom labels to apply to the job and any Cloud Logging 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.
map<string, string> labels = 8;
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Custom labels to apply to the job and any Cloud Logging 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.
map<string, string> labels = 8;
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
Returns | |
---|---|
Type | Description |
String |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Custom labels to apply to the job and any Cloud Logging 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.
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. |
getLogsPolicyBuilder()
public LogsPolicy.Builder getLogsPolicyBuilder()
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
Returns | |
---|---|
Type | Description |
LogsPolicy.Builder |
getLogsPolicyOrBuilder()
public LogsPolicyOrBuilder getLogsPolicyOrBuilder()
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
Returns | |
---|---|
Type | Description |
LogsPolicyOrBuilder |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getName()
public 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 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 |
Returns | |
---|---|
Type | Description |
JobNotification |
getNotificationsBuilder(int index)
public JobNotification.Builder getNotificationsBuilder(int index)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
JobNotification.Builder |
getNotificationsBuilderList()
public List<JobNotification.Builder> getNotificationsBuilderList()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Returns | |
---|---|
Type | Description |
List<Builder> |
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;
Returns | |
---|---|
Type | Description |
List<JobNotification> |
getNotificationsOrBuilder(int index)
public 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 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 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 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. |
getStatusBuilder()
public JobStatus.Builder getStatusBuilder()
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.Builder |
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];
Returns | |
---|---|
Type | Description |
JobStatusOrBuilder |
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 |
Returns | |
---|---|
Type | Description |
TaskGroup |
getTaskGroupsBuilder(int index)
public TaskGroup.Builder getTaskGroupsBuilder(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.Builder |
getTaskGroupsBuilderList()
public List<TaskGroup.Builder> getTaskGroupsBuilderList()
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<Builder> |
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];
Returns | |
---|---|
Type | Description |
List<TaskGroup> |
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 |
Returns | |
---|---|
Type | Description |
TaskGroupOrBuilder |
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()
public 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 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 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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
Output only. The last time the Job was updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
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];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeAllocationPolicy(AllocationPolicy value)
public Job.Builder mergeAllocationPolicy(AllocationPolicy value)
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
Parameter | |
---|---|
Name | Description |
value |
AllocationPolicy |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeCreateTime(Timestamp value)
public Job.Builder mergeCreateTime(Timestamp value)
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeFrom(Job other)
public Job.Builder mergeFrom(Job other)
Parameter | |
---|---|
Name | Description |
other |
Job |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Job.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Job.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Job.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeLogsPolicy(LogsPolicy value)
public Job.Builder mergeLogsPolicy(LogsPolicy value)
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
Parameter | |
---|---|
Name | Description |
value |
LogsPolicy |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeStatus(JobStatus value)
public Job.Builder mergeStatus(JobStatus value)
Output only. Job status. It is read only for users.
.google.cloud.batch.v1.JobStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
JobStatus |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Job.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeUpdateTime(Timestamp value)
public Job.Builder mergeUpdateTime(Timestamp value)
Output only. The last time the Job was updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Job.Builder |
putAllLabels(Map<String,String> values)
public Job.Builder putAllLabels(Map<String,String> values)
Custom labels to apply to the job and any Cloud Logging 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.
map<string, string> labels = 8;
Parameter | |
---|---|
Name | Description |
values |
Map<String,String> |
Returns | |
---|---|
Type | Description |
Job.Builder |
putLabels(String key, String value)
public Job.Builder putLabels(String key, String value)
Custom labels to apply to the job and any Cloud Logging 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.
map<string, string> labels = 8;
Parameters | |
---|---|
Name | Description |
key |
String |
value |
String |
Returns | |
---|---|
Type | Description |
Job.Builder |
removeLabels(String key)
public Job.Builder removeLabels(String key)
Custom labels to apply to the job and any Cloud Logging 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.
map<string, string> labels = 8;
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
Job.Builder |
removeNotifications(int index)
public Job.Builder removeNotifications(int index)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Job.Builder |
removeTaskGroups(int index)
public Job.Builder removeTaskGroups(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 |
Job.Builder |
setAllocationPolicy(AllocationPolicy value)
public Job.Builder setAllocationPolicy(AllocationPolicy value)
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
Parameter | |
---|---|
Name | Description |
value |
AllocationPolicy |
Returns | |
---|---|
Type | Description |
Job.Builder |
setAllocationPolicy(AllocationPolicy.Builder builderForValue)
public Job.Builder setAllocationPolicy(AllocationPolicy.Builder builderForValue)
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
Parameter | |
---|---|
Name | Description |
builderForValue |
AllocationPolicy.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setCreateTime(Timestamp value)
public Job.Builder setCreateTime(Timestamp value)
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Job.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Job.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Job.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Job.Builder |
setLogsPolicy(LogsPolicy value)
public Job.Builder setLogsPolicy(LogsPolicy value)
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
Parameter | |
---|---|
Name | Description |
value |
LogsPolicy |
Returns | |
---|---|
Type | Description |
Job.Builder |
setLogsPolicy(LogsPolicy.Builder builderForValue)
public Job.Builder setLogsPolicy(LogsPolicy.Builder builderForValue)
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
Parameter | |
---|---|
Name | Description |
builderForValue |
LogsPolicy.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setName(String value)
public Job.Builder setName(String value)
Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Job.Builder setNameBytes(ByteString value)
Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
setNotifications(int index, JobNotification value)
public Job.Builder setNotifications(int index, JobNotification value)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
JobNotification |
Returns | |
---|---|
Type | Description |
Job.Builder |
setNotifications(int index, JobNotification.Builder builderForValue)
public Job.Builder setNotifications(int index, JobNotification.Builder builderForValue)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
JobNotification.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setPriority(long value)
public Job.Builder setPriority(long value)
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;
Parameter | |
---|---|
Name | Description |
value |
long The priority to set. |
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Job.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Job.Builder |
setStatus(JobStatus value)
public Job.Builder setStatus(JobStatus value)
Output only. Job status. It is read only for users.
.google.cloud.batch.v1.JobStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
JobStatus |
Returns | |
---|---|
Type | Description |
Job.Builder |
setStatus(JobStatus.Builder builderForValue)
public Job.Builder setStatus(JobStatus.Builder builderForValue)
Output only. Job status. It is read only for users.
.google.cloud.batch.v1.JobStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
JobStatus.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setTaskGroups(int index, TaskGroup value)
public Job.Builder setTaskGroups(int index, TaskGroup value)
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];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
TaskGroup |
Returns | |
---|---|
Type | Description |
Job.Builder |
setTaskGroups(int index, TaskGroup.Builder builderForValue)
public Job.Builder setTaskGroups(int index, TaskGroup.Builder builderForValue)
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];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
TaskGroup.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setUid(String value)
public Job.Builder setUid(String value)
Output only. A system generated unique ID for the Job.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The uid to set. |
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
setUidBytes(ByteString value)
public Job.Builder setUidBytes(ByteString value)
Output only. A system generated unique ID for the Job.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for uid to set. |
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Job.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Job.Builder |
setUpdateTime(Timestamp value)
public Job.Builder setUpdateTime(Timestamp value)
Output only. The last time the Job was updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Job.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public Job.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. The last time the Job was updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |