Class Job (0.17.32)

Job(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The Cloud Batch Job description.

Attributes

Name Description
name str
Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
uid str
Output only. A system generated unique ID for the Job.
priority int
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 MutableSequence[google.cloud.batch_v1alpha.types.TaskGroup]
Required. TaskGroups in the Job. Only one TaskGroup is supported now.
scheduling_policy google.cloud.batch_v1alpha.types.Job.SchedulingPolicy
Scheduling policy for TaskGroups in the job.
dependencies MutableSequence[google.cloud.batch_v1alpha.types.JobDependency]
At least one of the dependencies must be satisfied before the Job is scheduled to run. Only one JobDependency is supported now. Not yet implemented.
allocation_policy google.cloud.batch_v1alpha.types.AllocationPolicy
Compute resource allocation for all TaskGroups in the Job.
labels MutableMapping[str, str]
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 google.cloud.batch_v1alpha.types.JobStatus
Output only. Job status. It is read only for users.
notification google.cloud.batch_v1alpha.types.JobNotification
Deprecated: please use notifications instead.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. When the Job was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The last time the Job was updated.
logs_policy google.cloud.batch_v1alpha.types.LogsPolicy
Log preservation policy for the Job.
notifications MutableSequence[google.cloud.batch_v1alpha.types.JobNotification]
Notification configurations.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

SchedulingPolicy

SchedulingPolicy(value)

The order that TaskGroups are scheduled relative to each other. Not yet implemented.