Class: Google::Cloud::DataCatalog::Lineage::V1::Run

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

Overview

A lineage run represents an execution of a process that creates lineage events.

Defined Under Namespace

Modules: State Classes: AttributesEntry

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

Returns Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run).

Up to 100 attributes are allowed.

Returns:

  • (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) —

    Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run).

    Up to 100 attributes are allowed.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/datacatalog/lineage/v1/lineage.rb', line 91

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

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

  # The current state of the run.
  module State
    # The state is unknown. The true state may be any of the below or a
    # different state that is not supported here explicitly.
    UNKNOWN = 0

    # The run is still executing.
    STARTED = 1

    # The run completed.
    COMPLETED = 2

    # The run failed.
    FAILED = 3

    # The run aborted.
    ABORTED = 4
  end
end

#display_name ⇒ ::String

Returns Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&..

Returns:

  • (::String) —

    Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/datacatalog/lineage/v1/lineage.rb', line 91

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

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

  # The current state of the run.
  module State
    # The state is unknown. The true state may be any of the below or a
    # different state that is not supported here explicitly.
    UNKNOWN = 0

    # The run is still executing.
    STARTED = 1

    # The run completed.
    COMPLETED = 2

    # The run failed.
    FAILED = 3

    # The run aborted.
    ABORTED = 4
  end
end

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

Returns Optional. The timestamp of the end of the run.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/datacatalog/lineage/v1/lineage.rb', line 91

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

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

  # The current state of the run.
  module State
    # The state is unknown. The true state may be any of the below or a
    # different state that is not supported here explicitly.
    UNKNOWN = 0

    # The run is still executing.
    STARTED = 1

    # The run completed.
    COMPLETED = 2

    # The run failed.
    FAILED = 3

    # The run aborted.
    ABORTED = 4
  end
end

#name ⇒ ::String

Returns Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:..

Returns:

  • (::String) —

    Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/datacatalog/lineage/v1/lineage.rb', line 91

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

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

  # The current state of the run.
  module State
    # The state is unknown. The true state may be any of the below or a
    # different state that is not supported here explicitly.
    UNKNOWN = 0

    # The run is still executing.
    STARTED = 1

    # The run completed.
    COMPLETED = 2

    # The run failed.
    FAILED = 3

    # The run aborted.
    ABORTED = 4
  end
end

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

Returns Required. The timestamp of the start of the run.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/datacatalog/lineage/v1/lineage.rb', line 91

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

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

  # The current state of the run.
  module State
    # The state is unknown. The true state may be any of the below or a
    # different state that is not supported here explicitly.
    UNKNOWN = 0

    # The run is still executing.
    STARTED = 1

    # The run completed.
    COMPLETED = 2

    # The run failed.
    FAILED = 3

    # The run aborted.
    ABORTED = 4
  end
end

#state ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run::State

Returns Required. The state of the run.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'proto_docs/google/cloud/datacatalog/lineage/v1/lineage.rb', line 91

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

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

  # The current state of the run.
  module State
    # The state is unknown. The true state may be any of the below or a
    # different state that is not supported here explicitly.
    UNKNOWN = 0

    # The run is still executing.
    STARTED = 1

    # The run completed.
    COMPLETED = 2

    # The run failed.
    FAILED = 3

    # The run aborted.
    ABORTED = 4
  end
end