Documentation
¶
Overview ¶
Package v1alpha2 contains the v1alpha2 group Sample resources of the http provider. +kubebuilder:object:generate=true +groupName=http.crossplane.io +versionName=v1alpha2
Index ¶
- Constants
- Variables
- type Cache
- type Mapping
- type Payload
- type Request
- func (in *Request) DeepCopy() *Request
- func (in *Request) DeepCopyInto(out *Request)
- func (in *Request) DeepCopyObject() runtime.Object
- func (mg *Request) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (mg *Request) GetDeletionPolicy() xpv1.DeletionPolicy
- func (mg *Request) GetManagementPolicy() xpv1.ManagementPolicy
- func (mg *Request) GetProviderConfigReference() *xpv1.Reference
- func (mg *Request) GetProviderReference() *xpv1.Reference
- func (mg *Request) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Request) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (d *Request) ResetFailures()
- func (d *Request) SetBody(body string)
- func (d *Request) SetCache(statusCode int, headers map[string][]string, body string)
- func (mg *Request) SetConditions(c ...xpv1.Condition)
- func (mg *Request) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (d *Request) SetError(err error)
- func (d *Request) SetHeaders(headers map[string][]string)
- func (mg *Request) SetManagementPolicy(r xpv1.ManagementPolicy)
- func (mg *Request) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Request) SetProviderReference(r *xpv1.Reference)
- func (mg *Request) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (d *Request) SetRequestDetails(url, method, body string, headers map[string][]string)
- func (d *Request) SetStatusCode(statusCode int)
- func (mg *Request) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type RequestList
- type RequestParameters
- type RequestSpec
- type RequestStatus
- type Response
- type SecretInjectionConfig
- type SecretRef
Constants ¶
const ( Group = "http.crossplane.io" Version = "v1alpha2" )
Package type metadata.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
var ( RequestKind = reflect.TypeOf(Request{}).Name() RequestGroupKind = schema.GroupKind{Group: Group, Kind: RequestKind}.String() RequestKindAPIVersion = RequestKind + "." + SchemeGroupVersion.String() RequestGroupVersionKind = SchemeGroupVersion.WithKind(RequestKind) )
Request type metadata.
Functions ¶
This section is empty.
Types ¶
type Cache ¶
type Cache struct {
LastUpdated string `json:"lastUpdated,omitempty"`
Response Response `json:"response,omitempty"`
}
func (*Cache) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cache.
func (*Cache) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Mapping ¶
type Mapping struct {
// +kubebuilder:validation:Enum=POST;GET;PUT;DELETE
Method string `json:"method"`
Body string `json:"body,omitempty"`
URL string `json:"url"`
Headers map[string][]string `json:"headers,omitempty"`
}
func (*Mapping) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Mapping.
func (*Mapping) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Payload ¶
type Payload struct {
BaseUrl string `json:"baseUrl,omitempty"`
Body string `json:"body,omitempty"`
}
func (*Payload) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Payload.
func (*Payload) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Request ¶
type Request struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec RequestSpec `json:"spec"`
Status RequestStatus `json:"status,omitempty"`
}
A Request is an example API type. +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,http} +kubebuilder:storageversion
func (*Request) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Request.
func (*Request) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Request) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Request) GetCondition ¶
func (mg *Request) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Request.
func (*Request) GetDeletionPolicy ¶
func (mg *Request) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Request.
func (*Request) GetManagementPolicy ¶
func (mg *Request) GetManagementPolicy() xpv1.ManagementPolicy
GetManagementPolicy of this Request.
func (*Request) GetProviderConfigReference ¶
GetProviderConfigReference of this Request.
func (*Request) GetProviderReference ¶
GetProviderReference of this Request. Deprecated: Use GetProviderConfigReference.
func (*Request) GetPublishConnectionDetailsTo ¶
func (mg *Request) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Request.
func (*Request) GetWriteConnectionSecretToReference ¶
func (mg *Request) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Request.
func (*Request) ResetFailures ¶
func (d *Request) ResetFailures()
func (*Request) SetConditions ¶
SetConditions of this Request.
func (*Request) SetDeletionPolicy ¶
func (mg *Request) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Request.
func (*Request) SetHeaders ¶
func (*Request) SetManagementPolicy ¶
func (mg *Request) SetManagementPolicy(r xpv1.ManagementPolicy)
SetManagementPolicy of this Request.
func (*Request) SetProviderConfigReference ¶
SetProviderConfigReference of this Request.
func (*Request) SetProviderReference ¶
SetProviderReference of this Request. Deprecated: Use SetProviderConfigReference.
func (*Request) SetPublishConnectionDetailsTo ¶
func (mg *Request) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Request.
func (*Request) SetRequestDetails ¶
func (*Request) SetStatusCode ¶
func (*Request) SetWriteConnectionSecretToReference ¶
func (mg *Request) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Request.
type RequestList ¶
type RequestList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Request `json:"items"`
}
RequestList contains a list of Request
func (*RequestList) DeepCopy ¶
func (in *RequestList) DeepCopy() *RequestList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RequestList.
func (*RequestList) DeepCopyInto ¶
func (in *RequestList) DeepCopyInto(out *RequestList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RequestList) DeepCopyObject ¶
func (in *RequestList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*RequestList) GetItems ¶
func (l *RequestList) GetItems() []resource.Managed
GetItems of this RequestList.
type RequestParameters ¶
type RequestParameters struct {
// Mappings defines the HTTP mappings for different methods.
Mappings []Mapping `json:"mappings"`
// Payload defines the payload for the request.
Payload Payload `json:"payload"`
// Headers defines default headers for each request.
Headers map[string][]string `json:"headers,omitempty"`
// WaitTimeout specifies the maximum time duration for waiting.
WaitTimeout *metav1.Duration `json:"waitTimeout,omitempty"`
// InsecureSkipTLSVerify, when set to true, skips TLS certificate checks for the HTTP request
InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`
// SecretInjectionConfig specifies the secrets receiving patches for response data.
SecretInjectionConfigs []SecretInjectionConfig `json:"secretInjectionConfigs,omitempty"`
}
RequestParameters are the configurable fields of a Request.
func (*RequestParameters) DeepCopy ¶
func (in *RequestParameters) DeepCopy() *RequestParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RequestParameters.
func (*RequestParameters) DeepCopyInto ¶
func (in *RequestParameters) DeepCopyInto(out *RequestParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RequestSpec ¶
type RequestSpec struct {
xpv1.ResourceSpec `json:",inline"`
ForProvider RequestParameters `json:"forProvider"`
}
A RequestSpec defines the desired state of a Request.
func (*RequestSpec) DeepCopy ¶
func (in *RequestSpec) DeepCopy() *RequestSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RequestSpec.
func (*RequestSpec) DeepCopyInto ¶
func (in *RequestSpec) DeepCopyInto(out *RequestSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RequestStatus ¶
type RequestStatus struct {
xpv1.ResourceStatus `json:",inline"`
Response Response `json:"response,omitempty"`
Cache Cache `json:"cache,omitempty"`
Failed int32 `json:"failed,omitempty"`
Error string `json:"error,omitempty"`
RequestDetails Mapping `json:"requestDetails,omitempty"`
}
A RequestStatus represents the observed state of a Request.
func (*RequestStatus) DeepCopy ¶
func (in *RequestStatus) DeepCopy() *RequestStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RequestStatus.
func (*RequestStatus) DeepCopyInto ¶
func (in *RequestStatus) DeepCopyInto(out *RequestStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Response ¶
type Response struct {
StatusCode int `json:"statusCode,omitempty"`
Body string `json:"body,omitempty"`
Headers map[string][]string `json:"headers,omitempty"`
}
RequestObservation are the observable fields of a Request.
func (*Response) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Response.
func (*Response) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretInjectionConfig ¶
type SecretInjectionConfig struct {
// SecretRef contains the name and namespace of the Kubernetes secret where the data will be injected.
SecretRef SecretRef `json:"secretRef"`
// SecretKey is the key within the Kubernetes secret where the data will be injected.
SecretKey string `json:"secretKey"`
// ResponsePath is is a jq filter expression represents the path in the response where the secret value will be extracted from.
ResponsePath string `json:"responsePath"`
}
SecretInjectionConfig represents the configuration for injecting secret data into a Kubernetes secret.
func (*SecretInjectionConfig) DeepCopy ¶
func (in *SecretInjectionConfig) DeepCopy() *SecretInjectionConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretInjectionConfig.
func (*SecretInjectionConfig) DeepCopyInto ¶
func (in *SecretInjectionConfig) DeepCopyInto(out *SecretInjectionConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretRef ¶
type SecretRef struct {
// Name is the name of the Kubernetes secret.
Name string `json:"name"`
// Namespace is the namespace of the Kubernetes secret.
Namespace string `json:"namespace"`
}
SecretRef contains the name and namespace of a Kubernetes secret.
func (*SecretRef) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretRef.
func (*SecretRef) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.