google_firestore_document

Documentation

Index

• type Args
• type Resource
  • func New(name string, args Args) *Resource
  • func (gfd *Resource) Attributes() googleFirestoreDocumentAttributes
  • func (gfd *Resource) Configuration() interface{}
  • func (gfd *Resource) DependOn() terra.Reference
  • func (gfd *Resource) Dependencies() terra.Dependencies
  • func (gfd *Resource) ImportState(state io.Reader) error
  • func (gfd *Resource) LifecycleManagement() *terra.Lifecycle
  • func (gfd *Resource) LocalName() string
  • func (gfd *Resource) State() (*googleFirestoreDocumentState, bool)
  • func (gfd *Resource) StateMust() *googleFirestoreDocumentState
  • func (gfd *Resource) Type() string
• type Timeouts
• type TimeoutsAttributes
  • func (t TimeoutsAttributes) Create() terra.StringValue
  • func (t TimeoutsAttributes) Delete() terra.StringValue
  • func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)
  • func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)
  • func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes
  • func (t TimeoutsAttributes) Update() terra.StringValue
• type TimeoutsState

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"`
	// DocumentId: string, required
	DocumentId terra.StringValue `hcl:"document_id,attr" validate:"required"`
	// Fields: string, required
	Fields terra.StringValue `hcl:"fields,attr" validate:"required"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// Project: string, optional
	Project terra.StringValue `hcl:"project,attr"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for google_firestore_document.

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

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (gfd *Resource) Attributes() googleFirestoreDocumentAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

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

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

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

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

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

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

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

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

func (*Resource) LifecycleManagement

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

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (gfd *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (gfd *Resource) State() (*googleFirestoreDocumentState, bool)

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

func (*Resource) StateMust

func (gfd *Resource) StateMust() *googleFirestoreDocumentState

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

func (*Resource) Type

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