- 0.73.0 (latest)
- 0.72.0
- 0.70.0
- 0.68.0
- 0.67.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 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
final
class
Job
extends
GeneratedMessageV3
implements
JobOrBuilder
The Cloud Batch Job description.
Protobuf type google.cloud.batch.v1.Job
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > JobImplements
JobOrBuilderStatic Fields
ALLOCATION_POLICY_FIELD_NUMBER
public
static
final
int
ALLOCATION_POLICY_FIELD_NUMBER
CREATE_TIME_FIELD_NUMBER
public
static
final
int
CREATE_TIME_FIELD_NUMBER
LABELS_FIELD_NUMBER
public
static
final
int
LABELS_FIELD_NUMBER
LOGS_POLICY_FIELD_NUMBER
public
static
final
int
LOGS_POLICY_FIELD_NUMBER
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
NOTIFICATIONS_FIELD_NUMBER
public
static
final
int
NOTIFICATIONS_FIELD_NUMBER
PRIORITY_FIELD_NUMBER
public
static
final
int
PRIORITY_FIELD_NUMBER
STATUS_FIELD_NUMBER
public
static
final
int
STATUS_FIELD_NUMBER
TASK_GROUPS_FIELD_NUMBER
public
static
final
int
TASK_GROUPS_FIELD_NUMBER
UID_FIELD_NUMBER
public
static
final
int
UID_FIELD_NUMBER
UPDATE_TIME_FIELD_NUMBER
public
static
final
int
UPDATE_TIME_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Job
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
Job
.
Builder
newBuilder
()
newBuilder(Job prototype)
public
static
Job
.
Builder
newBuilder
(
Job
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Job
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Job
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Job
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Job
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Job
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Job
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Job
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Job
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Job
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Job
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Job
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Job
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Job>
parser
()
Methods
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;
equals(Object obj)
public
boolean
equals
(
Object
obj
)
getAllocationPolicy()
public
AllocationPolicy
getAllocationPolicy
()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
getAllocationPolicyOrBuilder()
public
AllocationPolicyOrBuilder
getAllocationPolicyOrBuilder
()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.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
()
getLabels() (deprecated)
public
Map<String
,
String
>
getLabels
()
Use #getLabelsMap() instead.
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;
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;
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;
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;
getLogsPolicy()
public
LogsPolicy
getLogsPolicy
()
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
getLogsPolicyOrBuilder()
public
LogsPolicyOrBuilder
getLogsPolicyOrBuilder
()
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
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];
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];
getNotifications(int index)
public
JobNotification
getNotifications
(
int
index
)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
getNotificationsCount()
public
int
getNotificationsCount
()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
getNotificationsList()
public
List<JobNotification>
getNotificationsList
()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
getNotificationsOrBuilder(int index)
public
JobNotificationOrBuilder
getNotificationsOrBuilder
(
int
index
)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
getNotificationsOrBuilderList()
public
List
< ?
extends
JobNotificationOrBuilder
>
getNotificationsOrBuilderList
()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
getParserForType()
public
Parser<Job>
getParserForType
()
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;
getSerializedSize()
public
int
getSerializedSize
()
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];
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];
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];
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];
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];
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];
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];
getUid()
public
String
getUid
()
Output only. A system generated unique ID for the Job.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUidBytes()
public
ByteString
getUidBytes
()
Output only. A system generated unique ID for the Job.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v1.AllocationPolicy allocation_policy = 7;
hasCreateTime()
public
boolean
hasCreateTime
()
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasLogsPolicy()
public
boolean
hasLogsPolicy
()
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
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];
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];
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
internalGetMapFieldReflection(int number)
protected
MapFieldReflectionAccessor
internalGetMapFieldReflection
(
int
number
)
com.google.protobuf.MapFieldReflectionAccessor
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
Job
.
Builder
newBuilderForType
()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Job
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
toBuilder()
public
Job
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
