Class UndeployModelRequest (3.12.0)

public final class UndeployModelRequest extends GeneratedMessageV3 implements UndeployModelRequestOrBuilder

Request message for EndpointService.UndeployModel.

Protobuf type google.cloud.aiplatform.v1.UndeployModelRequest

Static Fields

DEPLOYED_MODEL_ID_FIELD_NUMBER

public static final int DEPLOYED_MODEL_ID_FIELD_NUMBER
Field Value
TypeDescription
int

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

TRAFFIC_SPLIT_FIELD_NUMBER

public static final int TRAFFIC_SPLIT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UndeployModelRequest getDefaultInstance()
Returns
TypeDescription
UndeployModelRequest

getDescriptor()

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

newBuilder()

public static UndeployModelRequest.Builder newBuilder()
Returns
TypeDescription
UndeployModelRequest.Builder

newBuilder(UndeployModelRequest prototype)

public static UndeployModelRequest.Builder newBuilder(UndeployModelRequest prototype)
Parameter
NameDescription
prototypeUndeployModelRequest
Returns
TypeDescription
UndeployModelRequest.Builder

parseDelimitedFrom(InputStream input)

public static UndeployModelRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UndeployModelRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UndeployModelRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UndeployModelRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UndeployModelRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UndeployModelRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UndeployModelRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UndeployModelRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UndeployModelRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UndeployModelRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UndeployModelRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UndeployModelRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UndeployModelRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UndeployModelRequest> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public UndeployModelRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for endpoint.

getParserForType()

public Parser<UndeployModelRequest> getParserForType()
Returns
TypeDescription
Parser<UndeployModelRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTrafficSplit()

public Map<String,Integer> getTrafficSplit()

Use #getTrafficSplitMap() instead.

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UndeployModelRequest.Builder newBuilderForType()
Returns
TypeDescription
UndeployModelRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UndeployModelRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UndeployModelRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UndeployModelRequest.Builder toBuilder()
Returns
TypeDescription
UndeployModelRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException