Class DeployModelRequest (3.45.0)

public final class DeployModelRequest extends GeneratedMessageV3 implements DeployModelRequestOrBuilder

Request message for EndpointService.DeployModel.

Protobuf type google.cloud.aiplatform.v1beta1.DeployModelRequest

Static Fields

DEPLOYED_MODEL_FIELD_NUMBER

public static final int DEPLOYED_MODEL_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

TRAFFIC_SPLIT_FIELD_NUMBER

public static final int TRAFFIC_SPLIT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DeployModelRequest getDefaultInstance()
Returns
Type Description
DeployModelRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DeployModelRequest.Builder newBuilder()
Returns
Type Description
DeployModelRequest.Builder

newBuilder(DeployModelRequest prototype)

public static DeployModelRequest.Builder newBuilder(DeployModelRequest prototype)
Parameter
Name Description
prototype DeployModelRequest
Returns
Type Description
DeployModelRequest.Builder

parseDelimitedFrom(InputStream input)

public static DeployModelRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployModelRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DeployModelRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DeployModelRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DeployModelRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DeployModelRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DeployModelRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployModelRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DeployModelRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployModelRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DeployModelRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DeployModelRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DeployModelRequest> parser()
Returns
Type Description
Parser<DeployModelRequest>

Methods

containsTrafficSplit(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DeployModelRequest getDefaultInstanceForType()
Returns
Type Description
DeployModelRequest

getDeployedModel()

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.v1beta1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DeployedModel

The deployedModel.

getDeployedModelOrBuilder()

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.v1beta1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DeployedModelOrBuilder

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

Returns
Type Description
String

The endpoint.

getEndpointBytes()

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

Returns
Type Description
ByteString

The bytes for endpoint.

getParserForType()

public Parser<DeployModelRequest> getParserForType()
Returns
Type Description
Parser<DeployModelRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTrafficSplit() (deprecated)

public Map<String,Integer> getTrafficSplit()

Use #getTrafficSplitMap() instead.

Returns
Type Description
Map<String,Integer>

getTrafficSplitCount()

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;

Returns
Type Description
int

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

Returns
Type Description
Map<String,Integer>

getTrafficSplitOrDefault(String key, int defaultValue)

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;

Parameters
Name Description
key String
defaultValue int
Returns
Type Description
int

getTrafficSplitOrThrow(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
int

hasDeployedModel()

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.v1beta1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the deployedModel field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DeployModelRequest.Builder newBuilderForType()
Returns
Type Description
DeployModelRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DeployModelRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DeployModelRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DeployModelRequest.Builder toBuilder()
Returns
Type Description
DeployModelRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException