Class protos.google.cloud.aiplatform.v1beta1.Artifact (3.3.0)

Represents an Artifact.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1beta1.IArtifact);

Constructs a new Artifact.

Parameter
NameDescription
properties IArtifact

Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Artifact createTime.

description

public description: string;

Artifact description.

displayName

public displayName: string;

Artifact displayName.

etag

public etag: string;

Artifact etag.

labels

public labels: { [k: string]: string };

Artifact labels.

metadata

public metadata?: (google.protobuf.IStruct|null);

Artifact metadata.

name

public name: string;

Artifact name.

schemaTitle

public schemaTitle: string;

Artifact schemaTitle.

schemaVersion

public schemaVersion: string;

Artifact schemaVersion.

state

public state: (google.cloud.aiplatform.v1beta1.Artifact.State|keyof typeof google.cloud.aiplatform.v1beta1.Artifact.State);

Artifact state.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Artifact updateTime.

uri

public uri: string;

Artifact uri.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.IArtifact): google.cloud.aiplatform.v1beta1.Artifact;

Creates a new Artifact instance using the specified properties.

Parameter
NameDescription
properties IArtifact

Properties to set

Returns
TypeDescription
Artifact

Artifact instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.Artifact;

Decodes an Artifact message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Artifact

Artifact

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.Artifact;

Decodes an Artifact message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Artifact

Artifact

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1beta1.IArtifact, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Artifact message. Does not implicitly messages.

Parameters
NameDescription
message IArtifact

Artifact message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.IArtifact, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Artifact message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IArtifact

Artifact message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.Artifact;

Creates an Artifact message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
Artifact

Artifact

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Artifact

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Artifact to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.v1beta1.Artifact, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an Artifact message. Also converts values to other types if specified.

Parameters
NameDescription
message Artifact

Artifact

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an Artifact message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not