google_vertex_ai_index

package
v0.0.0-...-4deecce Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 16, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Args

type Args struct {
	// Description: string, optional
	Description terra.StringValue `hcl:"description,attr"`
	// DisplayName: string, required
	DisplayName terra.StringValue `hcl:"display_name,attr" validate:"required"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// IndexUpdateMethod: string, optional
	IndexUpdateMethod terra.StringValue `hcl:"index_update_method,attr"`
	// Labels: map of string, optional
	Labels terra.MapValue[terra.StringValue] `hcl:"labels,attr"`
	// Project: string, optional
	Project terra.StringValue `hcl:"project,attr"`
	// Region: string, optional
	Region terra.StringValue `hcl:"region,attr"`
	// Metadata: optional
	Metadata *Metadata `hcl:"metadata,block"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for google_vertex_ai_index.

type DataArgs

type DataArgs struct {
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// Project: string, optional
	Project terra.StringValue `hcl:"project,attr"`
	// Region: string, required
	Region terra.StringValue `hcl:"region,attr" validate:"required"`
}

DataArgs contains the configurations for google_vertex_ai_index.

type DataDeployedIndexesAttributes

type DataDeployedIndexesAttributes struct {
	// contains filtered or unexported fields
}

func (DataDeployedIndexesAttributes) DeployedIndexId

func (di DataDeployedIndexesAttributes) DeployedIndexId() terra.StringValue

func (DataDeployedIndexesAttributes) IndexEndpoint

func (di DataDeployedIndexesAttributes) IndexEndpoint() terra.StringValue

func (DataDeployedIndexesAttributes) InternalRef

func (di DataDeployedIndexesAttributes) InternalRef() (terra.Reference, error)

func (DataDeployedIndexesAttributes) InternalTokens

func (di DataDeployedIndexesAttributes) InternalTokens() (hclwrite.Tokens, error)

func (DataDeployedIndexesAttributes) InternalWithRef

type DataDeployedIndexesState

type DataDeployedIndexesState struct {
	DeployedIndexId string `json:"deployed_index_id"`
	IndexEndpoint   string `json:"index_endpoint"`
}

type DataIndexStatsAttributes

type DataIndexStatsAttributes struct {
	// contains filtered or unexported fields
}

func (DataIndexStatsAttributes) InternalRef

func (is DataIndexStatsAttributes) InternalRef() (terra.Reference, error)

func (DataIndexStatsAttributes) InternalTokens

func (is DataIndexStatsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (DataIndexStatsAttributes) InternalWithRef

func (DataIndexStatsAttributes) ShardsCount

func (is DataIndexStatsAttributes) ShardsCount() terra.NumberValue

func (DataIndexStatsAttributes) VectorsCount

func (is DataIndexStatsAttributes) VectorsCount() terra.StringValue

type DataIndexStatsState

type DataIndexStatsState struct {
	ShardsCount  float64 `json:"shards_count"`
	VectorsCount string  `json:"vectors_count"`
}

type DataMetadataAttributes

type DataMetadataAttributes struct {
	// contains filtered or unexported fields
}

func (DataMetadataAttributes) Config

func (DataMetadataAttributes) ContentsDeltaUri

func (m DataMetadataAttributes) ContentsDeltaUri() terra.StringValue

func (DataMetadataAttributes) InternalRef

func (m DataMetadataAttributes) InternalRef() (terra.Reference, error)

func (DataMetadataAttributes) InternalTokens

func (m DataMetadataAttributes) InternalTokens() (hclwrite.Tokens, error)

func (DataMetadataAttributes) InternalWithRef

func (DataMetadataAttributes) IsCompleteOverwrite

func (m DataMetadataAttributes) IsCompleteOverwrite() terra.BoolValue

type DataMetadataConfigAlgorithmConfigAttributes

type DataMetadataConfigAlgorithmConfigAttributes struct {
	// contains filtered or unexported fields
}

func (DataMetadataConfigAlgorithmConfigAttributes) InternalRef

func (DataMetadataConfigAlgorithmConfigAttributes) InternalTokens

func (DataMetadataConfigAlgorithmConfigAttributes) InternalWithRef

func (DataMetadataConfigAlgorithmConfigAttributes) TreeAhConfig

type DataMetadataConfigAlgorithmConfigBruteForceConfigAttributes

type DataMetadataConfigAlgorithmConfigBruteForceConfigAttributes struct {
	// contains filtered or unexported fields
}

func (DataMetadataConfigAlgorithmConfigBruteForceConfigAttributes) InternalRef

func (DataMetadataConfigAlgorithmConfigBruteForceConfigAttributes) InternalTokens

func (DataMetadataConfigAlgorithmConfigBruteForceConfigAttributes) InternalWithRef

type DataMetadataConfigAlgorithmConfigBruteForceConfigState

type DataMetadataConfigAlgorithmConfigBruteForceConfigState struct{}

type DataMetadataConfigAlgorithmConfigState

type DataMetadataConfigAlgorithmConfigState struct {
	BruteForceConfig []DataMetadataConfigAlgorithmConfigBruteForceConfigState `json:"brute_force_config"`
	TreeAhConfig     []DataMetadataConfigAlgorithmConfigTreeAhConfigState     `json:"tree_ah_config"`
}

type DataMetadataConfigAlgorithmConfigTreeAhConfigAttributes

type DataMetadataConfigAlgorithmConfigTreeAhConfigAttributes struct {
	// contains filtered or unexported fields
}

func (DataMetadataConfigAlgorithmConfigTreeAhConfigAttributes) InternalRef

func (DataMetadataConfigAlgorithmConfigTreeAhConfigAttributes) InternalTokens

func (DataMetadataConfigAlgorithmConfigTreeAhConfigAttributes) InternalWithRef

func (DataMetadataConfigAlgorithmConfigTreeAhConfigAttributes) LeafNodeEmbeddingCount

func (DataMetadataConfigAlgorithmConfigTreeAhConfigAttributes) LeafNodesToSearchPercent

type DataMetadataConfigAlgorithmConfigTreeAhConfigState

type DataMetadataConfigAlgorithmConfigTreeAhConfigState struct {
	LeafNodeEmbeddingCount   float64 `json:"leaf_node_embedding_count"`
	LeafNodesToSearchPercent float64 `json:"leaf_nodes_to_search_percent"`
}

type DataMetadataConfigAttributes

type DataMetadataConfigAttributes struct {
	// contains filtered or unexported fields
}

func (DataMetadataConfigAttributes) AlgorithmConfig

func (DataMetadataConfigAttributes) ApproximateNeighborsCount

func (c DataMetadataConfigAttributes) ApproximateNeighborsCount() terra.NumberValue

func (DataMetadataConfigAttributes) Dimensions

func (DataMetadataConfigAttributes) DistanceMeasureType

func (c DataMetadataConfigAttributes) DistanceMeasureType() terra.StringValue

func (DataMetadataConfigAttributes) FeatureNormType

func (c DataMetadataConfigAttributes) FeatureNormType() terra.StringValue

func (DataMetadataConfigAttributes) InternalRef

func (DataMetadataConfigAttributes) InternalTokens

func (c DataMetadataConfigAttributes) InternalTokens() (hclwrite.Tokens, error)

func (DataMetadataConfigAttributes) InternalWithRef

func (DataMetadataConfigAttributes) ShardSize

type DataMetadataConfigState

type DataMetadataConfigState struct {
	ApproximateNeighborsCount float64                                  `json:"approximate_neighbors_count"`
	Dimensions                float64                                  `json:"dimensions"`
	DistanceMeasureType       string                                   `json:"distance_measure_type"`
	FeatureNormType           string                                   `json:"feature_norm_type"`
	ShardSize                 string                                   `json:"shard_size"`
	AlgorithmConfig           []DataMetadataConfigAlgorithmConfigState `json:"algorithm_config"`
}

type DataMetadataState

type DataMetadataState struct {
	ContentsDeltaUri    string                    `json:"contents_delta_uri"`
	IsCompleteOverwrite bool                      `json:"is_complete_overwrite"`
	Config              []DataMetadataConfigState `json:"config"`
}

type DataSource

type DataSource struct {
	Name string
	Args DataArgs
}

DataSource represents the Terraform data resource google_vertex_ai_index.

func Data

func Data(name string, args DataArgs) *DataSource

Data creates a new instance of DataSource.

func (*DataSource) Attributes

func (gvai *DataSource) Attributes() dataGoogleVertexAiIndexAttributes

Attributes returns the attributes for DataSource.

func (*DataSource) Configuration

func (gvai *DataSource) Configuration() interface{}

Configuration returns the configuration (args) for DataSource.

func (*DataSource) DataSource

func (gvai *DataSource) DataSource() string

DataSource returns the Terraform object type for DataSource.

func (*DataSource) LocalName

func (gvai *DataSource) LocalName() string

LocalName returns the local name for DataSource.

type DeployedIndexesAttributes

type DeployedIndexesAttributes struct {
	// contains filtered or unexported fields
}

func (DeployedIndexesAttributes) DeployedIndexId

func (di DeployedIndexesAttributes) DeployedIndexId() terra.StringValue

func (DeployedIndexesAttributes) IndexEndpoint

func (di DeployedIndexesAttributes) IndexEndpoint() terra.StringValue

func (DeployedIndexesAttributes) InternalRef

func (di DeployedIndexesAttributes) InternalRef() (terra.Reference, error)

func (DeployedIndexesAttributes) InternalTokens

func (di DeployedIndexesAttributes) InternalTokens() (hclwrite.Tokens, error)

func (DeployedIndexesAttributes) InternalWithRef

type DeployedIndexesState

type DeployedIndexesState struct {
	DeployedIndexId string `json:"deployed_index_id"`
	IndexEndpoint   string `json:"index_endpoint"`
}

type IndexStatsAttributes

type IndexStatsAttributes struct {
	// contains filtered or unexported fields
}

func (IndexStatsAttributes) InternalRef

func (is IndexStatsAttributes) InternalRef() (terra.Reference, error)

func (IndexStatsAttributes) InternalTokens

func (is IndexStatsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (IndexStatsAttributes) InternalWithRef

func (is IndexStatsAttributes) InternalWithRef(ref terra.Reference) IndexStatsAttributes

func (IndexStatsAttributes) ShardsCount

func (is IndexStatsAttributes) ShardsCount() terra.NumberValue

func (IndexStatsAttributes) VectorsCount

func (is IndexStatsAttributes) VectorsCount() terra.StringValue

type IndexStatsState

type IndexStatsState struct {
	ShardsCount  float64 `json:"shards_count"`
	VectorsCount string  `json:"vectors_count"`
}

type Metadata

type Metadata struct {
	// ContentsDeltaUri: string, required
	ContentsDeltaUri terra.StringValue `hcl:"contents_delta_uri,attr" validate:"required"`
	// IsCompleteOverwrite: bool, optional
	IsCompleteOverwrite terra.BoolValue `hcl:"is_complete_overwrite,attr"`
	// MetadataConfig: optional
	Config *MetadataConfig `hcl:"config,block"`
}

type MetadataAttributes

type MetadataAttributes struct {
	// contains filtered or unexported fields
}

func (MetadataAttributes) Config

func (MetadataAttributes) ContentsDeltaUri

func (m MetadataAttributes) ContentsDeltaUri() terra.StringValue

func (MetadataAttributes) InternalRef

func (m MetadataAttributes) InternalRef() (terra.Reference, error)

func (MetadataAttributes) InternalTokens

func (m MetadataAttributes) InternalTokens() (hclwrite.Tokens, error)

func (MetadataAttributes) InternalWithRef

func (m MetadataAttributes) InternalWithRef(ref terra.Reference) MetadataAttributes

func (MetadataAttributes) IsCompleteOverwrite

func (m MetadataAttributes) IsCompleteOverwrite() terra.BoolValue

type MetadataConfig

type MetadataConfig struct {
	// ApproximateNeighborsCount: number, optional
	ApproximateNeighborsCount terra.NumberValue `hcl:"approximate_neighbors_count,attr"`
	// Dimensions: number, required
	Dimensions terra.NumberValue `hcl:"dimensions,attr" validate:"required"`
	// DistanceMeasureType: string, optional
	DistanceMeasureType terra.StringValue `hcl:"distance_measure_type,attr"`
	// FeatureNormType: string, optional
	FeatureNormType terra.StringValue `hcl:"feature_norm_type,attr"`
	// ShardSize: string, optional
	ShardSize terra.StringValue `hcl:"shard_size,attr"`
	// MetadataConfigAlgorithmConfig: optional
	AlgorithmConfig *MetadataConfigAlgorithmConfig `hcl:"algorithm_config,block"`
}

type MetadataConfigAlgorithmConfig

type MetadataConfigAlgorithmConfig struct {
	// MetadataConfigAlgorithmConfigBruteForceConfig: optional
	BruteForceConfig *MetadataConfigAlgorithmConfigBruteForceConfig `hcl:"brute_force_config,block"`
	// MetadataConfigAlgorithmConfigTreeAhConfig: optional
	TreeAhConfig *MetadataConfigAlgorithmConfigTreeAhConfig `hcl:"tree_ah_config,block"`
}

type MetadataConfigAlgorithmConfigAttributes

type MetadataConfigAlgorithmConfigAttributes struct {
	// contains filtered or unexported fields
}

func (MetadataConfigAlgorithmConfigAttributes) BruteForceConfig

func (MetadataConfigAlgorithmConfigAttributes) InternalRef

func (MetadataConfigAlgorithmConfigAttributes) InternalTokens

func (MetadataConfigAlgorithmConfigAttributes) InternalWithRef

func (MetadataConfigAlgorithmConfigAttributes) TreeAhConfig

type MetadataConfigAlgorithmConfigBruteForceConfig

type MetadataConfigAlgorithmConfigBruteForceConfig struct{}

type MetadataConfigAlgorithmConfigBruteForceConfigAttributes

type MetadataConfigAlgorithmConfigBruteForceConfigAttributes struct {
	// contains filtered or unexported fields
}

func (MetadataConfigAlgorithmConfigBruteForceConfigAttributes) InternalRef

func (MetadataConfigAlgorithmConfigBruteForceConfigAttributes) InternalTokens

func (MetadataConfigAlgorithmConfigBruteForceConfigAttributes) InternalWithRef

type MetadataConfigAlgorithmConfigBruteForceConfigState

type MetadataConfigAlgorithmConfigBruteForceConfigState struct{}

type MetadataConfigAlgorithmConfigState

type MetadataConfigAlgorithmConfigState struct {
	BruteForceConfig []MetadataConfigAlgorithmConfigBruteForceConfigState `json:"brute_force_config"`
	TreeAhConfig     []MetadataConfigAlgorithmConfigTreeAhConfigState     `json:"tree_ah_config"`
}

type MetadataConfigAlgorithmConfigTreeAhConfig

type MetadataConfigAlgorithmConfigTreeAhConfig struct {
	// LeafNodeEmbeddingCount: number, optional
	LeafNodeEmbeddingCount terra.NumberValue `hcl:"leaf_node_embedding_count,attr"`
	// LeafNodesToSearchPercent: number, optional
	LeafNodesToSearchPercent terra.NumberValue `hcl:"leaf_nodes_to_search_percent,attr"`
}

type MetadataConfigAlgorithmConfigTreeAhConfigAttributes

type MetadataConfigAlgorithmConfigTreeAhConfigAttributes struct {
	// contains filtered or unexported fields
}

func (MetadataConfigAlgorithmConfigTreeAhConfigAttributes) InternalRef

func (MetadataConfigAlgorithmConfigTreeAhConfigAttributes) InternalTokens

func (MetadataConfigAlgorithmConfigTreeAhConfigAttributes) InternalWithRef

func (MetadataConfigAlgorithmConfigTreeAhConfigAttributes) LeafNodeEmbeddingCount

func (MetadataConfigAlgorithmConfigTreeAhConfigAttributes) LeafNodesToSearchPercent

type MetadataConfigAlgorithmConfigTreeAhConfigState

type MetadataConfigAlgorithmConfigTreeAhConfigState struct {
	LeafNodeEmbeddingCount   float64 `json:"leaf_node_embedding_count"`
	LeafNodesToSearchPercent float64 `json:"leaf_nodes_to_search_percent"`
}

type MetadataConfigAttributes

type MetadataConfigAttributes struct {
	// contains filtered or unexported fields
}

func (MetadataConfigAttributes) AlgorithmConfig

func (MetadataConfigAttributes) ApproximateNeighborsCount

func (c MetadataConfigAttributes) ApproximateNeighborsCount() terra.NumberValue

func (MetadataConfigAttributes) Dimensions

func (MetadataConfigAttributes) DistanceMeasureType

func (c MetadataConfigAttributes) DistanceMeasureType() terra.StringValue

func (MetadataConfigAttributes) FeatureNormType

func (c MetadataConfigAttributes) FeatureNormType() terra.StringValue

func (MetadataConfigAttributes) InternalRef

func (c MetadataConfigAttributes) InternalRef() (terra.Reference, error)

func (MetadataConfigAttributes) InternalTokens

func (c MetadataConfigAttributes) InternalTokens() (hclwrite.Tokens, error)

func (MetadataConfigAttributes) InternalWithRef

func (MetadataConfigAttributes) ShardSize

type MetadataConfigState

type MetadataConfigState struct {
	ApproximateNeighborsCount float64                              `json:"approximate_neighbors_count"`
	Dimensions                float64                              `json:"dimensions"`
	DistanceMeasureType       string                               `json:"distance_measure_type"`
	FeatureNormType           string                               `json:"feature_norm_type"`
	ShardSize                 string                               `json:"shard_size"`
	AlgorithmConfig           []MetadataConfigAlgorithmConfigState `json:"algorithm_config"`
}

type MetadataState

type MetadataState struct {
	ContentsDeltaUri    string                `json:"contents_delta_uri"`
	IsCompleteOverwrite bool                  `json:"is_complete_overwrite"`
	Config              []MetadataConfigState `json:"config"`
}

type Resource

type Resource struct {
	Name string
	Args Args

	DependsOn terra.Dependencies
	Lifecycle *terra.Lifecycle
	// contains filtered or unexported fields
}

Resource represents the Terraform resource google_vertex_ai_index.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (gvai *Resource) Attributes() googleVertexAiIndexAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

func (gvai *Resource) Configuration() interface{}

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

func (gvai *Resource) DependOn() terra.Reference

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

func (gvai *Resource) Dependencies() terra.Dependencies

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

func (gvai *Resource) ImportState(state io.Reader) error

ImportState imports the given attribute values into Resource's state.

func (*Resource) LifecycleManagement

func (gvai *Resource) LifecycleManagement() *terra.Lifecycle

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (gvai *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (gvai *Resource) State() (*googleVertexAiIndexState, bool)

State returns the state and a bool indicating if Resource has state.

func (*Resource) StateMust

func (gvai *Resource) StateMust() *googleVertexAiIndexState

StateMust returns the state for Resource. Panics if the state is nil.

func (*Resource) Type

func (gvai *Resource) Type() string

Type returns the Terraform object type for Resource.

type Timeouts

type Timeouts struct {
	// Create: string, optional
	Create terra.StringValue `hcl:"create,attr"`
	// Delete: string, optional
	Delete terra.StringValue `hcl:"delete,attr"`
	// Update: string, optional
	Update terra.StringValue `hcl:"update,attr"`
}

type TimeoutsAttributes

type TimeoutsAttributes struct {
	// contains filtered or unexported fields
}

func (TimeoutsAttributes) Create

func (TimeoutsAttributes) Delete

func (TimeoutsAttributes) InternalRef

func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)

func (TimeoutsAttributes) InternalTokens

func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (TimeoutsAttributes) InternalWithRef

func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes

func (TimeoutsAttributes) Update

type TimeoutsState

type TimeoutsState struct {
	Create string `json:"create"`
	Delete string `json:"delete"`
	Update string `json:"update"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL