public final class Execution extends GeneratedMessageV3 implements ExecutionOrBuilder
Instance of a general execution.
Protobuf type google.cloud.aiplatform.v1.Execution
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SCHEMA_TITLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SCHEMA_VERSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static Execution getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Execution.Builder newBuilder()
public static Execution.Builder newBuilder(Execution prototype)
| Parameter |
| Name |
Description |
prototype |
Execution
|
public static Execution parseDelimitedFrom(InputStream input)
public static Execution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Execution parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static Execution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Execution parseFrom(ByteString data)
public static Execution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Execution parseFrom(CodedInputStream input)
public static Execution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Execution parseFrom(InputStream input)
public static Execution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Execution parseFrom(ByteBuffer data)
public static Execution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Execution> parser()
Methods
public boolean containsLabels(String key)
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).
map<string, string> labels = 10;
| Parameter |
| Name |
Description |
key |
String
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public Timestamp getCreateTime()
Output only. Timestamp when this Execution was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Execution was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Execution getDefaultInstanceForType()
public String getDescription()
Description of the Execution
string description = 16;
| Returns |
| Type |
Description |
String |
The description.
|
public ByteString getDescriptionBytes()
Description of the Execution
string description = 16;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
public String getDisplayName()
User provided display name of the Execution.
May be up to 128 Unicode characters.
string display_name = 2;
| Returns |
| Type |
Description |
String |
The displayName.
|
public ByteString getDisplayNameBytes()
User provided display name of the Execution.
May be up to 128 Unicode characters.
string display_name = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
An eTag used to perform consistent read-modify-write updates. If not set, a
blind "overwrite" update happens.
string etag = 9;
| Returns |
| Type |
Description |
String |
The etag.
|
public ByteString getEtagBytes()
An eTag used to perform consistent read-modify-write updates. If not set, a
blind "overwrite" update happens.
string etag = 9;
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
public Map<String,String> getLabels()
public int getLabelsCount()
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).
map<string, string> labels = 10;
| Returns |
| Type |
Description |
int |
|
public Map<String,String> getLabelsMap()
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).
map<string, string> labels = 10;
public String getLabelsOrDefault(String key, String defaultValue)
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).
map<string, string> labels = 10;
| Returns |
| Type |
Description |
String |
|
public String getLabelsOrThrow(String key)
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).
map<string, string> labels = 10;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
public Struct 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.
.google.protobuf.Struct metadata = 15;
| Returns |
| Type |
Description |
Struct |
The metadata.
|
public StructOrBuilder getMetadataOrBuilder()
Properties of the Execution.
Top level metadata keys' heading and trailing spaces will be trimmed.
The size of this field should not exceed 200KB.
.google.protobuf.Struct metadata = 15;
Output only. The resource name of the Execution.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Output only. The resource name of the Execution.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public Parser<Execution> getParserForType()
Overrides
public String 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.
string schema_title = 13;
| Returns |
| Type |
Description |
String |
The schemaTitle.
|
public ByteString getSchemaTitleBytes()
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.
string schema_title = 13;
| Returns |
| Type |
Description |
ByteString |
The bytes for schemaTitle.
|
public String 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.
string schema_version = 14;
| Returns |
| Type |
Description |
String |
The schemaVersion.
|
public ByteString getSchemaVersionBytes()
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.
string schema_version = 14;
| Returns |
| Type |
Description |
ByteString |
The bytes for schemaVersion.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public Execution.State 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.
.google.cloud.aiplatform.v1.Execution.State state = 6;
public int getStateValue()
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.
.google.cloud.aiplatform.v1.Execution.State state = 6;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
public Timestamp getUpdateTime()
Output only. Timestamp when this Execution was last updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Execution was last updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. Timestamp when this Execution was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
public boolean hasMetadata()
Properties of the Execution.
Top level metadata keys' heading and trailing spaces will be trimmed.
The size of this field should not exceed 200KB.
.google.protobuf.Struct metadata = 15;
| Returns |
| Type |
Description |
boolean |
Whether the metadata field is set.
|
public boolean hasUpdateTime()
Output only. Timestamp when this Execution was last updated.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public Execution.Builder newBuilderForType()
protected Execution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public Execution.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
