Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Artifact (v0.19.0)

Version 0.19.0

• 0.39.0 (latest)
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Artifact.

Instance of a general artifact.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this Artifact was created.

#description

def description() -> ::String

Returns

• (::String) — Description of the Artifact

#description=

def description=(value) -> ::String

Parameter

• value (::String) — Description of the Artifact

Returns

• (::String) — Description of the Artifact

#display_name

def display_name() -> ::String

Returns

• (::String) — User provided display name of the Artifact. May be up to 128 Unicode characters.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::String) — 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.

#etag

def etag() -> ::String

Returns

• (::String) — An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#etag=

def etag=(value) -> ::String

Parameter

• value (::String) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

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).

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::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).

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).

#metadata

def metadata() -> ::Google::Protobuf::Struct

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.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Struct

Parameter

• value (::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.

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.

#name

def name() -> ::String

Returns

• (::String) — Output only. The resource name of the Artifact.

#schema_title

def schema_title() -> ::String

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.

#schema_title=

def schema_title=(value) -> ::String

Parameter

• value (::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.

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.

#schema_version

def schema_version() -> ::String

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.

#schema_version=

def schema_version=(value) -> ::String

Parameter

• value (::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.

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.

#state

def state() -> ::Google::Cloud::AIPlatform::V1::Artifact::State

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.

#state=

def state=(value) -> ::Google::Cloud::AIPlatform::V1::Artifact::State

Parameter

• value (::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.

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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this Artifact was last updated.

#uri

def uri() -> ::String

Returns

• (::String) — The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.

#uri=

def uri=(value) -> ::String

Parameter

• value (::String) — 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.