Package com.google.cloud.aiplatform.v1

Interface DeployModelRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DeployModelRequest, DeployModelRequest.Builder

public interface DeployModelRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

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.
DeployedModel	getDeployedModel()	Required.
DeployedModelOrBuilder	getDeployedModelOrBuilder()	Required.
String	getEndpoint()	Required.
com.google.protobuf.ByteString	getEndpointBytes()	Required.
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.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getEndpoint

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) = { ... }

Returns:

The endpoint.

getEndpointBytes

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) = { ... }

Returns:

The bytes for endpoint.

hasDeployedModel

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];

Returns:

Whether the deployedModel field is set.

getDeployedModel

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];

Returns:

The deployedModel.

getDeployedModelOrBuilder

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];

getTrafficSplitCount

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][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;

containsTrafficSplit

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;

getTrafficSplit

@Deprecated
Map<String,Integer> getTrafficSplit()

Deprecated.

Use getTrafficSplitMap() instead.

getTrafficSplitMap

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;

getTrafficSplitOrDefault

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;

getTrafficSplitOrThrow

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;