public static final class DeployModelRequest.Builder extends GeneratedMessageV3.Builder<DeployModelRequest.Builder> implements DeployModelRequestOrBuilder
Request message for EndpointService.DeployModel.
Protobuf type google.cloud.aiplatform.v1.DeployModelRequest
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
public DeployModelRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public DeployModelRequest build()
Returns
public DeployModelRequest buildPartial()
Returns
public DeployModelRequest.Builder clear()
Returns
Overrides
public DeployModelRequest.Builder clearDeployedModel()
Required. The DeployedModel to be created within the Endpoint. Note that
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.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
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) = { ... }
public DeployModelRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
public DeployModelRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
public DeployModelRequest.Builder clearTrafficSplit()
Returns
public DeployModelRequest.Builder clone()
Returns
Overrides
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 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 is not updated.
map<string, int32> traffic_split = 3;
public DeployModelRequest getDefaultInstanceForType()
Returns
public DeployedModel getDeployedModel()
Required. The DeployedModel to be created within the Endpoint. Note that
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.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
public DeployedModel.Builder getDeployedModelBuilder()
Required. The DeployedModel to be created within the Endpoint. Note that
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.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
public DeployedModelOrBuilder getDeployedModelOrBuilder()
Required. The DeployedModel to be created within the Endpoint. Note that
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.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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) = { ... }
| Type | Description |
| String | The endpoint.
|
public 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) = { ... }
public Map<String,Integer> getMutableTrafficSplit()
Use alternate mutation accessors instead.
public Map<String,Integer> getTrafficSplit()
Returns
public int getTrafficSplitCount()
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 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 is not updated.
map<string, int32> traffic_split = 3;
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 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 is not updated.
map<string, int32> traffic_split = 3;
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 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 is not updated.
map<string, int32> traffic_split = 3;
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 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 is not updated.
map<string, int32> traffic_split = 3;
public boolean hasDeployedModel()
Required. The DeployedModel to be created within the Endpoint. Note that
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.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the deployedModel field is set.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public DeployModelRequest.Builder mergeDeployedModel(DeployedModel value)
Required. The DeployedModel to be created within the Endpoint. Note that
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.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
public DeployModelRequest.Builder mergeFrom(DeployModelRequest other)
Parameter
Returns
public DeployModelRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
public DeployModelRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
public final DeployModelRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
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 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 is not updated.
map<string, int32> traffic_split = 3;
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 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 is not updated.
map<string, int32> traffic_split = 3;
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 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 is not updated.
map<string, int32> traffic_split = 3;
public DeployModelRequest.Builder setDeployedModel(DeployedModel value)
Required. The DeployedModel to be created within the Endpoint. Note that
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.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
public DeployModelRequest.Builder setDeployedModel(DeployedModel.Builder builderForValue)
Required. The DeployedModel to be created within the Endpoint. Note that
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.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];
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) = { ... }
| Name | Description |
| value | String
The endpoint to set.
|
Returns
public DeployModelRequest.Builder setEndpointBytes(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) = { ... }
| Name | Description |
| value | ByteString
The bytes for endpoint to set.
|
Returns
public DeployModelRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public DeployModelRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
public final DeployModelRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
