public
final
class
Job
extends
GeneratedMessageV3
implements
JobOrBuilder
The Cloud Batch Job description.
Protobuf type google.cloud.batch.v1.Job
Static Fields
ALLOCATION_POLICY_FIELD_NUMBER
public
static
final
int
ALLOCATION_POLICY_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public
static
final
int
CREATE_TIME_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public
static
final
int
LABELS_FIELD_NUMBER
Field Value
LOGS_POLICY_FIELD_NUMBER
public
static
final
int
LOGS_POLICY_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
Field Value
NOTIFICATIONS_FIELD_NUMBER
public
static
final
int
NOTIFICATIONS_FIELD_NUMBER
Field Value
PRIORITY_FIELD_NUMBER
public
static
final
int
PRIORITY_FIELD_NUMBER
Field Value
STATUS_FIELD_NUMBER
public
static
final
int
STATUS_FIELD_NUMBER
Field Value
TASK_GROUPS_FIELD_NUMBER
public
static
final
int
TASK_GROUPS_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public
static
final
int
UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public
static
final
int
UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public
static
Job
getDefaultInstance
()
Returns
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
Returns
newBuilder()
public
static
Job
.
Builder
newBuilder
()
Returns
newBuilder(Job prototype)
public
static
Job
.
Builder
newBuilder
(
Job
prototype
)
Parameter
Returns
public
static
Job
parseDelimitedFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Job
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public
static
Job
parseFrom
(
byte
[]
data
)
Parameter
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Job
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public
static
Job
parseFrom
(
ByteString
data
)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Job
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Job
parseFrom
(
CodedInputStream
input
)
Parameter
Returns
Exceptions
public
static
Job
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Job
parseFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Job
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public
static
Job
parseFrom
(
ByteBuffer
data
)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Job
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parser()
public
static
Parser<Job>
parser
()
Returns
Methods
containsLabels(String key)
public
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
Returns
equals(Object obj)
public
boolean
equals
(
Object
obj
)
Parameter
Returns
Overrides
getAllocationPolicy()
public
AllocationPolicy
getAllocationPolicy
()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
Returns
getAllocationPolicyOrBuilder()
public
AllocationPolicyOrBuilder
getAllocationPolicyOrBuilder
()
Compute resource allocation for all TaskGroups in the Job.
.google.cloud.batch.v1.AllocationPolicy allocation_policy = 7;
Returns
getCreateTime()
public
Timestamp
getCreateTime
()
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getCreateTimeOrBuilder()
public
TimestampOrBuilder
getCreateTimeOrBuilder
()
Output only. When the Job was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getDefaultInstanceForType()
public
Job
getDefaultInstanceForType
()
Returns
getLabels()
public
Map<String
,
String
>
getLabels
()
Returns
getLabelsCount()
public
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
getLabelsMap()
public
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
getLabelsOrDefault(String key, String defaultValue)
public
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
Returns
getLabelsOrThrow(String key)
public
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
Returns
getLogsPolicy()
public
LogsPolicy
getLogsPolicy
()
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
Returns
getLogsPolicyOrBuilder()
public
LogsPolicyOrBuilder
getLogsPolicyOrBuilder
()
Log preservation policy for the Job.
.google.cloud.batch.v1.LogsPolicy logs_policy = 13;
Returns
getName()
Output only. Job name.
For example: "projects/123456/locations/us-central1/jobs/job01".
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
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
getNotifications(int index)
public
JobNotification
getNotifications
(
int
index
)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameter
Returns
getNotificationsCount()
public
int
getNotificationsCount
()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Returns
getNotificationsList()
public
List<JobNotification>
getNotificationsList
()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Returns
getNotificationsOrBuilder(int index)
public
JobNotificationOrBuilder
getNotificationsOrBuilder
(
int
index
)
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Parameter
Returns
getNotificationsOrBuilderList()
public
List
< ?
extends
JobNotificationOrBuilder
>
getNotificationsOrBuilderList
()
Notification configurations.
repeated .google.cloud.batch.v1.JobNotification notifications = 14;
Returns
getParserForType()
public
Parser<Job>
getParserForType
()
Returns
Overrides
getPriority()
public
long
getPriority
()
Priority of the Job.
The valid value range is [0, 100).
A job with higher priority value is more likely to run earlier if all other
requirements are satisfied.
int64 priority = 3;
Returns
getSerializedSize()
public
int
getSerializedSize
()
Returns
Overrides
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
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
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
Returns
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
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
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
Returns
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
getUid()
Output only. A system generated unique ID (in UUID4 format) for the Job.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getUidBytes()
public
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
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
Returns
Overrides
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
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
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
Returns
Overrides
internalGetMapField(int number)
protected
MapField
internalGetMapField
(
int
number
)
Parameter
Returns
Overrides
isInitialized()
public
final
boolean
isInitialized
()
Returns
Overrides
newBuilderForType()
public
Job
.
Builder
newBuilderForType
()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Job
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
Parameter
Returns
Overrides
toBuilder()
public
Job
.
Builder
toBuilder
()
Returns
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
Parameter
Overrides
Exceptions
