clientconfig

Documentation

Index

• func CopyAndModifyForKind(dclConfig *dcl.Config, kind string) *dcl.Config
• func New(ctx context.Context, opt Options) (*dcl.Config, error)
• func NewForIntegrationTest() *dcl.Config
• func SetUserAgentWithBlueprintAttribution(dclConfig *dcl.Config, resource metav1.Object) *dcl.Config
• type Options

Functions

func CopyAndModifyForKind

func CopyAndModifyForKind(dclConfig *dcl.Config, kind string) *dcl.Config

func New

func New(ctx context.Context, opt Options) (*dcl.Config, error)

func NewForIntegrationTest

func NewForIntegrationTest() *dcl.Config

NewForIntegrationTest creates a dcl.Config for use in integration tests. Deprecated: Prefer using a harness.

func SetUserAgentWithBlueprintAttribution

func SetUserAgentWithBlueprintAttribution(dclConfig *dcl.Config, resource metav1.Object) *dcl.Config

SetUserAgentWithBlueprintAttribution returns a new DCL Config with the user agent containing the blueprint attribution if the resource has the blueprint attribution annotation. Otherwise, the existing DCL Config is unmodified and returned.

Types

type Options

type Options struct {
	UserAgent string

	// UserProjectOverride provides the option to use the resource project for preconditions, quota, and billing,
	// instead of the project the credentials belong to; false by default
	UserProjectOverride bool

	// BillingProject is the project used by the TF provider and DCL client to determine preconditions,
	// quota, and billing if UserProjectOverride is set to true. If this field is empty,
	// but UserProjectOverride is set to true, resource project will be used.
	BillingProject string

	// HTTPClient allows us to specify the HTTP client to use with DCL.
	// This is particularly useful in mocks/tests.
	HTTPClient *http.Client
}