v1

package
v1.28.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 12, 2024 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

Package v1 is the v1 version of the API. +groupName=cloud.google.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: backendconfig.GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func GetOpenAPIDefinitions 

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type BackendConfig 

type BackendConfig struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BackendConfigSpec   `json:"spec,omitempty"`
	Status BackendConfigStatus `json:"status,omitempty"`
}

+k8s:openapi-gen=true

func (*BackendConfig) DeepCopy 

func (in *BackendConfig) DeepCopy() *BackendConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackendConfig.

func (*BackendConfig) DeepCopyInto 

func (in *BackendConfig) DeepCopyInto(out *BackendConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BackendConfig) DeepCopyObject 

func (in *BackendConfig) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BackendConfigList 

type BackendConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []BackendConfig `json:"items"`
}

BackendConfigList is a list of BackendConfig resources

func (*BackendConfigList) DeepCopy 

func (in *BackendConfigList) DeepCopy() *BackendConfigList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackendConfigList.

func (*BackendConfigList) DeepCopyInto 

func (in *BackendConfigList) DeepCopyInto(out *BackendConfigList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BackendConfigList) DeepCopyObject 

func (in *BackendConfigList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BackendConfigSpec 

type BackendConfigSpec struct {
	Iap                   *IAPConfig                   `json:"iap,omitempty"`
	Cdn                   *CDNConfig                   `json:"cdn,omitempty"`
	SecurityPolicy        *SecurityPolicyConfig        `json:"securityPolicy,omitempty"`
	TimeoutSec            *int64                       `json:"timeoutSec,omitempty"`
	ConnectionDraining    *ConnectionDrainingConfig    `json:"connectionDraining,omitempty"`
	SessionAffinity       *SessionAffinityConfig       `json:"sessionAffinity,omitempty"`
	CustomRequestHeaders  *CustomRequestHeadersConfig  `json:"customRequestHeaders,omitempty"`
	CustomResponseHeaders *CustomResponseHeadersConfig `json:"customResponseHeaders,omitempty"`
	HealthCheck           *HealthCheckConfig           `json:"healthCheck,omitempty"`
	// Logging specifies the configuration for access logs.
	Logging *LogConfig `json:"logging,omitempty"`
}

BackendConfigSpec is the spec for a BackendConfig resource +k8s:openapi-gen=true

func (*BackendConfigSpec) DeepCopy 

func (in *BackendConfigSpec) DeepCopy() *BackendConfigSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackendConfigSpec.

func (*BackendConfigSpec) DeepCopyInto 

func (in *BackendConfigSpec) DeepCopyInto(out *BackendConfigSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackendConfigStatus 

type BackendConfigStatus struct {
}

BackendConfigStatus is the status for a BackendConfig resource

func (*BackendConfigStatus) DeepCopy 

func (in *BackendConfigStatus) DeepCopy() *BackendConfigStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackendConfigStatus.

func (*BackendConfigStatus) DeepCopyInto 

func (in *BackendConfigStatus) DeepCopyInto(out *BackendConfigStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BypassCacheOnRequestHeader added in v1.15.0 

type BypassCacheOnRequestHeader struct {
	// The header field name to match on when bypassing cache. Values are
	// case-insensitive.
	HeaderName string `json:"headerName,omitempty"`
}

BypassCacheOnRequestHeader contains configuration for how requests containing specific request headers bypass the cache, even if the content was previously cached. +k8s:openapi-gen=true

func (*BypassCacheOnRequestHeader) DeepCopy added in v1.15.0 

func (in *BypassCacheOnRequestHeader) DeepCopy() *BypassCacheOnRequestHeader

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BypassCacheOnRequestHeader.

func (*BypassCacheOnRequestHeader) DeepCopyInto added in v1.15.0 

func (in *BypassCacheOnRequestHeader) DeepCopyInto(out *BypassCacheOnRequestHeader)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CDNConfig 

type CDNConfig struct {
	Enabled                     bool                          `json:"enabled"`
	BypassCacheOnRequestHeaders []*BypassCacheOnRequestHeader `json:"bypassCacheOnRequestHeaders,omitempty"`
	CachePolicy                 *CacheKeyPolicy               `json:"cachePolicy,omitempty"`
	CacheMode                   *string                       `json:"cacheMode,omitempty"`
	ClientTtl                   *int64                        `json:"clientTtl,omitempty"`
	DefaultTtl                  *int64                        `json:"defaultTtl,omitempty"`
	MaxTtl                      *int64                        `json:"maxTtl,omitempty"`
	NegativeCaching             *bool                         `json:"negativeCaching,omitempty"`
	NegativeCachingPolicy       []*NegativeCachingPolicy      `json:"negativeCachingPolicy,omitempty"`
	RequestCoalescing           *bool                         `json:"requestCoalescing,omitempty"`
	ServeWhileStale             *int64                        `json:"serveWhileStale,omitempty"`
	SignedUrlCacheMaxAgeSec     *int64                        `json:"signedUrlCacheMaxAgeSec,omitempty"`
	SignedUrlKeys               []*SignedUrlKey               `json:"signedUrlKeys,omitempty"`
}

CDNConfig contains configuration for CDN-enabled backends. +k8s:openapi-gen=true

func (*CDNConfig) DeepCopy 

func (in *CDNConfig) DeepCopy() *CDNConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CDNConfig.

func (*CDNConfig) DeepCopyInto 

func (in *CDNConfig) DeepCopyInto(out *CDNConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CacheKeyPolicy 

type CacheKeyPolicy struct {
	// If true, requests to different hosts will be cached separately.
	IncludeHost bool `json:"includeHost,omitempty"`
	// If true, http and https requests will be cached separately.
	IncludeProtocol bool `json:"includeProtocol,omitempty"`
	// If true, query string parameters are included in the cache key
	// according to QueryStringBlacklist and QueryStringWhitelist.
	// If neither is set, the entire query string is included and if false
	// the entire query string is excluded.
	IncludeQueryString bool `json:"includeQueryString,omitempty"`
	// Names of query strint parameters to exclude from cache keys. All other
	// parameters are included. Either specify QueryStringBlacklist or
	// QueryStringWhitelist, but not both.
	QueryStringBlacklist []string `json:"queryStringBlacklist,omitempty"`
	// Names of query string parameters to include in cache keys. All other
	// parameters are excluded. Either specify QueryStringBlacklist or
	// QueryStringWhitelist, but not both.
	QueryStringWhitelist []string `json:"queryStringWhitelist,omitempty"`
}

CacheKeyPolicy contains configuration for how requests to a CDN-enabled backend are cached. +k8s:openapi-gen=true

func (*CacheKeyPolicy) DeepCopy 

func (in *CacheKeyPolicy) DeepCopy() *CacheKeyPolicy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CacheKeyPolicy.

func (*CacheKeyPolicy) DeepCopyInto 

func (in *CacheKeyPolicy) DeepCopyInto(out *CacheKeyPolicy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionDrainingConfig 

type ConnectionDrainingConfig struct {
	// Draining timeout in seconds.
	DrainingTimeoutSec int64 `json:"drainingTimeoutSec,omitempty"`
}

ConnectionDrainingConfig contains configuration for connection draining. For now the draining timeout. May manage more settings in the future. +k8s:openapi-gen=true

func (*ConnectionDrainingConfig) DeepCopy 

func (in *ConnectionDrainingConfig) DeepCopy() *ConnectionDrainingConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionDrainingConfig.

func (*ConnectionDrainingConfig) DeepCopyInto 

func (in *ConnectionDrainingConfig) DeepCopyInto(out *ConnectionDrainingConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CustomRequestHeadersConfig added in v1.7.0 

type CustomRequestHeadersConfig struct {
	Headers []string `json:"headers,omitempty"`
}

CustomRequestHeadersConfig contains configuration for custom request headers +k8s:openapi-gen=true

func (*CustomRequestHeadersConfig) DeepCopy added in v1.9.0 

func (in *CustomRequestHeadersConfig) DeepCopy() *CustomRequestHeadersConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomRequestHeadersConfig.

func (*CustomRequestHeadersConfig) DeepCopyInto added in v1.9.0 

func (in *CustomRequestHeadersConfig) DeepCopyInto(out *CustomRequestHeadersConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CustomResponseHeadersConfig added in v1.20.0 

type CustomResponseHeadersConfig struct {
	Headers []string `json:"headers,omitempty"`
}

CustomResponseHeadersConfig contains configuration for custom response headers +k8s:openapi-gen=true

func (*CustomResponseHeadersConfig) DeepCopy added in v1.20.0 

func (in *CustomResponseHeadersConfig) DeepCopy() *CustomResponseHeadersConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResponseHeadersConfig.

func (*CustomResponseHeadersConfig) DeepCopyInto added in v1.20.0 

func (in *CustomResponseHeadersConfig) DeepCopyInto(out *CustomResponseHeadersConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HealthCheckConfig added in v1.9.0 

type HealthCheckConfig struct {
	// CheckIntervalSec is a health check parameter. See
	// https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks.
	CheckIntervalSec *int64 `json:"checkIntervalSec,omitempty"`
	// TimeoutSec is a health check parameter. See
	// https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks.
	TimeoutSec *int64 `json:"timeoutSec,omitempty"`
	// HealthyThreshold is a health check parameter. See
	// https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks.
	HealthyThreshold *int64 `json:"healthyThreshold,omitempty"`
	// UnhealthyThreshold is a health check parameter. See
	// https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks.
	UnhealthyThreshold *int64 `json:"unhealthyThreshold,omitempty"`
	// Type is a health check parameter. See
	// https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks.
	Type *string `json:"type,omitempty"`
	// Port is a health check parameter. See
	// https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks.
	// If Port is used, the controller updates portSpecification as well
	Port *int64 `json:"port,omitempty"`
	// RequestPath is a health check parameter. See
	// https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks.
	RequestPath *string `json:"requestPath,omitempty"`
}

HealthCheckConfig contains configuration for the health check. +k8s:openapi-gen=true

func (*HealthCheckConfig) DeepCopy added in v1.9.0 

func (in *HealthCheckConfig) DeepCopy() *HealthCheckConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HealthCheckConfig.

func (*HealthCheckConfig) DeepCopyInto added in v1.9.0 

func (in *HealthCheckConfig) DeepCopyInto(out *HealthCheckConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IAPConfig 

type IAPConfig struct {
	Enabled bool `json:"enabled"`
	// +optional
	OAuthClientCredentials *OAuthClientCredentials `json:"oauthclientCredentials"`
}

IAPConfig contains configuration for IAP-enabled backends. +k8s:openapi-gen=true

func (*IAPConfig) DeepCopy 

func (in *IAPConfig) DeepCopy() *IAPConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IAPConfig.

func (*IAPConfig) DeepCopyInto 

func (in *IAPConfig) DeepCopyInto(out *IAPConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LogConfig added in v1.9.0 

type LogConfig struct {
	// This field denotes whether to enable logging for the load balancer
	// traffic served by this backend service.
	Enable bool `json:"enable,omitempty"`
	// This field can only be specified if logging is enabled for this
	// backend service. The value of the field must be in [0, 1]. This
	// configures the sampling rate of requests to the load balancer where
	// 1.0 means all logged requests are reported and 0.0 means no logged
	// requests are reported. The default value is 1.0.
	SampleRate *float64 `json:"sampleRate,omitempty"`
}

LogConfig contains configuration for logging. +k8s:openapi-gen=true

func (*LogConfig) DeepCopy added in v1.9.0 

func (in *LogConfig) DeepCopy() *LogConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LogConfig.

func (*LogConfig) DeepCopyInto added in v1.9.0 

func (in *LogConfig) DeepCopyInto(out *LogConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NegativeCachingPolicy added in v1.15.0 

type NegativeCachingPolicy struct {
	// The HTTP status code to define a TTL against. Only HTTP status codes
	// 300, 301, 308, 404, 405, 410, 421, 451 and 501 are can be specified
	// as values, and you cannot specify a status code more than once.
	Code int64 `json:"code,omitempty"`
	// The TTL (in seconds) for which to cache responses with the
	// corresponding status code. The maximum allowed value is 1800s (30
	// minutes), noting that infrequently accessed objects may be evicted
	// from the cache before the defined TTL.
	Ttl int64 `json:"ttl,omitempty"`
}

NegativeCachingPolicy contains configuration for how negative caching is applied. +k8s:openapi-gen=true

func (*NegativeCachingPolicy) DeepCopy added in v1.15.0 

func (in *NegativeCachingPolicy) DeepCopy() *NegativeCachingPolicy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NegativeCachingPolicy.

func (*NegativeCachingPolicy) DeepCopyInto added in v1.15.0 

func (in *NegativeCachingPolicy) DeepCopyInto(out *NegativeCachingPolicy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OAuthClientCredentials 

type OAuthClientCredentials struct {
	// The name of a k8s secret which stores the OAuth client id & secret.
	SecretName string `json:"secretName"`
	// Direct reference to OAuth client id.
	ClientID string `json:"clientID,omitempty"`
	// Direct reference to OAuth client secret.
	ClientSecret string `json:"clientSecret,omitempty"`
}

OAuthClientCredentials contains credentials for a single IAP-enabled backend. +k8s:openapi-gen=true

func (*OAuthClientCredentials) DeepCopy 

func (in *OAuthClientCredentials) DeepCopy() *OAuthClientCredentials

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuthClientCredentials.

func (*OAuthClientCredentials) DeepCopyInto 

func (in *OAuthClientCredentials) DeepCopyInto(out *OAuthClientCredentials)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SecurityPolicyConfig 

type SecurityPolicyConfig struct {
	// Name of the security policy that should be associated. If set to empty, the
	// existing security policy on the backend will be removed.
	Name string `json:"name"`
}

SecurityPolicyConfig contains configuration for CloudArmor-enabled backends. If not specified, the controller will not reconcile the security policy configuration. In other words, users can make changes in GCE without the controller overwriting them. +k8s:openapi-gen=true

func (*SecurityPolicyConfig) DeepCopy 

func (in *SecurityPolicyConfig) DeepCopy() *SecurityPolicyConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityPolicyConfig.

func (*SecurityPolicyConfig) DeepCopyInto 

func (in *SecurityPolicyConfig) DeepCopyInto(out *SecurityPolicyConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SessionAffinityConfig 

type SessionAffinityConfig struct {
	AffinityType         string `json:"affinityType,omitempty"`
	AffinityCookieTtlSec *int64 `json:"affinityCookieTtlSec,omitempty"`
}

SessionAffinityConfig contains configuration for stickiness parameters. +k8s:openapi-gen=true

func (*SessionAffinityConfig) DeepCopy 

func (in *SessionAffinityConfig) DeepCopy() *SessionAffinityConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SessionAffinityConfig.

func (*SessionAffinityConfig) DeepCopyInto 

func (in *SessionAffinityConfig) DeepCopyInto(out *SessionAffinityConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SignedUrlKey added in v1.15.0 

type SignedUrlKey struct {
	// KeyName: Name of the key. The name must be 1-63 characters long, and
	// comply with RFC1035. Specifically, the name must be 1-63 characters
	// long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
	// which means the first character must be a lowercase letter, and all
	// following characters must be a dash, lowercase letter, or digit,
	// except the last character, which cannot be a dash.
	KeyName string `json:"keyName,omitempty"`

	// KeyValue: 128-bit key value used for signing the URL. The key value
	// must be a valid RFC 4648 Section 5 base64url encoded string.
	KeyValue string `json:"keyValue,omitempty"`

	// The name of a k8s secret which stores the 128-bit key value
	// used for signing the URL. The key value must be a valid RFC 4648 Section 5
	// base64url encoded string
	SecretName string `json:"secretName,omitempty"`
}

SignedUrlKey represents a customer-supplied Signing Key used by Cloud CDN Signed URLs +k8s:openapi-gen=true

func (*SignedUrlKey) DeepCopy added in v1.15.0 

func (in *SignedUrlKey) DeepCopy() *SignedUrlKey

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SignedUrlKey.

func (*SignedUrlKey) DeepCopyInto added in v1.15.0 

func (in *SignedUrlKey) DeepCopyInto(out *SignedUrlKey)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.