Google Cloud Ai Platform V1 Client - Class CreateExecutionRequest (0.23.0)

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

Request message for MetadataService.CreateExecution.

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

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 Execution should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

↳ execution Google\Cloud\AIPlatform\V1\Execution

Required. The Execution to create.

↳ execution_id string

The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution'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 Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)

getParent

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

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

Returns
TypeDescription
string

setParent

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getExecution

Required. The Execution to create.

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

hasExecution

clearExecution

setExecution

Required. The Execution to create.

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

getExecutionId

The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution'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 Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)

Returns
TypeDescription
string

setExecutionId

The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution'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 Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

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

execution Google\Cloud\AIPlatform\V1\Execution

Required. The Execution to create.

executionId string

The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution'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 Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\CreateExecutionRequest