Class DeployModelRequest.Builder (3.44.0)

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DeployModelRequest.Builder

Implements

DeployModelRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeployModelRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DeployModelRequest build()

Returns
Type	Description
`DeployModelRequest`

buildPartial()

public DeployModelRequest buildPartial()

Returns
Type	Description
`DeployModelRequest`

clear()

public DeployModelRequest.Builder clear()

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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

Returns
Type	Description
`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
Type	Description
`DeployModelRequest.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DeployModelRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public DeployModelRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearTrafficSplit()

public DeployModelRequest.Builder clearTrafficSplit()

Returns
Type	Description
`DeployModelRequest.Builder`

clone()

public DeployModelRequest.Builder clone()

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

getDefaultInstanceForType()

public DeployModelRequest getDefaultInstanceForType()

Returns
Type	Description
`DeployModelRequest`

getDeployedModel()

public DeployedModel getDeployedModel()

.google.cloud.aiplatform.v1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`DeployedModel`	The deployedModel.

getDeployedModelBuilder()

public DeployedModel.Builder getDeployedModelBuilder()

.google.cloud.aiplatform.v1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`DeployedModel.Builder`

getDeployedModelOrBuilder()

public DeployedModelOrBuilder getDeployedModelOrBuilder()

.google.cloud.aiplatform.v1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`DeployedModelOrBuilder`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getMutableTrafficSplit() (deprecated)

public Map<String,Integer> getMutableTrafficSplit()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,Integer>`

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 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 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 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 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()

.google.cloud.aiplatform.v1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the deployedModel field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeDeployedModel(DeployedModel value)

public DeployModelRequest.Builder mergeDeployedModel(DeployedModel value)

.google.cloud.aiplatform.v1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`DeployedModel`

Returns
Type	Description
`DeployModelRequest.Builder`

mergeFrom(DeployModelRequest other)

public DeployModelRequest.Builder mergeFrom(DeployModelRequest other)

Parameter
Name	Description
`other`	`DeployModelRequest`

Returns
Type	Description
`DeployModelRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeployModelRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DeployModelRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeployModelRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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 empty, then the Endpoint's traffic_split is not updated.

map<string, int32> traffic_split = 3;

Parameter
Name	Description
`values`	`Map<String,Integer>`

Returns
Type	Description
`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 empty, then the Endpoint's traffic_split is not updated.

map<string, int32> traffic_split = 3;

Parameters
Name	Description
`key`	`String`
`value`	`int`

Returns
Type	Description
`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 empty, then the Endpoint's traffic_split is not updated.

map<string, int32> traffic_split = 3;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`DeployModelRequest.Builder`

setDeployedModel(DeployedModel value)

public DeployModelRequest.Builder setDeployedModel(DeployedModel value)

.google.cloud.aiplatform.v1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`DeployedModel`

Returns
Type	Description
`DeployModelRequest.Builder`

setDeployedModel(DeployedModel.Builder builderForValue)

public DeployModelRequest.Builder setDeployedModel(DeployedModel.Builder builderForValue)

.google.cloud.aiplatform.v1.DeployedModel deployed_model = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`builderForValue`	`DeployedModel.Builder`

Returns
Type	Description
`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
Name	Description
`value`	`String` The endpoint to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for endpoint to set.

Returns
Type	Description
`DeployModelRequest.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DeployModelRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final DeployModelRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DeployModelRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)