v1alpha1

package
v1.125.0 Latest Latest
Warning

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

Go to latest
Published: Nov 12, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

+kcc:proto=google.cloud.discoveryengine.v1

+kubebuilder:object:generate=true +groupName=discoveryengine.cnrm.cloud.google.com

Index

Constants

This section is empty.

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "discoveryengine.cnrm.cloud.google.com", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source
var DiscoveryEngineDataStoreGVK = GroupVersion.WithKind("DiscoveryEngineDataStore")

Functions

This section is empty.

Types

type CollectionLink struct {
	*ProjectAndLocation
	Collection string
}

func (*CollectionLink) DeepCopy

func (in *CollectionLink) DeepCopy() *CollectionLink

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

func (*CollectionLink) DeepCopyInto

func (in *CollectionLink) DeepCopyInto(out *CollectionLink)

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

func (*CollectionLink) String

func (p *CollectionLink) String() string

type DataStore_BillingEstimation

type DataStore_BillingEstimation struct {
	// Data size for structured data in terms of bytes.
	StructuredDataSize *int64 `json:"structuredDataSize,omitempty"`

	// Data size for unstructured data in terms of bytes.
	UnstructuredDataSize *int64 `json:"unstructuredDataSize,omitempty"`

	// Data size for websites in terms of bytes.
	WebsiteDataSize *int64 `json:"websiteDataSize,omitempty"`

	// Last updated timestamp for structured data.
	StructuredDataUpdateTime *string `json:"structuredDataUpdateTime,omitempty"`

	// Last updated timestamp for unstructured data.
	UnstructuredDataUpdateTime *string `json:"unstructuredDataUpdateTime,omitempty"`

	// Last updated timestamp for websites.
	WebsiteDataUpdateTime *string `json:"websiteDataUpdateTime,omitempty"`
}

+kcc:proto=google.cloud.discoveryengine.v1.DataStore.BillingEstimation

func (*DataStore_BillingEstimation) DeepCopy

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

func (*DataStore_BillingEstimation) DeepCopyInto

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

type DiscoveryEngineDataStore

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

	// +required
	Spec   DiscoveryEngineDataStoreSpec   `json:"spec,omitempty"`
	Status DiscoveryEngineDataStoreStatus `json:"status,omitempty"`
}

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

func (*DiscoveryEngineDataStore) DeepCopy

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

func (*DiscoveryEngineDataStore) DeepCopyInto

func (in *DiscoveryEngineDataStore) DeepCopyInto(out *DiscoveryEngineDataStore)

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

func (*DiscoveryEngineDataStore) DeepCopyObject

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

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

type DiscoveryEngineDataStoreID

type DiscoveryEngineDataStoreID struct {
	*CollectionLink
	DataStore string
}

DiscoveryEngineDataStoreRef defines the resource reference to DiscoveryEngineDataStore, which "External" field holds the GCP identifier for the KRM object.

func NewDiscoveryEngineDataStoreIDFromObject

func NewDiscoveryEngineDataStoreIDFromObject(ctx context.Context, reader client.Reader, obj *DiscoveryEngineDataStore) (*DiscoveryEngineDataStoreID, error)

New builds a DiscoveryEngineDataStoreRef from the Config Connector DiscoveryEngineDataStore object.

func ParseDiscoveryEngineDataStoreExternal

func ParseDiscoveryEngineDataStoreExternal(external string) (*DiscoveryEngineDataStoreID, error)

func (*DiscoveryEngineDataStoreID) DeepCopy

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

func (*DiscoveryEngineDataStoreID) DeepCopyInto

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

func (*DiscoveryEngineDataStoreID) String

func (p *DiscoveryEngineDataStoreID) String() string

type DiscoveryEngineDataStoreList

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

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object DiscoveryEngineDataStoreList contains a list of DiscoveryEngineDataStore

func (*DiscoveryEngineDataStoreList) DeepCopy

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

func (*DiscoveryEngineDataStoreList) DeepCopyInto

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

func (*DiscoveryEngineDataStoreList) DeepCopyObject

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

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

type DiscoveryEngineDataStoreObservedState

type DiscoveryEngineDataStoreObservedState struct {
	// Output only. The id of the default
	// [Schema][google.cloud.discoveryengine.v1.Schema] asscociated to this data
	// store.
	DefaultSchemaID *string `json:"defaultSchemaID,omitempty"`

	// Output only. Timestamp the
	// [DataStore][google.cloud.discoveryengine.v1.DataStore] was created at.
	CreateTime *string `json:"createTime,omitempty"`

	// Output only. Data size estimation for billing.
	BillingEstimation *DataStore_BillingEstimation `json:"billingEstimation,omitempty"`
}

DiscoveryEngineDataStoreObservedState is the state of the DiscoveryEngineDataStore resource as most recently observed in GCP. +kcc:proto=google.cloud.discoveryengine.v1.DataStore

func (*DiscoveryEngineDataStoreObservedState) DeepCopy

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

func (*DiscoveryEngineDataStoreObservedState) DeepCopyInto

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

type DiscoveryEngineDataStoreRef

type DiscoveryEngineDataStoreRef struct {
	// A reference to an externally managed DiscoveryEngineDataStore resource.
	// Should be in the format "projects/<projectID>/locations/<location>/datastores/<datastoreID>".
	External string `json:"external,omitempty"`

	// The name of a DiscoveryEngineDataStore resource.
	Name string `json:"name,omitempty"`

	// The namespace of a DiscoveryEngineDataStore resource.
	Namespace string `json:"namespace,omitempty"`
}

DiscoveryEngineDataStoreRef defines the resource reference to DiscoveryEngineDataStore, which "External" field holds the GCP identifier for the KRM object.

func (*DiscoveryEngineDataStoreRef) DeepCopy

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

func (*DiscoveryEngineDataStoreRef) DeepCopyInto

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

func (*DiscoveryEngineDataStoreRef) NormalizedExternal

func (r *DiscoveryEngineDataStoreRef) NormalizedExternal(ctx context.Context, reader client.Reader, defaultNamespace string) (string, error)

NormalizedExternal provision the "External" value for other resource that depends on DiscoveryEngineDataStore. If the "External" is given in the other resource's spec.DiscoveryEngineDataStoreRef, the given value will be used. Otherwise, the "Name" and "Namespace" will be used to query the actual DiscoveryEngineDataStore object from the cluster.

type DiscoveryEngineDataStoreSpec

type DiscoveryEngineDataStoreSpec struct {
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="ResourceID field is immutable"
	// Immutable.
	// The DiscoveryEngineDataStore name. If not given, the metadata.name will be used.
	ResourceID *string `json:"resourceID,omitempty"`

	// Required. The data store display name.
	//
	// This field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	DisplayName *string `json:"displayName,omitempty"`

	// Immutable. The industry vertical that the data store registers.
	IndustryVertical *string `json:"industryVertical,omitempty"`

	// The solutions that the data store enrolls. Available solutions for each
	// [industry_vertical][google.cloud.discoveryengine.v1.DataStore.industry_vertical]:
	//
	// * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
	// * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
	//   solutions cannot be enrolled.
	SolutionTypes []string `json:"solutionTypes,omitempty"`

	// Immutable. The content config of the data store. If this field is unset,
	// the server behavior defaults to
	// [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1.DataStore.ContentConfig.NO_CONTENT].
	ContentConfig *string `json:"contentConfig,omitempty"`

	// Config to store data store type configuration for workspace data. This
	// must be set when
	// [DataStore.content_config][google.cloud.discoveryengine.v1.DataStore.content_config]
	// is set as
	// [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE].
	WorkspaceConfig *WorkspaceConfig `json:"workspaceConfig,omitempty"`

	/* The ID of the project in which the resource belongs.*/
	ProjectRef *refs.ProjectRef `json:"projectRef"`

	// Immutable. The collection for the DataStore.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Collection field is immutable"
	// +required
	Collection string `json:"collection"`

	// Immutable. The location for the resource.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Location field is immutable"
	// +required
	Location string `json:"location"`
}

DiscoveryEngineDataStoreSpec defines the desired state of DiscoveryEngineDataStore +kcc:proto=google.cloud.discoveryengine.v1.DataStore

func (*DiscoveryEngineDataStoreSpec) DeepCopy

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

func (*DiscoveryEngineDataStoreSpec) DeepCopyInto

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

type DiscoveryEngineDataStoreStatus

type DiscoveryEngineDataStoreStatus struct {
	/* Conditions represent the latest available observations of the
	   object'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.
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`

	// A unique specifier for the DiscoveryEngineDataStore resource in GCP.
	ExternalRef *string `json:"externalRef,omitempty"`

	// ObservedState is the state of the resource as most recently observed in GCP.
	ObservedState *DiscoveryEngineDataStoreObservedState `json:"observedState,omitempty"`
}

DiscoveryEngineDataStoreStatus defines the config connector machine state of DiscoveryEngineDataStore

func (*DiscoveryEngineDataStoreStatus) DeepCopy

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

func (*DiscoveryEngineDataStoreStatus) DeepCopyInto

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

type DocumentProcessingConfig

type DocumentProcessingConfig struct {
	// The full resource name of the Document Processing Config.
	//  Format:
	//  `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
	Name *string `json:"name,omitempty"`

	// Whether chunking mode is enabled.
	ChunkingConfig *DocumentProcessingConfig_ChunkingConfig `json:"chunkingConfig,omitempty"`

	// Configurations for default Document parser.
	//  If not specified, we will configure it as default DigitalParsingConfig, and
	//  the default parsing config will be applied to all file types for Document
	//  parsing.
	DefaultParsingConfig *DocumentProcessingConfig_ParsingConfig `json:"defaultParsingConfig,omitempty"`
}

+kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig

func (*DocumentProcessingConfig) DeepCopy

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

func (*DocumentProcessingConfig) DeepCopyInto

func (in *DocumentProcessingConfig) DeepCopyInto(out *DocumentProcessingConfig)

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

type DocumentProcessingConfig_ChunkingConfig

type DocumentProcessingConfig_ChunkingConfig struct {
	// Configuration for the layout based chunking.
	LayoutBasedChunkingConfig *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig `json:"layoutBasedChunkingConfig,omitempty"`
}

+kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ChunkingConfig

func (*DocumentProcessingConfig_ChunkingConfig) DeepCopy

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

func (*DocumentProcessingConfig_ChunkingConfig) DeepCopyInto

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

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig

type DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig struct {
	// The token size limit for each chunk.
	//
	//  Supported values: 100-500 (inclusive).
	//  Default value: 500.
	ChunkSize *int32 `json:"chunkSize,omitempty"`

	// Whether to include appending different levels of headings to chunks
	//  from the middle of the document to prevent context loss.
	//
	//  Default value: False.
	IncludeAncestorHeadings *bool `json:"includeAncestorHeadings,omitempty"`
}

+kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) DeepCopy

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

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) DeepCopyInto

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

type DocumentProcessingConfig_ParsingConfig

type DocumentProcessingConfig_ParsingConfig struct {
	// Configurations applied to digital parser.
	DigitalParsingConfig *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig `json:"digitalParsingConfig,omitempty"`

	// Configurations applied to OCR parser. Currently it only applies to
	//  PDFs.
	OcrParsingConfig *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig `json:"ocrParsingConfig,omitempty"`

	// Configurations applied to layout parser.
	LayoutParsingConfig *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig `json:"layoutParsingConfig,omitempty"`
}

+kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ParsingConfig

func (*DocumentProcessingConfig_ParsingConfig) DeepCopy

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

func (*DocumentProcessingConfig_ParsingConfig) DeepCopyInto

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

type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig

type DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig struct {
}

+kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ParsingConfig.DigitalParsingConfig

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) DeepCopy

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

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) DeepCopyInto

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

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig

type DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig struct {
}

+kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) DeepCopy

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

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) DeepCopyInto

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

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig

type DocumentProcessingConfig_ParsingConfig_OcrParsingConfig struct {
	// [DEPRECATED] This field is deprecated. To use the additional enhanced
	//  document elements processing, please switch to `layout_parsing_config`.
	EnhancedDocumentElements []string `json:"enhancedDocumentElements,omitempty"`

	// If true, will use native text instead of OCR text on pages containing
	//  native text.
	UseNativeText *bool `json:"useNativeText,omitempty"`
}

+kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ParsingConfig.OcrParsingConfig

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) DeepCopy

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

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) DeepCopyInto

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

type ProjectAndLocation

type ProjectAndLocation struct {
	ProjectID string
	Location  string
}

func (*ProjectAndLocation) DeepCopy

func (in *ProjectAndLocation) DeepCopy() *ProjectAndLocation

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

func (*ProjectAndLocation) DeepCopyInto

func (in *ProjectAndLocation) DeepCopyInto(out *ProjectAndLocation)

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

func (*ProjectAndLocation) String

func (p *ProjectAndLocation) String() string

type Schema

type Schema struct {
	// The structured representation of the schema.
	StructSchema map[string]string `json:"structSchema,omitempty"`

	// The JSON representation of the schema.
	JsonSchema *string `json:"jsonSchema,omitempty"`

	// Immutable. The full resource name of the schema, in the format of
	//  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
	//
	//  This field must be a UTF-8 encoded string with a length limit of 1024
	//  characters.
	Name *string `json:"name,omitempty"`
}

+kcc:proto=google.cloud.discoveryengine.v1.Schema

func (*Schema) DeepCopy

func (in *Schema) DeepCopy() *Schema

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

func (*Schema) DeepCopyInto

func (in *Schema) DeepCopyInto(out *Schema)

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

type WorkspaceConfig

type WorkspaceConfig struct {
	// The Google Workspace data source.
	Type *string `json:"type,omitempty"`

	// Obfuscated Dasher customer ID.
	DasherCustomerID *string `json:"dasherCustomerID,omitempty"`

	// Optional. The super admin service account for the workspace that will be
	//  used for access token generation. For now we only use it for Native Google
	//  Drive connector data ingestion.
	SuperAdminServiceAccount *string `json:"superAdminServiceAccount,omitempty"`

	// Optional. The super admin email address for the workspace that will be used
	//  for access token generation. For now we only use it for Native Google Drive
	//  connector data ingestion.
	SuperAdminEmailAddress *string `json:"superAdminEmailAddress,omitempty"`
}

+kcc:proto=google.cloud.discoveryengine.v1.WorkspaceConfig

func (*WorkspaceConfig) DeepCopy

func (in *WorkspaceConfig) DeepCopy() *WorkspaceConfig

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

func (*WorkspaceConfig) DeepCopyInto

func (in *WorkspaceConfig) DeepCopyInto(out *WorkspaceConfig)

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

Jump to

Keyboard shortcuts

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