Class UndeployModelRequest (3.0.0) 

public final class UndeployModelRequest extends GeneratedMessageV3 implements UndeployModelRequestOrBuilder

Request message for EndpointService.UndeployModel.

Protobuf type google.cloud.aiplatform.v1.UndeployModelRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > UndeployModelRequest

Static Fields

DEPLOYED_MODEL_ID_FIELD_NUMBER

public static final int DEPLOYED_MODEL_ID_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 UndeployModelRequest getDefaultInstance()
Returns
Type Description
UndeployModelRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UndeployModelRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

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

equals(Object obj)

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

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.

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTrafficSplit()

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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