Class CreateCollectionRequest.Builder (0.6.0)

public static final class CreateCollectionRequest.Builder extends GeneratedMessage.Builder<CreateCollectionRequest.Builder> implements CreateCollectionRequestOrBuilder

Message for creating a Collection

Protobuf type google.cloud.vectorsearch.v1beta.CreateCollectionRequest

Static Methods

getDescriptor()

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

Methods

build()

public CreateCollectionRequest build()
Returns
Type Description
CreateCollectionRequest

buildPartial()

public CreateCollectionRequest buildPartial()
Returns
Type Description
CreateCollectionRequest

clear()

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

clearCollection()

public CreateCollectionRequest.Builder clearCollection()

Required. The resource being created

.google.cloud.vectorsearch.v1beta.Collection collection = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateCollectionRequest.Builder

clearCollectionId()

public CreateCollectionRequest.Builder clearCollectionId()

Required. ID of the Collection to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression a-z?.

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

Returns
Type Description
CreateCollectionRequest.Builder

This builder for chaining.

clearParent()

public CreateCollectionRequest.Builder clearParent()

Required. Value for parent.

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

Returns
Type Description
CreateCollectionRequest.Builder

This builder for chaining.

clearRequestId()

public CreateCollectionRequest.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 = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
CreateCollectionRequest.Builder

This builder for chaining.

getCollection()

public Collection getCollection()

Required. The resource being created

.google.cloud.vectorsearch.v1beta.Collection collection = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Collection

The collection.

getCollectionBuilder()

public Collection.Builder getCollectionBuilder()

Required. The resource being created

.google.cloud.vectorsearch.v1beta.Collection collection = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Collection.Builder

getCollectionId()

public String getCollectionId()

Required. ID of the Collection to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression a-z?.

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

Returns
Type Description
String

The collectionId.

getCollectionIdBytes()

public ByteString getCollectionIdBytes()

Required. ID of the Collection to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression a-z?.

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

Returns
Type Description
ByteString

The bytes for collectionId.

getCollectionOrBuilder()

public CollectionOrBuilder getCollectionOrBuilder()

Required. The resource being created

.google.cloud.vectorsearch.v1beta.Collection collection = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CollectionOrBuilder

getDefaultInstanceForType()

public CreateCollectionRequest getDefaultInstanceForType()
Returns
Type Description
CreateCollectionRequest

getDescriptorForType()

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

getParent()

public String getParent()

Required. Value for parent.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Value for parent.

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

Returns
Type Description
ByteString

The bytes for parent.

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 = 4 [(.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 = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for requestId.

hasCollection()

public boolean hasCollection()

Required. The resource being created

.google.cloud.vectorsearch.v1beta.Collection collection = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the collection field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCollection(Collection value)

public CreateCollectionRequest.Builder mergeCollection(Collection value)

Required. The resource being created

.google.cloud.vectorsearch.v1beta.Collection collection = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Collection
Returns
Type Description
CreateCollectionRequest.Builder

mergeFrom(CreateCollectionRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setCollection(Collection value)

public CreateCollectionRequest.Builder setCollection(Collection value)

Required. The resource being created

.google.cloud.vectorsearch.v1beta.Collection collection = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Collection
Returns
Type Description
CreateCollectionRequest.Builder

setCollection(Collection.Builder builderForValue)

public CreateCollectionRequest.Builder setCollection(Collection.Builder builderForValue)

Required. The resource being created

.google.cloud.vectorsearch.v1beta.Collection collection = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Collection.Builder
Returns
Type Description
CreateCollectionRequest.Builder

setCollectionId(String value)

public CreateCollectionRequest.Builder setCollectionId(String value)

Required. ID of the Collection to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression a-z?.

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

Parameter
Name Description
value String

The collectionId to set.

Returns
Type Description
CreateCollectionRequest.Builder

This builder for chaining.

setCollectionIdBytes(ByteString value)

public CreateCollectionRequest.Builder setCollectionIdBytes(ByteString value)

Required. ID of the Collection to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression a-z?.

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

Parameter
Name Description
value ByteString

The bytes for collectionId to set.

Returns
Type Description
CreateCollectionRequest.Builder

This builder for chaining.

setParent(String value)

public CreateCollectionRequest.Builder setParent(String value)

Required. Value for parent.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateCollectionRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateCollectionRequest.Builder setParentBytes(ByteString value)

Required. Value for parent.

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateCollectionRequest.Builder

This builder for chaining.

setRequestId(String value)

public CreateCollectionRequest.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 = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
CreateCollectionRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public CreateCollectionRequest.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 = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
CreateCollectionRequest.Builder

This builder for chaining.