Documentation
¶
Overview ¶
Generate deepcopy object for cloudfunctions2/v1alpha1 API group
Package v1alpha1 contains API Schema definitions for the cloudfunctions2 v1alpha1 API group. +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/pkg/apis/cloudfunctions2 +k8s:defaulter-gen=TypeMeta +groupName=cloudfunctions2.cnrm.cloud.google.com
Index ¶
- Variables
- type CloudFunctions2Function
- type CloudFunctions2FunctionList
- type CloudFunctions2FunctionSpec
- type CloudFunctions2FunctionStatus
- type FunctionBuildConfig
- type FunctionEventFilters
- type FunctionEventTrigger
- type FunctionRepoSource
- type FunctionSecretEnvironmentVariables
- type FunctionSecretVolumes
- type FunctionServiceConfig
- type FunctionSource
- type FunctionStorageSource
- type FunctionVersions
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is the group version used to register these objects. SchemeGroupVersion = schema.GroupVersion{Group: "cloudfunctions2.cnrm.cloud.google.com", Version: "v1beta1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme. SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme is a global function that registers this API group & version to a scheme AddToScheme = SchemeBuilder.AddToScheme CloudFunctions2FunctionGVK = schema.GroupVersionKind{ Group: SchemeGroupVersion.Group, Version: SchemeGroupVersion.Version, Kind: reflect.TypeOf(CloudFunctions2Function{}).Name(), } )
Functions ¶
This section is empty.
Types ¶
type CloudFunctions2Function ¶
type CloudFunctions2Function struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec CloudFunctions2FunctionSpec `json:"spec,omitempty"`
Status CloudFunctions2FunctionStatus `json:"status,omitempty"`
}
CloudFunctions2Function is the Schema for the cloudfunctions2 API +k8s:openapi-gen=true
func (*CloudFunctions2Function) DeepCopy ¶
func (in *CloudFunctions2Function) DeepCopy() *CloudFunctions2Function
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudFunctions2Function.
func (*CloudFunctions2Function) DeepCopyInto ¶
func (in *CloudFunctions2Function) DeepCopyInto(out *CloudFunctions2Function)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CloudFunctions2Function) DeepCopyObject ¶
func (in *CloudFunctions2Function) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CloudFunctions2FunctionList ¶
type CloudFunctions2FunctionList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []CloudFunctions2Function `json:"items"`
}
CloudFunctions2FunctionList contains a list of CloudFunctions2Function
func (*CloudFunctions2FunctionList) DeepCopy ¶
func (in *CloudFunctions2FunctionList) DeepCopy() *CloudFunctions2FunctionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudFunctions2FunctionList.
func (*CloudFunctions2FunctionList) DeepCopyInto ¶
func (in *CloudFunctions2FunctionList) DeepCopyInto(out *CloudFunctions2FunctionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CloudFunctions2FunctionList) DeepCopyObject ¶
func (in *CloudFunctions2FunctionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CloudFunctions2FunctionSpec ¶
type CloudFunctions2FunctionSpec struct {
/* Describes the Build step of the function that builds a container
from the given source. */
// +optional
BuildConfig *FunctionBuildConfig `json:"buildConfig,omitempty"`
/* User-provided description of a function. */
// +optional
Description *string `json:"description,omitempty"`
/* An Eventarc trigger managed by Google Cloud Functions that fires events in
response to a condition in another service. */
// +optional
EventTrigger *FunctionEventTrigger `json:"eventTrigger,omitempty"`
/* Immutable. The location of this cloud function. */
Location string `json:"location"`
/* The project that this resource belongs to. */
ProjectRef v1alpha1.ResourceRef `json:"projectRef"`
/* Immutable. Optional. The name 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"`
/* Describes the Service being deployed. */
// +optional
ServiceConfig *FunctionServiceConfig `json:"serviceConfig,omitempty"`
}
func (*CloudFunctions2FunctionSpec) DeepCopy ¶
func (in *CloudFunctions2FunctionSpec) DeepCopy() *CloudFunctions2FunctionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudFunctions2FunctionSpec.
func (*CloudFunctions2FunctionSpec) DeepCopyInto ¶
func (in *CloudFunctions2FunctionSpec) DeepCopyInto(out *CloudFunctions2FunctionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CloudFunctions2FunctionStatus ¶
type CloudFunctions2FunctionStatus struct {
/* Conditions represent the latest available observations of the
CloudFunctions2Function's current state. */
Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
/* The environment the function is hosted on. */
// +optional
Environment *string `json:"environment,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 *int `json:"observedGeneration,omitempty"`
/* Describes the current state of the function. */
// +optional
State *string `json:"state,omitempty"`
/* The last update timestamp of a Cloud Function. */
// +optional
UpdateTime *string `json:"updateTime,omitempty"`
}
func (*CloudFunctions2FunctionStatus) DeepCopy ¶
func (in *CloudFunctions2FunctionStatus) DeepCopy() *CloudFunctions2FunctionStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudFunctions2FunctionStatus.
func (*CloudFunctions2FunctionStatus) DeepCopyInto ¶
func (in *CloudFunctions2FunctionStatus) DeepCopyInto(out *CloudFunctions2FunctionStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionBuildConfig ¶
type FunctionBuildConfig struct {
/* The Cloud Build name of the latest successful
deployment of the function. */
// +optional
Build *string `json:"build,omitempty"`
/* User managed repository created in Artifact Registry optionally with a customer managed encryption key. */
// +optional
DockerRepository *string `json:"dockerRepository,omitempty"`
/* The name of the function (as defined in source code) that will be executed.
Defaults to the resource name suffix, if not specified. For backward
compatibility, if function with given name is not found, then the system
will try to use function named "function". For Node.js this is name of a
function exported by the module specified in source_location. */
// +optional
EntryPoint *string `json:"entryPoint,omitempty"`
/* User-provided build-time environment variables for the function. */
// +optional
EnvironmentVariables map[string]string `json:"environmentVariables,omitempty"`
/* The runtime in which to run the function. Required when deploying a new
function, optional when updating an existing function. */
// +optional
Runtime *string `json:"runtime,omitempty"`
/* The location of the function source code. */
// +optional
Source *FunctionSource `json:"source,omitempty"`
/* Name of the Cloud Build Custom Worker Pool that should be used to build the function. */
// +optional
WorkerPool *string `json:"workerPool,omitempty"`
}
func (*FunctionBuildConfig) DeepCopy ¶
func (in *FunctionBuildConfig) DeepCopy() *FunctionBuildConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionBuildConfig.
func (*FunctionBuildConfig) DeepCopyInto ¶
func (in *FunctionBuildConfig) DeepCopyInto(out *FunctionBuildConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionEventFilters ¶
type FunctionEventFilters struct {
/* 'Required. The name of a CloudEvents attribute.
Currently, only a subset of attributes are supported for filtering. Use the 'gcloud eventarc providers describe' command to learn more about events and their attributes.
Do not filter for the 'type' attribute here, as this is already achieved by the resource's 'event_type' attribute. */
Attribute string `json:"attribute"`
/* Optional. The operator used for matching the events with the value of
the filter. If not specified, only events that have an exact key-value
pair specified in the filter are matched.
The only allowed value is 'match-path-pattern'.
[See documentation on path patterns here](https://cloud.google.com/eventarc/docs/path-patterns)'. */
// +optional
Operator *string `json:"operator,omitempty"`
/* Required. The value for the attribute.
If the operator field is set as 'match-path-pattern', this value can be a path pattern instead of an exact value. */
Value string `json:"value"`
}
func (*FunctionEventFilters) DeepCopy ¶
func (in *FunctionEventFilters) DeepCopy() *FunctionEventFilters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionEventFilters.
func (*FunctionEventFilters) DeepCopyInto ¶
func (in *FunctionEventFilters) DeepCopyInto(out *FunctionEventFilters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionEventTrigger ¶
type FunctionEventTrigger struct {
/* Criteria used to filter events. */
// +optional
EventFilters []FunctionEventFilters `json:"eventFilters,omitempty"`
/* Required. The type of event to observe. */
// +optional
EventType *string `json:"eventType,omitempty"`
/* The name of a Pub/Sub topic in the same project that will be used
as the transport topic for the event delivery. */
// +optional
PubsubTopic *string `json:"pubsubTopic,omitempty"`
/* Describes the retry policy in case of function's execution failure.
Retried execution is charged as any other execution. Possible values: ["RETRY_POLICY_UNSPECIFIED", "RETRY_POLICY_DO_NOT_RETRY", "RETRY_POLICY_RETRY"]. */
// +optional
RetryPolicy *string `json:"retryPolicy,omitempty"`
/* The email of the service account for this function. */
// +optional
ServiceAccountEmail *string `json:"serviceAccountEmail,omitempty"`
/* Output only. The resource name of the Eventarc trigger. */
// +optional
Trigger *string `json:"trigger,omitempty"`
/* The region that the trigger will be in. The trigger will only receive
events originating in this region. It can be the same
region as the function, a different region or multi-region, or the global
region. If not provided, defaults to the same region as the function. */
// +optional
TriggerRegion *string `json:"triggerRegion,omitempty"`
}
func (*FunctionEventTrigger) DeepCopy ¶
func (in *FunctionEventTrigger) DeepCopy() *FunctionEventTrigger
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionEventTrigger.
func (*FunctionEventTrigger) DeepCopyInto ¶
func (in *FunctionEventTrigger) DeepCopyInto(out *FunctionEventTrigger)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionRepoSource ¶
type FunctionRepoSource struct {
/* Regex matching branches to build. */
// +optional
BranchName *string `json:"branchName,omitempty"`
/* Regex matching tags to build. */
// +optional
CommitSha *string `json:"commitSha,omitempty"`
/* Directory, relative to the source root, in which to run the build. */
// +optional
Dir *string `json:"dir,omitempty"`
/* Only trigger a build if the revision regex does
NOT match the revision regex. */
// +optional
InvertRegex *bool `json:"invertRegex,omitempty"`
/* Immutable. ID of the project that owns the Cloud Source Repository. If omitted, the
project ID requesting the build is assumed. */
// +optional
ProjectId *string `json:"projectId,omitempty"`
/* Name of the Cloud Source Repository. */
// +optional
RepoName *string `json:"repoName,omitempty"`
/* Regex matching tags to build. */
// +optional
TagName *string `json:"tagName,omitempty"`
}
func (*FunctionRepoSource) DeepCopy ¶
func (in *FunctionRepoSource) DeepCopy() *FunctionRepoSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionRepoSource.
func (*FunctionRepoSource) DeepCopyInto ¶
func (in *FunctionRepoSource) DeepCopyInto(out *FunctionRepoSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionSecretEnvironmentVariables ¶
type FunctionSecretEnvironmentVariables struct {
/* Name of the environment variable. */
Key string `json:"key"`
/* Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function. */
ProjectId string `json:"projectId"`
/* Name of the secret in secret manager (not the full resource name). */
Secret string `json:"secret"`
/* Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start. */
Version string `json:"version"`
}
func (*FunctionSecretEnvironmentVariables) DeepCopy ¶
func (in *FunctionSecretEnvironmentVariables) DeepCopy() *FunctionSecretEnvironmentVariables
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionSecretEnvironmentVariables.
func (*FunctionSecretEnvironmentVariables) DeepCopyInto ¶
func (in *FunctionSecretEnvironmentVariables) DeepCopyInto(out *FunctionSecretEnvironmentVariables)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionSecretVolumes ¶
type FunctionSecretVolumes struct {
/* The path within the container to mount the secret volume. For example, setting the mountPath as /etc/secrets would mount the secret value files under the /etc/secrets directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount path: /etc/secrets. */
MountPath string `json:"mountPath"`
/* Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function. */
ProjectId string `json:"projectId"`
/* Name of the secret in secret manager (not the full resource name). */
Secret string `json:"secret"`
/* List of secret versions to mount for this secret. If empty, the latest version of the secret will be made available in a file named after the secret under the mount point.'. */
// +optional
Versions []FunctionVersions `json:"versions,omitempty"`
}
func (*FunctionSecretVolumes) DeepCopy ¶
func (in *FunctionSecretVolumes) DeepCopy() *FunctionSecretVolumes
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionSecretVolumes.
func (*FunctionSecretVolumes) DeepCopyInto ¶
func (in *FunctionSecretVolumes) DeepCopyInto(out *FunctionSecretVolumes)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionServiceConfig ¶
type FunctionServiceConfig struct {
/* Whether 100% of traffic is routed to the latest revision. Defaults to true. */
// +optional
AllTrafficOnLatestRevision *bool `json:"allTrafficOnLatestRevision,omitempty"`
/* The number of CPUs used in a single container instance. Default value is calculated from available memory. */
// +optional
AvailableCpu *string `json:"availableCpu,omitempty"`
/* The amount of memory available for a function.
Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is
supplied the value is interpreted as bytes. */
// +optional
AvailableMemory *string `json:"availableMemory,omitempty"`
/* Environment variables that shall be available during function execution. */
// +optional
EnvironmentVariables map[string]string `json:"environmentVariables,omitempty"`
/* URIs of the Service deployed. */
// +optional
GcfUri *string `json:"gcfUri,omitempty"`
/* Available ingress settings. Defaults to "ALLOW_ALL" if unspecified. Default value: "ALLOW_ALL" Possible values: ["ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]. */
// +optional
IngressSettings *string `json:"ingressSettings,omitempty"`
/* The limit on the maximum number of function instances that may coexist at a
given time. */
// +optional
MaxInstanceCount *int `json:"maxInstanceCount,omitempty"`
/* Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1. */
// +optional
MaxInstanceRequestConcurrency *int `json:"maxInstanceRequestConcurrency,omitempty"`
/* The limit on the minimum number of function instances that may coexist at a
given time. */
// +optional
MinInstanceCount *int `json:"minInstanceCount,omitempty"`
/* Secret environment variables configuration. */
// +optional
SecretEnvironmentVariables []FunctionSecretEnvironmentVariables `json:"secretEnvironmentVariables,omitempty"`
/* Secret volumes configuration. */
// +optional
SecretVolumes []FunctionSecretVolumes `json:"secretVolumes,omitempty"`
/* Name of the service associated with a Function. */
// +optional
Service *string `json:"service,omitempty"`
/* The email of the service account for this function. */
// +optional
ServiceAccountEmail *string `json:"serviceAccountEmail,omitempty"`
/* The function execution timeout. Execution is considered failed and
can be terminated if the function is not completed at the end of the
timeout period. Defaults to 60 seconds. */
// +optional
TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`
/* URI of the Service deployed. */
// +optional
Uri *string `json:"uri,omitempty"`
/* The Serverless VPC Access connector that this cloud function can connect to. */
// +optional
VpcConnector *string `json:"vpcConnector,omitempty"`
/* Available egress settings. Possible values: ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]. */
// +optional
VpcConnectorEgressSettings *string `json:"vpcConnectorEgressSettings,omitempty"`
}
func (*FunctionServiceConfig) DeepCopy ¶
func (in *FunctionServiceConfig) DeepCopy() *FunctionServiceConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionServiceConfig.
func (*FunctionServiceConfig) DeepCopyInto ¶
func (in *FunctionServiceConfig) DeepCopyInto(out *FunctionServiceConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionSource ¶
type FunctionSource struct {
/* If provided, get the source from this location in a Cloud Source Repository. */
// +optional
RepoSource *FunctionRepoSource `json:"repoSource,omitempty"`
/* If provided, get the source from this location in Google Cloud Storage. */
// +optional
StorageSource *FunctionStorageSource `json:"storageSource,omitempty"`
}
func (*FunctionSource) DeepCopy ¶
func (in *FunctionSource) DeepCopy() *FunctionSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionSource.
func (*FunctionSource) DeepCopyInto ¶
func (in *FunctionSource) DeepCopyInto(out *FunctionSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionStorageSource ¶
type FunctionStorageSource struct {
/* Google Cloud Storage bucket containing the source. */
// +optional
Bucket *string `json:"bucket,omitempty"`
/* Google Cloud Storage generation for the object. If the generation
is omitted, the latest generation will be used. */
// +optional
Generation *int `json:"generation,omitempty"`
/* Google Cloud Storage object containing the source. */
// +optional
Object *string `json:"object,omitempty"`
}
func (*FunctionStorageSource) DeepCopy ¶
func (in *FunctionStorageSource) DeepCopy() *FunctionStorageSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionStorageSource.
func (*FunctionStorageSource) DeepCopyInto ¶
func (in *FunctionStorageSource) DeepCopyInto(out *FunctionStorageSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionVersions ¶
type FunctionVersions struct {
/* Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mountPath as '/etc/secrets' and path as secret_foo would mount the secret value file at /etc/secrets/secret_foo. */
Path string `json:"path"`
/* Version of the secret (version number or the string 'latest'). It is preferable to use latest version with secret volumes as secret value changes are reflected immediately. */
Version string `json:"version"`
}
func (*FunctionVersions) DeepCopy ¶
func (in *FunctionVersions) DeepCopy() *FunctionVersions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionVersions.
func (*FunctionVersions) DeepCopyInto ¶
func (in *FunctionVersions) DeepCopyInto(out *FunctionVersions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.