1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1beta1
  6. Index

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.aiplatform/v1beta1.Index

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Creates an Index. Auto-naming is currently not supported for this resource.

Create Index Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Index(name: string, args: IndexArgs, opts?: CustomResourceOptions);
@overload
def Index(resource_name: str,
          args: IndexArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Index(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          display_name: Optional[str] = None,
          description: Optional[str] = None,
          encryption_spec: Optional[GoogleCloudAiplatformV1beta1EncryptionSpecArgs] = None,
          etag: Optional[str] = None,
          index_update_method: Optional[IndexIndexUpdateMethod] = None,
          labels: Optional[Mapping[str, str]] = None,
          location: Optional[str] = None,
          metadata: Optional[Any] = None,
          metadata_schema_uri: Optional[str] = None,
          project: Optional[str] = None)
func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)
public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)
public Index(String name, IndexArgs args)
public Index(String name, IndexArgs args, CustomResourceOptions options)
type: google-native:aiplatform/v1beta1:Index
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IndexArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IndexArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IndexArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IndexArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IndexArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var google_nativeIndexResource = new GoogleNative.Aiplatform.V1Beta1.Index("google-nativeIndexResource", new()
{
    DisplayName = "string",
    Description = "string",
    EncryptionSpec = new GoogleNative.Aiplatform.V1Beta1.Inputs.GoogleCloudAiplatformV1beta1EncryptionSpecArgs
    {
        KmsKeyName = "string",
    },
    Etag = "string",
    IndexUpdateMethod = GoogleNative.Aiplatform.V1Beta1.IndexIndexUpdateMethod.IndexUpdateMethodUnspecified,
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Metadata = "any",
    MetadataSchemaUri = "string",
    Project = "string",
});
Copy
example, err := aiplatformv1beta1.NewIndex(ctx, "google-nativeIndexResource", &aiplatformv1beta1.IndexArgs{
	DisplayName: pulumi.String("string"),
	Description: pulumi.String("string"),
	EncryptionSpec: &aiplatform.GoogleCloudAiplatformV1beta1EncryptionSpecArgs{
		KmsKeyName: pulumi.String("string"),
	},
	Etag:              pulumi.String("string"),
	IndexUpdateMethod: aiplatformv1beta1.IndexIndexUpdateMethodIndexUpdateMethodUnspecified,
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location:          pulumi.String("string"),
	Metadata:          pulumi.Any("any"),
	MetadataSchemaUri: pulumi.String("string"),
	Project:           pulumi.String("string"),
})
Copy
var google_nativeIndexResource = new Index("google-nativeIndexResource", IndexArgs.builder()
    .displayName("string")
    .description("string")
    .encryptionSpec(GoogleCloudAiplatformV1beta1EncryptionSpecArgs.builder()
        .kmsKeyName("string")
        .build())
    .etag("string")
    .indexUpdateMethod("INDEX_UPDATE_METHOD_UNSPECIFIED")
    .labels(Map.of("string", "string"))
    .location("string")
    .metadata("any")
    .metadataSchemaUri("string")
    .project("string")
    .build());
Copy
google_native_index_resource = google_native.aiplatform.v1beta1.Index("google-nativeIndexResource",
    display_name="string",
    description="string",
    encryption_spec={
        "kms_key_name": "string",
    },
    etag="string",
    index_update_method=google_native.aiplatform.v1beta1.IndexIndexUpdateMethod.INDEX_UPDATE_METHOD_UNSPECIFIED,
    labels={
        "string": "string",
    },
    location="string",
    metadata="any",
    metadata_schema_uri="string",
    project="string")
Copy
const google_nativeIndexResource = new google_native.aiplatform.v1beta1.Index("google-nativeIndexResource", {
    displayName: "string",
    description: "string",
    encryptionSpec: {
        kmsKeyName: "string",
    },
    etag: "string",
    indexUpdateMethod: google_native.aiplatform.v1beta1.IndexIndexUpdateMethod.IndexUpdateMethodUnspecified,
    labels: {
        string: "string",
    },
    location: "string",
    metadata: "any",
    metadataSchemaUri: "string",
    project: "string",
});
Copy
type: google-native:aiplatform/v1beta1:Index
properties:
    description: string
    displayName: string
    encryptionSpec:
        kmsKeyName: string
    etag: string
    indexUpdateMethod: INDEX_UPDATE_METHOD_UNSPECIFIED
    labels:
        string: string
    location: string
    metadata: any
    metadataSchemaUri: string
    project: string
Copy

Index Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Index resource accepts the following input properties:

DisplayName This property is required. string
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
Description string
The description of the Index.
EncryptionSpec Pulumi.GoogleNative.Aiplatform.V1Beta1.Inputs.GoogleCloudAiplatformV1beta1EncryptionSpec
Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
Etag string
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
IndexUpdateMethod Pulumi.GoogleNative.Aiplatform.V1Beta1.IndexIndexUpdateMethod
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
Labels Dictionary<string, string>
The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
Location Changes to this property will trigger replacement. string
Metadata object
An additional information about the Index; the schema of the metadata can be found in metadata_schema.
MetadataSchemaUri string
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
Project Changes to this property will trigger replacement. string
DisplayName This property is required. string
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
Description string
The description of the Index.
EncryptionSpec GoogleCloudAiplatformV1beta1EncryptionSpecArgs
Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
Etag string
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
IndexUpdateMethod IndexIndexUpdateMethod
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
Labels map[string]string
The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
Location Changes to this property will trigger replacement. string
Metadata interface{}
An additional information about the Index; the schema of the metadata can be found in metadata_schema.
MetadataSchemaUri string
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
Project Changes to this property will trigger replacement. string
displayName This property is required. String
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
description String
The description of the Index.
encryptionSpec GoogleCloudAiplatformV1beta1EncryptionSpec
Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
etag String
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
indexUpdateMethod IndexIndexUpdateMethod
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
labels Map<String,String>
The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
location Changes to this property will trigger replacement. String
metadata Object
An additional information about the Index; the schema of the metadata can be found in metadata_schema.
metadataSchemaUri String
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
project Changes to this property will trigger replacement. String
displayName This property is required. string
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
description string
The description of the Index.
encryptionSpec GoogleCloudAiplatformV1beta1EncryptionSpec
Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
etag string
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
indexUpdateMethod IndexIndexUpdateMethod
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
labels {[key: string]: string}
The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
location Changes to this property will trigger replacement. string
metadata any
An additional information about the Index; the schema of the metadata can be found in metadata_schema.
metadataSchemaUri string
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
project Changes to this property will trigger replacement. string
display_name This property is required. str
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
description str
The description of the Index.
encryption_spec GoogleCloudAiplatformV1beta1EncryptionSpecArgs
Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
etag str
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
index_update_method IndexIndexUpdateMethod
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
labels Mapping[str, str]
The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
location Changes to this property will trigger replacement. str
metadata Any
An additional information about the Index; the schema of the metadata can be found in metadata_schema.
metadata_schema_uri str
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
project Changes to this property will trigger replacement. str
displayName This property is required. String
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
description String
The description of the Index.
encryptionSpec Property Map
Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
etag String
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
indexUpdateMethod "INDEX_UPDATE_METHOD_UNSPECIFIED" | "BATCH_UPDATE" | "STREAM_UPDATE"
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
labels Map<String>
The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
location Changes to this property will trigger replacement. String
metadata Any
An additional information about the Index; the schema of the metadata can be found in metadata_schema.
metadataSchemaUri String
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
project Changes to this property will trigger replacement. String

Outputs

All input properties are implicitly available as output properties. Additionally, the Index resource produces the following output properties:

CreateTime string
Timestamp when this Index was created.
DeployedIndexes List<Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleCloudAiplatformV1beta1DeployedIndexRefResponse>
The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
Id string
The provider-assigned unique ID for this managed resource.
IndexStats Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleCloudAiplatformV1beta1IndexStatsResponse
Stats of the index resource.
Name string
The resource name of the Index.
UpdateTime string
Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
CreateTime string
Timestamp when this Index was created.
DeployedIndexes []GoogleCloudAiplatformV1beta1DeployedIndexRefResponse
The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
Id string
The provider-assigned unique ID for this managed resource.
IndexStats GoogleCloudAiplatformV1beta1IndexStatsResponse
Stats of the index resource.
Name string
The resource name of the Index.
UpdateTime string
Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
createTime String
Timestamp when this Index was created.
deployedIndexes List<GoogleCloudAiplatformV1beta1DeployedIndexRefResponse>
The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
id String
The provider-assigned unique ID for this managed resource.
indexStats GoogleCloudAiplatformV1beta1IndexStatsResponse
Stats of the index resource.
name String
The resource name of the Index.
updateTime String
Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
createTime string
Timestamp when this Index was created.
deployedIndexes GoogleCloudAiplatformV1beta1DeployedIndexRefResponse[]
The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
id string
The provider-assigned unique ID for this managed resource.
indexStats GoogleCloudAiplatformV1beta1IndexStatsResponse
Stats of the index resource.
name string
The resource name of the Index.
updateTime string
Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
create_time str
Timestamp when this Index was created.
deployed_indexes Sequence[GoogleCloudAiplatformV1beta1DeployedIndexRefResponse]
The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
id str
The provider-assigned unique ID for this managed resource.
index_stats GoogleCloudAiplatformV1beta1IndexStatsResponse
Stats of the index resource.
name str
The resource name of the Index.
update_time str
Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
createTime String
Timestamp when this Index was created.
deployedIndexes List<Property Map>
The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
id String
The provider-assigned unique ID for this managed resource.
indexStats Property Map
Stats of the index resource.
name String
The resource name of the Index.
updateTime String
Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.

Supporting Types

GoogleCloudAiplatformV1beta1DeployedIndexRefResponse
, GoogleCloudAiplatformV1beta1DeployedIndexRefResponseArgs

DeployedIndexId This property is required. string
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
IndexEndpoint This property is required. string
Immutable. A resource name of the IndexEndpoint.
DeployedIndexId This property is required. string
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
IndexEndpoint This property is required. string
Immutable. A resource name of the IndexEndpoint.
deployedIndexId This property is required. String
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
indexEndpoint This property is required. String
Immutable. A resource name of the IndexEndpoint.
deployedIndexId This property is required. string
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
indexEndpoint This property is required. string
Immutable. A resource name of the IndexEndpoint.
deployed_index_id This property is required. str
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
index_endpoint This property is required. str
Immutable. A resource name of the IndexEndpoint.
deployedIndexId This property is required. String
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
indexEndpoint This property is required. String
Immutable. A resource name of the IndexEndpoint.

GoogleCloudAiplatformV1beta1EncryptionSpec
, GoogleCloudAiplatformV1beta1EncryptionSpecArgs

KmsKeyName This property is required. string
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
KmsKeyName This property is required. string
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kmsKeyName This property is required. String
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kmsKeyName This property is required. string
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kms_key_name This property is required. str
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kmsKeyName This property is required. String
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.

GoogleCloudAiplatformV1beta1EncryptionSpecResponse
, GoogleCloudAiplatformV1beta1EncryptionSpecResponseArgs

KmsKeyName This property is required. string
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
KmsKeyName This property is required. string
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kmsKeyName This property is required. String
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kmsKeyName This property is required. string
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kms_key_name This property is required. str
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kmsKeyName This property is required. String
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.

GoogleCloudAiplatformV1beta1IndexStatsResponse
, GoogleCloudAiplatformV1beta1IndexStatsResponseArgs

ShardsCount This property is required. int
The number of shards in the Index.
VectorsCount This property is required. string
The number of vectors in the Index.
ShardsCount This property is required. int
The number of shards in the Index.
VectorsCount This property is required. string
The number of vectors in the Index.
shardsCount This property is required. Integer
The number of shards in the Index.
vectorsCount This property is required. String
The number of vectors in the Index.
shardsCount This property is required. number
The number of shards in the Index.
vectorsCount This property is required. string
The number of vectors in the Index.
shards_count This property is required. int
The number of shards in the Index.
vectors_count This property is required. str
The number of vectors in the Index.
shardsCount This property is required. Number
The number of shards in the Index.
vectorsCount This property is required. String
The number of vectors in the Index.

IndexIndexUpdateMethod
, IndexIndexUpdateMethodArgs

IndexUpdateMethodUnspecified
INDEX_UPDATE_METHOD_UNSPECIFIEDShould not be used.
BatchUpdate
BATCH_UPDATEBatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update.
StreamUpdate
STREAM_UPDATEStreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time.
IndexIndexUpdateMethodIndexUpdateMethodUnspecified
INDEX_UPDATE_METHOD_UNSPECIFIEDShould not be used.
IndexIndexUpdateMethodBatchUpdate
BATCH_UPDATEBatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update.
IndexIndexUpdateMethodStreamUpdate
STREAM_UPDATEStreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time.
IndexUpdateMethodUnspecified
INDEX_UPDATE_METHOD_UNSPECIFIEDShould not be used.
BatchUpdate
BATCH_UPDATEBatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update.
StreamUpdate
STREAM_UPDATEStreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time.
IndexUpdateMethodUnspecified
INDEX_UPDATE_METHOD_UNSPECIFIEDShould not be used.
BatchUpdate
BATCH_UPDATEBatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update.
StreamUpdate
STREAM_UPDATEStreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time.
INDEX_UPDATE_METHOD_UNSPECIFIED
INDEX_UPDATE_METHOD_UNSPECIFIEDShould not be used.
BATCH_UPDATE
BATCH_UPDATEBatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update.
STREAM_UPDATE
STREAM_UPDATEStreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time.
"INDEX_UPDATE_METHOD_UNSPECIFIED"
INDEX_UPDATE_METHOD_UNSPECIFIEDShould not be used.
"BATCH_UPDATE"
BATCH_UPDATEBatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update.
"STREAM_UPDATE"
STREAM_UPDATEStreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi