Class UndeployModelRequest.Builder (0.8.0)

public static final class UndeployModelRequest.Builder extends GeneratedMessageV3.Builder<UndeployModelRequest.Builder> implements UndeployModelRequestOrBuilder

Request message for EndpointService.UndeployModel.

Protobuf type google.cloud.vertexai.v1.UndeployModelRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UndeployModelRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UndeployModelRequest.Builder
Overrides

build()

public UndeployModelRequest build()
Returns
Type Description
UndeployModelRequest

buildPartial()

public UndeployModelRequest buildPartial()
Returns
Type Description
UndeployModelRequest

clear()

public UndeployModelRequest.Builder clear()
Returns
Type Description
UndeployModelRequest.Builder
Overrides

clearDeployedModelId()

public UndeployModelRequest.Builder clearDeployedModelId()

Required. The ID of the DeployedModel to be undeployed from the Endpoint.

string deployed_model_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UndeployModelRequest.Builder

This builder for chaining.

clearEndpoint()

public UndeployModelRequest.Builder clearEndpoint()

Required. The name of the Endpoint resource from which to undeploy a Model. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
UndeployModelRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UndeployModelRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UndeployModelRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UndeployModelRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UndeployModelRequest.Builder
Overrides

clearTrafficSplit()

public UndeployModelRequest.Builder clearTrafficSplit()
Returns
Type Description
UndeployModelRequest.Builder

clone()

public UndeployModelRequest.Builder clone()
Returns
Type Description
UndeployModelRequest.Builder
Overrides

containsTrafficSplit(String key)

public boolean containsTrafficSplit(String key)

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

map<string, int32> traffic_split = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public UndeployModelRequest getDefaultInstanceForType()
Returns
Type Description
UndeployModelRequest

getDeployedModelId()

public String getDeployedModelId()

Required. The ID of the DeployedModel to be undeployed from the Endpoint.

string deployed_model_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The deployedModelId.

getDeployedModelIdBytes()

public ByteString getDeployedModelIdBytes()

Required. The ID of the DeployedModel to be undeployed from the Endpoint.

string deployed_model_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for deployedModelId.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEndpoint()

public String getEndpoint()

Required. The name of the Endpoint resource from which to undeploy 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 from which to undeploy 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()

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

map<string, int32> traffic_split = 3;

Returns
Type Description
int

getTrafficSplitMap()

public Map<String,Integer> getTrafficSplitMap()

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

map<string, int32> traffic_split = 3;

Returns
Type Description
Map<String,Integer>

getTrafficSplitOrDefault(String key, int defaultValue)

public int getTrafficSplitOrDefault(String key, int defaultValue)

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

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)

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

map<string, int32> traffic_split = 3;

Parameter
Name Description
key String
Returns
Type Description
int

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

mergeFrom(UndeployModelRequest other)

public UndeployModelRequest.Builder mergeFrom(UndeployModelRequest other)
Parameter
Name Description
other UndeployModelRequest
Returns
Type Description
UndeployModelRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UndeployModelRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UndeployModelRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UndeployModelRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UndeployModelRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UndeployModelRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UndeployModelRequest.Builder
Overrides

putAllTrafficSplit(Map<String,Integer> values)

public UndeployModelRequest.Builder putAllTrafficSplit(Map<String,Integer> values)

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

map<string, int32> traffic_split = 3;

Parameter
Name Description
values Map<String,Integer>
Returns
Type Description
UndeployModelRequest.Builder

putTrafficSplit(String key, int value)

public UndeployModelRequest.Builder putTrafficSplit(String key, int value)

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

map<string, int32> traffic_split = 3;

Parameters
Name Description
key String
value int
Returns
Type Description
UndeployModelRequest.Builder

removeTrafficSplit(String key)

public UndeployModelRequest.Builder removeTrafficSplit(String key)

If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

map<string, int32> traffic_split = 3;

Parameter
Name Description
key String
Returns
Type Description
UndeployModelRequest.Builder

setDeployedModelId(String value)

public UndeployModelRequest.Builder setDeployedModelId(String value)

Required. The ID of the DeployedModel to be undeployed from the Endpoint.

string deployed_model_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The deployedModelId to set.

Returns
Type Description
UndeployModelRequest.Builder

This builder for chaining.

setDeployedModelIdBytes(ByteString value)

public UndeployModelRequest.Builder setDeployedModelIdBytes(ByteString value)

Required. The ID of the DeployedModel to be undeployed from the Endpoint.

string deployed_model_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for deployedModelId to set.

Returns
Type Description
UndeployModelRequest.Builder

This builder for chaining.

setEndpoint(String value)

public UndeployModelRequest.Builder setEndpoint(String value)

Required. The name of the Endpoint resource from which to undeploy 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
UndeployModelRequest.Builder

This builder for chaining.

setEndpointBytes(ByteString value)

public UndeployModelRequest.Builder setEndpointBytes(ByteString value)

Required. The name of the Endpoint resource from which to undeploy 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
UndeployModelRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UndeployModelRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UndeployModelRequest.Builder
Overrides

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

public UndeployModelRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UndeployModelRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UndeployModelRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UndeployModelRequest.Builder
Overrides