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

Inherits:

Object

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

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

• #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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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