google_firestore_field

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 {
	// Collection: string, required
	Collection terra.StringValue `hcl:"collection,attr" validate:"required"`
	// Database: string, optional
	Database terra.StringValue `hcl:"database,attr"`
	// Field: string, required
	Field terra.StringValue `hcl:"field,attr" validate:"required"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Project: string, optional
	Project terra.StringValue `hcl:"project,attr"`
	// IndexConfig: optional
	IndexConfig *IndexConfig `hcl:"index_config,block"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
	// TtlConfig: optional
	TtlConfig *TtlConfig `hcl:"ttl_config,block"`
}

Args contains the configurations for google_firestore_field.

type IndexConfig 

type IndexConfig struct {
	// IndexConfigIndexes: min=0
	Indexes []IndexConfigIndexes `hcl:"indexes,block" validate:"min=0"`
}

type IndexConfigAttributes 

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

func (IndexConfigAttributes) Indexes 

func (ic IndexConfigAttributes) Indexes() terra.SetValue[IndexConfigIndexesAttributes]

func (IndexConfigAttributes) InternalRef 

func (ic IndexConfigAttributes) InternalRef() (terra.Reference, error)

func (IndexConfigAttributes) InternalTokens 

func (ic IndexConfigAttributes) InternalTokens() (hclwrite.Tokens, error)

func (IndexConfigAttributes) InternalWithRef 

func (ic IndexConfigAttributes) InternalWithRef(ref terra.Reference) IndexConfigAttributes

type IndexConfigIndexes 

type IndexConfigIndexes struct {
	// ArrayConfig: string, optional
	ArrayConfig terra.StringValue `hcl:"array_config,attr"`
	// Order: string, optional
	Order terra.StringValue `hcl:"order,attr"`
	// QueryScope: string, optional
	QueryScope terra.StringValue `hcl:"query_scope,attr"`
}

type IndexConfigIndexesAttributes 

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

func (IndexConfigIndexesAttributes) ArrayConfig 

func (i IndexConfigIndexesAttributes) ArrayConfig() terra.StringValue

func (IndexConfigIndexesAttributes) InternalRef 

func (i IndexConfigIndexesAttributes) InternalRef() (terra.Reference, error)

func (IndexConfigIndexesAttributes) InternalTokens 

func (i IndexConfigIndexesAttributes) InternalTokens() (hclwrite.Tokens, error)

func (IndexConfigIndexesAttributes) InternalWithRef 

func (i IndexConfigIndexesAttributes) InternalWithRef(ref terra.Reference) IndexConfigIndexesAttributes

func (IndexConfigIndexesAttributes) Order 

func (i IndexConfigIndexesAttributes) Order() terra.StringValue

func (IndexConfigIndexesAttributes) QueryScope 

func (i IndexConfigIndexesAttributes) QueryScope() terra.StringValue

type IndexConfigIndexesState 

type IndexConfigIndexesState struct {
	ArrayConfig string `json:"array_config"`
	Order       string `json:"order"`
	QueryScope  string `json:"query_scope"`
}

type IndexConfigState 

type IndexConfigState struct {
	Indexes []IndexConfigIndexesState `json:"indexes"`
}

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

func New 

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes 

func (gff *Resource) Attributes() googleFirestoreFieldAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration 

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn 

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies 

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState 

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

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

func (*Resource) LifecycleManagement 

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName 

func (gff *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State 

func (gff *Resource) State() (*googleFirestoreFieldState, bool)

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

func (*Resource) StateMust 

func (gff *Resource) StateMust() *googleFirestoreFieldState

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

func (*Resource) Type 

func (gff *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 (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

func (TimeoutsAttributes) Update 

func (t TimeoutsAttributes) Update() terra.StringValue

type TimeoutsState 

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

type TtlConfig 

type TtlConfig struct{}

type TtlConfigAttributes 

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

func (TtlConfigAttributes) InternalRef 

func (tc TtlConfigAttributes) InternalRef() (terra.Reference, error)

func (TtlConfigAttributes) InternalTokens 

func (tc TtlConfigAttributes) InternalTokens() (hclwrite.Tokens, error)

func (TtlConfigAttributes) InternalWithRef 

func (tc TtlConfigAttributes) InternalWithRef(ref terra.Reference) TtlConfigAttributes

func (TtlConfigAttributes) State 

func (tc TtlConfigAttributes) State() terra.StringValue

type TtlConfigState 

type TtlConfigState struct {
	State string `json:"state"`
}

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.