v1alpha1

Documentation

Overview

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

Index

• Variables
• type DocumentAIProcessor
  • func (in *DocumentAIProcessor) DeepCopy() *DocumentAIProcessor
  • func (in *DocumentAIProcessor) DeepCopyInto(out *DocumentAIProcessor)
  • func (in *DocumentAIProcessor) DeepCopyObject() runtime.Object
• type DocumentAIProcessorDefaultVersion
  • func (in *DocumentAIProcessorDefaultVersion) DeepCopy() *DocumentAIProcessorDefaultVersion
  • func (in *DocumentAIProcessorDefaultVersion) DeepCopyInto(out *DocumentAIProcessorDefaultVersion)
  • func (in *DocumentAIProcessorDefaultVersion) DeepCopyObject() runtime.Object
• type DocumentAIProcessorDefaultVersionList
  • func (in *DocumentAIProcessorDefaultVersionList) DeepCopy() *DocumentAIProcessorDefaultVersionList
  • func (in *DocumentAIProcessorDefaultVersionList) DeepCopyInto(out *DocumentAIProcessorDefaultVersionList)
  • func (in *DocumentAIProcessorDefaultVersionList) DeepCopyObject() runtime.Object
• type DocumentAIProcessorDefaultVersionSpec
  • func (in *DocumentAIProcessorDefaultVersionSpec) DeepCopy() *DocumentAIProcessorDefaultVersionSpec
  • func (in *DocumentAIProcessorDefaultVersionSpec) DeepCopyInto(out *DocumentAIProcessorDefaultVersionSpec)
• type DocumentAIProcessorDefaultVersionStatus
  • func (in *DocumentAIProcessorDefaultVersionStatus) DeepCopy() *DocumentAIProcessorDefaultVersionStatus
  • func (in *DocumentAIProcessorDefaultVersionStatus) DeepCopyInto(out *DocumentAIProcessorDefaultVersionStatus)
• type DocumentAIProcessorList
  • func (in *DocumentAIProcessorList) DeepCopy() *DocumentAIProcessorList
  • func (in *DocumentAIProcessorList) DeepCopyInto(out *DocumentAIProcessorList)
  • func (in *DocumentAIProcessorList) DeepCopyObject() runtime.Object
• type DocumentAIProcessorSpec
  • func (in *DocumentAIProcessorSpec) DeepCopy() *DocumentAIProcessorSpec
  • func (in *DocumentAIProcessorSpec) DeepCopyInto(out *DocumentAIProcessorSpec)
• type DocumentAIProcessorStatus
  • func (in *DocumentAIProcessorStatus) DeepCopy() *DocumentAIProcessorStatus
  • func (in *DocumentAIProcessorStatus) DeepCopyInto(out *DocumentAIProcessorStatus)

Variables

var (
	// SchemeGroupVersion is the group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: "documentai.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

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

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

Types

type DocumentAIProcessor

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

	Spec   DocumentAIProcessorSpec   `json:"spec,omitempty"`
	Status DocumentAIProcessorStatus `json:"status,omitempty"`
}

DocumentAIProcessor is the Schema for the documentai API +k8s:openapi-gen=true

func (*DocumentAIProcessor) DeepCopy

func (in *DocumentAIProcessor) DeepCopy() *DocumentAIProcessor

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

func (*DocumentAIProcessor) DeepCopyInto

func (in *DocumentAIProcessor) DeepCopyInto(out *DocumentAIProcessor)

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

func (*DocumentAIProcessor) DeepCopyObject

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

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

type DocumentAIProcessorDefaultVersion

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

	Spec   DocumentAIProcessorDefaultVersionSpec   `json:"spec,omitempty"`
	Status DocumentAIProcessorDefaultVersionStatus `json:"status,omitempty"`
}

DocumentAIProcessorDefaultVersion is the Schema for the documentai API +k8s:openapi-gen=true

func (*DocumentAIProcessorDefaultVersion) DeepCopy

func (in *DocumentAIProcessorDefaultVersion) DeepCopy() *DocumentAIProcessorDefaultVersion

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

func (*DocumentAIProcessorDefaultVersion) DeepCopyInto

func (in *DocumentAIProcessorDefaultVersion) DeepCopyInto(out *DocumentAIProcessorDefaultVersion)

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

func (*DocumentAIProcessorDefaultVersion) DeepCopyObject

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

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

type DocumentAIProcessorDefaultVersionList

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

DocumentAIProcessorDefaultVersionList contains a list of DocumentAIProcessorDefaultVersion

func (*DocumentAIProcessorDefaultVersionList) DeepCopy

func (in *DocumentAIProcessorDefaultVersionList) DeepCopy() *DocumentAIProcessorDefaultVersionList

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

func (*DocumentAIProcessorDefaultVersionList) DeepCopyInto

func (in *DocumentAIProcessorDefaultVersionList) DeepCopyInto(out *DocumentAIProcessorDefaultVersionList)

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

func (*DocumentAIProcessorDefaultVersionList) DeepCopyObject

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

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

type DocumentAIProcessorDefaultVersionSpec

type DocumentAIProcessorDefaultVersionSpec struct {
	/* Immutable. Optional. The processor 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"`

	/* Immutable. The version to set. Using 'stable' or 'rc' will cause the API to return the latest version in that release channel.
	Apply 'lifecycle.ignore_changes' to the 'version' field to suppress this diff. */
	Version string `json:"version"`
}

func (*DocumentAIProcessorDefaultVersionSpec) DeepCopy

func (in *DocumentAIProcessorDefaultVersionSpec) DeepCopy() *DocumentAIProcessorDefaultVersionSpec

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

func (*DocumentAIProcessorDefaultVersionSpec) DeepCopyInto

func (in *DocumentAIProcessorDefaultVersionSpec) DeepCopyInto(out *DocumentAIProcessorDefaultVersionSpec)

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

type DocumentAIProcessorDefaultVersionStatus

type DocumentAIProcessorDefaultVersionStatus struct {
	/* Conditions represent the latest available observations of the
	   DocumentAIProcessorDefaultVersion's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
	// +optional
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
}

func (*DocumentAIProcessorDefaultVersionStatus) DeepCopy

func (in *DocumentAIProcessorDefaultVersionStatus) DeepCopy() *DocumentAIProcessorDefaultVersionStatus

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

func (*DocumentAIProcessorDefaultVersionStatus) DeepCopyInto

func (in *DocumentAIProcessorDefaultVersionStatus) DeepCopyInto(out *DocumentAIProcessorDefaultVersionStatus)

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

type DocumentAIProcessorList

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

DocumentAIProcessorList contains a list of DocumentAIProcessor

func (*DocumentAIProcessorList) DeepCopy

func (in *DocumentAIProcessorList) DeepCopy() *DocumentAIProcessorList

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

func (*DocumentAIProcessorList) DeepCopyInto

func (in *DocumentAIProcessorList) DeepCopyInto(out *DocumentAIProcessorList)

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

func (*DocumentAIProcessorList) DeepCopyObject

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

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

type DocumentAIProcessorSpec

type DocumentAIProcessorSpec struct {
	/* Immutable. The display name. Must be unique. */
	DisplayName string `json:"displayName"`

	/* Immutable. The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management. */
	// +optional
	KmsKeyName *string `json:"kmsKeyName,omitempty"`

	/* Immutable. The location of the resource. */
	Location string `json:"location"`

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

	/* Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`

	/* Immutable. The type of processor. For possible types see the [official list](https://cloud.google.com/document-ai/docs/reference/rest/v1/projects.locations/fetchProcessorTypes#google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes). */
	Type string `json:"type"`
}

func (*DocumentAIProcessorSpec) DeepCopy

func (in *DocumentAIProcessorSpec) DeepCopy() *DocumentAIProcessorSpec

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

func (*DocumentAIProcessorSpec) DeepCopyInto

func (in *DocumentAIProcessorSpec) DeepCopyInto(out *DocumentAIProcessorSpec)

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

type DocumentAIProcessorStatus

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

func (in *DocumentAIProcessorStatus) DeepCopy() *DocumentAIProcessorStatus

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

func (*DocumentAIProcessorStatus) DeepCopyInto

func (in *DocumentAIProcessorStatus) DeepCopyInto(out *DocumentAIProcessorStatus)

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