Class: Google::Cloud::Dataplex::V1::JobEvent

Inherits:

Object

• Object
• Google::Cloud::Dataplex::V1::JobEvent

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dataplex/v1/logs.rb

Overview

The payload associated with Job logs that contains events describing jobs that have run within a Lake.

Defined Under Namespace

Modules: Service, State, Type

Instance Attribute Summary

• #end_time ⇒ ::Google::Protobuf::Timestamp

  The time when the job ended running.

• #job_id ⇒ ::String

  The unique id identifying the job.

• #message ⇒ ::String

  The log message.

• #retries ⇒ ::Integer

  The number of retries.

• #service ⇒ ::Google::Cloud::Dataplex::V1::JobEvent::Service

  The service used to execute the job.

• #service_job ⇒ ::String

  The reference to the job within the service.

• #start_time ⇒ ::Google::Protobuf::Timestamp

  The time when the job started running.

• #state ⇒ ::Google::Cloud::Dataplex::V1::JobEvent::State

  The job state on completion.

• #type ⇒ ::Google::Cloud::Dataplex::V1::JobEvent::Type

  The type of the job.

Instance Attribute Details

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when the job ended running.

Returns:

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

  The time when the job ended running.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 193

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

  # The type of the job.
  module Type
    # Unspecified job type.
    TYPE_UNSPECIFIED = 0

    # Spark jobs.
    SPARK = 1

    # Notebook jobs.
    NOTEBOOK = 2
  end

  # The completion status of the job.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Job successfully completed.
    SUCCEEDED = 1

    # Job was unsuccessful.
    FAILED = 2

    # Job was cancelled by the user.
    CANCELLED = 3

    # Job was cancelled or aborted via the service executing the job.
    ABORTED = 4
  end

  # The service used to execute the job.
  module Service
    # Unspecified service.
    SERVICE_UNSPECIFIED = 0

    # Cloud Dataproc.
    DATAPROC = 1
  end
end

#job_id ⇒ ::String

Returns The unique id identifying the job.

Returns:

• (::String) —

  The unique id identifying the job.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 193

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

  # The type of the job.
  module Type
    # Unspecified job type.
    TYPE_UNSPECIFIED = 0

    # Spark jobs.
    SPARK = 1

    # Notebook jobs.
    NOTEBOOK = 2
  end

  # The completion status of the job.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Job successfully completed.
    SUCCEEDED = 1

    # Job was unsuccessful.
    FAILED = 2

    # Job was cancelled by the user.
    CANCELLED = 3

    # Job was cancelled or aborted via the service executing the job.
    ABORTED = 4
  end

  # The service used to execute the job.
  module Service
    # Unspecified service.
    SERVICE_UNSPECIFIED = 0

    # Cloud Dataproc.
    DATAPROC = 1
  end
end

#message ⇒ ::String

Returns The log message.

Returns:

• (::String) —

  The log message.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 193

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

  # The type of the job.
  module Type
    # Unspecified job type.
    TYPE_UNSPECIFIED = 0

    # Spark jobs.
    SPARK = 1

    # Notebook jobs.
    NOTEBOOK = 2
  end

  # The completion status of the job.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Job successfully completed.
    SUCCEEDED = 1

    # Job was unsuccessful.
    FAILED = 2

    # Job was cancelled by the user.
    CANCELLED = 3

    # Job was cancelled or aborted via the service executing the job.
    ABORTED = 4
  end

  # The service used to execute the job.
  module Service
    # Unspecified service.
    SERVICE_UNSPECIFIED = 0

    # Cloud Dataproc.
    DATAPROC = 1
  end
end

#retries ⇒ ::Integer

Returns The number of retries.

Returns:

• (::Integer) —

  The number of retries.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 193

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

  # The type of the job.
  module Type
    # Unspecified job type.
    TYPE_UNSPECIFIED = 0

    # Spark jobs.
    SPARK = 1

    # Notebook jobs.
    NOTEBOOK = 2
  end

  # The completion status of the job.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Job successfully completed.
    SUCCEEDED = 1

    # Job was unsuccessful.
    FAILED = 2

    # Job was cancelled by the user.
    CANCELLED = 3

    # Job was cancelled or aborted via the service executing the job.
    ABORTED = 4
  end

  # The service used to execute the job.
  module Service
    # Unspecified service.
    SERVICE_UNSPECIFIED = 0

    # Cloud Dataproc.
    DATAPROC = 1
  end
end

#service ⇒ ::Google::Cloud::Dataplex::V1::JobEvent::Service

Returns The service used to execute the job.

Returns:

• (::Google::Cloud::Dataplex::V1::JobEvent::Service) —

  The service used to execute the job.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 193

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

  # The type of the job.
  module Type
    # Unspecified job type.
    TYPE_UNSPECIFIED = 0

    # Spark jobs.
    SPARK = 1

    # Notebook jobs.
    NOTEBOOK = 2
  end

  # The completion status of the job.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Job successfully completed.
    SUCCEEDED = 1

    # Job was unsuccessful.
    FAILED = 2

    # Job was cancelled by the user.
    CANCELLED = 3

    # Job was cancelled or aborted via the service executing the job.
    ABORTED = 4
  end

  # The service used to execute the job.
  module Service
    # Unspecified service.
    SERVICE_UNSPECIFIED = 0

    # Cloud Dataproc.
    DATAPROC = 1
  end
end

#service_job ⇒ ::String

Returns The reference to the job within the service.

Returns:

• (::String) —

  The reference to the job within the service.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 193

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

  # The type of the job.
  module Type
    # Unspecified job type.
    TYPE_UNSPECIFIED = 0

    # Spark jobs.
    SPARK = 1

    # Notebook jobs.
    NOTEBOOK = 2
  end

  # The completion status of the job.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Job successfully completed.
    SUCCEEDED = 1

    # Job was unsuccessful.
    FAILED = 2

    # Job was cancelled by the user.
    CANCELLED = 3

    # Job was cancelled or aborted via the service executing the job.
    ABORTED = 4
  end

  # The service used to execute the job.
  module Service
    # Unspecified service.
    SERVICE_UNSPECIFIED = 0

    # Cloud Dataproc.
    DATAPROC = 1
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when the job started running.

Returns:

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

  The time when the job started running.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 193

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

  # The type of the job.
  module Type
    # Unspecified job type.
    TYPE_UNSPECIFIED = 0

    # Spark jobs.
    SPARK = 1

    # Notebook jobs.
    NOTEBOOK = 2
  end

  # The completion status of the job.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Job successfully completed.
    SUCCEEDED = 1

    # Job was unsuccessful.
    FAILED = 2

    # Job was cancelled by the user.
    CANCELLED = 3

    # Job was cancelled or aborted via the service executing the job.
    ABORTED = 4
  end

  # The service used to execute the job.
  module Service
    # Unspecified service.
    SERVICE_UNSPECIFIED = 0

    # Cloud Dataproc.
    DATAPROC = 1
  end
end

#state ⇒ ::Google::Cloud::Dataplex::V1::JobEvent::State

Returns The job state on completion.

Returns:

• (::Google::Cloud::Dataplex::V1::JobEvent::State) —

  The job state on completion.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 193

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

  # The type of the job.
  module Type
    # Unspecified job type.
    TYPE_UNSPECIFIED = 0

    # Spark jobs.
    SPARK = 1

    # Notebook jobs.
    NOTEBOOK = 2
  end

  # The completion status of the job.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Job successfully completed.
    SUCCEEDED = 1

    # Job was unsuccessful.
    FAILED = 2

    # Job was cancelled by the user.
    CANCELLED = 3

    # Job was cancelled or aborted via the service executing the job.
    ABORTED = 4
  end

  # The service used to execute the job.
  module Service
    # Unspecified service.
    SERVICE_UNSPECIFIED = 0

    # Cloud Dataproc.
    DATAPROC = 1
  end
end

#type ⇒ ::Google::Cloud::Dataplex::V1::JobEvent::Type

Returns The type of the job.

Returns:

• (::Google::Cloud::Dataplex::V1::JobEvent::Type) —

  The type of the job.

# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 193

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

  # The type of the job.
  module Type
    # Unspecified job type.
    TYPE_UNSPECIFIED = 0

    # Spark jobs.
    SPARK = 1

    # Notebook jobs.
    NOTEBOOK = 2
  end

  # The completion status of the job.
  module State
    # Unspecified job state.
    STATE_UNSPECIFIED = 0

    # Job successfully completed.
    SUCCEEDED = 1

    # Job was unsuccessful.
    FAILED = 2

    # Job was cancelled by the user.
    CANCELLED = 3

    # Job was cancelled or aborted via the service executing the job.
    ABORTED = 4
  end

  # The service used to execute the job.
  module Service
    # Unspecified service.
    SERVICE_UNSPECIFIED = 0

    # Cloud Dataproc.
    DATAPROC = 1
  end
end