appenginestandardappversion_types.go

// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// ----------------------------------------------------------------------------
//
//     ***     AUTO GENERATED CODE    ***    AUTO GENERATED CODE     ***
//
// ----------------------------------------------------------------------------
//
//     This file is automatically generated by Config Connector and manual
//     changes will be clobbered when the file is regenerated.
//
// ----------------------------------------------------------------------------

// *** DISCLAIMER ***
// Config Connector's go-client for CRDs is currently in ALPHA, which means
// that future versions of the go-client may include breaking changes.
// Please try it out and give us feedback!

package v1alpha1

import (
	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/k8s/v1alpha1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

type StandardappversionAutomaticScaling struct {
	/* Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.

	Defaults to a runtime-specific value. */
	// +optional
	MaxConcurrentRequests *int64 `json:"maxConcurrentRequests,omitempty"`

	/* Maximum number of idle instances that should be maintained for this version. */
	// +optional
	MaxIdleInstances *int64 `json:"maxIdleInstances,omitempty"`

	/* Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
	A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". */
	// +optional
	MaxPendingLatency *string `json:"maxPendingLatency,omitempty"`

	/* Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service. */
	// +optional
	MinIdleInstances *int64 `json:"minIdleInstances,omitempty"`

	/* Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
	A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". */
	// +optional
	MinPendingLatency *string `json:"minPendingLatency,omitempty"`

	/* Scheduler settings for standard environment. */
	// +optional
	StandardSchedulerSettings *StandardappversionStandardSchedulerSettings `json:"standardSchedulerSettings,omitempty"`
}

type StandardappversionBasicScaling struct {
	/* Duration of time after the last request that an instance must wait before the instance is shut down.
	A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". Defaults to 900s. */
	// +optional
	IdleTimeout *string `json:"idleTimeout,omitempty"`

	/* Maximum number of instances to create for this version. Must be in the range [1.0, 200.0]. */
	MaxInstances int64 `json:"maxInstances"`
}

type StandardappversionDeployment struct {
	/* Manifest of the files stored in Google Cloud Storage that are included as part of this version.
	All files must be readable using the credentials supplied with this call. */
	// +optional
	Files []StandardappversionFiles `json:"files,omitempty"`

	/* Zip File. */
	// +optional
	Zip *StandardappversionZip `json:"zip,omitempty"`
}

type StandardappversionEntrypoint struct {
	/* The format should be a shell command that can be fed to bash -c. */
	Shell string `json:"shell"`
}

type StandardappversionFiles struct {
	Name string `json:"name"`

	/* SHA1 checksum of the file. */
	// +optional
	Sha1Sum *string `json:"sha1Sum,omitempty"`

	/* Source URL. */
	SourceUrl string `json:"sourceUrl"`
}

type StandardappversionHandlers struct {
	/* Actions to take when the user is not logged in. Possible values: ["AUTH_FAIL_ACTION_REDIRECT", "AUTH_FAIL_ACTION_UNAUTHORIZED"]. */
	// +optional
	AuthFailAction *string `json:"authFailAction,omitempty"`

	/* Methods to restrict access to a URL based on login status. Possible values: ["LOGIN_OPTIONAL", "LOGIN_ADMIN", "LOGIN_REQUIRED"]. */
	// +optional
	Login *string `json:"login,omitempty"`

	/* 30x code to use when performing redirects for the secure field. Possible values: ["REDIRECT_HTTP_RESPONSE_CODE_301", "REDIRECT_HTTP_RESPONSE_CODE_302", "REDIRECT_HTTP_RESPONSE_CODE_303", "REDIRECT_HTTP_RESPONSE_CODE_307"]. */
	// +optional
	RedirectHttpResponseCode *string `json:"redirectHttpResponseCode,omitempty"`

	/* Executes a script to handle the requests that match this URL pattern.
	Only the auto value is supported for Node.js in the App Engine standard environment, for example "script:" "auto". */
	// +optional
	Script *StandardappversionScript `json:"script,omitempty"`

	/* Security (HTTPS) enforcement for this URL. Possible values: ["SECURE_DEFAULT", "SECURE_NEVER", "SECURE_OPTIONAL", "SECURE_ALWAYS"]. */
	// +optional
	SecurityLevel *string `json:"securityLevel,omitempty"`

	/* Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. */
	// +optional
	StaticFiles *StandardappversionStaticFiles `json:"staticFiles,omitempty"`

	/* URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings.
	All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. */
	// +optional
	UrlRegex *string `json:"urlRegex,omitempty"`
}

type StandardappversionLibraries struct {
	/* Name of the library. Example "django". */
	// +optional
	Name *string `json:"name,omitempty"`

	/* Version of the library to select, or "latest". */
	// +optional
	Version *string `json:"version,omitempty"`
}

type StandardappversionManualScaling struct {
	/* Number of instances to assign to the service at the start.

	**Note:** When managing the number of instances at runtime through the App Engine Admin API or the (now deprecated) Python 2
	Modules API set_num_instances() you must use 'lifecycle.ignore_changes = ["manual_scaling"[0].instances]' to prevent drift detection. */
	Instances int64 `json:"instances"`
}

type StandardappversionScript struct {
	/* Path to the script from the application root directory. */
	ScriptPath string `json:"scriptPath"`
}

type StandardappversionStandardSchedulerSettings struct {
	/* Maximum number of instances to run for this version. Set to zero to disable maxInstances configuration. */
	// +optional
	MaxInstances *int64 `json:"maxInstances,omitempty"`

	/* Minimum number of instances to run for this version. Set to zero to disable minInstances configuration. */
	// +optional
	MinInstances *int64 `json:"minInstances,omitempty"`

	/* Target CPU utilization ratio to maintain when scaling. Should be a value in the range [0.50, 0.95], zero, or a negative value. */
	// +optional
	TargetCpuUtilization *float64 `json:"targetCpuUtilization,omitempty"`

	/* Target throughput utilization ratio to maintain when scaling. Should be a value in the range [0.50, 0.95], zero, or a negative value. */
	// +optional
	TargetThroughputUtilization *float64 `json:"targetThroughputUtilization,omitempty"`
}

type StandardappversionStaticFiles struct {
	/* Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as
	static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged
	against both your code and static data storage resource quotas. */
	// +optional
	ApplicationReadable *bool `json:"applicationReadable,omitempty"`

	/* Time a static file served by this handler should be cached by web proxies and browsers.
	A duration in seconds with up to nine fractional digits, terminated by 's'. Example "3.5s". */
	// +optional
	Expiration *string `json:"expiration,omitempty"`

	/* HTTP headers to use for all responses from these URLs.
	An object containing a list of "key:value" value pairs.". */
	// +optional
	HttpHeaders map[string]string `json:"httpHeaders,omitempty"`

	/* MIME type used to serve all files served by this handler.
	Defaults to file-specific MIME types, which are derived from each file's filename extension. */
	// +optional
	MimeType *string `json:"mimeType,omitempty"`

	/* Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern. */
	// +optional
	Path *string `json:"path,omitempty"`

	/* Whether this handler should match the request if the file referenced by the handler does not exist. */
	// +optional
	RequireMatchingFile *bool `json:"requireMatchingFile,omitempty"`

	/* Regular expression that matches the file paths for all files that should be referenced by this handler. */
	// +optional
	UploadPathRegex *string `json:"uploadPathRegex,omitempty"`
}

type StandardappversionVpcAccessConnector struct {
	/* The egress setting for the connector, controlling what traffic is diverted through it. */
	// +optional
	EgressSetting *string `json:"egressSetting,omitempty"`

	/* Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1. */
	Name string `json:"name"`
}

type StandardappversionZip struct {
	/* files count. */
	// +optional
	FilesCount *int64 `json:"filesCount,omitempty"`

	/* Source URL. */
	SourceUrl string `json:"sourceUrl"`
}

type AppEngineStandardAppVersionSpec struct {
	/* Allows App Engine second generation runtimes to access the legacy bundled services. */
	// +optional
	AppEngineApis *bool `json:"appEngineApis,omitempty"`

	/* Automatic scaling is based on request rate, response latencies, and other application metrics. */
	// +optional
	AutomaticScaling *StandardappversionAutomaticScaling `json:"automaticScaling,omitempty"`

	/* Basic scaling creates instances when your application receives requests. Each instance will be shut down when the application becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. */
	// +optional
	BasicScaling *StandardappversionBasicScaling `json:"basicScaling,omitempty"`

	/* If set to 'true', the service will be deleted if it is the last version. */
	// +optional
	DeleteServiceOnDestroy *bool `json:"deleteServiceOnDestroy,omitempty"`

	/* Code and application artifacts that make up this version. */
	Deployment StandardappversionDeployment `json:"deployment"`

	/* The entrypoint for the application. */
	Entrypoint StandardappversionEntrypoint `json:"entrypoint"`

	/* Environment variables available to the application. */
	// +optional
	EnvVariables map[string]string `json:"envVariables,omitempty"`

	/* An ordered list of URL-matching patterns that should be applied to incoming requests.
	The first matching URL handles the request and other request handlers are not attempted. */
	// +optional
	Handlers []StandardappversionHandlers `json:"handlers,omitempty"`

	/* A list of the types of messages that this application is able to receive. Possible values: ["INBOUND_SERVICE_MAIL", "INBOUND_SERVICE_MAIL_BOUNCE", "INBOUND_SERVICE_XMPP_ERROR", "INBOUND_SERVICE_XMPP_MESSAGE", "INBOUND_SERVICE_XMPP_SUBSCRIBE", "INBOUND_SERVICE_XMPP_PRESENCE", "INBOUND_SERVICE_CHANNEL_PRESENCE", "INBOUND_SERVICE_WARMUP"]. */
	// +optional
	InboundServices []string `json:"inboundServices,omitempty"`

	/* Instance class that is used to run this version. Valid values are
	AutomaticScaling: F1, F2, F4, F4_1G
	BasicScaling or ManualScaling: B1, B2, B4, B4_1G, B8
	Defaults to F1 for AutomaticScaling and B2 for ManualScaling and BasicScaling. If no scaling is specified, AutomaticScaling is chosen. */
	// +optional
	InstanceClass *string `json:"instanceClass,omitempty"`

	/* Configuration for third-party Python runtime libraries that are required by the application. */
	// +optional
	Libraries []StandardappversionLibraries `json:"libraries,omitempty"`

	/* A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. */
	// +optional
	ManualScaling *StandardappversionManualScaling `json:"manualScaling,omitempty"`

	/* If set to 'true', the application version will not be deleted. */
	// +optional
	NoopOnDestroy *bool `json:"noopOnDestroy,omitempty"`

	/* Immutable. */
	// +optional
	Project *string `json:"project,omitempty"`

	/* Immutable. Optional. The versionId of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`

	/* Desired runtime. Example python27. */
	Runtime string `json:"runtime"`

	/* The version of the API in the given runtime environment.
	Please see the app.yaml reference for valid values at 'https://cloud.google.com/appengine/docs/standard/<language>/config/appref'\
	Substitute '<language>' with 'python', 'java', 'php', 'ruby', 'go' or 'nodejs'. */
	// +optional
	RuntimeApiVersion *string `json:"runtimeApiVersion,omitempty"`

	/* The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. */
	// +optional
	ServiceAccount *string `json:"serviceAccount,omitempty"`

	ServiceRef v1alpha1.ResourceRef `json:"serviceRef"`

	/* Whether multiple requests can be dispatched to this version at once. */
	// +optional
	Threadsafe *bool `json:"threadsafe,omitempty"`

	/* Enables VPC connectivity for standard apps. */
	// +optional
	VpcAccessConnector *StandardappversionVpcAccessConnector `json:"vpcAccessConnector,omitempty"`
}

type AppEngineStandardAppVersionStatus struct {
	/* Conditions represent the latest available observations of the
	   AppEngineStandardAppVersion's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* Full path to the Version resource in the API. Example, "v1". */
	// +optional
	Name *string `json:"name,omitempty"`

	/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
	// +optional
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
}

// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:resource:categories=gcp,shortName=gcpappenginestandardappversion;gcpappenginestandardappversions
// +kubebuilder:subresource:status
// +kubebuilder:metadata:labels="cnrm.cloud.google.com/managed-by-kcc=true";"cnrm.cloud.google.com/stability-level=alpha";"cnrm.cloud.google.com/system=true";"cnrm.cloud.google.com/tf2crd=true"
// +kubebuilder:printcolumn:name="Age",JSONPath=".metadata.creationTimestamp",type="date"
// +kubebuilder:printcolumn:name="Ready",JSONPath=".status.conditions[?(@.type=='Ready')].status",type="string",description="When 'True', the most recent reconcile of the resource succeeded"
// +kubebuilder:printcolumn:name="Status",JSONPath=".status.conditions[?(@.type=='Ready')].reason",type="string",description="The reason for the value in 'Ready'"
// +kubebuilder:printcolumn:name="Status Age",JSONPath=".status.conditions[?(@.type=='Ready')].lastTransitionTime",type="date",description="The last transition time for the value in 'Status'"

// AppEngineStandardAppVersion is the Schema for the appengine API
// +k8s:openapi-gen=true
type AppEngineStandardAppVersion struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AppEngineStandardAppVersionSpec   `json:"spec,omitempty"`
	Status AppEngineStandardAppVersionStatus `json:"status,omitempty"`
}

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// AppEngineStandardAppVersionList contains a list of AppEngineStandardAppVersion
type AppEngineStandardAppVersionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AppEngineStandardAppVersion `json:"items"`
}

func init() {
	SchemeBuilder.Register(&AppEngineStandardAppVersion{}, &AppEngineStandardAppVersionList{})
}