Class Batch (5.9.3)

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

A representation of a batch workload in the service.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
name str
Output only. The resource name of the batch.
uuid str
Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the batch was created.
pyspark_batch google.cloud.dataproc_v1.types.PySparkBatch
Optional. PySpark batch config. This field is a member of oneof_ batch_config.
spark_batch google.cloud.dataproc_v1.types.SparkBatch
Optional. Spark batch config. This field is a member of oneof_ batch_config.
spark_r_batch google.cloud.dataproc_v1.types.SparkRBatch
Optional. SparkR batch config. This field is a member of oneof_ batch_config.
spark_sql_batch google.cloud.dataproc_v1.types.SparkSqlBatch
Optional. SparkSql batch config. This field is a member of oneof_ batch_config.
runtime_info google.cloud.dataproc_v1.types.RuntimeInfo
Output only. Runtime information about batch execution.
state google.cloud.dataproc_v1.types.Batch.State
Output only. The state of the batch.
state_message str
Output only. Batch state details, such as a failure description if the state is FAILED.
state_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the batch entered a current state.
creator str
Output only. The email address of the user who created the batch.
labels MutableMapping[str, str]
Optional. The labels to associate with this batch. Label **keys** must contain 1 to 63 characters, and must conform to RFC 1035 __. Label **values** may be empty, but, if present, must contain 1 to 63 characters, and must conform to `RFC 1035
runtime_config google.cloud.dataproc_v1.types.RuntimeConfig
Optional. Runtime configuration for the batch execution.
environment_config google.cloud.dataproc_v1.types.EnvironmentConfig
Optional. Environment configuration for the batch execution.
operation str
Output only. The resource name of the operation associated with this batch.
state_history MutableSequence[google.cloud.dataproc_v1.types.Batch.StateHistory]
Output only. Historical state information for the batch.

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.

State

State(value)

The batch state.

Values: STATE_UNSPECIFIED (0): The batch state is unknown. PENDING (1): The batch is created before running. RUNNING (2): The batch is running. CANCELLING (3): The batch is cancelling. CANCELLED (4): The batch cancellation was successful. SUCCEEDED (5): The batch completed successfully. FAILED (6): The batch is no longer running due to an error.

StateHistory

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

Historical state information.