Class: Google::Cloud::Dataplex::V1::Job

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/tasks.rb

Overview

A job represents an instance of a task.

Defined Under Namespace

Modules: Service, State

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. The time when the job ended.

Returns:



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 367

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

  module Service
    # Service used to run the job is unspecified.
    SERVICE_UNSPECIFIED = 0

    # Dataproc service is used to run this job.
    DATAPROC = 1
  end

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

    # The job is running.
    RUNNING = 1

    # The job is cancelling.
    CANCELLING = 2

    # The job cancellation was successful.
    CANCELLED = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job is no longer running due to an error.
    FAILED = 5

    # The job was cancelled outside of Dataplex.
    ABORTED = 6
  end
end

#message ⇒ ::String (readonly)

Returns Output only. Additional information about the current state.

Returns:

  • (::String) —

    Output only. Additional information about the current state.



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 367

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

  module Service
    # Service used to run the job is unspecified.
    SERVICE_UNSPECIFIED = 0

    # Dataproc service is used to run this job.
    DATAPROC = 1
  end

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

    # The job is running.
    RUNNING = 1

    # The job is cancelling.
    CANCELLING = 2

    # The job cancellation was successful.
    CANCELLED = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job is no longer running due to an error.
    FAILED = 5

    # The job was cancelled outside of Dataplex.
    ABORTED = 6
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.

Returns:

  • (::String) —

    Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 367

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

  module Service
    # Service used to run the job is unspecified.
    SERVICE_UNSPECIFIED = 0

    # Dataproc service is used to run this job.
    DATAPROC = 1
  end

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

    # The job is running.
    RUNNING = 1

    # The job is cancelling.
    CANCELLING = 2

    # The job cancellation was successful.
    CANCELLED = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job is no longer running due to an error.
    FAILED = 5

    # The job was cancelled outside of Dataplex.
    ABORTED = 6
  end
end

#retry_count ⇒ ::Integer (readonly)

Returns Output only. The number of times the job has been retried (excluding the initial attempt).

Returns:

  • (::Integer) —

    Output only. The number of times the job has been retried (excluding the initial attempt).



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 367

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

  module Service
    # Service used to run the job is unspecified.
    SERVICE_UNSPECIFIED = 0

    # Dataproc service is used to run this job.
    DATAPROC = 1
  end

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

    # The job is running.
    RUNNING = 1

    # The job is cancelling.
    CANCELLING = 2

    # The job cancellation was successful.
    CANCELLED = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job is no longer running due to an error.
    FAILED = 5

    # The job was cancelled outside of Dataplex.
    ABORTED = 6
  end
end

#service ⇒ ::Google::Cloud::Dataplex::V1::Job::Service (readonly)

Returns Output only. The underlying service running a job.

Returns:



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 367

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

  module Service
    # Service used to run the job is unspecified.
    SERVICE_UNSPECIFIED = 0

    # Dataproc service is used to run this job.
    DATAPROC = 1
  end

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

    # The job is running.
    RUNNING = 1

    # The job is cancelling.
    CANCELLING = 2

    # The job cancellation was successful.
    CANCELLED = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job is no longer running due to an error.
    FAILED = 5

    # The job was cancelled outside of Dataplex.
    ABORTED = 6
  end
end

#service_job ⇒ ::String (readonly)

Returns Output only. The full resource name for the job run under a particular service.

Returns:

  • (::String) —

    Output only. The full resource name for the job run under a particular service.



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 367

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

  module Service
    # Service used to run the job is unspecified.
    SERVICE_UNSPECIFIED = 0

    # Dataproc service is used to run this job.
    DATAPROC = 1
  end

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

    # The job is running.
    RUNNING = 1

    # The job is cancelling.
    CANCELLING = 2

    # The job cancellation was successful.
    CANCELLED = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job is no longer running due to an error.
    FAILED = 5

    # The job was cancelled outside of Dataplex.
    ABORTED = 6
  end
end

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

Returns Output only. The time when the job was started.

Returns:



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 367

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

  module Service
    # Service used to run the job is unspecified.
    SERVICE_UNSPECIFIED = 0

    # Dataproc service is used to run this job.
    DATAPROC = 1
  end

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

    # The job is running.
    RUNNING = 1

    # The job is cancelling.
    CANCELLING = 2

    # The job cancellation was successful.
    CANCELLED = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job is no longer running due to an error.
    FAILED = 5

    # The job was cancelled outside of Dataplex.
    ABORTED = 6
  end
end

#state ⇒ ::Google::Cloud::Dataplex::V1::Job::State (readonly)

Returns Output only. Execution state for the job.

Returns:



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 367

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

  module Service
    # Service used to run the job is unspecified.
    SERVICE_UNSPECIFIED = 0

    # Dataproc service is used to run this job.
    DATAPROC = 1
  end

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

    # The job is running.
    RUNNING = 1

    # The job is cancelling.
    CANCELLING = 2

    # The job cancellation was successful.
    CANCELLED = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job is no longer running due to an error.
    FAILED = 5

    # The job was cancelled outside of Dataplex.
    ABORTED = 6
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. System generated globally unique ID for the job.

Returns:

  • (::String) —

    Output only. System generated globally unique ID for the job.



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 367

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

  module Service
    # Service used to run the job is unspecified.
    SERVICE_UNSPECIFIED = 0

    # Dataproc service is used to run this job.
    DATAPROC = 1
  end

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

    # The job is running.
    RUNNING = 1

    # The job is cancelling.
    CANCELLING = 2

    # The job cancellation was successful.
    CANCELLED = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job is no longer running due to an error.
    FAILED = 5

    # The job was cancelled outside of Dataplex.
    ABORTED = 6
  end
end