v1alpha1

package
v1.127.0 Latest Latest
Warning

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

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

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the apigateway 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/apigateway +k8s:defaulter-gen=TypeMeta +groupName=apigateway.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: "apigateway.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

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

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

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

Functions

This section is empty.

Types

type APIGatewayAPI

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

	Spec   APIGatewayAPISpec   `json:"spec,omitempty"`
	Status APIGatewayAPIStatus `json:"status,omitempty"`
}

APIGatewayAPI is the Schema for the apigateway API +k8s:openapi-gen=true

func (*APIGatewayAPI) DeepCopy

func (in *APIGatewayAPI) DeepCopy() *APIGatewayAPI

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

func (*APIGatewayAPI) DeepCopyInto

func (in *APIGatewayAPI) DeepCopyInto(out *APIGatewayAPI)

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

func (*APIGatewayAPI) DeepCopyObject

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

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

type APIGatewayAPIConfig

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

	Spec   APIGatewayAPIConfigSpec   `json:"spec,omitempty"`
	Status APIGatewayAPIConfigStatus `json:"status,omitempty"`
}

APIGatewayAPIConfig is the Schema for the apigateway API +k8s:openapi-gen=true

func (*APIGatewayAPIConfig) DeepCopy

func (in *APIGatewayAPIConfig) DeepCopy() *APIGatewayAPIConfig

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

func (*APIGatewayAPIConfig) DeepCopyInto

func (in *APIGatewayAPIConfig) DeepCopyInto(out *APIGatewayAPIConfig)

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

func (*APIGatewayAPIConfig) DeepCopyObject

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

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

type APIGatewayAPIConfigList

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

APIGatewayAPIConfigList contains a list of APIGatewayAPIConfig

func (*APIGatewayAPIConfigList) DeepCopy

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

func (*APIGatewayAPIConfigList) DeepCopyInto

func (in *APIGatewayAPIConfigList) DeepCopyInto(out *APIGatewayAPIConfigList)

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

func (*APIGatewayAPIConfigList) DeepCopyObject

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

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

type APIGatewayAPIConfigSpec

type APIGatewayAPIConfigSpec struct {
	/* Immutable. The API to attach the config to. */
	Api string `json:"api"`

	/* Immutable. Creates a unique name beginning with the specified prefix. If this and api_config_id are unspecified, a random value is chosen for the name. */
	// +optional
	ApiConfigIdPrefix *string `json:"apiConfigIdPrefix,omitempty"`

	/* A user-visible name for the API. */
	// +optional
	DisplayName *string `json:"displayName,omitempty"`

	/* Immutable. Immutable. Gateway specific configuration.
	If not specified, backend authentication will be set to use OIDC authentication using the default compute service account. */
	// +optional
	GatewayConfig *ApiconfigGatewayConfig `json:"gatewayConfig,omitempty"`

	/* gRPC service definition files. If specified, openapiDocuments must not be included. */
	// +optional
	GrpcServices []ApiconfigGrpcServices `json:"grpcServices,omitempty"`

	/* Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents.
	If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields. */
	// +optional
	ManagedServiceConfigs []ApiconfigManagedServiceConfigs `json:"managedServiceConfigs,omitempty"`

	/* OpenAPI specification documents. If specified, grpcServices and managedServiceConfigs must not be included. */
	// +optional
	OpenapiDocuments []ApiconfigOpenapiDocuments `json:"openapiDocuments,omitempty"`

	/* The project that this resource belongs to. */
	ProjectRef v1alpha1.ResourceRef `json:"projectRef"`

	/* Immutable. Optional. The apiConfigId 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"`
}

func (*APIGatewayAPIConfigSpec) DeepCopy

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

func (*APIGatewayAPIConfigSpec) DeepCopyInto

func (in *APIGatewayAPIConfigSpec) DeepCopyInto(out *APIGatewayAPIConfigSpec)

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

type APIGatewayAPIConfigStatus

type APIGatewayAPIConfigStatus struct {
	/* Conditions represent the latest available observations of the
	   APIGatewayAPIConfig's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* The resource name of the API Config. */
	// +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"`

	/* The ID of the associated Service Config (https://cloud.google.com/service-infrastructure/docs/glossary#config). */
	// +optional
	ServiceConfigId *string `json:"serviceConfigId,omitempty"`
}

func (*APIGatewayAPIConfigStatus) DeepCopy

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

func (*APIGatewayAPIConfigStatus) DeepCopyInto

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

type APIGatewayAPIList

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

APIGatewayAPIList contains a list of APIGatewayAPI

func (*APIGatewayAPIList) DeepCopy

func (in *APIGatewayAPIList) DeepCopy() *APIGatewayAPIList

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

func (*APIGatewayAPIList) DeepCopyInto

func (in *APIGatewayAPIList) DeepCopyInto(out *APIGatewayAPIList)

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

func (*APIGatewayAPIList) DeepCopyObject

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

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

type APIGatewayAPISpec

type APIGatewayAPISpec struct {
	/* A user-visible name for the API. */
	// +optional
	DisplayName *string `json:"displayName,omitempty"`

	/* Immutable. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed).
	If not specified, a new Service will automatically be created in the same project as this API. */
	// +optional
	ManagedService *string `json:"managedService,omitempty"`

	/* The project that this resource belongs to. */
	ProjectRef v1alpha1.ResourceRef `json:"projectRef"`

	/* Immutable. Optional. The apiId 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"`
}

func (*APIGatewayAPISpec) DeepCopy

func (in *APIGatewayAPISpec) DeepCopy() *APIGatewayAPISpec

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

func (*APIGatewayAPISpec) DeepCopyInto

func (in *APIGatewayAPISpec) DeepCopyInto(out *APIGatewayAPISpec)

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

type APIGatewayAPIStatus

type APIGatewayAPIStatus struct {
	/* Conditions represent the latest available observations of the
	   APIGatewayAPI's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* Creation timestamp in RFC3339 text format. */
	// +optional
	CreateTime *string `json:"createTime,omitempty"`

	/* The resource name of the API. Format 'projects/{{project}}/locations/global/apis/{{apiId}}'. */
	// +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"`
}

func (*APIGatewayAPIStatus) DeepCopy

func (in *APIGatewayAPIStatus) DeepCopy() *APIGatewayAPIStatus

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

func (*APIGatewayAPIStatus) DeepCopyInto

func (in *APIGatewayAPIStatus) DeepCopyInto(out *APIGatewayAPIStatus)

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

type APIGatewayGateway

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

	Spec   APIGatewayGatewaySpec   `json:"spec,omitempty"`
	Status APIGatewayGatewayStatus `json:"status,omitempty"`
}

APIGatewayGateway is the Schema for the apigateway API +k8s:openapi-gen=true

func (*APIGatewayGateway) DeepCopy

func (in *APIGatewayGateway) DeepCopy() *APIGatewayGateway

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

func (*APIGatewayGateway) DeepCopyInto

func (in *APIGatewayGateway) DeepCopyInto(out *APIGatewayGateway)

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

func (*APIGatewayGateway) DeepCopyObject

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

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

type APIGatewayGatewayList

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

APIGatewayGatewayList contains a list of APIGatewayGateway

func (*APIGatewayGatewayList) DeepCopy

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

func (*APIGatewayGatewayList) DeepCopyInto

func (in *APIGatewayGatewayList) DeepCopyInto(out *APIGatewayGatewayList)

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

func (*APIGatewayGatewayList) DeepCopyObject

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

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

type APIGatewayGatewaySpec

type APIGatewayGatewaySpec struct {
	/* Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}.
	When changing api configs please ensure the new config is a new resource and the lifecycle rule 'create_before_destroy' is set. */
	ApiConfig string `json:"apiConfig"`

	/* A user-visible name for the API. */
	// +optional
	DisplayName *string `json:"displayName,omitempty"`

	/* The project that this resource belongs to. */
	ProjectRef v1alpha1.ResourceRef `json:"projectRef"`

	/* Immutable. The region of the gateway for the API. */
	Region string `json:"region"`

	/* Immutable. Optional. The gatewayId 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"`
}

func (*APIGatewayGatewaySpec) DeepCopy

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

func (*APIGatewayGatewaySpec) DeepCopyInto

func (in *APIGatewayGatewaySpec) DeepCopyInto(out *APIGatewayGatewaySpec)

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

type APIGatewayGatewayStatus

type APIGatewayGatewayStatus struct {
	/* Conditions represent the latest available observations of the
	   APIGatewayGateway's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* The default API Gateway host name of the form {gatewayId}-{hash}.{region_code}.gateway.dev. */
	// +optional
	DefaultHostname *string `json:"defaultHostname,omitempty"`

	/* Resource name of the Gateway. Format: projects/{project}/locations/{region}/gateways/{gateway}. */
	// +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"`
}

func (*APIGatewayGatewayStatus) DeepCopy

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

func (*APIGatewayGatewayStatus) DeepCopyInto

func (in *APIGatewayGatewayStatus) DeepCopyInto(out *APIGatewayGatewayStatus)

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

type ApiconfigBackendConfig

type ApiconfigBackendConfig struct {
	/* Immutable. Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured
	(https://cloud.google.com/service-infrastructure/docs/service-management/reference/rest/v1/services.configs#backend). */
	GoogleServiceAccount string `json:"googleServiceAccount"`
}

func (*ApiconfigBackendConfig) DeepCopy

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

func (*ApiconfigBackendConfig) DeepCopyInto

func (in *ApiconfigBackendConfig) DeepCopyInto(out *ApiconfigBackendConfig)

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

type ApiconfigDocument

type ApiconfigDocument struct {
	/* Immutable. Base64 encoded content of the file. */
	Contents string `json:"contents"`

	/* Immutable. The file path (full or relative path). This is typically the path of the file when it is uploaded. */
	Path string `json:"path"`
}

func (*ApiconfigDocument) DeepCopy

func (in *ApiconfigDocument) DeepCopy() *ApiconfigDocument

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

func (*ApiconfigDocument) DeepCopyInto

func (in *ApiconfigDocument) DeepCopyInto(out *ApiconfigDocument)

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

type ApiconfigFileDescriptorSet

type ApiconfigFileDescriptorSet struct {
	/* Immutable. Base64 encoded content of the file. */
	Contents string `json:"contents"`

	/* Immutable. The file path (full or relative path). This is typically the path of the file when it is uploaded. */
	Path string `json:"path"`
}

func (*ApiconfigFileDescriptorSet) DeepCopy

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

func (*ApiconfigFileDescriptorSet) DeepCopyInto

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

type ApiconfigGatewayConfig

type ApiconfigGatewayConfig struct {
	/* Backend settings that are applied to all backends of the Gateway. */
	BackendConfig ApiconfigBackendConfig `json:"backendConfig"`
}

func (*ApiconfigGatewayConfig) DeepCopy

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

func (*ApiconfigGatewayConfig) DeepCopyInto

func (in *ApiconfigGatewayConfig) DeepCopyInto(out *ApiconfigGatewayConfig)

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

type ApiconfigGrpcServices

type ApiconfigGrpcServices struct {
	/* Immutable. Input only. File descriptor set, generated by protoc.
	To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb.

	$ protoc --include_imports --include_source_info test.proto -o out.pb. */
	FileDescriptorSet ApiconfigFileDescriptorSet `json:"fileDescriptorSet"`

	/* Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate fileDescriptorSet. */
	// +optional
	Source []ApiconfigSource `json:"source,omitempty"`
}

func (*ApiconfigGrpcServices) DeepCopy

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

func (*ApiconfigGrpcServices) DeepCopyInto

func (in *ApiconfigGrpcServices) DeepCopyInto(out *ApiconfigGrpcServices)

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

type ApiconfigManagedServiceConfigs

type ApiconfigManagedServiceConfigs struct {
	/* Immutable. Base64 encoded content of the file. */
	Contents string `json:"contents"`

	/* Immutable. The file path (full or relative path). This is typically the path of the file when it is uploaded. */
	Path string `json:"path"`
}

func (*ApiconfigManagedServiceConfigs) DeepCopy

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

func (*ApiconfigManagedServiceConfigs) DeepCopyInto

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

type ApiconfigOpenapiDocuments

type ApiconfigOpenapiDocuments struct {
	/* The OpenAPI Specification document file. */
	Document ApiconfigDocument `json:"document"`
}

func (*ApiconfigOpenapiDocuments) DeepCopy

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

func (*ApiconfigOpenapiDocuments) DeepCopyInto

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

type ApiconfigSource

type ApiconfigSource struct {
	/* Immutable. Base64 encoded content of the file. */
	Contents string `json:"contents"`

	/* Immutable. The file path (full or relative path). This is typically the path of the file when it is uploaded. */
	Path string `json:"path"`
}

func (*ApiconfigSource) DeepCopy

func (in *ApiconfigSource) DeepCopy() *ApiconfigSource

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

func (*ApiconfigSource) DeepCopyInto

func (in *ApiconfigSource) DeepCopyInto(out *ApiconfigSource)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL