Package com.google.cloud.aiplatform.v1

Class DeployModelRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.DeployModelRequest
All Implemented Interfaces:
DeployModelRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DeployModelRequest extends com.google.protobuf.GeneratedMessage implements DeployModelRequestOrBuilder
 Request message for
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
Protobuf type google.cloud.aiplatform.v1.DeployModelRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DeployModelRequest.Builder
    Request message for [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEPLOYED_MODEL_FIELD_NUMBER
     
    static final int
    ENDPOINT_FIELD_NUMBER
     
    static final int
    TRAFFIC_SPLIT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsTrafficSplit(String key)
    A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.
    boolean
    equals(Object obj)
     
    static DeployModelRequest
    getDefaultInstance()
     
    DeployModelRequest
    getDefaultInstanceForType()
     
    DeployedModel
    getDeployedModel()
    Required.
    DeployedModelOrBuilder
    getDeployedModelOrBuilder()
    Required.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEndpoint()
    Required.
    com.google.protobuf.ByteString
    getEndpointBytes()
    Required.
    com.google.protobuf.Parser<DeployModelRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    Map<String,Integer>
    getTrafficSplit()
    Deprecated.
    int
    getTrafficSplitCount()
    A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.
    Map<String,Integer>
    getTrafficSplitMap()
    A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.
    int
    getTrafficSplitOrDefault(String key, int defaultValue)
    A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.
    int
    getTrafficSplitOrThrow(String key)
    A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel.
    boolean
    hasDeployedModel()
    Required.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static DeployModelRequest.Builder
    newBuilder()
     
    static DeployModelRequest.Builder
    newBuilder(DeployModelRequest prototype)
     
    DeployModelRequest.Builder
    newBuilderForType()
     
    protected DeployModelRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static DeployModelRequest
    parseDelimitedFrom(InputStream input)
     
    static DeployModelRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DeployModelRequest
    parseFrom(byte[] data)
     
    static DeployModelRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DeployModelRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static DeployModelRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DeployModelRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DeployModelRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DeployModelRequest
    parseFrom(InputStream input)
     
    static DeployModelRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DeployModelRequest
    parseFrom(ByteBuffer data)
     
    static DeployModelRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DeployModelRequest>
    parser()
     
    DeployModelRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • ENDPOINT_FIELD_NUMBER

      public static final int ENDPOINT_FIELD_NUMBER
      See Also:

    • DEPLOYED_MODEL_FIELD_NUMBER

      public static final int DEPLOYED_MODEL_FIELD_NUMBER
      See Also:

    • TRAFFIC_SPLIT_FIELD_NUMBER

      public static final int TRAFFIC_SPLIT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getEndpoint

      public String getEndpoint()
       Required. The name of the Endpoint resource into which to deploy a Model.
 Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
      string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getEndpoint in interface DeployModelRequestOrBuilder
      Returns:
      The endpoint.

    • getEndpointBytes

      public com.google.protobuf.ByteString getEndpointBytes()
       Required. The name of the Endpoint resource into which to deploy a Model.
 Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
      string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getEndpointBytes in interface DeployModelRequestOrBuilder
      Returns:
      The bytes for endpoint.

    • hasDeployedModel

      public boolean hasDeployedModel()
       Required. The DeployedModel to be created within the Endpoint. Note that
 [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split]
 must be updated for the DeployedModel to start receiving traffic, either as
 part of this call, or via
 [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
      .google.cloud.aiplatform.v1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasDeployedModel in interface DeployModelRequestOrBuilder
      Returns:
      Whether the deployedModel field is set.

    • getDeployedModel

      public DeployedModel getDeployedModel()
       Required. The DeployedModel to be created within the Endpoint. Note that
 [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split]
 must be updated for the DeployedModel to start receiving traffic, either as
 part of this call, or via
 [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
      .google.cloud.aiplatform.v1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDeployedModel in interface DeployModelRequestOrBuilder
      Returns:
      The deployedModel.

    • getDeployedModelOrBuilder

      public DeployedModelOrBuilder getDeployedModelOrBuilder()
       Required. The DeployedModel to be created within the Endpoint. Note that
 [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split]
 must be updated for the DeployedModel to start receiving traffic, either as
 part of this call, or via
 [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
      .google.cloud.aiplatform.v1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDeployedModelOrBuilder in interface DeployModelRequestOrBuilder

    • getTrafficSplitCount

      public int getTrafficSplitCount()
      Description copied from interface: DeployModelRequestOrBuilder
       A map from a DeployedModel's ID to the percentage of this Endpoint's
 traffic that should be forwarded to that DeployedModel.

 If this field is non-empty, then the Endpoint's
 [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
 overwritten with it. To refer to the ID of the just being deployed Model, a
 "0" should be used, and the actual ID of the new DeployedModel will be
 filled in its place by this method. The traffic percentage values must add
 up to 100.

 If this field is empty, then the Endpoint's
 [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not
 updated.
      map<string, int32> traffic_split = 3;
      Specified by:
      getTrafficSplitCount in interface DeployModelRequestOrBuilder

    • containsTrafficSplit

      public boolean containsTrafficSplit(String key)
       A map from a DeployedModel's ID to the percentage of this Endpoint's
 traffic that should be forwarded to that DeployedModel.

 If this field is non-empty, then the Endpoint's
 [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
 overwritten with it. To refer to the ID of the just being deployed Model, a
 "0" should be used, and the actual ID of the new DeployedModel will be
 filled in its place by this method. The traffic percentage values must add
 up to 100.

 If this field is empty, then the Endpoint's
 [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not
 updated.
      map<string, int32> traffic_split = 3;
      Specified by:
      containsTrafficSplit in interface DeployModelRequestOrBuilder

    • getTrafficSplit

      @Deprecated public Map<String,Integer> getTrafficSplit()
      Deprecated.
      Use getTrafficSplitMap() instead.
      Specified by:
      getTrafficSplit in interface DeployModelRequestOrBuilder

    • getTrafficSplitMap

      public Map<String,Integer> getTrafficSplitMap()
       A map from a DeployedModel's ID to the percentage of this Endpoint's
 traffic that should be forwarded to that DeployedModel.

 If this field is non-empty, then the Endpoint's
 [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
 overwritten with it. To refer to the ID of the just being deployed Model, a
 "0" should be used, and the actual ID of the new DeployedModel will be
 filled in its place by this method. The traffic percentage values must add
 up to 100.

 If this field is empty, then the Endpoint's
 [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not
 updated.
      map<string, int32> traffic_split = 3;
      Specified by:
      getTrafficSplitMap in interface DeployModelRequestOrBuilder

    • getTrafficSplitOrDefault

      public int getTrafficSplitOrDefault(String key, int defaultValue)
       A map from a DeployedModel's ID to the percentage of this Endpoint's
 traffic that should be forwarded to that DeployedModel.

 If this field is non-empty, then the Endpoint's
 [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
 overwritten with it. To refer to the ID of the just being deployed Model, a
 "0" should be used, and the actual ID of the new DeployedModel will be
 filled in its place by this method. The traffic percentage values must add
 up to 100.

 If this field is empty, then the Endpoint's
 [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not
 updated.
      map<string, int32> traffic_split = 3;
      Specified by:
      getTrafficSplitOrDefault in interface DeployModelRequestOrBuilder

    • getTrafficSplitOrThrow

      public int getTrafficSplitOrThrow(String key)
       A map from a DeployedModel's ID to the percentage of this Endpoint's
 traffic that should be forwarded to that DeployedModel.

 If this field is non-empty, then the Endpoint's
 [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
 overwritten with it. To refer to the ID of the just being deployed Model, a
 "0" should be used, and the actual ID of the new DeployedModel will be
 filled in its place by this method. The traffic percentage values must add
 up to 100.

 If this field is empty, then the Endpoint's
 [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not
 updated.
      map<string, int32> traffic_split = 3;
      Specified by:
      getTrafficSplitOrThrow in interface DeployModelRequestOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 DeployModelRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DeployModelRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DeployModelRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DeployModelRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DeployModelRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DeployModelRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DeployModelRequest.Builder newBuilder()

    • newBuilder

      public static DeployModelRequest.Builder newBuilder(DeployModelRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected DeployModelRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DeployModelRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DeployModelRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

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