Package com.google.cloud.notebooks.v1

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
     The definition of a single executed notebook.
    Protobuf type google.cloud.notebooks.v1.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()

      • internalGetFieldAccessorTable

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

      • hasExecutionTemplate

        public boolean hasExecutionTemplate()
         execute metadata including name, hardware spec, region, labels, etc.
        .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;
        Specified by:
        hasExecutionTemplate in interface ExecutionOrBuilder
        Returns:
        Whether the executionTemplate field is set.

      • getExecutionTemplate

        public ExecutionTemplate getExecutionTemplate()
         execute metadata including name, hardware spec, region, labels, etc.
        .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;
        Specified by:
        getExecutionTemplate in interface ExecutionOrBuilder
        Returns:
        The executionTemplate.

      • getName

        public String getName()
         Output only. The resource name of the execute. Format:
 `projects/{project_id}/locations/{location}/executions/{execution_id}`
        string name = 2 [(.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 execute. Format:
 `projects/{project_id}/locations/{location}/executions/{execution_id}`
        string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Output only. Name used for UI purposes.
 Name can only contain alphanumeric characters and underscores '_'.
        string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDisplayName in interface ExecutionOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Output only. Name used for UI purposes.
 Name can only contain alphanumeric characters and underscores '_'.
        string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDisplayNameBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         A brief description of this execution.
        string description = 4;
        Specified by:
        getDescription in interface ExecutionOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         A brief description of this execution.
        string description = 4;
        Specified by:
        getDescriptionBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for description.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Time the Execution was instantiated.
        .google.protobuf.Timestamp create_time = 5 [(.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. Time the Execution was instantiated.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ExecutionOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Time the Execution was instantiated.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ExecutionOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Time the Execution was last updated.
        .google.protobuf.Timestamp update_time = 6 [(.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. Time the Execution was last updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface ExecutionOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

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

      • getStateValue

        public int getStateValue()
         Output only. State of the underlying AI Platform job.
        .google.cloud.notebooks.v1.Execution.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface ExecutionOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Execution.State getState()
         Output only. State of the underlying AI Platform job.
        .google.cloud.notebooks.v1.Execution.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface ExecutionOrBuilder
        Returns:
        The state.

      • getOutputNotebookFile

        public String getOutputNotebookFile()
         Output notebook file generated by this execution
        string output_notebook_file = 8;
        Specified by:
        getOutputNotebookFile in interface ExecutionOrBuilder
        Returns:
        The outputNotebookFile.

      • getOutputNotebookFileBytes

        public com.google.protobuf.ByteString getOutputNotebookFileBytes()
         Output notebook file generated by this execution
        string output_notebook_file = 8;
        Specified by:
        getOutputNotebookFileBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for outputNotebookFile.

      • getJobUri

        public String getJobUri()
         Output only. The URI of the external job used to execute the notebook.
        string job_uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getJobUri in interface ExecutionOrBuilder
        Returns:
        The jobUri.

      • getJobUriBytes

        public com.google.protobuf.ByteString getJobUriBytes()
         Output only. The URI of the external job used to execute the notebook.
        string job_uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getJobUriBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for jobUri.

      • 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