Reference documentation and code samples for the Google Cloud Batch V1 Client class Job.
The Cloud Batch Job description.
Generated from protobuf message google.cloud.batch.v1.Job
Namespace
Google \ Cloud \ Batch \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
↳ uid
string
Output only. A system generated unique ID for the Job.
↳ priority
int|string
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.
↳ task_groups
↳ allocation_policy
↳ labels
array| Google\Protobuf\Internal\MapField
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
.
↳ status
↳ create_time
↳ update_time
↳ logs_policy
↳ notifications
getName
Output only. Job name.
For example: "projects/123456/locations/us-central1/jobs/job01".
string
setName
Output only. Job name.
For example: "projects/123456/locations/us-central1/jobs/job01".
var
string
$this
getUid
Output only. A system generated unique ID for the Job.
string
setUid
Output only. A system generated unique ID for the Job.
var
string
$this
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.
int|string
setPriority
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.
var
int|string
$this
getTaskGroups
Required. TaskGroups in the Job. Only one TaskGroup is supported now.
setTaskGroups
Required. TaskGroups in the Job. Only one TaskGroup is supported now.
$this
getAllocationPolicy
Compute resource allocation for all TaskGroups in the Job.
hasAllocationPolicy
clearAllocationPolicy
setAllocationPolicy
Compute resource allocation for all TaskGroups in the Job.
$this
getLabels
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
.
setLabels
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
.
$this
getStatus
Output only. Job status. It is read only for users.
hasStatus
clearStatus
setStatus
Output only. Job status. It is read only for users.
$this
getCreateTime
Output only. When the Job was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. When the Job was created.
$this
getUpdateTime
Output only. The last time the Job was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last time the Job was updated.
$this
getLogsPolicy
Log preservation policy for the Job.
hasLogsPolicy
clearLogsPolicy
setLogsPolicy
Log preservation policy for the Job.
$this
getNotifications
Notification configurations.
setNotifications
Notification configurations.
$this
