Documentation
¶
Overview ¶
Package v1beta1 contains API Schema definitions for the cloudfunctions v1beta1 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/cloudfunctions +k8s:defaulter-gen=TypeMeta +groupName=cloudfunctions.cnrm.cloud.google.com
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is the group version used to register these objects. SchemeGroupVersion = schema.GroupVersion{Group: "cloudfunctions.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 CloudFunctionsFunctionGVK = schema.GroupVersionKind{ Group: SchemeGroupVersion.Group, Version: SchemeGroupVersion.Version, Kind: reflect.TypeOf(CloudFunctionsFunction{}).Name(), } )
Functions ¶
This section is empty.
Types ¶
type CloudFunctionsFunction ¶
type CloudFunctionsFunction struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec CloudFunctionsFunctionSpec `json:"spec,omitempty"`
Status CloudFunctionsFunctionStatus `json:"status,omitempty"`
}
CloudFunctionsFunction is the Schema for the cloudfunctions API +k8s:openapi-gen=true
func (*CloudFunctionsFunction) DeepCopy ¶
func (in *CloudFunctionsFunction) DeepCopy() *CloudFunctionsFunction
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudFunctionsFunction.
func (*CloudFunctionsFunction) DeepCopyInto ¶
func (in *CloudFunctionsFunction) DeepCopyInto(out *CloudFunctionsFunction)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CloudFunctionsFunction) DeepCopyObject ¶
func (in *CloudFunctionsFunction) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CloudFunctionsFunctionList ¶
type CloudFunctionsFunctionList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []CloudFunctionsFunction `json:"items"`
}
CloudFunctionsFunctionList contains a list of CloudFunctionsFunction
func (*CloudFunctionsFunctionList) DeepCopy ¶
func (in *CloudFunctionsFunctionList) DeepCopy() *CloudFunctionsFunctionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudFunctionsFunctionList.
func (*CloudFunctionsFunctionList) DeepCopyInto ¶
func (in *CloudFunctionsFunctionList) DeepCopyInto(out *CloudFunctionsFunctionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CloudFunctionsFunctionList) DeepCopyObject ¶
func (in *CloudFunctionsFunctionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CloudFunctionsFunctionSpec ¶
type CloudFunctionsFunctionSpec struct {
/* Memory (in MB), available to the function. Default value is 256MB. Allowed values are: 128MB, 256MB, 512MB, 1024MB, and 2048MB. */
// +optional
AvailableMemoryMb *int64 `json:"availableMemoryMb,omitempty"`
/* User-provided description of a function. */
// +optional
Description *string `json:"description,omitempty"`
/* Immutable. 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"`
/* Environment variables that shall be available during function execution. */
// +optional
EnvironmentVariables map[string]string `json:"environmentVariables,omitempty"`
/* Immutable. A source that fires events in response to a condition in another service. */
// +optional
EventTrigger *FunctionEventTrigger `json:"eventTrigger,omitempty"`
/* Immutable. An HTTPS endpoint type of source that can be triggered via URL. */
// +optional
HttpsTrigger *FunctionHttpsTrigger `json:"httpsTrigger,omitempty"`
/* The ingress settings for the function, controlling what traffic can reach
it. Possible values: INGRESS_SETTINGS_UNSPECIFIED, 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
MaxInstances *int64 `json:"maxInstances,omitempty"`
/* Immutable. The Project that this resource belongs to. */
ProjectRef v1alpha1.ResourceRef `json:"projectRef"`
/* Immutable. The name of the Cloud Functions region of the function. */
Region string `json:"region"`
/* 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"`
/* The runtime in which to run the function. Required when deploying a new
function, optional when updating an existing function. For a complete
list of possible choices, see the
[`gcloud` command
reference](/sdk/gcloud/reference/functions/deploy#--runtime). */
Runtime string `json:"runtime"`
/* Immutable. */
// +optional
ServiceAccountRef *v1alpha1.ResourceRef `json:"serviceAccountRef,omitempty"`
/* Immutable. The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. */
// +optional
SourceArchiveUrl *string `json:"sourceArchiveUrl,omitempty"`
/* Immutable. Represents parameters related to source repository where a function is hosted. */
// +optional
SourceRepository *FunctionSourceRepository `json:"sourceRepository,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
Timeout *string `json:"timeout,omitempty"`
/* The egress settings for the connector, controlling what traffic is diverted
through it. Possible values: VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED, PRIVATE_RANGES_ONLY, ALL_TRAFFIC */
// +optional
VpcConnectorEgressSettings *string `json:"vpcConnectorEgressSettings,omitempty"`
// +optional
VpcConnectorRef *v1alpha1.ResourceRef `json:"vpcConnectorRef,omitempty"`
}
func (*CloudFunctionsFunctionSpec) DeepCopy ¶
func (in *CloudFunctionsFunctionSpec) DeepCopy() *CloudFunctionsFunctionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudFunctionsFunctionSpec.
func (*CloudFunctionsFunctionSpec) DeepCopyInto ¶
func (in *CloudFunctionsFunctionSpec) DeepCopyInto(out *CloudFunctionsFunctionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CloudFunctionsFunctionStatus ¶
type CloudFunctionsFunctionStatus struct {
/* Conditions represent the latest available observations of the
CloudFunctionsFunction's current state. */
Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
// +optional
HttpsTrigger *FunctionHttpsTriggerStatus `json:"httpsTrigger,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"`
// +optional
SourceRepository *FunctionSourceRepositoryStatus `json:"sourceRepository,omitempty"`
/* Output only. Status of the function deployment. Possible values: CLOUD_FUNCTION_STATUS_UNSPECIFIED, ACTIVE, OFFLINE, DEPLOY_IN_PROGRESS, DELETE_IN_PROGRESS, UNKNOWN */
// +optional
Status *string `json:"status,omitempty"`
/* Output only. The last update timestamp of a Cloud Function in RFC3339 UTC 'Zulu' format, with nanosecond resolution and up to nine fractional digits. */
// +optional
UpdateTime *string `json:"updateTime,omitempty"`
/* Output only. The version identifier of the Cloud Function. Each deployment attempt
results in a new version of a function being created. */
// +optional
VersionId *int64 `json:"versionId,omitempty"`
}
func (*CloudFunctionsFunctionStatus) DeepCopy ¶
func (in *CloudFunctionsFunctionStatus) DeepCopy() *CloudFunctionsFunctionStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudFunctionsFunctionStatus.
func (*CloudFunctionsFunctionStatus) DeepCopyInto ¶
func (in *CloudFunctionsFunctionStatus) DeepCopyInto(out *CloudFunctionsFunctionStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionEventTrigger ¶
type FunctionEventTrigger struct {
/* Immutable. Required. The type of event to observe. For example:
`providers/cloud.storage/eventTypes/object.change` and
`providers/cloud.pubsub/eventTypes/topic.publish`.
Event types match pattern `providers/* /eventTypes/*.*`.
The pattern contains:
1. namespace: For example, `cloud.storage` and
`google.firebase.analytics`.
2. resource type: The type of resource on which event occurs. For
example, the Google Cloud Storage API includes the type `object`.
3. action: The action that generates the event. For example, action for
a Google Cloud Storage Object is 'change'.
These parts are lower case. */
EventType string `json:"eventType"`
/* Immutable. Specifies policy for failed executions. */
// +optional
FailurePolicy *bool `json:"failurePolicy,omitempty"`
/* Immutable. */
ResourceRef v1alpha1.ResourceRef `json:"resourceRef"`
/* Immutable. The hostname of the service that should be observed.
If no string is provided, the default service implementing the API will
be used. For example, `storage.googleapis.com` is the default for all
event types in the `google.storage` namespace. */
// +optional
Service *string `json:"service,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 FunctionHttpsTrigger ¶
type FunctionHttpsTrigger struct {
/* Immutable. Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly. Possible values: SECURITY_LEVEL_UNSPECIFIED, SECURE_ALWAYS, SECURE_OPTIONAL */
// +optional
SecurityLevel *string `json:"securityLevel,omitempty"`
}
func (*FunctionHttpsTrigger) DeepCopy ¶
func (in *FunctionHttpsTrigger) DeepCopy() *FunctionHttpsTrigger
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionHttpsTrigger.
func (*FunctionHttpsTrigger) DeepCopyInto ¶
func (in *FunctionHttpsTrigger) DeepCopyInto(out *FunctionHttpsTrigger)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionHttpsTriggerStatus ¶
type FunctionHttpsTriggerStatus struct {
/* Output only. The deployed url for the function. */
// +optional
Url *string `json:"url,omitempty"`
}
func (*FunctionHttpsTriggerStatus) DeepCopy ¶
func (in *FunctionHttpsTriggerStatus) DeepCopy() *FunctionHttpsTriggerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionHttpsTriggerStatus.
func (*FunctionHttpsTriggerStatus) DeepCopyInto ¶
func (in *FunctionHttpsTriggerStatus) DeepCopyInto(out *FunctionHttpsTriggerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionSourceRepository ¶
type FunctionSourceRepository struct {
/* Immutable. The URL pointing to the hosted repository where the function is defined.
There are supported Cloud Source Repository URLs in the following
formats:
To refer to a specific commit:
`https://source.developers.google.com/projects/* /repos/* /revisions/* /paths/*`
To refer to a moveable alias (branch):
`https://source.developers.google.com/projects/* /repos/* /moveable-aliases/* /paths/*`
In particular, to refer to HEAD use `master` moveable alias.
To refer to a specific fixed alias (tag):
`https://source.developers.google.com/projects/* /repos/* /fixed-aliases/* /paths/*`
You may omit `paths/*` if you want to use the main directory. */
Url string `json:"url"`
}
func (*FunctionSourceRepository) DeepCopy ¶
func (in *FunctionSourceRepository) DeepCopy() *FunctionSourceRepository
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionSourceRepository.
func (*FunctionSourceRepository) DeepCopyInto ¶
func (in *FunctionSourceRepository) DeepCopyInto(out *FunctionSourceRepository)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FunctionSourceRepositoryStatus ¶
type FunctionSourceRepositoryStatus struct {
/* Output only. The URL pointing to the hosted repository where the function
were defined at the time of deployment. It always points to a specific
commit in the format described above. */
// +optional
DeployedUrl *string `json:"deployedUrl,omitempty"`
}
func (*FunctionSourceRepositoryStatus) DeepCopy ¶
func (in *FunctionSourceRepositoryStatus) DeepCopy() *FunctionSourceRepositoryStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionSourceRepositoryStatus.
func (*FunctionSourceRepositoryStatus) DeepCopyInto ¶
func (in *FunctionSourceRepositoryStatus) DeepCopyInto(out *FunctionSourceRepositoryStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.