Class: Google::Cloud::AIPlatform::V1::Artifact

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

Overview

Instance of a general artifact.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Timestamp when this Artifact was created.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

#description ⇒ ::String

Returns Description of the Artifact.

Returns:

  • (::String) —

    Description of the Artifact



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

#display_name ⇒ ::String

Returns User provided display name of the Artifact. May be up to 128 Unicode characters.

Returns:

  • (::String) —

    User provided display name of the Artifact. May be up to 128 Unicode characters.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

#etag ⇒ ::String

Returns An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns:

  • (::String) —

    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

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

Returns The labels with user-defined metadata to organize your Artifacts.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).

Returns:

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

    The labels with user-defined metadata to organize your Artifacts.

    Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

#metadata ⇒ ::Google::Protobuf::Struct

Returns Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.

Returns:

  • (::Google::Protobuf::Struct) —

    Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the Artifact.

Returns:

  • (::String) —

    Output only. The resource name of the Artifact.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

#schema_title ⇒ ::String

Returns The title of the schema describing the metadata.

Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.

Returns:

  • (::String) —

    The title of the schema describing the metadata.

    Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

#schema_version ⇒ ::String

Returns The version of the schema in schema_name to use.

Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.

Returns:

  • (::String) —

    The version of the schema in schema_name to use.

    Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

#state ⇒ ::Google::Cloud::AIPlatform::V1::Artifact::State

Returns The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.

Returns:

  • (::Google::Cloud::AIPlatform::V1::Artifact::State) —

    The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

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

Returns Output only. Timestamp when this Artifact was last updated.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end

#uri ⇒ ::String

Returns The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.

Returns:

  • (::String) —

    The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/aiplatform/v1/artifact.rb', line 83

class Artifact
  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

  # Describes the state of the Artifact.
  module State
    # Unspecified state for the Artifact.
    STATE_UNSPECIFIED = 0

    # A state used by systems like Vertex AI Pipelines to indicate that the
    # underlying data item represented by this Artifact is being created.
    PENDING = 1

    # A state indicating that the Artifact should exist, unless something
    # external to the system deletes it.
    LIVE = 2
  end
end