Documentation ¶
Overview ¶
+kubebuilder:object:generate=true +groupName=documentai.gcp.upbound.io +versionName=v1beta1
Index ¶
- Constants
- Variables
- type Processor
- func (in *Processor) DeepCopy() *Processor
- func (in *Processor) DeepCopyInto(out *Processor)
- func (in *Processor) DeepCopyObject() runtime.Object
- func (mg *Processor) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Processor) GetConnectionDetailsMapping() map[string]string
- func (mg *Processor) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Processor) GetID() string
- func (tr *Processor) GetInitParameters() (map[string]any, error)
- func (mg *Processor) GetManagementPolicies() xpv1.ManagementPolicies
- func (tr *Processor) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)
- func (tr *Processor) GetObservation() (map[string]any, error)
- func (tr *Processor) GetParameters() (map[string]any, error)
- func (mg *Processor) GetProviderConfigReference() *xpv1.Reference
- func (mg *Processor) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Processor) GetTerraformResourceType() string
- func (tr *Processor) GetTerraformSchemaVersion() int
- func (mg *Processor) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Processor) Hub()
- func (tr *Processor) LateInitialize(attrs []byte) (bool, error)
- func (mg *Processor) SetConditions(c ...xpv1.Condition)
- func (mg *Processor) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *Processor) SetManagementPolicies(r xpv1.ManagementPolicies)
- func (tr *Processor) SetObservation(obs map[string]any) error
- func (tr *Processor) SetParameters(params map[string]any) error
- func (mg *Processor) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Processor) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Processor) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type ProcessorInitParameters
- type ProcessorList
- type ProcessorObservation
- type ProcessorParameters
- type ProcessorSpec
- type ProcessorStatus
Constants ¶
const ( CRDGroup = "documentai.gcp.upbound.io" CRDVersion = "v1beta1" )
Package type metadata.
Variables ¶
var ( // CRDGroupVersion is the API Group Version used to register the objects CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
var ( Processor_Kind = "Processor" Processor_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Processor_Kind}.String() Processor_KindAPIVersion = Processor_Kind + "." + CRDGroupVersion.String() Processor_GroupVersionKind = CRDGroupVersion.WithKind(Processor_Kind) )
Repository type metadata.
Functions ¶
This section is empty.
Types ¶
type Processor ¶
type Processor struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.displayName) || (has(self.initProvider) && has(self.initProvider.displayName))",message="spec.forProvider.displayName is a required parameter" // +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.location) || (has(self.initProvider) && has(self.initProvider.location))",message="spec.forProvider.location is a required parameter" // +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.type) || (has(self.initProvider) && has(self.initProvider.type))",message="spec.forProvider.type is a required parameter" Spec ProcessorSpec `json:"spec"` Status ProcessorStatus `json:"status,omitempty"` }
Processor is the Schema for the Processors API. The first-class citizen for Document AI. +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].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:resource:scope=Cluster,categories={crossplane,managed,gcp}
func (*Processor) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Processor.
func (*Processor) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Processor) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Processor) GetCondition ¶
func (mg *Processor) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Processor.
func (*Processor) GetConnectionDetailsMapping ¶
GetConnectionDetailsMapping for this Processor
func (*Processor) GetDeletionPolicy ¶
func (mg *Processor) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Processor.
func (*Processor) GetInitParameters ¶ added in v0.35.0
GetInitParameters of this Processor
func (*Processor) GetManagementPolicies ¶ added in v0.35.0
func (mg *Processor) GetManagementPolicies() xpv1.ManagementPolicies
GetManagementPolicies of this Processor.
func (*Processor) GetMergedParameters ¶ added in v0.40.0
GetInitParameters of this Processor
func (*Processor) GetObservation ¶
GetObservation of this Processor
func (*Processor) GetParameters ¶
GetParameters of this Processor
func (*Processor) GetProviderConfigReference ¶
GetProviderConfigReference of this Processor.
func (*Processor) GetPublishConnectionDetailsTo ¶
func (mg *Processor) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Processor.
func (*Processor) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Processor
func (*Processor) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Processor) GetWriteConnectionSecretToReference ¶
func (mg *Processor) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Processor.
func (*Processor) Hub ¶ added in v0.41.2
func (tr *Processor) Hub()
Hub marks this type as a conversion hub.
func (*Processor) LateInitialize ¶
LateInitialize this Processor using its observed tfState. returns True if there are any spec changes for the resource.
func (*Processor) SetConditions ¶
SetConditions of this Processor.
func (*Processor) SetDeletionPolicy ¶
func (mg *Processor) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Processor.
func (*Processor) SetManagementPolicies ¶ added in v0.35.0
func (mg *Processor) SetManagementPolicies(r xpv1.ManagementPolicies)
SetManagementPolicies of this Processor.
func (*Processor) SetObservation ¶
SetObservation for this Processor
func (*Processor) SetParameters ¶
SetParameters for this Processor
func (*Processor) SetProviderConfigReference ¶
SetProviderConfigReference of this Processor.
func (*Processor) SetPublishConnectionDetailsTo ¶
func (mg *Processor) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Processor.
func (*Processor) SetWriteConnectionSecretToReference ¶
func (mg *Processor) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Processor.
type ProcessorInitParameters ¶ added in v0.35.0
type ProcessorInitParameters struct { // The display name. Must be unique. DisplayName *string `json:"displayName,omitempty" tf:"display_name,omitempty"` // The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management. KMSKeyName *string `json:"kmsKeyName,omitempty" tf:"kms_key_name,omitempty"` // The location of the resource. Location *string `json:"location,omitempty" tf:"location,omitempty"` // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project *string `json:"project,omitempty" tf:"project,omitempty"` // The type of processor. For possible types see the official list Type *string `json:"type,omitempty" tf:"type,omitempty"` }
func (*ProcessorInitParameters) DeepCopy ¶ added in v0.35.0
func (in *ProcessorInitParameters) DeepCopy() *ProcessorInitParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProcessorInitParameters.
func (*ProcessorInitParameters) DeepCopyInto ¶ added in v0.35.0
func (in *ProcessorInitParameters) DeepCopyInto(out *ProcessorInitParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProcessorList ¶
type ProcessorList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Processor `json:"items"` }
ProcessorList contains a list of Processors
func (*ProcessorList) DeepCopy ¶
func (in *ProcessorList) DeepCopy() *ProcessorList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProcessorList.
func (*ProcessorList) DeepCopyInto ¶
func (in *ProcessorList) DeepCopyInto(out *ProcessorList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProcessorList) DeepCopyObject ¶
func (in *ProcessorList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ProcessorList) GetItems ¶
func (l *ProcessorList) GetItems() []resource.Managed
GetItems of this ProcessorList.
type ProcessorObservation ¶
type ProcessorObservation struct { // The display name. Must be unique. DisplayName *string `json:"displayName,omitempty" tf:"display_name,omitempty"` // an identifier for the resource with format projects/{{project}}/locations/{{location}}/processors/{{name}} ID *string `json:"id,omitempty" tf:"id,omitempty"` // The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management. KMSKeyName *string `json:"kmsKeyName,omitempty" tf:"kms_key_name,omitempty"` // The location of the resource. Location *string `json:"location,omitempty" tf:"location,omitempty"` // The resource name of the processor. Name *string `json:"name,omitempty" tf:"name,omitempty"` // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project *string `json:"project,omitempty" tf:"project,omitempty"` // The type of processor. For possible types see the official list Type *string `json:"type,omitempty" tf:"type,omitempty"` }
func (*ProcessorObservation) DeepCopy ¶
func (in *ProcessorObservation) DeepCopy() *ProcessorObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProcessorObservation.
func (*ProcessorObservation) DeepCopyInto ¶
func (in *ProcessorObservation) DeepCopyInto(out *ProcessorObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProcessorParameters ¶
type ProcessorParameters struct { // The display name. Must be unique. // +kubebuilder:validation:Optional DisplayName *string `json:"displayName,omitempty" tf:"display_name,omitempty"` // The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management. // +kubebuilder:validation:Optional KMSKeyName *string `json:"kmsKeyName,omitempty" tf:"kms_key_name,omitempty"` // The location of the resource. // +kubebuilder:validation:Optional Location *string `json:"location,omitempty" tf:"location,omitempty"` // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. // +kubebuilder:validation:Optional Project *string `json:"project,omitempty" tf:"project,omitempty"` // The type of processor. For possible types see the official list // +kubebuilder:validation:Optional Type *string `json:"type,omitempty" tf:"type,omitempty"` }
func (*ProcessorParameters) DeepCopy ¶
func (in *ProcessorParameters) DeepCopy() *ProcessorParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProcessorParameters.
func (*ProcessorParameters) DeepCopyInto ¶
func (in *ProcessorParameters) DeepCopyInto(out *ProcessorParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProcessorSpec ¶
type ProcessorSpec struct { v1.ResourceSpec `json:",inline"` ForProvider ProcessorParameters `json:"forProvider"` // THIS IS A BETA FIELD. It will be honored // unless the Management Policies feature flag is disabled. // InitProvider holds the same fields as ForProvider, with the exception // of Identifier and other resource reference fields. The fields that are // in InitProvider are merged into ForProvider when the resource is created. // The same fields are also added to the terraform ignore_changes hook, to // avoid updating them after creation. This is useful for fields that are // required on creation, but we do not desire to update them after creation, // for example because of an external controller is managing them, like an // autoscaler. InitProvider ProcessorInitParameters `json:"initProvider,omitempty"` }
ProcessorSpec defines the desired state of Processor
func (*ProcessorSpec) DeepCopy ¶
func (in *ProcessorSpec) DeepCopy() *ProcessorSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProcessorSpec.
func (*ProcessorSpec) DeepCopyInto ¶
func (in *ProcessorSpec) DeepCopyInto(out *ProcessorSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProcessorStatus ¶
type ProcessorStatus struct { v1.ResourceStatus `json:",inline"` AtProvider ProcessorObservation `json:"atProvider,omitempty"` }
ProcessorStatus defines the observed state of Processor.
func (*ProcessorStatus) DeepCopy ¶
func (in *ProcessorStatus) DeepCopy() *ProcessorStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProcessorStatus.
func (*ProcessorStatus) DeepCopyInto ¶
func (in *ProcessorStatus) DeepCopyInto(out *ProcessorStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.