Package com.google.cloud.aiplatform.v1

Class DeployModelRequest.Builder

  • All Implemented Interfaces:
    DeployModelRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    DeployModelRequest
    public static final class DeployModelRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>
implements DeployModelRequestOrBuilder
     Request message for
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
    Protobuf type google.cloud.aiplatform.v1.DeployModelRequest

    • Method Detail

      • 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.Builder<DeployModelRequest.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • clear

        public DeployModelRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public DeployModelRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • setField

        public DeployModelRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • clearField

        public DeployModelRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • clearOneof

        public DeployModelRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • setRepeatedField

        public DeployModelRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • addRepeatedField

        public DeployModelRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • mergeFrom

        public DeployModelRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeployModelRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public DeployModelRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeployModelRequest.Builder>
        Throws:
        IOException

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

      • setEndpoint

        public DeployModelRequest.Builder setEndpoint​(String value)
         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) = { ... }
        Parameters:
        value - The endpoint to set.
        Returns:
        This builder for chaining.

      • clearEndpoint

        public DeployModelRequest.Builder clearEndpoint()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setEndpointBytes

        public DeployModelRequest.Builder setEndpointBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for endpoint to set.
        Returns:
        This builder for chaining.

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

      • setDeployedModel

        public DeployModelRequest.Builder setDeployedModel​(DeployedModel value)
         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];

      • setDeployedModel

        public DeployModelRequest.Builder setDeployedModel​(DeployedModel.Builder builderForValue)
         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];

      • mergeDeployedModel

        public DeployModelRequest.Builder mergeDeployedModel​(DeployedModel value)
         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];

      • clearDeployedModel

        public DeployModelRequest.Builder clearDeployedModel()
         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];

      • getDeployedModelBuilder

        public DeployedModel.Builder getDeployedModelBuilder()
         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];

      • 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

      • removeTrafficSplit

        public DeployModelRequest.Builder removeTrafficSplit​(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;

      • getMutableTrafficSplit

        @Deprecated
public Map<String,​Integer> getMutableTrafficSplit()
        Deprecated.
        Use alternate mutation accessors instead.

      • putTrafficSplit

        public DeployModelRequest.Builder putTrafficSplit​(String key,
                                                  int value)
         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;

      • putAllTrafficSplit

        public DeployModelRequest.Builder putAllTrafficSplit​(Map<String,​Integer> values)
         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;

      • setUnknownFields

        public final DeployModelRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>

      • mergeUnknownFields

        public final DeployModelRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DeployModelRequest.Builder>