client

Documentation

Index

• Constants
• Variables
• func GetCachedGcpClient(ctx context.Context, saJsonKeyPath string) (*http.Client, error)
• func GetCachedProjectNumber(projectId string, crmService *cloudresourcemanager.Service) (int64, error)
• func GetCompleteServiceName(projectId string, serviceName GcpServiceName) string
• func GetConfigDuration(env abstractions.Environment, key string, defaultValue time.Duration) time.Duration
• func GetFilestoreInstancePath(projectId, location, instanceId string) string
• func GetFilestoreParentPath(projectId, location string) string
• func GetNetworkFilter(projectId, vpcId string) string
• func GetVPCPath(projectId, vpcId string) string
• type ClientProvider
  • func NewCachedClientProvider[T comparable](p ClientProvider[T]) ClientProvider[T]
  • func NewServiceUsageClientProvider() ClientProvider[ServiceUsageClient]
• type FilestoreState
• type GcpConfig
  • func GetGcpConfig(env abstractions.Environment) *GcpConfig
• type GcpServiceName
• type OperationType
• type ServiceUsageClient
  • func NewServiceUsageClient(svcServiceUsage *serviceusage.Service) ServiceUsageClient

Constants

const (
	NetworkTierPremium  networkTier = "PREMIUM"
	NetworkTierStandard networkTier = "STANDARD"
)

const (
	IpVersionIpV4 ipVersion = "IPV4"
	IpVersionIpV6 ipVersion = "IPV6"
)

const (
	AddressTypeExternal addressType = "EXTERNAL"
	AddressTypeInternal addressType = "INTERNAL"
)

const (
	IpRangePurposeVPCPeering            ipRangePurpose = "VPC_PEERING"
	IpRangePurposePrivateServiceConnect ipRangePurpose = "PRIVATE_SERVICE_CONNECT"
)

const (
	Ipv6EndpointTypeVm    ipv6EndpointType = "VM"
	Ipv6EndpointTypeNetlb ipv6EndpointType = "NETLB"
)

const (
	//Common States
	Deleted v1beta1.StatusState = "Deleted"

	//IPRange States
	SyncAddress         v1beta1.StatusState = "SyncAddress"
	SyncPsaConnection   v1beta1.StatusState = "SyncPSAConnection"
	DeletePsaConnection v1beta1.StatusState = "DeletePSAConnection"
	DeleteAddress       v1beta1.StatusState = "DeleteAddress"

	//Filestore States
	SyncFilestore   v1beta1.StatusState = "SyncFilestore"
	DeleteFilestore v1beta1.StatusState = "DeleteFilestore"
)

const GcpOperationWaitTime = time.Second * 5

const GcpRetryWaitTime = time.Second * 3

const PsaPeeringName = "servicenetworking-googleapis-com"

const ServiceNetworkingServiceConnectionName = "services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com"

const ServiceNetworkingServicePath = "services/servicenetworking.googleapis.com"

Variables

var FilestoreInstanceRegEx *regexp.Regexp = regexp.MustCompile(`^projects\/([^/]+)\/locations\/([^/]+)\/instances\/([^/]+)$`)

Functions

func GetCachedGcpClient

func GetCachedGcpClient(ctx context.Context, saJsonKeyPath string) (*http.Client, error)

func GetCachedProjectNumber

func GetCachedProjectNumber(projectId string, crmService *cloudresourcemanager.Service) (int64, error)

GetCachedProjectNumber get project number from cloud resources manager for a given project id

func GetCompleteServiceName

func GetCompleteServiceName(projectId string, serviceName GcpServiceName) string

func GetConfigDuration

func GetConfigDuration(env abstractions.Environment, key string, defaultValue time.Duration) time.Duration

func GetFilestoreInstancePath

func GetFilestoreInstancePath(projectId, location, instanceId string) string

func GetFilestoreParentPath

func GetFilestoreParentPath(projectId, location string) string

func GetNetworkFilter

func GetNetworkFilter(projectId, vpcId string) string

func GetVPCPath

func GetVPCPath(projectId, vpcId string) string

Types

type ClientProvider

type ClientProvider[T any] func(ctx context.Context, saJsonKeyPath string) (T, error)

func NewCachedClientProvider

func NewCachedClientProvider[T comparable](p ClientProvider[T]) ClientProvider[T]

func NewServiceUsageClientProvider

func NewServiceUsageClientProvider() ClientProvider[ServiceUsageClient]

type FilestoreState

type FilestoreState string

const (
	CREATING   FilestoreState = "CREATING"
	READY      FilestoreState = "READY"
	REPAIRING  FilestoreState = "REPAIRING"
	DELETING   FilestoreState = "DELETING"
	ERROR      FilestoreState = "ERROR"
	RESTORING  FilestoreState = "RESTORING"
	SUSPENDED  FilestoreState = "SUSPENDED"
	SUSPENDING FilestoreState = "SUSPENDING"
	RESUMING   FilestoreState = "RESUMING"
	REVERTING  FilestoreState = "REVERTING"
)

type GcpConfig

type GcpConfig struct {
	GcpRetryWaitTime     time.Duration
	GcpOperationWaitTime time.Duration
}

func GetGcpConfig

func GetGcpConfig(env abstractions.Environment) *GcpConfig

type GcpServiceName

type GcpServiceName string

const (
	ServiceNetworkingService    GcpServiceName = "servicenetworking.googleapis.com"
	ComputeService              GcpServiceName = "compute.googleapis.com"
	FilestoreService            GcpServiceName = "file.googleapis.com"
	CloudResourceManagerService GcpServiceName = "cloudresourcemanager.googleapis.com"
)

type OperationType

type OperationType int

const (
	NONE OperationType = iota
	ADD
	MODIFY
	DELETE
)

type ServiceUsageClient

type ServiceUsageClient interface {
	EnableService(ctx context.Context, projectId string, serviceName GcpServiceName) (*serviceusage.Operation, error)
	DisableService(ctx context.Context, projectId string, serviceName GcpServiceName) (*serviceusage.Operation, error)
	IsServiceEnabled(ctx context.Context, projectId string, serviceName GcpServiceName) (bool, error)
	GetServiceUsageOperation(ctx context.Context, operationName string) (*serviceusage.Operation, error)
}

func NewServiceUsageClient

func NewServiceUsageClient(svcServiceUsage *serviceusage.Service) ServiceUsageClient