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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/jobs.rb

Overview

Dataproc job status.

Defined Under Namespace

Modules: State, Substate

Instance Attribute Summary collapse

Instance Attribute Details

#details ⇒ String

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.



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/jobs.rb', line 378

class JobStatus
  # 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

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

Returns:



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/jobs.rb', line 378

class JobStatus
  # 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

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

Returns:



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/jobs.rb', line 378

class JobStatus
  # 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

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

Returns:



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/jobs.rb', line 378

class JobStatus
  # 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