Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Execution.
Instance of a general execution.
Generated from protobuf messagegoogle.cloud.aiplatform.v1.Execution
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 Execution.
↳ display_name
string
User provided display name of the Execution. May be up to 128 Unicode characters.
↳ state
int
The state of this Execution. This is a property of the Execution, 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.
↳ etag
string
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
The labels with user-defined metadata to organize your Executions. 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 Execution (System labels are excluded).
Output only. Timestamp when this Execution was last updated.
↳ 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 inschema_titleto 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.
Properties of the Execution. 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 Execution
getName
Output only. The resource name of the Execution.
Returns
Type
Description
string
setName
Output only. The resource name of the Execution.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
User provided display name of the Execution.
May be up to 128 Unicode characters.
Returns
Type
Description
string
setDisplayName
User provided display name of the Execution.
May be up to 128 Unicode characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getState
The state of this Execution. This is a property of the Execution, 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 Execution. This is a property of the Execution, 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
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 Executions.
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 Execution (System
labels are excluded).
The labels with user-defined metadata to organize your Executions.
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 Execution (System
labels are excluded).
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 inschema_titleto 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 inschema_titleto 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 Execution.
Top level metadata keys' heading and trailing spaces will be trimmed.
The size of this field should not exceed 200KB.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class Execution (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.Execution)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.Execution)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.Execution)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.Execution)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.Execution)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.Execution)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.Execution)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.Execution)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.Execution)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.Execution)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.Execution)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.Execution)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.Execution)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.Execution)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.Execution)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.Execution)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.Execution)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.Execution)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.Execution)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.Execution)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.Execution)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.Execution)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.Execution)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.Execution)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.Execution)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.Execution)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.Execution)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.Execution)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.Execution)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.Execution)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.Execution)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.Execution)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.Execution)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.Execution)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.Execution)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.Execution)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.Execution)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.Execution)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.Execution)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.Execution)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.Execution)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.Execution)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.Execution)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.Execution)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.Execution)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.Execution)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.Execution)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.Execution)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.Execution)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.Execution)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.Execution)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.Execution)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.Execution)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.Execution)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.Execution)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.Execution) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class Execution.\n\nInstance of a general execution.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.Execution`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. The resource name of the Execution.\n\n### setName\n\nOutput only. The resource name of the Execution.\n\n### getDisplayName\n\nUser provided display name of the Execution.\n\nMay be up to 128 Unicode characters.\n\n### setDisplayName\n\nUser provided display name of the Execution.\n\nMay be up to 128 Unicode characters.\n\n### getState\n\nThe state of this Execution. This is a property of the Execution, and does\nnot imply or capture any ongoing process. This property is managed by\nclients (such as Vertex AI Pipelines) and the system does not prescribe\nor check the validity of state transitions.\n\n### setState\n\nThe state of this Execution. This is a property of the Execution, and does\nnot imply or capture any ongoing process. This property is managed by\nclients (such as Vertex AI Pipelines) and the system does not prescribe\nor check the validity of state transitions.\n\n### getEtag\n\nAn eTag used to perform consistent read-modify-write updates. If not set, a\nblind \"overwrite\" update happens.\n\n### setEtag\n\nAn eTag used to perform consistent read-modify-write updates. If not set, a\nblind \"overwrite\" update happens.\n\n### getLabels\n\nThe labels with user-defined metadata to organize your Executions.\n\nLabel keys and values can be no longer than 64 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nNo more than 64 user labels can be associated with one Execution (System\nlabels are excluded).\n\n### setLabels\n\nThe labels with user-defined metadata to organize your Executions.\n\nLabel keys and values can be no longer than 64 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nNo more than 64 user labels can be associated with one Execution (System\nlabels are excluded).\n\n### getCreateTime\n\nOutput only. Timestamp when this Execution was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Timestamp when this Execution was created.\n\n### getUpdateTime\n\nOutput only. Timestamp when this Execution was last updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. Timestamp when this Execution was last updated.\n\n### getSchemaTitle\n\nThe title of the schema describing the metadata.\n\nSchema title and version is expected to be registered in earlier Create\nSchema calls. And both are used together as unique identifiers to identify\nschemas within the local metadata store.\n\n### setSchemaTitle\n\nThe title of the schema describing the metadata.\n\nSchema title and version is expected to be registered in earlier Create\nSchema calls. And both are used together as unique identifiers to identify\nschemas within the local metadata store.\n\n### getSchemaVersion\n\nThe version of the schema in `schema_title` to use.\n\nSchema title and version is expected to be registered in earlier Create\nSchema calls. And both are used together as unique identifiers to identify\nschemas within the local metadata store.\n\n### setSchemaVersion\n\nThe version of the schema in `schema_title` to use.\n\nSchema title and version is expected to be registered in earlier Create\nSchema calls. And both are used together as unique identifiers to identify\nschemas within the local metadata store.\n\n### getMetadata\n\nProperties of the Execution.\n\nTop level metadata keys' heading and trailing spaces will be trimmed.\nThe size of this field should not exceed 200KB.\n\n### hasMetadata\n\n### clearMetadata\n\n### setMetadata\n\nProperties of the Execution.\n\nTop level metadata keys' heading and trailing spaces will be trimmed.\nThe size of this field should not exceed 200KB.\n\n### getDescription\n\nDescription of the Execution\n\n### setDescription\n\nDescription of the Execution"]]
