entity

Documentation

Index

• Variables
• type Context
• type Entity
  • func (me *Entity) MarshalHCL(properties hcl.Properties) error
  • func (me *Entity) Schema() map[string]*schema.Schema
  • func (me *Entity) UnmarshalHCL(decoder hcl.Decoder) error
• type Tag
  • func (me *Tag) MarshalHCL(properties hcl.Properties) error
  • func (me *Tag) Schema() map[string]*schema.Schema
  • func (me *Tag) UnmarshalHCL(decoder hcl.Decoder) error
• type Tags
  • func (me Tags) MarshalHCL(properties hcl.Properties) error
  • func (me Tags) Schema() map[string]*schema.Schema
  • func (me *Tags) UnmarshalHCL(decoder hcl.Decoder) error

Variables

var Contexts = struct {
	AWS          Context
	AWSGeneric   Context
	Azure        Context
	CloudFoundry Context
	Contextless  Context
	Environment  Context
	GoogleCloud  Context
	Kubernetes   Context
}{
	"AWS",
	"AWS_GENERIC",
	"AZURE",
	"CLOUD_FOUNDRY",
	"CONTEXTLESS",
	"ENVIRONMENT",
	"GOOGLE_CLOUD",
	"KUBERNETES",
}

Contexts offers the known enum values

Types

type Context

type Context string

Context The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value.

type Entity

type Entity struct {
	EntityId    *string        `json:"entityId,omitempty"`    // The ID of the entity.
	Type        *string        `json:"type,omitempty"`        // The type of the entity.
	DisplayName *string        `json:"displayName,omitempty"` // The name of the entity, displayed in the UI.
	Tags        Tags           `json:"tags,omitempty"`        // A set of tags assigned to the entity.
	Properties  map[string]any `json:"properties"`
}

func (*Entity) MarshalHCL

func (me *Entity) MarshalHCL(properties hcl.Properties) error

func (*Entity) Schema

func (me *Entity) Schema() map[string]*schema.Schema

func (*Entity) UnmarshalHCL

func (me *Entity) UnmarshalHCL(decoder hcl.Decoder) error

type Tag

type Tag struct {
	Context              Context `json:"context"`                        // The origin of the tag, such as AWS or Cloud Foundry.  Custom tags use the `CONTEXTLESS` value.
	Key                  string  `json:"key"`                            // The key of the tag. Custom tags have the tag value here.
	Value                *string `json:"value,omitempty"`                // The value of the tag. Not applicable to custom tags.
	StringRepresentation *string `json:"stringRepresentation,omitempty"` // The string representation of the tag.
}

Tag A tag-based filter of monitored entities.

func (*Tag) MarshalHCL

func (me *Tag) MarshalHCL(properties hcl.Properties) error

func (*Tag) Schema

func (me *Tag) Schema() map[string]*schema.Schema

func (*Tag) UnmarshalHCL

func (me *Tag) UnmarshalHCL(decoder hcl.Decoder) error

type Tags

type Tags []*Tag // A set of tags assigned to the entity.

func (Tags) MarshalHCL

func (me Tags) MarshalHCL(properties hcl.Properties) error

func (Tags) Schema

func (me Tags) Schema() map[string]*schema.Schema

func (*Tags) UnmarshalHCL

func (me *Tags) UnmarshalHCL(decoder hcl.Decoder) error