Package com.google.cloud.aiplatform.v1beta1

Class Execution

  • All Implemented Interfaces:
    ExecutionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Execution
extends com.google.protobuf.GeneratedMessageV3
implements ExecutionOrBuilder
     Instance of a general execution.
    Protobuf type google.cloud.aiplatform.v1beta1.Execution
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The resource name of the Execution.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface ExecutionOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the Execution.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         User provided display name of the Execution.
 May be up to 128 Unicode characters.
        string display_name = 2;
        Specified by:
        getDisplayName in interface ExecutionOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         User provided display name of the Execution.
 May be up to 128 Unicode characters.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for displayName.

      • getStateValue

        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.v1beta1.Execution.State state = 6;
        Specified by:
        getStateValue in interface ExecutionOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        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.v1beta1.Execution.State state = 6;
        Specified by:
        getState in interface ExecutionOrBuilder
        Returns:
        The state.

      • getEtag

        public String getEtag()
         An eTag used to perform consistent read-modify-write updates. If not set, a
 blind "overwrite" update happens.
        string etag = 9;
        Specified by:
        getEtag in interface ExecutionOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         An eTag used to perform consistent read-modify-write updates. If not set, a
 blind "overwrite" update happens.
        string etag = 9;
        Specified by:
        getEtagBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for etag.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: ExecutionOrBuilder
         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;
        Specified by:
        getLabelsCount in interface ExecutionOrBuilder

      • containsLabels

        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;
        Specified by:
        containsLabels in interface ExecutionOrBuilder

      • getLabelsMap

        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;
        Specified by:
        getLabelsMap in interface ExecutionOrBuilder

      • getLabelsOrDefault

        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;
        Specified by:
        getLabelsOrDefault in interface ExecutionOrBuilder

      • getLabelsOrThrow

        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;
        Specified by:
        getLabelsOrThrow in interface ExecutionOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this Execution was created.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ExecutionOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this Execution was created.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ExecutionOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this Execution was created.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ExecutionOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Timestamp when this Execution was last updated.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface ExecutionOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Timestamp when this Execution was last updated.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface ExecutionOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Timestamp when this Execution was last updated.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface ExecutionOrBuilder

      • getSchemaTitle

        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;
        Specified by:
        getSchemaTitle in interface ExecutionOrBuilder
        Returns:
        The schemaTitle.

      • getSchemaTitleBytes

        public com.google.protobuf.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;
        Specified by:
        getSchemaTitleBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for schemaTitle.

      • getSchemaVersion

        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;
        Specified by:
        getSchemaVersion in interface ExecutionOrBuilder
        Returns:
        The schemaVersion.

      • getSchemaVersionBytes

        public com.google.protobuf.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;
        Specified by:
        getSchemaVersionBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for schemaVersion.

      • hasMetadata

        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;
        Specified by:
        hasMetadata in interface ExecutionOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public com.google.protobuf.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;
        Specified by:
        getMetadata in interface ExecutionOrBuilder
        Returns:
        The metadata.

      • getMetadataOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getMetadataOrBuilder in interface ExecutionOrBuilder

      • getDescription

        public String getDescription()
         Description of the Execution
        string description = 16;
        Specified by:
        getDescription in interface ExecutionOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Description of the Execution
        string description = 16;
        Specified by:
        getDescriptionBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for description.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Execution parseFrom​(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Execution parseFrom​(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Execution parseFrom​(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Execution parseFrom​(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Execution parseFrom​(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Execution parseFrom​(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Execution parseFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Execution.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Execution.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Execution.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Execution getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Execution> parser()

      • getParserForType

        public com.google.protobuf.Parser<Execution> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Execution getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder