Class UndeployIndexRequest.Builder (3.84.0)

public static final class UndeployIndexRequest.Builder extends GeneratedMessage.Builder<UndeployIndexRequest.Builder> implements UndeployIndexRequestOrBuilder

Request message for IndexEndpointService.UndeployIndex.

Protobuf type google.cloud.aiplatform.v1.UndeployIndexRequest

Static Methods

getDescriptor()

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

Methods

build()

public UndeployIndexRequest build()
Returns
Type Description
UndeployIndexRequest

buildPartial()

public UndeployIndexRequest buildPartial()
Returns
Type Description
UndeployIndexRequest

clear()

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

clearDeployedIndexId()

public UndeployIndexRequest.Builder clearDeployedIndexId()

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

This builder for chaining.

clearIndexEndpoint()

public UndeployIndexRequest.Builder clearIndexEndpoint()

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

This builder for chaining.

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.

getDescriptorForType()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UndeployIndexRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setDeployedIndexId(String value)

public UndeployIndexRequest.Builder setDeployedIndexId(String value)

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

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

Parameter
Name Description
value String

The deployedIndexId to set.

Returns
Type Description
UndeployIndexRequest.Builder

This builder for chaining.

setDeployedIndexIdBytes(ByteString value)

public UndeployIndexRequest.Builder setDeployedIndexIdBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for deployedIndexId to set.

Returns
Type Description
UndeployIndexRequest.Builder

This builder for chaining.

setIndexEndpoint(String value)

public UndeployIndexRequest.Builder setIndexEndpoint(String value)

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) = { ... }

Parameter
Name Description
value String

The indexEndpoint to set.

Returns
Type Description
UndeployIndexRequest.Builder

This builder for chaining.

setIndexEndpointBytes(ByteString value)

public UndeployIndexRequest.Builder setIndexEndpointBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for indexEndpoint to set.

Returns
Type Description
UndeployIndexRequest.Builder

This builder for chaining.