Class UndeployIndexRequest (3.8.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
TypeDescription
int

INDEX_ENDPOINT_FIELD_NUMBER

public static final int INDEX_ENDPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UndeployIndexRequest getDefaultInstance()
Returns
TypeDescription
UndeployIndexRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UndeployIndexRequest prototype)

public static UndeployIndexRequest.Builder newBuilder(UndeployIndexRequest prototype)
Parameter
NameDescription
prototypeUndeployIndexRequest
Returns
TypeDescription
UndeployIndexRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<UndeployIndexRequest> parser()
Returns
TypeDescription
Parser<UndeployIndexRequest>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

The bytes for indexEndpoint.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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