Class: Google::Cloud::Dataproc::V1::JobStatus

Inherits:

Object

• Object
• Google::Cloud::Dataproc::V1::JobStatus

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

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

Overview

Dataproc job status.

Defined Under Namespace

Modules: State, Substate

Instance Attribute Summary

• #details ⇒ ::String readonly

  Optional.

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

  Output only.

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

  Output only.

• #substate ⇒ ::Google::Cloud::Dataproc::V1::JobStatus::Substate readonly

  Output only.

Instance Attribute Details

#details ⇒ ::String (readonly)

Returns Optional. Output only. Job state details, such as an error description if the state is ERROR.

Returns:

• (::String) —

  Optional. Output only. Job state details, such as an error description if the state is ERROR.

# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 541

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

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

    # The job is pending; it has been submitted, but is not yet running.
    PENDING = 1

    # Job has been received by the service and completed initial setup;
    # it will soon be submitted to the cluster.
    SETUP_DONE = 8

    # The job is running on the cluster.
    RUNNING = 2

    # A CancelJob request has been received, but is pending.
    CANCEL_PENDING = 3

    # Transient in-flight resources have been canceled, and the request to
    # cancel the running job has been issued to the cluster.
    CANCEL_STARTED = 7

    # The job cancellation was successful.
    CANCELLED = 4

    # The job has completed successfully.
    DONE = 5

    # The job has completed, but encountered an error.
    ERROR = 6

    # Job attempt has failed. The detail field contains failure details for
    # this attempt.
    #
    # Applies to restartable jobs only.
    ATTEMPT_FAILURE = 9
  end

  # The job substate.
  module Substate
    # The job substate is unknown.
    UNSPECIFIED = 0

    # The Job is submitted to the agent.
    #
    # Applies to RUNNING state.
    SUBMITTED = 1

    # The Job has been received and is awaiting execution (it may be waiting
    # for a condition to be met). See the "details" field for the reason for
    # the delay.
    #
    # Applies to RUNNING state.
    QUEUED = 2

    # The agent-reported status is out of date, which may be caused by a
    # loss of communication between the agent and Dataproc. If the
    # agent does not send a timely update, the job will fail.
    #
    # Applies to RUNNING state.
    STALE_STATUS = 3
  end
end

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

Returns Output only. A state message specifying the overall job state.

Returns:

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

  Output only. A state message specifying the overall job state.

# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 541

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

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

    # The job is pending; it has been submitted, but is not yet running.
    PENDING = 1

    # Job has been received by the service and completed initial setup;
    # it will soon be submitted to the cluster.
    SETUP_DONE = 8

    # The job is running on the cluster.
    RUNNING = 2

    # A CancelJob request has been received, but is pending.
    CANCEL_PENDING = 3

    # Transient in-flight resources have been canceled, and the request to
    # cancel the running job has been issued to the cluster.
    CANCEL_STARTED = 7

    # The job cancellation was successful.
    CANCELLED = 4

    # The job has completed successfully.
    DONE = 5

    # The job has completed, but encountered an error.
    ERROR = 6

    # Job attempt has failed. The detail field contains failure details for
    # this attempt.
    #
    # Applies to restartable jobs only.
    ATTEMPT_FAILURE = 9
  end

  # The job substate.
  module Substate
    # The job substate is unknown.
    UNSPECIFIED = 0

    # The Job is submitted to the agent.
    #
    # Applies to RUNNING state.
    SUBMITTED = 1

    # The Job has been received and is awaiting execution (it may be waiting
    # for a condition to be met). See the "details" field for the reason for
    # the delay.
    #
    # Applies to RUNNING state.
    QUEUED = 2

    # The agent-reported status is out of date, which may be caused by a
    # loss of communication between the agent and Dataproc. If the
    # agent does not send a timely update, the job will fail.
    #
    # Applies to RUNNING state.
    STALE_STATUS = 3
  end
end

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

Returns Output only. The time when this state was entered.

Returns:

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

  Output only. The time when this state was entered.

# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 541

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

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

    # The job is pending; it has been submitted, but is not yet running.
    PENDING = 1

    # Job has been received by the service and completed initial setup;
    # it will soon be submitted to the cluster.
    SETUP_DONE = 8

    # The job is running on the cluster.
    RUNNING = 2

    # A CancelJob request has been received, but is pending.
    CANCEL_PENDING = 3

    # Transient in-flight resources have been canceled, and the request to
    # cancel the running job has been issued to the cluster.
    CANCEL_STARTED = 7

    # The job cancellation was successful.
    CANCELLED = 4

    # The job has completed successfully.
    DONE = 5

    # The job has completed, but encountered an error.
    ERROR = 6

    # Job attempt has failed. The detail field contains failure details for
    # this attempt.
    #
    # Applies to restartable jobs only.
    ATTEMPT_FAILURE = 9
  end

  # The job substate.
  module Substate
    # The job substate is unknown.
    UNSPECIFIED = 0

    # The Job is submitted to the agent.
    #
    # Applies to RUNNING state.
    SUBMITTED = 1

    # The Job has been received and is awaiting execution (it may be waiting
    # for a condition to be met). See the "details" field for the reason for
    # the delay.
    #
    # Applies to RUNNING state.
    QUEUED = 2

    # The agent-reported status is out of date, which may be caused by a
    # loss of communication between the agent and Dataproc. If the
    # agent does not send a timely update, the job will fail.
    #
    # Applies to RUNNING state.
    STALE_STATUS = 3
  end
end

#substate ⇒ ::Google::Cloud::Dataproc::V1::JobStatus::Substate (readonly)

Returns Output only. Additional state information, which includes status reported by the agent.

Returns:

• (::Google::Cloud::Dataproc::V1::JobStatus::Substate) —

  Output only. Additional state information, which includes status reported by the agent.

# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 541

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

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

    # The job is pending; it has been submitted, but is not yet running.
    PENDING = 1

    # Job has been received by the service and completed initial setup;
    # it will soon be submitted to the cluster.
    SETUP_DONE = 8

    # The job is running on the cluster.
    RUNNING = 2

    # A CancelJob request has been received, but is pending.
    CANCEL_PENDING = 3

    # Transient in-flight resources have been canceled, and the request to
    # cancel the running job has been issued to the cluster.
    CANCEL_STARTED = 7

    # The job cancellation was successful.
    CANCELLED = 4

    # The job has completed successfully.
    DONE = 5

    # The job has completed, but encountered an error.
    ERROR = 6

    # Job attempt has failed. The detail field contains failure details for
    # this attempt.
    #
    # Applies to restartable jobs only.
    ATTEMPT_FAILURE = 9
  end

  # The job substate.
  module Substate
    # The job substate is unknown.
    UNSPECIFIED = 0

    # The Job is submitted to the agent.
    #
    # Applies to RUNNING state.
    SUBMITTED = 1

    # The Job has been received and is awaiting execution (it may be waiting
    # for a condition to be met). See the "details" field for the reason for
    # the delay.
    #
    # Applies to RUNNING state.
    QUEUED = 2

    # The agent-reported status is out of date, which may be caused by a
    # loss of communication between the agent and Dataproc. If the
    # agent does not send a timely update, the job will fail.
    #
    # Applies to RUNNING state.
    STALE_STATUS = 3
  end
end