v1alpha2

package
v0.31.2 Latest Latest
Warning

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

Go to latest
Published: May 22, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIBindingApplyConfiguration

type APIBindingApplyConfiguration struct {
	v1.TypeMetaApplyConfiguration    `json:",inline"`
	*v1.ObjectMetaApplyConfiguration `json:"metadata,omitempty"`
	// Spec holds the desired state.
	Spec *APIBindingSpecApplyConfiguration `json:"spec,omitempty"`
	// Status communicates the observed state.
	Status *APIBindingStatusApplyConfiguration `json:"status,omitempty"`
}

APIBindingApplyConfiguration represents a declarative configuration of the APIBinding type for use with apply.

APIBinding enables a set of resources and their behaviour through an external service provider in this workspace.

The service provider uses an APIExport to expose the API.

func APIBinding

func APIBinding(name string) *APIBindingApplyConfiguration

APIBinding constructs a declarative configuration of the APIBinding type for use with apply.

func (*APIBindingApplyConfiguration) GetAPIVersion added in v0.30.0

func (b *APIBindingApplyConfiguration) GetAPIVersion() *string

GetAPIVersion retrieves the value of the APIVersion field in the declarative configuration.

func (*APIBindingApplyConfiguration) GetKind added in v0.30.0

func (b *APIBindingApplyConfiguration) GetKind() *string

GetKind retrieves the value of the Kind field in the declarative configuration.

func (*APIBindingApplyConfiguration) GetName

func (b *APIBindingApplyConfiguration) GetName() *string

GetName retrieves the value of the Name field in the declarative configuration.

func (*APIBindingApplyConfiguration) GetNamespace added in v0.30.0

func (b *APIBindingApplyConfiguration) GetNamespace() *string

GetNamespace retrieves the value of the Namespace field in the declarative configuration.

func (APIBindingApplyConfiguration) IsApplyConfiguration added in v0.30.0

func (b APIBindingApplyConfiguration) IsApplyConfiguration()

func (*APIBindingApplyConfiguration) WithAPIVersion

WithAPIVersion sets the APIVersion field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIVersion field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithAnnotations

WithAnnotations puts the entries into the Annotations field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Annotations field, overwriting an existing map entries in Annotations field with the same key.

func (*APIBindingApplyConfiguration) WithCreationTimestamp

func (b *APIBindingApplyConfiguration) WithCreationTimestamp(value metav1.Time) *APIBindingApplyConfiguration

WithCreationTimestamp sets the CreationTimestamp field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the CreationTimestamp field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithDeletionGracePeriodSeconds

func (b *APIBindingApplyConfiguration) WithDeletionGracePeriodSeconds(value int64) *APIBindingApplyConfiguration

WithDeletionGracePeriodSeconds sets the DeletionGracePeriodSeconds field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DeletionGracePeriodSeconds field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithDeletionTimestamp

func (b *APIBindingApplyConfiguration) WithDeletionTimestamp(value metav1.Time) *APIBindingApplyConfiguration

WithDeletionTimestamp sets the DeletionTimestamp field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DeletionTimestamp field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithFinalizers

WithFinalizers adds the given value to the Finalizers field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Finalizers field.

func (*APIBindingApplyConfiguration) WithGenerateName

WithGenerateName sets the GenerateName field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the GenerateName field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithGeneration

WithGeneration sets the Generation field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Generation field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithKind

WithKind sets the Kind field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Kind field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithLabels

WithLabels puts the entries into the Labels field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Labels field, overwriting an existing map entries in Labels field with the same key.

func (*APIBindingApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithNamespace

WithNamespace sets the Namespace field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Namespace field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithOwnerReferences

WithOwnerReferences adds the given value to the OwnerReferences field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the OwnerReferences field.

func (*APIBindingApplyConfiguration) WithResourceVersion

func (b *APIBindingApplyConfiguration) WithResourceVersion(value string) *APIBindingApplyConfiguration

WithResourceVersion sets the ResourceVersion field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ResourceVersion field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithSpec

WithSpec sets the Spec field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Spec field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithStatus

WithStatus sets the Status field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Status field is set to the value of the last call.

func (*APIBindingApplyConfiguration) WithUID

WithUID sets the UID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the UID field is set to the value of the last call.

type APIBindingSpecApplyConfiguration

type APIBindingSpecApplyConfiguration struct {
	// reference uniquely identifies an API to bind to.
	Reference *BindingReferenceApplyConfiguration `json:"reference,omitempty"`
	// permissionClaims records decisions about permission claims requested by the API service provider.
	// Individual claims can be accepted or rejected. If accepted, the API service provider gets the
	// requested access to the specified resources in this workspace. Access is granted per
	// GroupResource, identity, and other properties.
	PermissionClaims []AcceptablePermissionClaimApplyConfiguration `json:"permissionClaims,omitempty"`
}

APIBindingSpecApplyConfiguration represents a declarative configuration of the APIBindingSpec type for use with apply.

APIBindingSpec records the APIs and implementations that are to be bound.

func APIBindingSpec

func APIBindingSpec() *APIBindingSpecApplyConfiguration

APIBindingSpecApplyConfiguration constructs a declarative configuration of the APIBindingSpec type for use with apply.

func (*APIBindingSpecApplyConfiguration) WithPermissionClaims

WithPermissionClaims adds the given value to the PermissionClaims field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the PermissionClaims field.

func (*APIBindingSpecApplyConfiguration) WithReference

WithReference sets the Reference field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Reference field is set to the value of the last call.

type APIBindingStatusApplyConfiguration

type APIBindingStatusApplyConfiguration struct {
	// APIExportClusterName records the name (not path) of the logical cluster that contains the APIExport.
	APIExportClusterName *string `json:"apiExportClusterName,omitempty"`
	// boundResources records the state of bound APIs.
	BoundResources []BoundAPIResourceApplyConfiguration `json:"boundResources,omitempty"`
	// phase is the current phase of the APIBinding:
	// - "": the APIBinding has just been created, waiting to be bound.
	// - Binding: the APIBinding is being bound.
	// - Bound: the APIBinding is bound and the referenced APIs are available in the workspace.
	Phase *apisv1alpha2.APIBindingPhaseType `json:"phase,omitempty"`
	// conditions is a list of conditions that apply to the APIBinding.
	Conditions *v1alpha1.Conditions `json:"conditions,omitempty"`
	// appliedPermissionClaims is a list of the permission claims the system has seen and applied,
	// according to the requests of the API service provider in the APIExport and the acceptance
	// state in spec.permissionClaims.
	AppliedPermissionClaims []ScopedPermissionClaimApplyConfiguration `json:"appliedPermissionClaims,omitempty"`
	// exportPermissionClaims records the permissions that the export provider is asking for
	// the binding to grant.
	ExportPermissionClaims []PermissionClaimApplyConfiguration `json:"exportPermissionClaims,omitempty"`
}

APIBindingStatusApplyConfiguration represents a declarative configuration of the APIBindingStatus type for use with apply.

APIBindingStatus records which schemas are bound.

func APIBindingStatus

func APIBindingStatus() *APIBindingStatusApplyConfiguration

APIBindingStatusApplyConfiguration constructs a declarative configuration of the APIBindingStatus type for use with apply.

func (*APIBindingStatusApplyConfiguration) WithAPIExportClusterName

WithAPIExportClusterName sets the APIExportClusterName field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIExportClusterName field is set to the value of the last call.

func (*APIBindingStatusApplyConfiguration) WithAppliedPermissionClaims

WithAppliedPermissionClaims adds the given value to the AppliedPermissionClaims field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the AppliedPermissionClaims field.

func (*APIBindingStatusApplyConfiguration) WithBoundResources

WithBoundResources adds the given value to the BoundResources field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the BoundResources field.

func (*APIBindingStatusApplyConfiguration) WithConditions

WithConditions sets the Conditions field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Conditions field is set to the value of the last call.

func (*APIBindingStatusApplyConfiguration) WithExportPermissionClaims

WithExportPermissionClaims adds the given value to the ExportPermissionClaims field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the ExportPermissionClaims field.

func (*APIBindingStatusApplyConfiguration) WithPhase

WithPhase sets the Phase field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Phase field is set to the value of the last call.

type APIExportApplyConfiguration

type APIExportApplyConfiguration struct {
	v1.TypeMetaApplyConfiguration    `json:",inline"`
	*v1.ObjectMetaApplyConfiguration `json:"metadata,omitempty"`
	// Spec holds the desired state.
	Spec *APIExportSpecApplyConfiguration `json:"spec,omitempty"`
	// Status communicates the observed state.
	Status *APIExportStatusApplyConfiguration `json:"status,omitempty"`
}

APIExportApplyConfiguration represents a declarative configuration of the APIExport type for use with apply.

APIExport registers an API and implementation to allow consumption by others through APIBindings.

func APIExport

func APIExport(name string) *APIExportApplyConfiguration

APIExport constructs a declarative configuration of the APIExport type for use with apply.

func (*APIExportApplyConfiguration) GetAPIVersion added in v0.30.0

func (b *APIExportApplyConfiguration) GetAPIVersion() *string

GetAPIVersion retrieves the value of the APIVersion field in the declarative configuration.

func (*APIExportApplyConfiguration) GetKind added in v0.30.0

func (b *APIExportApplyConfiguration) GetKind() *string

GetKind retrieves the value of the Kind field in the declarative configuration.

func (*APIExportApplyConfiguration) GetName

func (b *APIExportApplyConfiguration) GetName() *string

GetName retrieves the value of the Name field in the declarative configuration.

func (*APIExportApplyConfiguration) GetNamespace added in v0.30.0

func (b *APIExportApplyConfiguration) GetNamespace() *string

GetNamespace retrieves the value of the Namespace field in the declarative configuration.

func (APIExportApplyConfiguration) IsApplyConfiguration added in v0.30.0

func (b APIExportApplyConfiguration) IsApplyConfiguration()

func (*APIExportApplyConfiguration) WithAPIVersion

WithAPIVersion sets the APIVersion field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIVersion field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithAnnotations

func (b *APIExportApplyConfiguration) WithAnnotations(entries map[string]string) *APIExportApplyConfiguration

WithAnnotations puts the entries into the Annotations field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Annotations field, overwriting an existing map entries in Annotations field with the same key.

func (*APIExportApplyConfiguration) WithCreationTimestamp

func (b *APIExportApplyConfiguration) WithCreationTimestamp(value metav1.Time) *APIExportApplyConfiguration

WithCreationTimestamp sets the CreationTimestamp field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the CreationTimestamp field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithDeletionGracePeriodSeconds

func (b *APIExportApplyConfiguration) WithDeletionGracePeriodSeconds(value int64) *APIExportApplyConfiguration

WithDeletionGracePeriodSeconds sets the DeletionGracePeriodSeconds field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DeletionGracePeriodSeconds field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithDeletionTimestamp

func (b *APIExportApplyConfiguration) WithDeletionTimestamp(value metav1.Time) *APIExportApplyConfiguration

WithDeletionTimestamp sets the DeletionTimestamp field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DeletionTimestamp field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithFinalizers

func (b *APIExportApplyConfiguration) WithFinalizers(values ...string) *APIExportApplyConfiguration

WithFinalizers adds the given value to the Finalizers field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Finalizers field.

func (*APIExportApplyConfiguration) WithGenerateName

WithGenerateName sets the GenerateName field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the GenerateName field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithGeneration

WithGeneration sets the Generation field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Generation field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithKind

WithKind sets the Kind field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Kind field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithLabels

WithLabels puts the entries into the Labels field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Labels field, overwriting an existing map entries in Labels field with the same key.

func (*APIExportApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithNamespace

WithNamespace sets the Namespace field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Namespace field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithOwnerReferences

WithOwnerReferences adds the given value to the OwnerReferences field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the OwnerReferences field.

func (*APIExportApplyConfiguration) WithResourceVersion

func (b *APIExportApplyConfiguration) WithResourceVersion(value string) *APIExportApplyConfiguration

WithResourceVersion sets the ResourceVersion field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ResourceVersion field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithSpec

WithSpec sets the Spec field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Spec field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithStatus

WithStatus sets the Status field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Status field is set to the value of the last call.

func (*APIExportApplyConfiguration) WithUID

WithUID sets the UID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the UID field is set to the value of the last call.

type APIExportSpecApplyConfiguration

type APIExportSpecApplyConfiguration struct {
	// Resources records the APIResourceSchemas that are exposed with this
	// APIExport.
	//
	// The schemas can be changed in the life-cycle of the APIExport. These changes
	// have no effect on existing APIBindings, but only on newly bound ones.
	//
	// For updating existing APIBindings, use an APIDeployment keeping bound
	// workspaces up-to-date.
	Resources []ResourceSchemaApplyConfiguration `json:"resources,omitempty"`
	// identity points to a secret that contains the API identity in the 'key' file.
	// The API identity determines an unique etcd prefix for objects stored via this
	// APIExport.
	//
	// Different APIExport in a workspace can share a common identity, or have different
	// ones. The identity (the secret) can also be transferred to another workspace
	// when the APIExport is moved.
	//
	// The identity is a secret of the API provider. The APIBindings referencing this APIExport
	// will store a derived, non-sensitive value of this identity.
	//
	// The identity of an APIExport cannot be changed. A derived, non-sensitive value of
	// the identity key is stored in the APIExport status and this value is immutable.
	//
	// The identity is defaulted. A secret with the name of the APIExport is automatically
	// created.
	Identity *IdentityApplyConfiguration `json:"identity,omitempty"`
	// maximalPermissionPolicy will allow for a service provider to set an upper bound on what is allowed
	// for a consumer of this API. If the policy is not set, no upper bound is applied,
	// i.e the consuming users can do whatever the user workspace allows the user to do.
	//
	// The policy consists of RBAC (Cluster)Roles and (Cluster)Bindings. A request of a user in
	// a workspace that binds to this APIExport via an APIBinding is additionally checked against
	// these rules, with the user name and the groups prefixed with `apis.kcp.io:binding:`.
	//
	// For example: assume a user `adam` with groups `system:authenticated` and `a-team` binds to
	// this APIExport in another workspace root:org:ws. Then a request in that workspace
	// against a resource of this APIExport is authorized as every other request in that workspace,
	// but in addition the RBAC policy here in the APIExport workspace has to grant access to the
	// user `apis.kcp.io:binding:adam` with the groups `apis.kcp.io:binding:system:authenticated`
	// and `apis.kcp.io:binding:a-team`.
	MaximalPermissionPolicy *MaximalPermissionPolicyApplyConfiguration `json:"maximalPermissionPolicy,omitempty"`
	// permissionClaims make resources available in APIExport's virtual workspace that are not part
	// of the actual APIExport resources.
	//
	// PermissionClaims are optional and should be the least access necessary to complete the functions
	// that the service provider needs. Access is asked for on a GroupResource + identity basis.
	//
	// PermissionClaims must be accepted by the user's explicit acknowledgement. Hence, when claims
	// change, the respecting objects are not visible immediately.
	//
	// PermissionClaims overlapping with the APIExport resources are ignored.
	PermissionClaims []PermissionClaimApplyConfiguration `json:"permissionClaims,omitempty"`
}

APIExportSpecApplyConfiguration represents a declarative configuration of the APIExportSpec type for use with apply.

APIExportSpec defines the desired state of APIExport.

func APIExportSpec

func APIExportSpec() *APIExportSpecApplyConfiguration

APIExportSpecApplyConfiguration constructs a declarative configuration of the APIExportSpec type for use with apply.

func (*APIExportSpecApplyConfiguration) WithIdentity

WithIdentity sets the Identity field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Identity field is set to the value of the last call.

func (*APIExportSpecApplyConfiguration) WithMaximalPermissionPolicy

WithMaximalPermissionPolicy sets the MaximalPermissionPolicy field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the MaximalPermissionPolicy field is set to the value of the last call.

func (*APIExportSpecApplyConfiguration) WithPermissionClaims

WithPermissionClaims adds the given value to the PermissionClaims field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the PermissionClaims field.

func (*APIExportSpecApplyConfiguration) WithResources

WithResources adds the given value to the Resources field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Resources field.

type APIExportStatusApplyConfiguration

type APIExportStatusApplyConfiguration struct {
	// identityHash is the hash of the API identity key of this APIExport. This value
	// is immutable as soon as it is set.
	IdentityHash *string `json:"identityHash,omitempty"`
	// conditions is a list of conditions that apply to the APIExport.
	Conditions *v1alpha1.Conditions `json:"conditions,omitempty"`
	// virtualWorkspaces contains all APIExport virtual workspace URLs.
	// this field is empty unless kcp has been started with the
	// 'EnableDeprecatedAPIExportVirtualWorkspacesUrls' feature gate.
	//
	// Deprecated: use APIExportEndpointSlice.status.endpoints instead. This
	// field will be removed in an upcoming API version.
	VirtualWorkspaces []VirtualWorkspaceApplyConfiguration `json:"virtualWorkspaces,omitempty"`
}

APIExportStatusApplyConfiguration represents a declarative configuration of the APIExportStatus type for use with apply.

APIExportStatus defines the observed state of APIExport.

func APIExportStatus

func APIExportStatus() *APIExportStatusApplyConfiguration

APIExportStatusApplyConfiguration constructs a declarative configuration of the APIExportStatus type for use with apply.

func (*APIExportStatusApplyConfiguration) WithConditions

WithConditions sets the Conditions field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Conditions field is set to the value of the last call.

func (*APIExportStatusApplyConfiguration) WithIdentityHash

WithIdentityHash sets the IdentityHash field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the IdentityHash field is set to the value of the last call.

func (*APIExportStatusApplyConfiguration) WithVirtualWorkspaces

WithVirtualWorkspaces adds the given value to the VirtualWorkspaces field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the VirtualWorkspaces field.

type AcceptablePermissionClaimApplyConfiguration

type AcceptablePermissionClaimApplyConfiguration struct {
	ScopedPermissionClaimApplyConfiguration `json:",inline"`
	State                                   *apisv1alpha2.AcceptablePermissionClaimState `json:"state,omitempty"`
}

AcceptablePermissionClaimApplyConfiguration represents a declarative configuration of the AcceptablePermissionClaim type for use with apply.

AcceptablePermissionClaim is a PermissionClaim that records if the user accepts or rejects it.

func AcceptablePermissionClaim

func AcceptablePermissionClaim() *AcceptablePermissionClaimApplyConfiguration

AcceptablePermissionClaimApplyConfiguration constructs a declarative configuration of the AcceptablePermissionClaim type for use with apply.

func (*AcceptablePermissionClaimApplyConfiguration) WithDefaultSelector added in v0.31.0

WithDefaultSelector sets the DefaultSelector field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DefaultSelector field is set to the value of the last call.

func (*AcceptablePermissionClaimApplyConfiguration) WithGroup

WithGroup sets the Group field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Group field is set to the value of the last call.

func (*AcceptablePermissionClaimApplyConfiguration) WithIdentityHash

WithIdentityHash sets the IdentityHash field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the IdentityHash field is set to the value of the last call.

func (*AcceptablePermissionClaimApplyConfiguration) WithResource

WithResource sets the Resource field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Resource field is set to the value of the last call.

func (*AcceptablePermissionClaimApplyConfiguration) WithSelector

WithSelector sets the Selector field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Selector field is set to the value of the last call.

func (*AcceptablePermissionClaimApplyConfiguration) WithState

WithState sets the State field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the State field is set to the value of the last call.

func (*AcceptablePermissionClaimApplyConfiguration) WithVerbs

WithVerbs adds the given value to the Verbs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Verbs field.

type BindingReferenceApplyConfiguration

type BindingReferenceApplyConfiguration struct {
	// export is a reference to an APIExport by cluster name and export name.
	// The creator of the APIBinding needs to have access to the APIExport with the
	// verb `bind` in order to bind to it.
	Export *ExportBindingReferenceApplyConfiguration `json:"export,omitempty"`
}

BindingReferenceApplyConfiguration represents a declarative configuration of the BindingReference type for use with apply.

BindingReference describes a reference to an APIExport. Exactly one of the fields must be set.

func BindingReference

func BindingReference() *BindingReferenceApplyConfiguration

BindingReferenceApplyConfiguration constructs a declarative configuration of the BindingReference type for use with apply.

func (*BindingReferenceApplyConfiguration) WithExport

WithExport sets the Export field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Export field is set to the value of the last call.

type BoundAPIResourceApplyConfiguration

type BoundAPIResourceApplyConfiguration struct {
	// group is the group of the bound API. Empty string for the core API group.
	Group *string `json:"group,omitempty"`
	// resource is the resource of the bound API.
	//
	// kubebuilder:validation:MinLength=1
	Resource *string `json:"resource,omitempty"`
	// Schema references the APIResourceSchema that is bound to this API.
	Schema *BoundAPIResourceSchemaApplyConfiguration `json:"schema,omitempty"`
	// storageVersions lists all versions of a resource that were ever persisted. Tracking these
	// versions allows a migration path for stored versions in etcd. The field is mutable
	// so a migration controller can finish a migration to another version (ensuring
	// no old objects are left in storage), and then remove the rest of the
	// versions from this list.
	//
	// Versions may not be removed while they exist in this list.
	StorageVersions []string `json:"storageVersions,omitempty"`
}

BoundAPIResourceApplyConfiguration represents a declarative configuration of the BoundAPIResource type for use with apply.

BoundAPIResource describes a bound GroupVersionResource through an APIResourceSchema of an APIExport..

func BoundAPIResource

func BoundAPIResource() *BoundAPIResourceApplyConfiguration

BoundAPIResourceApplyConfiguration constructs a declarative configuration of the BoundAPIResource type for use with apply.

func (*BoundAPIResourceApplyConfiguration) WithGroup

WithGroup sets the Group field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Group field is set to the value of the last call.

func (*BoundAPIResourceApplyConfiguration) WithResource

WithResource sets the Resource field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Resource field is set to the value of the last call.

func (*BoundAPIResourceApplyConfiguration) WithSchema

WithSchema sets the Schema field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Schema field is set to the value of the last call.

func (*BoundAPIResourceApplyConfiguration) WithStorageVersions

WithStorageVersions adds the given value to the StorageVersions field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the StorageVersions field.

type BoundAPIResourceSchemaApplyConfiguration

type BoundAPIResourceSchemaApplyConfiguration struct {
	// name is the bound APIResourceSchema name.
	Name *string `json:"name,omitempty"`
	// UID is the UID of the APIResourceSchema that is bound to this API.
	UID *string `json:"UID,omitempty"`
	// identityHash is the hash of the API identity that this schema is bound to.
	// The API identity determines the etcd prefix used to persist the object.
	// Different identity means that the objects are effectively served and stored
	// under a distinct resource. A CRD of the same GroupVersionResource uses a
	// different identity and hence a separate etcd prefix.
	IdentityHash *string `json:"identityHash,omitempty"`
}

BoundAPIResourceSchemaApplyConfiguration represents a declarative configuration of the BoundAPIResourceSchema type for use with apply.

BoundAPIResourceSchema is a reference to an APIResourceSchema.

func BoundAPIResourceSchema

func BoundAPIResourceSchema() *BoundAPIResourceSchemaApplyConfiguration

BoundAPIResourceSchemaApplyConfiguration constructs a declarative configuration of the BoundAPIResourceSchema type for use with apply.

func (*BoundAPIResourceSchemaApplyConfiguration) WithIdentityHash

WithIdentityHash sets the IdentityHash field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the IdentityHash field is set to the value of the last call.

func (*BoundAPIResourceSchemaApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*BoundAPIResourceSchemaApplyConfiguration) WithUID

WithUID sets the UID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the UID field is set to the value of the last call.

type ExportBindingReferenceApplyConfiguration

type ExportBindingReferenceApplyConfiguration struct {
	// path is a logical cluster path where the APIExport is defined.
	// If the path is unset, the logical cluster of the APIBinding is used.
	Path *string `json:"path,omitempty"`
	// name is the name of the APIExport that describes the API.
	Name *string `json:"name,omitempty"`
}

ExportBindingReferenceApplyConfiguration represents a declarative configuration of the ExportBindingReference type for use with apply.

ExportBindingReference is a reference to an APIExport by cluster and name.

func ExportBindingReference

func ExportBindingReference() *ExportBindingReferenceApplyConfiguration

ExportBindingReferenceApplyConfiguration constructs a declarative configuration of the ExportBindingReference type for use with apply.

func (*ExportBindingReferenceApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*ExportBindingReferenceApplyConfiguration) WithPath

WithPath sets the Path field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Path field is set to the value of the last call.

type GroupResourceApplyConfiguration

type GroupResourceApplyConfiguration struct {
	// group is the name of an API group.
	// For core groups this is the empty string '""'.
	Group *string `json:"group,omitempty"`
	// resource is the name of the resource.
	// Note: it is worth noting that you can not ask for permissions for resource provided by a CRD
	// not provided by an api export.
	Resource *string `json:"resource,omitempty"`
}

GroupResourceApplyConfiguration represents a declarative configuration of the GroupResource type for use with apply.

GroupResource identifies a resource.

func GroupResource

func GroupResource() *GroupResourceApplyConfiguration

GroupResourceApplyConfiguration constructs a declarative configuration of the GroupResource type for use with apply.

func (*GroupResourceApplyConfiguration) WithGroup

WithGroup sets the Group field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Group field is set to the value of the last call.

func (*GroupResourceApplyConfiguration) WithResource

WithResource sets the Resource field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Resource field is set to the value of the last call.

type IdentityApplyConfiguration

type IdentityApplyConfiguration struct {
	// secretRef is a reference to a secret that contains the API identity in the 'key' file.
	SecretRef *v1.SecretReference `json:"secretRef,omitempty"`
}

IdentityApplyConfiguration represents a declarative configuration of the Identity type for use with apply.

Identity defines the identity of an APIExport, i.e. determines the etcd prefix data of this APIExport are stored under.

func Identity

func Identity() *IdentityApplyConfiguration

IdentityApplyConfiguration constructs a declarative configuration of the Identity type for use with apply.

func (*IdentityApplyConfiguration) WithSecretRef

WithSecretRef sets the SecretRef field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SecretRef field is set to the value of the last call.

type MaximalPermissionPolicyApplyConfiguration

type MaximalPermissionPolicyApplyConfiguration struct {
	// local is the policy that is defined in same workspace as the API Export.
	Local *apisv1alpha2.LocalAPIExportPolicy `json:"local,omitempty"`
}

MaximalPermissionPolicyApplyConfiguration represents a declarative configuration of the MaximalPermissionPolicy type for use with apply.

MaximalPermissionPolicy is a wrapper type around the multiple options that would be allowed.

func MaximalPermissionPolicy

func MaximalPermissionPolicy() *MaximalPermissionPolicyApplyConfiguration

MaximalPermissionPolicyApplyConfiguration constructs a declarative configuration of the MaximalPermissionPolicy type for use with apply.

func (*MaximalPermissionPolicyApplyConfiguration) WithLocal

WithLocal sets the Local field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Local field is set to the value of the last call.

type PermissionClaimApplyConfiguration

type PermissionClaimApplyConfiguration struct {
	GroupResourceApplyConfiguration `json:",inline"`
	// verbs is a list of supported API operation types (this includes
	// but is not limited to get, list, watch, create, update, patch,
	// delete, deletecollection, and proxy).
	Verbs []string `json:"verbs,omitempty"`
	// This is the identity for a given APIExport that the APIResourceSchema belongs to.
	// The hash can be found on APIExport and APIResourceSchema's status.
	// It will be empty for core types.
	// Note that one must look this up for a particular kcp instance.
	IdentityHash *string `json:"identityHash,omitempty"`
	// defaultSelector is the default selector to use when creating APIBindings
	// via WorkspaceType's defaultAPIBindings. If not set, the APIBinding will
	// default to matchAll: true.
	//
	// This allows API providers to suggest a default scope for permission claims
	// that will be used when workspaces are automatically created with default
	// APIBindings. Users can always override the default selector by accepting the
	// claim with a different selector or by manually creating APIBindings with a custom selector.
	DefaultSelector *PermissionClaimSelectorApplyConfiguration `json:"defaultSelector,omitempty"`
}

PermissionClaimApplyConfiguration represents a declarative configuration of the PermissionClaim type for use with apply.

PermissionClaim identifies an object by GR and identity hash. Its purpose is to determine the added permissions that a service provider may request and that a consumer may accept and allow the service provider access to.

func PermissionClaim

func PermissionClaim() *PermissionClaimApplyConfiguration

PermissionClaimApplyConfiguration constructs a declarative configuration of the PermissionClaim type for use with apply.

func (*PermissionClaimApplyConfiguration) WithDefaultSelector added in v0.31.0

WithDefaultSelector sets the DefaultSelector field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DefaultSelector field is set to the value of the last call.

func (*PermissionClaimApplyConfiguration) WithGroup

WithGroup sets the Group field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Group field is set to the value of the last call.

func (*PermissionClaimApplyConfiguration) WithIdentityHash

WithIdentityHash sets the IdentityHash field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the IdentityHash field is set to the value of the last call.

func (*PermissionClaimApplyConfiguration) WithResource

WithResource sets the Resource field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Resource field is set to the value of the last call.

func (*PermissionClaimApplyConfiguration) WithVerbs

WithVerbs adds the given value to the Verbs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Verbs field.

type PermissionClaimSelectorApplyConfiguration

type PermissionClaimSelectorApplyConfiguration struct {
	v1.LabelSelectorApplyConfiguration `json:",inline"`
	// matchAll grants access to all objects of the claimed resource.
	MatchAll *bool `json:"matchAll,omitempty"`
}

PermissionClaimSelectorApplyConfiguration represents a declarative configuration of the PermissionClaimSelector type for use with apply.

PermissionClaimSelector configures scoped access to objects of a claimed resource.

func PermissionClaimSelector

func PermissionClaimSelector() *PermissionClaimSelectorApplyConfiguration

PermissionClaimSelectorApplyConfiguration constructs a declarative configuration of the PermissionClaimSelector type for use with apply.

func (*PermissionClaimSelectorApplyConfiguration) WithMatchAll

WithMatchAll sets the MatchAll field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the MatchAll field is set to the value of the last call.

func (*PermissionClaimSelectorApplyConfiguration) WithMatchExpressions

WithMatchExpressions adds the given value to the MatchExpressions field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the MatchExpressions field.

func (*PermissionClaimSelectorApplyConfiguration) WithMatchLabels

WithMatchLabels puts the entries into the MatchLabels field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the MatchLabels field, overwriting an existing map entries in MatchLabels field with the same key.

type ResourceSchemaApplyConfiguration

type ResourceSchemaApplyConfiguration struct {
	// Name is the name of the resource.
	Name *string `json:"name,omitempty"`
	// Group is the API group of the resource. Empty string represents the core group.
	Group *string `json:"group,omitempty"`
	// Schema is the name of the referenced APIResourceSchema. This must be of the format
	// "<version>.<name>.<group>".
	Schema *string `json:"schema,omitempty"`
	// Storage defines how the resource is stored.
	Storage *ResourceSchemaStorageApplyConfiguration `json:"storage,omitempty"`
}

ResourceSchemaApplyConfiguration represents a declarative configuration of the ResourceSchema type for use with apply.

ResourceSchema defines the resource schemas that are exposed with this APIExport.

func ResourceSchema

func ResourceSchema() *ResourceSchemaApplyConfiguration

ResourceSchemaApplyConfiguration constructs a declarative configuration of the ResourceSchema type for use with apply.

func (*ResourceSchemaApplyConfiguration) WithGroup

WithGroup sets the Group field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Group field is set to the value of the last call.

func (*ResourceSchemaApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*ResourceSchemaApplyConfiguration) WithSchema

WithSchema sets the Schema field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Schema field is set to the value of the last call.

func (*ResourceSchemaApplyConfiguration) WithStorage

WithStorage sets the Storage field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Storage field is set to the value of the last call.

type ResourceSchemaStorageApplyConfiguration

type ResourceSchemaStorageApplyConfiguration struct {
	// CRD storage defines that this APIResourceSchema is exposed as
	// CustomResourceDefinitions inside the workspaces that bind to the APIExport.
	// Like in vanilla Kubernetes, users can then create, update and delete
	// custom resources.
	CRD *apisv1alpha2.ResourceSchemaStorageCRD `json:"crd,omitempty"`
	// Virtual storage defines that this APIResourceSchema is exposed as
	// a projection of the referenced resource inside the workspaces that
	// bind to the APIExport.
	Virtual *ResourceSchemaStorageVirtualApplyConfiguration `json:"virtual,omitempty"`
}

ResourceSchemaStorageApplyConfiguration represents a declarative configuration of the ResourceSchemaStorage type for use with apply.

ResourceSchemaStorage defines how the resource is stored.

func ResourceSchemaStorage

func ResourceSchemaStorage() *ResourceSchemaStorageApplyConfiguration

ResourceSchemaStorageApplyConfiguration constructs a declarative configuration of the ResourceSchemaStorage type for use with apply.

func (*ResourceSchemaStorageApplyConfiguration) WithCRD

WithCRD sets the CRD field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the CRD field is set to the value of the last call.

func (*ResourceSchemaStorageApplyConfiguration) WithVirtual

WithVirtual sets the Virtual field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Virtual field is set to the value of the last call.

type ResourceSchemaStorageVirtualApplyConfiguration

type ResourceSchemaStorageVirtualApplyConfiguration struct {
	// Reference points to another object that has a URL to a virtual workspace
	// in a "url" field in its status. The object can be of any kind.
	Reference *v1.TypedLocalObjectReference `json:"reference,omitempty"`
	// IdentityHash is the identity of the virtual resource.
	IdentityHash *string `json:"identityHash,omitempty"`
}

ResourceSchemaStorageVirtualApplyConfiguration represents a declarative configuration of the ResourceSchemaStorageVirtual type for use with apply.

ResourceSchemaStorageVirtual refers to an endpoint slice object from which the virtual resource is served.

func ResourceSchemaStorageVirtual

func ResourceSchemaStorageVirtual() *ResourceSchemaStorageVirtualApplyConfiguration

ResourceSchemaStorageVirtualApplyConfiguration constructs a declarative configuration of the ResourceSchemaStorageVirtual type for use with apply.

func (*ResourceSchemaStorageVirtualApplyConfiguration) WithIdentityHash

WithIdentityHash sets the IdentityHash field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the IdentityHash field is set to the value of the last call.

func (*ResourceSchemaStorageVirtualApplyConfiguration) WithReference

WithReference sets the Reference field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Reference field is set to the value of the last call.

type ScopedPermissionClaimApplyConfiguration

type ScopedPermissionClaimApplyConfiguration struct {
	PermissionClaimApplyConfiguration `json:",inline"`
	Selector                          *PermissionClaimSelectorApplyConfiguration `json:"selector,omitempty"`
}

ScopedPermissionClaimApplyConfiguration represents a declarative configuration of the ScopedPermissionClaim type for use with apply.

ScopedPermissionClaim embeds a PermissionClaim and adds a selector to scope down access to objects of the claimed resource.

func ScopedPermissionClaim

func ScopedPermissionClaim() *ScopedPermissionClaimApplyConfiguration

ScopedPermissionClaimApplyConfiguration constructs a declarative configuration of the ScopedPermissionClaim type for use with apply.

func (*ScopedPermissionClaimApplyConfiguration) WithDefaultSelector added in v0.31.0

WithDefaultSelector sets the DefaultSelector field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DefaultSelector field is set to the value of the last call.

func (*ScopedPermissionClaimApplyConfiguration) WithGroup

WithGroup sets the Group field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Group field is set to the value of the last call.

func (*ScopedPermissionClaimApplyConfiguration) WithIdentityHash

WithIdentityHash sets the IdentityHash field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the IdentityHash field is set to the value of the last call.

func (*ScopedPermissionClaimApplyConfiguration) WithResource

WithResource sets the Resource field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Resource field is set to the value of the last call.

func (*ScopedPermissionClaimApplyConfiguration) WithSelector

WithSelector sets the Selector field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Selector field is set to the value of the last call.

func (*ScopedPermissionClaimApplyConfiguration) WithVerbs

WithVerbs adds the given value to the Verbs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Verbs field.

type VirtualWorkspaceApplyConfiguration

type VirtualWorkspaceApplyConfiguration struct {
	// url is an APIExport virtual workspace URL.
	URL *string `json:"url,omitempty"`
}

VirtualWorkspaceApplyConfiguration represents a declarative configuration of the VirtualWorkspace type for use with apply.

func VirtualWorkspace

func VirtualWorkspace() *VirtualWorkspaceApplyConfiguration

VirtualWorkspaceApplyConfiguration constructs a declarative configuration of the VirtualWorkspace type for use with apply.

func (*VirtualWorkspaceApplyConfiguration) WithURL

WithURL sets the URL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the URL field is set to the value of the last call.

Jump to

Keyboard shortcuts

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