Google Cloud Ai Platform V1 Client - Class Artifact (1.5.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Artifact.

Instance of a general artifact.

Generated from protobuf message google.cloud.aiplatform.v1.Artifact

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of the Artifact.

↳ display_name string

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

↳ uri string

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

↳ etag string

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

↳ labels array|Google\Protobuf\Internal\MapField

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

↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when this Artifact was created.

↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp when this Artifact was last updated.

↳ state int

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.

↳ schema_title 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 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.

↳ metadata 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.

↳ description string

Description of the Artifact

getName

Output only. The resource name of the Artifact.

Returns
Type Description
string

setName

Output only. The resource name of the Artifact.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

User provided display name of the Artifact.

May be up to 128 Unicode characters.

Returns
Type Description
string

setDisplayName

User provided display name of the Artifact.

May be up to 128 Unicode characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getUri

The uniform resource identifier of the artifact file.

May be empty if there is no actual artifact file.

Returns
Type Description
string

setUri

The uniform resource identifier of the artifact file.

May be empty if there is no actual artifact file.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

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

Returns
Type Description
string

setEtag

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

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

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
Type Description
Google\Protobuf\Internal\MapField

setLabels

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when this Artifact was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this Artifact was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Timestamp when this Artifact was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this Artifact was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

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
Type Description
int

setState

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getSchemaTitle

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
Type Description
string

setSchemaTitle

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getSchemaVersion

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
Type Description
string

setSchemaVersion

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getMetadata

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
Type Description
Google\Protobuf\Struct|null

hasMetadata

clearMetadata

setMetadata

Properties of the Artifact.

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

Parameter
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this

getDescription

Description of the Artifact

Returns
Type Description
string

setDescription

Description of the Artifact

Parameter
Name Description
var string
Returns
Type Description
$this