Class CreateTensorboardRunRequest

  • All Implemented Interfaces:
    CreateTensorboardRunRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class CreateTensorboardRunRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements CreateTensorboardRunRequestOrBuilder
     Request message for
     [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun].
     
    Protobuf type google.cloud.aiplatform.v1beta1.CreateTensorboardRunRequest
    See Also:
    Serialized Form
    • Field Detail

      • TENSORBOARD_RUN_FIELD_NUMBER

        public static final int TENSORBOARD_RUN_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TENSORBOARD_RUN_ID_FIELD_NUMBER

        public static final int TENSORBOARD_RUN_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
    • 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
      • getParent

        public String getParent()
         Required. The resource name of the TensorboardExperiment to create the
         TensorboardRun in. Format:
         `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface CreateTensorboardRunRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the TensorboardExperiment to create the
         TensorboardRun in. Format:
         `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface CreateTensorboardRunRequestOrBuilder
        Returns:
        The bytes for parent.
      • hasTensorboardRun

        public boolean hasTensorboardRun()
         Required. The TensorboardRun to create.
         
        .google.cloud.aiplatform.v1beta1.TensorboardRun tensorboard_run = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasTensorboardRun in interface CreateTensorboardRunRequestOrBuilder
        Returns:
        Whether the tensorboardRun field is set.
      • getTensorboardRunId

        public String getTensorboardRunId()
         Required. The ID to use for the Tensorboard run, which becomes the final
         component of the Tensorboard run's resource name.
        
         This value should be 1-128 characters, and valid characters
         are /[a-z][0-9]-/.
         
        string tensorboard_run_id = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTensorboardRunId in interface CreateTensorboardRunRequestOrBuilder
        Returns:
        The tensorboardRunId.
      • getTensorboardRunIdBytes

        public com.google.protobuf.ByteString getTensorboardRunIdBytes()
         Required. The ID to use for the Tensorboard run, which becomes the final
         component of the Tensorboard run's resource name.
        
         This value should be 1-128 characters, and valid characters
         are /[a-z][0-9]-/.
         
        string tensorboard_run_id = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTensorboardRunIdBytes in interface CreateTensorboardRunRequestOrBuilder
        Returns:
        The bytes for tensorboardRunId.
      • 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 CreateTensorboardRunRequest parseFrom​(ByteBuffer data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

        public com.google.protobuf.Parser<CreateTensorboardRunRequest> 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 CreateTensorboardRunRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder