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

Inherits:

Object

Object
Google::Cloud::Dataplex::V1::Job

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, Trigger Classes: LabelsEntry

Instance Attribute Summary collapse

#end_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#execution_spec ⇒ ::Google::Cloud::Dataplex::V1::Task::ExecutionSpec readonly
Output only.
#labels ⇒ ::Google::Protobuf::Map{::String => ::String} readonly
Output only.
#message ⇒ ::String readonly
Output only.
#name ⇒ ::String readonly
Output only.
#retry_count ⇒ ::Integer readonly
Output only.
#service ⇒ ::Google::Cloud::Dataplex::V1::Job::Service readonly
Output only.
#service_job ⇒ ::String readonly
Output only.
#start_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#state ⇒ ::Google::Cloud::Dataplex::V1::Job::State readonly
Output only.
#trigger ⇒ ::Google::Cloud::Dataplex::V1::Job::Trigger readonly
Output only.
#uid ⇒ ::String readonly
Output only.

Instance Attribute Details

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

Returns Output only. The time when the job ended.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. The time when the job ended.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  end
end

#execution_spec ⇒ `::Google::Cloud::Dataplex::V1::Task::ExecutionSpec` (readonly)

Returns Output only. Spec related to how a task is executed.

Returns:

(::Google::Cloud::Dataplex::V1::Task::ExecutionSpec) —
Output only. Spec related to how a task is executed.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  end
end

#labels ⇒ `::Google::Protobuf::Map{::String => ::String}` (readonly)

Returns Output only. User-defined labels for the task.

Returns:

(::Google::Protobuf::Map{::String => ::String}) —
Output only. User-defined labels for the task.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  end
end

#message ⇒ `::String` (readonly)

Returns Output only. Additional information about the current state.

Returns:

(::String) —
Output only. Additional information about the current state.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  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}.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  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).

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  end
end

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

Returns Output only. The underlying service running a job.

Returns:

(::Google::Cloud::Dataplex::V1::Job::Service) —
Output only. The underlying service running a job.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  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.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  end
end

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

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

Returns:

(::Google::Protobuf::Timestamp) —
Output only. The time when the job was started.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  end
end

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

Returns Output only. Execution state for the job.

Returns:

(::Google::Cloud::Dataplex::V1::Job::State) —
Output only. Execution state for the job.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  end
end

#trigger ⇒ `::Google::Cloud::Dataplex::V1::Job::Trigger` (readonly)

Returns Output only. Job execution trigger.

Returns:

(::Google::Cloud::Dataplex::V1::Job::Trigger) —
Output only. Job execution trigger.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  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.

# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 375

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

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

  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

  # Job execution trigger.
  module Trigger
    # The trigger is unspecified.
    TRIGGER_UNSPECIFIED = 0

    # The job was triggered by Dataplex based on trigger spec from task
    # definition.
    TASK_CONFIG = 1

    # The job was triggered by the explicit call of Task API.
    RUN_REQUEST = 2
  end
end

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

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

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

#execution_spec ⇒ ::Google::Cloud::Dataplex::V1::Task::ExecutionSpec (readonly)

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

#message ⇒ ::String (readonly)

#name ⇒ ::String (readonly)

#retry_count ⇒ ::Integer (readonly)

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

#service_job ⇒ ::String (readonly)

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

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

#trigger ⇒ ::Google::Cloud::Dataplex::V1::Job::Trigger (readonly)

#uid ⇒ ::String (readonly)

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

#execution_spec ⇒ `::Google::Cloud::Dataplex::V1::Task::ExecutionSpec` (readonly)

#labels ⇒ `::Google::Protobuf::Map{::String => ::String}` (readonly)

#message ⇒ `::String` (readonly)

#name ⇒ `::String` (readonly)

#retry_count ⇒ `::Integer` (readonly)

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

#service_job ⇒ `::String` (readonly)

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

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

#trigger ⇒ `::Google::Cloud::Dataplex::V1::Job::Trigger` (readonly)

#uid ⇒ `::String` (readonly)