functions

Documentation

Overview

Copyright (c) HashiCorp, Inc. SPDX-License-Identifier: MPL-2.0

Copyright (c) HashiCorp, Inc. SPDX-License-Identifier: MPL-2.0

Copyright (c) HashiCorp, Inc. SPDX-License-Identifier: MPL-2.0

Copyright (c) HashiCorp, Inc. SPDX-License-Identifier: MPL-2.0

Copyright (c) HashiCorp, Inc. SPDX-License-Identifier: MPL-2.0

Copyright (c) HashiCorp, Inc. SPDX-License-Identifier: MPL-2.0

Copyright (c) HashiCorp, Inc. SPDX-License-Identifier: MPL-2.0

Index

• func GetElementFromId(input string, regex *regexp.Regexp, template string) string
• func NewLocationFromIdFunction() function.Function
• func NewNameFromIdFunction() function.Function
• func NewProjectFromIdFunction() function.Function
• func NewRegionFromIdFunction() function.Function
• func NewRegionFromZoneFunction() function.Function
• func NewZoneFromIdFunction() function.Function
• func ValidateElementFromIdArguments(ctx context.Context, input string, regex *regexp.Regexp, pattern string, ...) *function.FuncError
• type LocationFromIdFunction
  • func (f LocationFromIdFunction) Definition(ctx context.Context, req function.DefinitionRequest, ...)
  • func (f LocationFromIdFunction) Metadata(ctx context.Context, req function.MetadataRequest, ...)
  • func (f LocationFromIdFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)
• type NameFromIdFunction
  • func (f NameFromIdFunction) Definition(ctx context.Context, req function.DefinitionRequest, ...)
  • func (f NameFromIdFunction) Metadata(ctx context.Context, req function.MetadataRequest, ...)
  • func (f NameFromIdFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)
• type ProjectFromIdFunction
  • func (f ProjectFromIdFunction) Definition(ctx context.Context, req function.DefinitionRequest, ...)
  • func (f ProjectFromIdFunction) Metadata(ctx context.Context, req function.MetadataRequest, ...)
  • func (f ProjectFromIdFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)
• type RegionFromIdFunction
  • func (f RegionFromIdFunction) Definition(ctx context.Context, req function.DefinitionRequest, ...)
  • func (f RegionFromIdFunction) Metadata(ctx context.Context, req function.MetadataRequest, ...)
  • func (f RegionFromIdFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)
• type RegionFromZoneFunction
  • func (f RegionFromZoneFunction) Definition(ctx context.Context, req function.DefinitionRequest, ...)
  • func (f RegionFromZoneFunction) Metadata(ctx context.Context, req function.MetadataRequest, ...)
  • func (f RegionFromZoneFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)
• type ZoneFromIdFunction
  • func (f ZoneFromIdFunction) Definition(ctx context.Context, req function.DefinitionRequest, ...)
  • func (f ZoneFromIdFunction) Metadata(ctx context.Context, req function.MetadataRequest, ...)
  • func (f ZoneFromIdFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)

Functions

func GetElementFromId

func GetElementFromId(input string, regex *regexp.Regexp, template string) string

GetElementFromId is reusable logic that is used in multiple provider-defined functions for pulling elements out of self links and ids of resources and data sources

func NewLocationFromIdFunction

func NewLocationFromIdFunction() function.Function

func NewNameFromIdFunction

func NewNameFromIdFunction() function.Function

func NewProjectFromIdFunction

func NewProjectFromIdFunction() function.Function

func NewRegionFromIdFunction

func NewRegionFromIdFunction() function.Function

func NewRegionFromZoneFunction

func NewRegionFromZoneFunction() function.Function

func NewZoneFromIdFunction

func NewZoneFromIdFunction() function.Function

func ValidateElementFromIdArguments

func ValidateElementFromIdArguments(ctx context.Context, input string, regex *regexp.Regexp, pattern string, functionName string) *function.FuncError

ValidateElementFromIdArguments is reusable validation logic used in provider-defined functions that use the GetElementFromId function

Types

type LocationFromIdFunction

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

func (LocationFromIdFunction) Definition

func (f LocationFromIdFunction) Definition(ctx context.Context, req function.DefinitionRequest, resp *function.DefinitionResponse)

func (LocationFromIdFunction) Metadata

func (f LocationFromIdFunction) Metadata(ctx context.Context, req function.MetadataRequest, resp *function.MetadataResponse)

func (LocationFromIdFunction) Run

func (f LocationFromIdFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)

type NameFromIdFunction

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

func (NameFromIdFunction) Definition

func (f NameFromIdFunction) Definition(ctx context.Context, req function.DefinitionRequest, resp *function.DefinitionResponse)

func (NameFromIdFunction) Metadata

func (f NameFromIdFunction) Metadata(ctx context.Context, req function.MetadataRequest, resp *function.MetadataResponse)

func (NameFromIdFunction) Run

func (f NameFromIdFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)

type ProjectFromIdFunction

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

func (ProjectFromIdFunction) Definition

func (f ProjectFromIdFunction) Definition(ctx context.Context, req function.DefinitionRequest, resp *function.DefinitionResponse)

func (ProjectFromIdFunction) Metadata

func (f ProjectFromIdFunction) Metadata(ctx context.Context, req function.MetadataRequest, resp *function.MetadataResponse)

func (ProjectFromIdFunction) Run

func (f ProjectFromIdFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)

type RegionFromIdFunction

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

func (RegionFromIdFunction) Definition

func (f RegionFromIdFunction) Definition(ctx context.Context, req function.DefinitionRequest, resp *function.DefinitionResponse)

func (RegionFromIdFunction) Metadata

func (f RegionFromIdFunction) Metadata(ctx context.Context, req function.MetadataRequest, resp *function.MetadataResponse)

func (RegionFromIdFunction) Run

func (f RegionFromIdFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)

type RegionFromZoneFunction

type RegionFromZoneFunction struct{}

func (RegionFromZoneFunction) Definition

func (f RegionFromZoneFunction) Definition(ctx context.Context, req function.DefinitionRequest, resp *function.DefinitionResponse)

func (RegionFromZoneFunction) Metadata

func (f RegionFromZoneFunction) Metadata(ctx context.Context, req function.MetadataRequest, resp *function.MetadataResponse)

func (RegionFromZoneFunction) Run

func (f RegionFromZoneFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)

type ZoneFromIdFunction

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

func (ZoneFromIdFunction) Definition

func (f ZoneFromIdFunction) Definition(ctx context.Context, req function.DefinitionRequest, resp *function.DefinitionResponse)

func (ZoneFromIdFunction) Metadata

func (f ZoneFromIdFunction) Metadata(ctx context.Context, req function.MetadataRequest, resp *function.MetadataResponse)

func (ZoneFromIdFunction) Run

func (f ZoneFromIdFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse)