- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Execution.
Instance of a general execution.
Generated from protobuf message google.cloud.aiplatform.v1.Execution
Methods
__construct
Constructor.
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.
↳ labels
array|Google\Protobuf\Internal\MapField
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).
↳ create_time
Google\Protobuf\Timestamp
Output only. Timestamp when this Execution was created.
↳ update_time
Google\Protobuf\Timestamp
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 in schema_title
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.
↳ metadata
Google\Protobuf\Struct
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.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setName
Output only. The resource name of the Execution.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getDisplayName
User provided display name of the Execution.
May be up to 128 Unicode characters.
Generated from protobuf field string display_name = 2;
string
setDisplayName
User provided display name of the Execution.
May be up to 128 Unicode characters.
Generated from protobuf field string display_name = 2;
var
string
$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.
Generated from protobuf field .google.cloud.aiplatform.v1.Execution.State state = 6;
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.
Generated from protobuf field .google.cloud.aiplatform.v1.Execution.State state = 6;
var
int
$this
getEtag
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 9;
string
setEtag
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 9;
var
string
$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).
Generated from protobuf field map<string, string> labels = 10;
Google\Protobuf\Internal\MapField
setLabels
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).
Generated from protobuf field map<string, string> labels = 10;
var
array|Google\Protobuf\Internal\MapField
$this
getCreateTime
Output only. Timestamp when this Execution was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Execution was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getUpdateTime
Output only. Timestamp when this Execution was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this Execution was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
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.
Generated from protobuf field string schema_title = 13;
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.
Generated from protobuf field string schema_title = 13;
var
string
$this
getSchemaVersion
The version of the schema in schema_title
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.
Generated from protobuf field string schema_version = 14;
string
setSchemaVersion
The version of the schema in schema_title
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.
Generated from protobuf field string schema_version = 14;
var
string
$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.
Generated from protobuf field .google.protobuf.Struct metadata = 15;
Google\Protobuf\Struct|null
hasMetadata
clearMetadata
setMetadata
Properties of the Execution.
Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
Generated from protobuf field .google.protobuf.Struct metadata = 15;
var
Google\Protobuf\Struct
$this
getDescription
Description of the Execution
Generated from protobuf field string description = 16;
string
setDescription
Description of the Execution
Generated from protobuf field string description = 16;
var
string
$this