Class Job (0.17.0)

  public 
  
 final 
  
 class 
 Job 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 JobOrBuilder 
 

The Cloud Batch Job description.

Protobuf type google.cloud.batch.v1.Job

Implements

JobOrBuilder

Static Fields

ALLOCATION_POLICY_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ALLOCATION_POLICY_FIELD_NUMBER 
 
Field Value
Type
Description
int

CREATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CREATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

LABELS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 LABELS_FIELD_NUMBER 
 
Field Value
Type
Description
int

LOGS_POLICY_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 LOGS_POLICY_FIELD_NUMBER 
 
Field Value
Type
Description
int

NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

NOTIFICATIONS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NOTIFICATIONS_FIELD_NUMBER 
 
Field Value
Type
Description
int

PRIORITY_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 PRIORITY_FIELD_NUMBER 
 
Field Value
Type
Description
int

STATUS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 STATUS_FIELD_NUMBER 
 
Field Value
Type
Description
int

TASK_GROUPS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 TASK_GROUPS_FIELD_NUMBER 
 
Field Value
Type
Description
int

UID_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 UID_FIELD_NUMBER 
 
Field Value
Type
Description
int

UPDATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 UPDATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 Job 
  
 getDefaultInstance 
 () 
 
Returns
Type
Description
Job

getDescriptor()

  public 
  
 static 
  
 final 
  
 Descriptors 
 . 
 Descriptor 
  
 getDescriptor 
 () 
 
Returns
Type
Description

newBuilder()

  public 
  
 static 
  
 Job 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(Job prototype)

  public 
  
 static 
  
 Job 
 . 
 Builder 
  
 newBuilder 
 ( 
 Job 
  
 prototype 
 ) 
 
Parameter
Name
Description
prototype
Job
Returns
Type
Description

parseDelimitedFrom(InputStream input)

  public 
  
 static 
  
 Job 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Job
Exceptions
Type
Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Job 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Job
Exceptions
Type
Description

parseFrom(byte[] data)

  public 
  
 static 
  
 Job 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 ) 
 
Parameter
Name
Description
data
byte []
Returns
Type
Description
Job
Exceptions
Type
Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Job 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
byte []
extensionRegistry
Returns
Type
Description
Job
Exceptions
Type
Description

parseFrom(ByteString data)

  public 
  
 static 
  
 Job 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Job
Exceptions
Type
Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Job 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Job
Exceptions
Type
Description

parseFrom(CodedInputStream input)

  public 
  
 static 
  
 Job 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Job
Exceptions
Type
Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Job 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
extensionRegistry
Returns
Type
Description
Job
Exceptions
Type
Description

parseFrom(InputStream input)

  public 
  
 static 
  
 Job 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Job
Exceptions
Type
Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Job 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Job
Exceptions
Type
Description

parseFrom(ByteBuffer data)

  public 
  
 static 
  
 Job 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Job
Exceptions
Type
Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Job 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Job
Exceptions
Type
Description

parser()

  public 
  
 static 
  
 Parser<Job> 
  
 parser 
 () 
 
Returns
Type
Description
Parser < Job >

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
Name
Description
key
Returns
Type
Description

equals(Object obj)

  public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 ) 
 
Parameter
Name
Description
obj
Returns
Type
Description
Overrides

getAllocationPolicy()

  public 
  
 AllocationPolicy 
  
 getAllocationPolicy 
 () 
 

Compute resource allocation for all TaskGroups in the Job.

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

Returns
Type
Description

The allocationPolicy.

getAllocationPolicyOrBuilder()

  public 
  
 AllocationPolicyOrBuilder 
  
 getAllocationPolicyOrBuilder 
 () 
 

Compute resource allocation for all TaskGroups in the Job.

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

Returns
Type
Description

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

The createTime.

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

getDefaultInstanceForType()

  public 
  
 Job 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description
Job

getLabels()

  public 
  
 Map<String 
 , 
 String 
>  
 getLabels 
 () 
 

Use #getLabelsMap() instead.

Returns
Type
Description
Map < String , String >

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
Type
Description
int

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
Type
Description
Map < String , String >

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
Name
Description
key
defaultValue
Returns
Type
Description

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
Name
Description
key
Returns
Type
Description

getLogsPolicy()

  public 
  
 LogsPolicy 
  
 getLogsPolicy 
 () 
 

Log preservation policy for the Job.

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

Returns
Type
Description

The logsPolicy.

getLogsPolicyOrBuilder()

  public 
  
 LogsPolicyOrBuilder 
  
 getLogsPolicyOrBuilder 
 () 
 

Log preservation policy for the Job.

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

Returns
Type
Description

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

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

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

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

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

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 >

getParserForType()

  public 
  
 Parser<Job> 
  
 getParserForType 
 () 
 
Returns
Type
Description
Parser < Job >
Overrides

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

The priority.

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
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
Type
Description

The status.

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

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

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

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

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 (in UUID4 format) for the Job.

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

Returns
Type
Description

The uid.

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
Type
Description

The bytes for uid.

getUnknownFields()

  public 
  
 final 
  
 UnknownFieldSet 
  
 getUnknownFields 
 () 
 
Returns
Type
Description
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
Type
Description

The updateTime.

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

hasAllocationPolicy()

  public 
  
 boolean 
  
 hasAllocationPolicy 
 () 
 

Compute resource allocation for all TaskGroups in the Job.

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

Returns
Type
Description

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

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

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

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

Whether the updateTime field is set.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

internalGetMapField(int number)

  protected 
  
 MapField 
  
 internalGetMapField 
 ( 
 int 
  
 number 
 ) 
 
Parameter
Name
Description
number
int
Returns
Type
Description
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 Job 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

  protected 
  
 Job 
 . 
 Builder 
  
 newBuilderForType 
 ( 
 GeneratedMessageV3 
 . 
 BuilderParent 
  
 parent 
 ) 
 
Parameter
Name
Description
parent
Returns
Type
Description
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

  protected 
  
 Object 
  
 newInstance 
 ( 
 GeneratedMessageV3 
 . 
 UnusedPrivateParameter 
  
 unused 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Overrides

toBuilder()

  public 
  
 Job 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: