Interface ArtifactOrBuilder (3.21.0)

Version 3.21.0

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public interface ArtifactOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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

map<string, string> labels = 10;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Timestamp when this Artifact was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Artifact was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Description of the Artifact

string description = 17;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Description of the Artifact

string description = 17;

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

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

string display_name = 2;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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

string display_name = 2;

Returns
Type	Description
ByteString	The bytes for displayName.

getEtag()

public abstract String getEtag()

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

string etag = 9;

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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

string etag = 9;

Returns
Type	Description
ByteString	The bytes for etag.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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

map<string, string> labels = 10;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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

map<string, string> labels = 10;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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

map<string, string> labels = 10;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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

map<string, string> labels = 10;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMetadata()

public abstract Struct 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.

.google.protobuf.Struct metadata = 16;

Returns
Type	Description
Struct	The metadata.

getMetadataOrBuilder()

public abstract StructOrBuilder getMetadataOrBuilder()

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

.google.protobuf.Struct metadata = 16;

Returns
Type	Description
StructOrBuilder

getName()

public abstract String getName()

Output only. The resource name of the Artifact.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The resource name of the Artifact.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for name.

getSchemaTitle()

public abstract String 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.

string schema_title = 14;

Returns
Type	Description
String	The schemaTitle.

getSchemaTitleBytes()

public abstract ByteString getSchemaTitleBytes()

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.

string schema_title = 14;

Returns
Type	Description
ByteString	The bytes for schemaTitle.

getSchemaVersion()

public abstract String 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.

string schema_version = 15;

Returns
Type	Description
String	The schemaVersion.

getSchemaVersionBytes()

public abstract ByteString getSchemaVersionBytes()

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.

string schema_version = 15;

Returns
Type	Description
ByteString	The bytes for schemaVersion.

getState()

public abstract Artifact.State 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.

.google.cloud.aiplatform.v1.Artifact.State state = 13;

Returns
Type	Description
Artifact.State	The state.

getStateValue()

public abstract int getStateValue()

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.

.google.cloud.aiplatform.v1.Artifact.State state = 13;

Returns
Type	Description
int	The enum numeric value on the wire for state.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Timestamp when this Artifact was last updated.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this Artifact was last updated.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getUri()

public abstract String getUri()

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

string uri = 6;

Returns
Type	Description
String	The uri.

getUriBytes()

public abstract ByteString getUriBytes()

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

string uri = 6;

Returns
Type	Description
ByteString	The bytes for uri.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Timestamp when this Artifact was created.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasMetadata()

public abstract boolean hasMetadata()

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

.google.protobuf.Struct metadata = 16;

Returns
Type	Description
boolean	Whether the metadata field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Timestamp when this Artifact was last updated.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.