Package com.google.cloud.aiplatform.v1

Class DeployModelRequest

  • All Implemented Interfaces:
    DeployModelRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DeployModelRequest
extends com.google.protobuf.GeneratedMessageV3
implements DeployModelRequestOrBuilder
     Request message for
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
    Protobuf type google.cloud.aiplatform.v1.DeployModelRequest
    See Also:
    Serialized Form

    • Field Detail

      • DEPLOYED_MODEL_FIELD_NUMBER

        public static final int DEPLOYED_MODEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRAFFIC_SPLIT_FIELD_NUMBER

        public static final int TRAFFIC_SPLIT_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()

      • 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

      • 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

      • 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.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 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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