Vector Search v1 API - Class CreateIndexRequest (1.0.0-beta01) 

public sealed class CreateIndexRequest : IMessage<CreateIndexRequest>, IEquatable<CreateIndexRequest>, IDeepCloneable<CreateIndexRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Vector Search v1 API class CreateIndexRequest.

Message for creating an Index.

Inheritance

object > CreateIndexRequest

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

CreateIndexRequest()

public CreateIndexRequest()

CreateIndexRequest(CreateIndexRequest)

public CreateIndexRequest(CreateIndexRequest other)
Parameter
Name Description
other CreateIndexRequest

Properties

Index

public Index Index { get; set; }

Required. The resource being created

Property Value
Type Description
Index

IndexId

public string IndexId { get; set; }

Required. ID of the Index 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](?:[-a-z0-9]{0,61}[a-z0-9])?.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The resource name of the Collection for which to create the Index. Format: projects/{project}/locations/{location}/collections/{collection}

Property Value
Type Description
string

ParentAsCollectionName

public CollectionName ParentAsCollectionName { get; set; }

CollectionName-typed view over the Parent resource name property.

Property Value
Type Description
CollectionName

RequestId

public string RequestId { get; set; }

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).

Property Value
Type Description
string