Google Cloud Ai Platform V1 Client - Class CreateArtifactRequest (0.31.0)

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

Request message for MetadataService.CreateArtifact.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the MetadataStore where the Artifact should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

↳ artifact Google\Cloud\AIPlatform\V1\Artifact

Required. The Artifact to create.

↳ artifact_id string

The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)

getParent

Required. The resource name of the MetadataStore where the Artifact should be created.

Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Returns
TypeDescription
string

setParent

Required. The resource name of the MetadataStore where the Artifact should be created.

Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getArtifact

Required. The Artifact to create.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\Artifact|null

hasArtifact

clearArtifact

setArtifact

Required. The Artifact to create.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\Artifact
Returns
TypeDescription
$this

getArtifactId

The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service.

Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)

Returns
TypeDescription
string

setArtifactId

The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service.

Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. The resource name of the MetadataStore where the Artifact should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore} Please see Google\Cloud\AIPlatform\V1\MetadataServiceClient::metadataStoreName() for help formatting this field.

artifact Google\Cloud\AIPlatform\V1\Artifact

Required. The Artifact to create.

artifactId string

The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\CreateArtifactRequest