public static final class DeleteIndexRequest.Builder extends GeneratedMessage.Builder<DeleteIndexRequest.Builder> implements DeleteIndexRequestOrBuilderMessage for deleting an Index.
Protobuf type google.cloud.vectorsearch.v1beta.DeleteIndexRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > DeleteIndexRequest.BuilderImplements
DeleteIndexRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public DeleteIndexRequest build()| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest |
|
buildPartial()
public DeleteIndexRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest |
|
clear()
public DeleteIndexRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest.Builder |
|
clearName()
public DeleteIndexRequest.Builder clearName() Required. The resource name of the Index to delete.
Format:
projects/{project}/locations/{location}/collections/{collection}/indexes/{index}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest.Builder |
This builder for chaining. |
clearRequestId()
public DeleteIndexRequest.Builder clearRequestId()Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public DeleteIndexRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getName()
public String getName() Required. The resource name of the Index to delete.
Format:
projects/{project}/locations/{location}/collections/{collection}/indexes/{index}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Required. The resource name of the Index to delete.
Format:
projects/{project}/locations/{location}/collections/{collection}/indexes/{index}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getRequestId()
public String getRequestId()Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The requestId. |
getRequestIdBytes()
public ByteString getRequestIdBytes()Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for requestId. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(DeleteIndexRequest other)
public DeleteIndexRequest.Builder mergeFrom(DeleteIndexRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
DeleteIndexRequest |
| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DeleteIndexRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DeleteIndexRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest.Builder |
|
setName(String value)
public DeleteIndexRequest.Builder setName(String value) Required. The resource name of the Index to delete.
Format:
projects/{project}/locations/{location}/collections/{collection}/indexes/{index}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public DeleteIndexRequest.Builder setNameBytes(ByteString value) Required. The resource name of the Index to delete.
Format:
projects/{project}/locations/{location}/collections/{collection}/indexes/{index}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest.Builder |
This builder for chaining. |
setRequestId(String value)
public DeleteIndexRequest.Builder setRequestId(String value)Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe requestId to set. |
| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest.Builder |
This builder for chaining. |
setRequestIdBytes(ByteString value)
public DeleteIndexRequest.Builder setRequestIdBytes(ByteString value)Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for requestId to set. |
| Returns | |
|---|---|
| Type | Description |
DeleteIndexRequest.Builder |
This builder for chaining. |