Class: Google::Cloud::Dataproc::V1::Batch

Inherits:

Object

• Object
• Google::Cloud::Dataproc::V1::Batch

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dataproc/v1/batches.rb

Overview

A representation of a batch workload in the service.

Defined Under Namespace

Modules: State Classes: LabelsEntry, StateHistory

Instance Attribute Summary

• #create_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #creator ⇒ ::String readonly

  Output only.

• #environment_config ⇒ ::Google::Cloud::Dataproc::V1::EnvironmentConfig

  Optional.

• #labels ⇒ ::Google::Protobuf::Map{::String => ::String}

  Optional.

• #name ⇒ ::String readonly

  Output only.

• #operation ⇒ ::String readonly

  Output only.

• #pyspark_batch ⇒ ::Google::Cloud::Dataproc::V1::PySparkBatch

  Optional.

• #runtime_config ⇒ ::Google::Cloud::Dataproc::V1::RuntimeConfig

  Optional.

• #runtime_info ⇒ ::Google::Cloud::Dataproc::V1::RuntimeInfo readonly

  Output only.

• #spark_batch ⇒ ::Google::Cloud::Dataproc::V1::SparkBatch

  Optional.

• #spark_r_batch ⇒ ::Google::Cloud::Dataproc::V1::SparkRBatch

  Optional.

• #spark_sql_batch ⇒ ::Google::Cloud::Dataproc::V1::SparkSqlBatch

  Optional.

• #state ⇒ ::Google::Cloud::Dataproc::V1::Batch::State readonly

  Output only.

• #state_history ⇒ ::Array<::Google::Cloud::Dataproc::V1::Batch::StateHistory> readonly

  Output only.

• #state_message ⇒ ::String readonly

  Output only.

• #state_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #uuid ⇒ ::String readonly

  Output only.

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the batch was created.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. The time when the batch was created.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#creator ⇒ ::String (readonly)

Returns Output only. The email address of the user who created the batch.

Returns:

• (::String) —

  Output only. The email address of the user who created the batch.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#environment_config ⇒ ::Google::Cloud::Dataproc::V1::EnvironmentConfig

Returns Optional. Environment configuration for the batch execution.

Returns:

• (::Google::Cloud::Dataproc::V1::EnvironmentConfig) —

  Optional. Environment configuration for the batch execution.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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. No more than 32 labels can be associated with a batch.

Returns:

• (::Google::Protobuf::Map{::String => ::String}) —

  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. No more than 32 labels can be associated with a batch.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the batch.

Returns:

• (::String) —

  Output only. The resource name of the batch.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#operation ⇒ ::String (readonly)

Returns Output only. The resource name of the operation associated with this batch.

Returns:

• (::String) —

  Output only. The resource name of the operation associated with this batch.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#pyspark_batch ⇒ ::Google::Cloud::Dataproc::V1::PySparkBatch

Returns Optional. PySpark batch config.

Returns:

• (::Google::Cloud::Dataproc::V1::PySparkBatch) —

  Optional. PySpark batch config.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#runtime_config ⇒ ::Google::Cloud::Dataproc::V1::RuntimeConfig

Returns Optional. Runtime configuration for the batch execution.

Returns:

• (::Google::Cloud::Dataproc::V1::RuntimeConfig) —

  Optional. Runtime configuration for the batch execution.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#runtime_info ⇒ ::Google::Cloud::Dataproc::V1::RuntimeInfo (readonly)

Returns Output only. Runtime information about batch execution.

Returns:

• (::Google::Cloud::Dataproc::V1::RuntimeInfo) —

  Output only. Runtime information about batch execution.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#spark_batch ⇒ ::Google::Cloud::Dataproc::V1::SparkBatch

Returns Optional. Spark batch config.

Returns:

• (::Google::Cloud::Dataproc::V1::SparkBatch) —

  Optional. Spark batch config.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#spark_r_batch ⇒ ::Google::Cloud::Dataproc::V1::SparkRBatch

Returns Optional. SparkR batch config.

Returns:

• (::Google::Cloud::Dataproc::V1::SparkRBatch) —

  Optional. SparkR batch config.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#spark_sql_batch ⇒ ::Google::Cloud::Dataproc::V1::SparkSqlBatch

Returns Optional. SparkSql batch config.

Returns:

• (::Google::Cloud::Dataproc::V1::SparkSqlBatch) —

  Optional. SparkSql batch config.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#state ⇒ ::Google::Cloud::Dataproc::V1::Batch::State (readonly)

Returns Output only. The state of the batch.

Returns:

• (::Google::Cloud::Dataproc::V1::Batch::State) —

  Output only. The state of the batch.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#state_history ⇒ ::Array<::Google::Cloud::Dataproc::V1::Batch::StateHistory> (readonly)

Returns Output only. Historical state information for the batch.

Returns:

• (::Array<::Google::Cloud::Dataproc::V1::Batch::StateHistory>) —

  Output only. Historical state information for the batch.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#state_message ⇒ ::String (readonly)

Returns Output only. Batch state details, such as a failure description if the state is FAILED.

Returns:

• (::String) —

  Output only. Batch state details, such as a failure description if the state is FAILED.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#state_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the batch entered a current state.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. The time when the batch entered a current state.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end

#uuid ⇒ ::String (readonly)

Returns Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch.

Returns:

• (::String) —

  Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch.

# File 'proto_docs/google/cloud/dataproc/v1/batches.rb', line 165

class Batch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Historical state information.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Dataproc::V1::Batch::State]
  #     Output only. The state of the batch at this point in history.
  # @!attribute [r] state_message
  #   @return [::String]
  #     Output only. Details about the state at this point in history.
  # @!attribute [r] state_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the batch entered the historical state.
  class StateHistory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The batch state.
  module State
    # The batch state is unknown.
    STATE_UNSPECIFIED = 0

    # The batch is created before running.
    PENDING = 1

    # The batch is running.
    RUNNING = 2

    # The batch is cancelling.
    CANCELLING = 3

    # The batch cancellation was successful.
    CANCELLED = 4

    # The batch completed successfully.
    SUCCEEDED = 5

    # The batch is no longer running due to an error.
    FAILED = 6
  end
end