Class DeployModelRequest.Builder (3.16.0)

public static final class DeployModelRequest.Builder extends GeneratedMessageV3.Builder<DeployModelRequest.Builder> implements DeployModelRequestOrBuilder

Request message for EndpointService.DeployModel.

Protobuf type google.cloud.aiplatform.v1beta1.DeployModelRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeployModelRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DeployModelRequest.Builder
Overrides

build()

public DeployModelRequest build()
Returns
TypeDescription
DeployModelRequest

buildPartial()

public DeployModelRequest buildPartial()
Returns
TypeDescription
DeployModelRequest

clear()

public DeployModelRequest.Builder clear()
Returns
TypeDescription
DeployModelRequest.Builder
Overrides

clearDeployedModel()

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

Returns
TypeDescription
DeployModelRequest.Builder

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DeployModelRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DeployModelRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public DeployModelRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DeployModelRequest.Builder
Overrides

clearTrafficSplit()

public DeployModelRequest.Builder clearTrafficSplit()
Returns
TypeDescription
DeployModelRequest.Builder

clone()

public DeployModelRequest.Builder clone()
Returns
TypeDescription
DeployModelRequest.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public DeployModelRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
DeployedModel

The deployedModel.

getDeployedModelBuilder()

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

Returns
TypeDescription
DeployedModel.Builder

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
TypeDescription
DeployedModelOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for endpoint.

getMutableTrafficSplit()

public Map<String,Integer> getMutableTrafficSplit()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Integer>

getTrafficSplit()

public Map<String,Integer> getTrafficSplit()

Use #getTrafficSplitMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueint
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
boolean

Whether the deployedModel field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDeployedModel(DeployedModel value)

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

Parameter
NameDescription
valueDeployedModel
Returns
TypeDescription
DeployModelRequest.Builder

mergeFrom(DeployModelRequest other)

public DeployModelRequest.Builder mergeFrom(DeployModelRequest other)
Parameter
NameDescription
otherDeployModelRequest
Returns
TypeDescription
DeployModelRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeployModelRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DeployModelRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DeployModelRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DeployModelRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeployModelRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DeployModelRequest.Builder
Overrides

putAllTrafficSplit(Map<String,Integer> values)

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;

Parameter
NameDescription
valuesMap<String,Integer>
Returns
TypeDescription
DeployModelRequest.Builder

putTrafficSplit(String key, int value)

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;

Parameters
NameDescription
keyString
valueint
Returns
TypeDescription
DeployModelRequest.Builder

removeTrafficSplit(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
DeployModelRequest.Builder

setDeployedModel(DeployedModel value)

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

Parameter
NameDescription
valueDeployedModel
Returns
TypeDescription
DeployModelRequest.Builder

setDeployedModel(DeployedModel.Builder builderForValue)

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

Parameter
NameDescription
builderForValueDeployedModel.Builder
Returns
TypeDescription
DeployModelRequest.Builder

setEndpoint(String value)

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

Parameter
NameDescription
valueString

The endpoint to set.

Returns
TypeDescription
DeployModelRequest.Builder

This builder for chaining.

setEndpointBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for endpoint to set.

Returns
TypeDescription
DeployModelRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DeployModelRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DeployModelRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DeployModelRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DeployModelRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DeployModelRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DeployModelRequest.Builder
Overrides