Class UndeployIndexRequest (3.45.0)

public final class UndeployIndexRequest extends GeneratedMessageV3 implements UndeployIndexRequestOrBuilder

Request message for IndexEndpointService.UndeployIndex.

Protobuf type google.cloud.aiplatform.v1.UndeployIndexRequest

Static Fields

DEPLOYED_INDEX_ID_FIELD_NUMBER

public static final int DEPLOYED_INDEX_ID_FIELD_NUMBER
Field Value
Type Description
int

INDEX_ENDPOINT_FIELD_NUMBER

public static final int INDEX_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UndeployIndexRequest getDefaultInstance()
Returns
Type Description
UndeployIndexRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UndeployIndexRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public UndeployIndexRequest getDefaultInstanceForType()
Returns
Type Description
UndeployIndexRequest

getDeployedIndexId()

public String getDeployedIndexId()

Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.

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

Returns
Type Description
String

The deployedIndexId.

getDeployedIndexIdBytes()

public ByteString getDeployedIndexIdBytes()

Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.

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

Returns
Type Description
ByteString

The bytes for deployedIndexId.

getIndexEndpoint()

public String getIndexEndpoint()

Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

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

Returns
Type Description
String

The indexEndpoint.

getIndexEndpointBytes()

public ByteString getIndexEndpointBytes()

Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

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

Returns
Type Description
ByteString

The bytes for indexEndpoint.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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