google

Documentation

Overview

----------------------------------------------------------------------------

***     AUTO GENERATED CODE    ***    Type: MMv1     ***

----------------------------------------------------------------------------

This file is automatically generated by Magic Modules and manual
changes will be clobbered when the file is regenerated.

Please read more about how to change this file in
.github/CONTRIBUTING.md.

----------------------------------------------------------------------------

Index

• Variables
• func AssetName(d tpgresource.TerraformResourceData, config *transport_tpg.Config, ...) (string, error)
• func NewConfig(ctx context.Context, project, zone, region string, offline bool, ...) (*transport_tpg.Config, error)
• func RandString(n int) string
• func ResourceConverters() map[string][]cai.ResourceConverter
• type Asset
• type AssetResource
• type BooleanPolicy
• type ConvertFunc
• type Expr
• type FetchFullResourceFunc
• type Folder
• type GetApiObjectFunc
• type IAMBinding
• type IAMPolicy
• type ListPolicy
• type ListPolicyAllValues
• type MergeFunc
• type OrgPolicy
• type PolicyRule
• type PolicySpec
• type ResourceConverter
• type RestoreDefault
• type StringValues
• type Timestamp
• type V2OrgPolicies

Variables

var ErrEmptyIdentityField = cai.ErrEmptyIdentityField

ErrEmptyIdentityField can be returned when fetching a resource is not possible due to the identity field of that resource returning empty.

var ErrNoConversion = cai.ErrNoConversion

because of the current state of the system. Example: The conversion requires that the resource has already been created and is now being updated).

var ErrResourceInaccessible = cai.ErrResourceInaccessible

ErrResourceInaccessible can be returned when fetching an IAM resource on a project that has not yet been created or if the service account lacks sufficient permissions

Functions

func AssetName

func AssetName(d tpgresource.TerraformResourceData, config *transport_tpg.Config, linkTmpl string) (string, error)

AssetName templates an asset.name by looking up and replacing all instances of {{field}}. In the case where a field would resolve to an empty string, a generated unique string will be used: "placeholder-" + randomString(). This is done to preserve uniqueness of asset.name for a given asset.asset_type.

func NewConfig

func NewConfig(ctx context.Context, project, zone, region string, offline bool, userAgent string, client *http.Client) (*transport_tpg.Config, error)

func RandString

func RandString(n int) string

func ResourceConverters

func ResourceConverters() map[string][]cai.ResourceConverter

ResourceConverter returns a map of terraform resource types (i.e. `google_project`) to a slice of ResourceConverters.

Modelling of relationships: terraform resources to CAI assets as []cai.ResourceConverter: 1:1 = [ResourceConverter{Convert: convertAbc}] (len=1) 1:N = [ResourceConverter{Convert: convertAbc}, ...] (len=N) N:1 = [ResourceConverter{Convert: convertAbc, merge: mergeAbc}] (len=1)

Types

type Asset

type Asset = cai.Asset

Asset is the CAI representation of a resource.

type AssetResource

type AssetResource = cai.AssetResource

AssetResource is the Asset's Resource field.

type BooleanPolicy

type BooleanPolicy = cai.BooleanPolicy

type ConvertFunc

type ConvertFunc = cai.ConvertFunc

type Expr

type Expr = cai.Expr

type FetchFullResourceFunc

type FetchFullResourceFunc = cai.FetchFullResourceFunc

type Folder

type Folder = cai.Folder

type GetApiObjectFunc

type GetApiObjectFunc = cai.GetApiObjectFunc

type IAMBinding

type IAMBinding = cai.IAMBinding

type IAMPolicy

type IAMPolicy = cai.IAMPolicy

type ListPolicy

type ListPolicy = cai.ListPolicy

type ListPolicyAllValues

type ListPolicyAllValues = cai.ListPolicyAllValues

type MergeFunc

type MergeFunc = cai.MergeFunc

type OrgPolicy

type OrgPolicy = cai.OrgPolicy

type PolicyRule

type PolicyRule = cai.PolicyRule

type PolicySpec

type PolicySpec = cai.PolicySpec

Spec is the representation of Spec for V2OrgPolicy

type ResourceConverter

type ResourceConverter = cai.ResourceConverter

type RestoreDefault

type RestoreDefault = cai.RestoreDefault

type StringValues

type StringValues = cai.StringValues

type Timestamp

type Timestamp = cai.Timestamp

type V2OrgPolicies

type V2OrgPolicies = cai.V2OrgPolicies

V2OrgPolicies is the represtation of V2OrgPolicies