google_firestore_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 {
	// ApiScope: string, optional
	ApiScope terra.StringValue `hcl:"api_scope,attr"`
	// Collection: string, required
	Collection terra.StringValue `hcl:"collection,attr" validate:"required"`
	// Database: string, optional
	Database terra.StringValue `hcl:"database,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Project: string, optional
	Project terra.StringValue `hcl:"project,attr"`
	// QueryScope: string, optional
	QueryScope terra.StringValue `hcl:"query_scope,attr"`
	// Fields: min=2
	Fields []Fields `hcl:"fields,block" validate:"min=2"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for google_firestore_index.

type Fields 

type Fields struct {
	// ArrayConfig: string, optional
	ArrayConfig terra.StringValue `hcl:"array_config,attr"`
	// FieldPath: string, optional
	FieldPath terra.StringValue `hcl:"field_path,attr"`
	// Order: string, optional
	Order terra.StringValue `hcl:"order,attr"`
	// FieldsVectorConfig: optional
	VectorConfig *FieldsVectorConfig `hcl:"vector_config,block"`
}

type FieldsAttributes 

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

func (FieldsAttributes) ArrayConfig 

func (f FieldsAttributes) ArrayConfig() terra.StringValue

func (FieldsAttributes) FieldPath 

func (f FieldsAttributes) FieldPath() terra.StringValue

func (FieldsAttributes) InternalRef 

func (f FieldsAttributes) InternalRef() (terra.Reference, error)

func (FieldsAttributes) InternalTokens 

func (f FieldsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (FieldsAttributes) InternalWithRef 

func (f FieldsAttributes) InternalWithRef(ref terra.Reference) FieldsAttributes

func (FieldsAttributes) Order 

func (f FieldsAttributes) Order() terra.StringValue

func (FieldsAttributes) VectorConfig 

func (f FieldsAttributes) VectorConfig() terra.ListValue[FieldsVectorConfigAttributes]

type FieldsState 

type FieldsState struct {
	ArrayConfig  string                    `json:"array_config"`
	FieldPath    string                    `json:"field_path"`
	Order        string                    `json:"order"`
	VectorConfig []FieldsVectorConfigState `json:"vector_config"`
}

type FieldsVectorConfig 

type FieldsVectorConfig struct {
	// Dimension: number, optional
	Dimension terra.NumberValue `hcl:"dimension,attr"`
	// FieldsVectorConfigFlat: optional
	Flat *FieldsVectorConfigFlat `hcl:"flat,block"`
}

type FieldsVectorConfigAttributes 

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

func (FieldsVectorConfigAttributes) Dimension 

func (vc FieldsVectorConfigAttributes) Dimension() terra.NumberValue

func (FieldsVectorConfigAttributes) Flat 

func (vc FieldsVectorConfigAttributes) Flat() terra.ListValue[FieldsVectorConfigFlatAttributes]

func (FieldsVectorConfigAttributes) InternalRef 

func (vc FieldsVectorConfigAttributes) InternalRef() (terra.Reference, error)

func (FieldsVectorConfigAttributes) InternalTokens 

func (vc FieldsVectorConfigAttributes) InternalTokens() (hclwrite.Tokens, error)

func (FieldsVectorConfigAttributes) InternalWithRef 

func (vc FieldsVectorConfigAttributes) InternalWithRef(ref terra.Reference) FieldsVectorConfigAttributes

type FieldsVectorConfigFlat 

type FieldsVectorConfigFlat struct{}

type FieldsVectorConfigFlatAttributes 

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

func (FieldsVectorConfigFlatAttributes) InternalRef 

func (f FieldsVectorConfigFlatAttributes) InternalRef() (terra.Reference, error)

func (FieldsVectorConfigFlatAttributes) InternalTokens 

func (f FieldsVectorConfigFlatAttributes) InternalTokens() (hclwrite.Tokens, error)

func (FieldsVectorConfigFlatAttributes) InternalWithRef 

func (f FieldsVectorConfigFlatAttributes) InternalWithRef(ref terra.Reference) FieldsVectorConfigFlatAttributes

type FieldsVectorConfigFlatState 

type FieldsVectorConfigFlatState struct{}

type FieldsVectorConfigState 

type FieldsVectorConfigState struct {
	Dimension float64                       `json:"dimension"`
	Flat      []FieldsVectorConfigFlatState `json:"flat"`
}

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

func New 

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes 

func (gfi *Resource) Attributes() googleFirestoreIndexAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration 

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn 

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies 

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState 

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

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

func (*Resource) LifecycleManagement 

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName 

func (gfi *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State 

func (gfi *Resource) State() (*googleFirestoreIndexState, bool)

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

func (*Resource) StateMust 

func (gfi *Resource) StateMust() *googleFirestoreIndexState

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

func (*Resource) Type 

func (gfi *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"`
}

type TimeoutsAttributes 

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

func (TimeoutsAttributes) Create 

func (t TimeoutsAttributes) Create() terra.StringValue

func (TimeoutsAttributes) Delete 

func (t TimeoutsAttributes) Delete() terra.StringValue

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

type TimeoutsState 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.