v1alpha1

package
v1.121.0 Latest Latest
Warning

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

 Go to latest Published: Aug 2, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the apikeys 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/apikeys +k8s:defaulter-gen=TypeMeta +groupName=apikeys.cnrm.cloud.google.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	// SchemeGroupVersion is the group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: "apikeys.cnrm.cloud.google.com", Version: "v1alpha1"}

	// 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

	APIKeysKeyGVK = schema.GroupVersionKind{
		Group:   SchemeGroupVersion.Group,
		Version: SchemeGroupVersion.Version,
		Kind:    reflect.TypeOf(APIKeysKey{}).Name(),
	}
)

Functions

This section is empty.

Types

type APIKeysKey 

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

	Spec   APIKeysKeySpec   `json:"spec,omitempty"`
	Status APIKeysKeyStatus `json:"status,omitempty"`
}

APIKeysKey is the Schema for the apikeys API +k8s:openapi-gen=true

func (*APIKeysKey) DeepCopy 

func (in *APIKeysKey) DeepCopy() *APIKeysKey

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

func (*APIKeysKey) DeepCopyInto 

func (in *APIKeysKey) DeepCopyInto(out *APIKeysKey)

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

func (*APIKeysKey) DeepCopyObject 

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

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

type APIKeysKeyList 

type APIKeysKeyList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []APIKeysKey `json:"items"`
}

APIKeysKeyList contains a list of APIKeysKey

func (*APIKeysKeyList) DeepCopy 

func (in *APIKeysKeyList) DeepCopy() *APIKeysKeyList

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

func (*APIKeysKeyList) DeepCopyInto 

func (in *APIKeysKeyList) DeepCopyInto(out *APIKeysKeyList)

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

func (*APIKeysKeyList) DeepCopyObject 

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

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

type APIKeysKeySpec 

type APIKeysKeySpec struct {
	/* Human-readable display name of this key that you can modify. The maximum length is 63 characters. */
	// +optional
	DisplayName *string `json:"displayName,omitempty"`

	/* Immutable. 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"`

	/* Key restrictions. */
	// +optional
	Restrictions *KeyRestrictions `json:"restrictions,omitempty"`
}

func (*APIKeysKeySpec) DeepCopy 

func (in *APIKeysKeySpec) DeepCopy() *APIKeysKeySpec

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

func (*APIKeysKeySpec) DeepCopyInto 

func (in *APIKeysKeySpec) DeepCopyInto(out *APIKeysKeySpec)

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

type APIKeysKeyStatus 

type APIKeysKeyStatus struct {
	/* Conditions represent the latest available observations of the
	   APIKeysKey's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,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"`

	/* ObservedState is the state of the resource as most recently observed in GCP. */
	// +optional
	ObservedState *KeyObservedStateStatus `json:"observedState,omitempty"`
}

func (*APIKeysKeyStatus) DeepCopy 

func (in *APIKeysKeyStatus) DeepCopy() *APIKeysKeyStatus

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

func (*APIKeysKeyStatus) DeepCopyInto 

func (in *APIKeysKeyStatus) DeepCopyInto(out *APIKeysKeyStatus)

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

type KeyAllowedApplications 

type KeyAllowedApplications struct {
	/* The package name of the application. */
	PackageName string `json:"packageName"`

	/* The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter. */
	Sha1Fingerprint string `json:"sha1Fingerprint"`
}

func (*KeyAllowedApplications) DeepCopy 

func (in *KeyAllowedApplications) DeepCopy() *KeyAllowedApplications

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

func (*KeyAllowedApplications) DeepCopyInto 

func (in *KeyAllowedApplications) DeepCopyInto(out *KeyAllowedApplications)

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

type KeyAndroidKeyRestrictions 

type KeyAndroidKeyRestrictions struct {
	/* A list of Android applications that are allowed to make API calls with this key. */
	AllowedApplications []KeyAllowedApplications `json:"allowedApplications"`
}

func (*KeyAndroidKeyRestrictions) DeepCopy 

func (in *KeyAndroidKeyRestrictions) DeepCopy() *KeyAndroidKeyRestrictions

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

func (*KeyAndroidKeyRestrictions) DeepCopyInto 

func (in *KeyAndroidKeyRestrictions) DeepCopyInto(out *KeyAndroidKeyRestrictions)

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

type KeyApiTargets 

type KeyApiTargets struct {
	/* Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*` */
	// +optional
	Methods []string `json:"methods,omitempty"`

	/* The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. */
	Service string `json:"service"`
}

func (*KeyApiTargets) DeepCopy 

func (in *KeyApiTargets) DeepCopy() *KeyApiTargets

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

func (*KeyApiTargets) DeepCopyInto 

func (in *KeyApiTargets) DeepCopyInto(out *KeyApiTargets)

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

type KeyBrowserKeyRestrictions 

type KeyBrowserKeyRestrictions struct {
	/* A list of regular expressions for the referrer URLs that are allowed to make API calls with this key. */
	AllowedReferrers []string `json:"allowedReferrers"`
}

func (*KeyBrowserKeyRestrictions) DeepCopy 

func (in *KeyBrowserKeyRestrictions) DeepCopy() *KeyBrowserKeyRestrictions

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

func (*KeyBrowserKeyRestrictions) DeepCopyInto 

func (in *KeyBrowserKeyRestrictions) DeepCopyInto(out *KeyBrowserKeyRestrictions)

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

type KeyIosKeyRestrictions 

type KeyIosKeyRestrictions struct {
	/* A list of bundle IDs that are allowed when making API calls with this key. */
	AllowedBundleIds []string `json:"allowedBundleIds"`
}

func (*KeyIosKeyRestrictions) DeepCopy 

func (in *KeyIosKeyRestrictions) DeepCopy() *KeyIosKeyRestrictions

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

func (*KeyIosKeyRestrictions) DeepCopyInto 

func (in *KeyIosKeyRestrictions) DeepCopyInto(out *KeyIosKeyRestrictions)

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

type KeyObservedStateStatus added in v1.118.2 

type KeyObservedStateStatus struct {
	/* Output only. Unique id in UUID4 format. */
	// +optional
	Uid *string `json:"uid,omitempty"`
}

func (*KeyObservedStateStatus) DeepCopy added in v1.118.2 

func (in *KeyObservedStateStatus) DeepCopy() *KeyObservedStateStatus

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

func (*KeyObservedStateStatus) DeepCopyInto added in v1.118.2 

func (in *KeyObservedStateStatus) DeepCopyInto(out *KeyObservedStateStatus)

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

type KeyRestrictions 

type KeyRestrictions struct {
	/* The Android apps that are allowed to use the key. */
	// +optional
	AndroidKeyRestrictions *KeyAndroidKeyRestrictions `json:"androidKeyRestrictions,omitempty"`

	/* A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed. */
	// +optional
	ApiTargets []KeyApiTargets `json:"apiTargets,omitempty"`

	/* The HTTP referrers (websites) that are allowed to use the key. */
	// +optional
	BrowserKeyRestrictions *KeyBrowserKeyRestrictions `json:"browserKeyRestrictions,omitempty"`

	/* The iOS apps that are allowed to use the key. */
	// +optional
	IosKeyRestrictions *KeyIosKeyRestrictions `json:"iosKeyRestrictions,omitempty"`

	/* The IP addresses of callers that are allowed to use the key. */
	// +optional
	ServerKeyRestrictions *KeyServerKeyRestrictions `json:"serverKeyRestrictions,omitempty"`
}

func (*KeyRestrictions) DeepCopy 

func (in *KeyRestrictions) DeepCopy() *KeyRestrictions

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

func (*KeyRestrictions) DeepCopyInto 

func (in *KeyRestrictions) DeepCopyInto(out *KeyRestrictions)

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

type KeyServerKeyRestrictions 

type KeyServerKeyRestrictions struct {
	/* A list of the caller IP addresses that are allowed to make API calls with this key. */
	AllowedIps []string `json:"allowedIps"`
}

func (*KeyServerKeyRestrictions) DeepCopy 

func (in *KeyServerKeyRestrictions) DeepCopy() *KeyServerKeyRestrictions

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

func (*KeyServerKeyRestrictions) DeepCopyInto 

func (in *KeyServerKeyRestrictions) DeepCopyInto(out *KeyServerKeyRestrictions)

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.