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.
| 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. |
↳ 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 |
↳ 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];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name of the Execution.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
User provided display name of the Execution.
May be up to 128 Unicode characters.
Generated from protobuf field string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
User provided display name of the Execution.
May be up to 128 Unicode characters.
Generated from protobuf field string display_name = 2;
| 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.
Generated from protobuf field .google.cloud.aiplatform.v1.Execution.State state = 6;
| 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.
Generated from protobuf field .google.cloud.aiplatform.v1.Execution.State state = 6;
| 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.
Generated from protobuf field string etag = 9;
| Returns | |
|---|---|
| Type | Description |
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;
| 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).
Generated from protobuf field map<string, string> labels = 10;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$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];
| Returns | |
|---|---|
| Type | Description |
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];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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];
| Returns | |
|---|---|
| Type | Description |
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];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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;
| 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.
Generated from protobuf field string schema_title = 13;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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;
| Returns | |
|---|---|
| Type | Description |
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;
| 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.
Generated from protobuf field .google.protobuf.Struct metadata = 15;
| Returns | |
|---|---|
| Type | Description |
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;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of the Execution
Generated from protobuf field string description = 16;
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of the Execution
Generated from protobuf field string description = 16;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |