v1alpha1

package
v1.128.0 Latest Latest
Warning

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

 Go to latest Published: Jan 31, 2025 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")
View Source 
var DiscoveryEngineDataStoreTargetSiteGVK = GroupVersion.WithKind("DiscoveryEngineDataStoreTargetSite")
View Source 
var DiscoveryEngineEngineGVK = GroupVersion.WithKind("DiscoveryEngineEngine")

Functions

func NewTargetSiteIdentityFromObject added in v1.128.0 

func NewTargetSiteIdentityFromObject(ctx context.Context, reader client.Reader, obj *DiscoveryEngineDataStoreTargetSite) (*DiscoveryEngineDataStoreID, *TargetSiteIdentity, error)

NewTargetSiteIdentityFromObject builds a TargetSiteIdentity from the Config Connector object.

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.
	// +kcc:proto=google.cloud.discoveryengine.v1.DataStore.BillingEstimation.structured_data_size
	StructuredDataSize *int64 `json:"structuredDataSize,omitempty"`

	// Data size for unstructured data in terms of bytes.
	// +kcc:proto=google.cloud.discoveryengine.v1.DataStore.BillingEstimation.unstructured_data_size
	UnstructuredDataSize *int64 `json:"unstructuredDataSize,omitempty"`

	// Data size for websites in terms of bytes.
	// +kcc:proto=google.cloud.discoveryengine.v1.DataStore.BillingEstimation.website_data_size
	WebsiteDataSize *int64 `json:"websiteDataSize,omitempty"`

	// Last updated timestamp for structured data.
	// +kcc:proto=google.cloud.discoveryengine.v1.DataStore.BillingEstimation.structured_data_update_time
	StructuredDataUpdateTime *string `json:"structuredDataUpdateTime,omitempty"`

	// Last updated timestamp for unstructured data.
	// +kcc:proto=google.cloud.discoveryengine.v1.DataStore.BillingEstimation.unstructured_data_update_time
	UnstructuredDataUpdateTime *string `json:"unstructuredDataUpdateTime,omitempty"`

	// Last updated timestamp for websites.
	// +kcc:proto=google.cloud.discoveryengine.v1.DataStore.BillingEstimation.website_data_update_time
	WebsiteDataUpdateTime *string `json:"websiteDataUpdateTime,omitempty"`
}

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

func (*DataStore_BillingEstimation) DeepCopy 

func (in *DataStore_BillingEstimation) DeepCopy() *DataStore_BillingEstimation

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

func (*DataStore_BillingEstimation) DeepCopyInto 

func (in *DataStore_BillingEstimation) DeepCopyInto(out *DataStore_BillingEstimation)

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 

func (in *DiscoveryEngineDataStore) DeepCopy() *DiscoveryEngineDataStore

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 

func (in *DiscoveryEngineDataStoreID) DeepCopy() *DiscoveryEngineDataStoreID

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

func (*DiscoveryEngineDataStoreID) DeepCopyInto 

func (in *DiscoveryEngineDataStoreID) DeepCopyInto(out *DiscoveryEngineDataStoreID)

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 

func (in *DiscoveryEngineDataStoreList) DeepCopy() *DiscoveryEngineDataStoreList

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

func (*DiscoveryEngineDataStoreList) DeepCopyInto 

func (in *DiscoveryEngineDataStoreList) DeepCopyInto(out *DiscoveryEngineDataStoreList)

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] associated 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 

func (in *DiscoveryEngineDataStoreObservedState) DeepCopy() *DiscoveryEngineDataStoreObservedState

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

func (*DiscoveryEngineDataStoreObservedState) DeepCopyInto 

func (in *DiscoveryEngineDataStoreObservedState) DeepCopyInto(out *DiscoveryEngineDataStoreObservedState)

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 

func (in *DiscoveryEngineDataStoreRef) DeepCopy() *DiscoveryEngineDataStoreRef

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

func (*DiscoveryEngineDataStoreRef) DeepCopyInto 

func (in *DiscoveryEngineDataStoreRef) DeepCopyInto(out *DiscoveryEngineDataStoreRef)

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 {
	// 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 

func (in *DiscoveryEngineDataStoreSpec) DeepCopy() *DiscoveryEngineDataStoreSpec

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

func (*DiscoveryEngineDataStoreSpec) DeepCopyInto 

func (in *DiscoveryEngineDataStoreSpec) DeepCopyInto(out *DiscoveryEngineDataStoreSpec)

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 

func (in *DiscoveryEngineDataStoreStatus) DeepCopy() *DiscoveryEngineDataStoreStatus

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

func (*DiscoveryEngineDataStoreStatus) DeepCopyInto 

func (in *DiscoveryEngineDataStoreStatus) DeepCopyInto(out *DiscoveryEngineDataStoreStatus)

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

type DiscoveryEngineDataStoreTargetSite added in v1.128.0 

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

	// +required
	Spec   DiscoveryEngineDataStoreTargetSiteSpec   `json:"spec,omitempty"`
	Status DiscoveryEngineDataStoreTargetSiteStatus `json:"status,omitempty"`
}

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

func (*DiscoveryEngineDataStoreTargetSite) DeepCopy added in v1.128.0 

func (in *DiscoveryEngineDataStoreTargetSite) DeepCopy() *DiscoveryEngineDataStoreTargetSite

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

func (*DiscoveryEngineDataStoreTargetSite) DeepCopyInto added in v1.128.0 

func (in *DiscoveryEngineDataStoreTargetSite) DeepCopyInto(out *DiscoveryEngineDataStoreTargetSite)

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

func (*DiscoveryEngineDataStoreTargetSite) DeepCopyObject added in v1.128.0 

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

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

type DiscoveryEngineDataStoreTargetSiteList added in v1.128.0 

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

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

func (*DiscoveryEngineDataStoreTargetSiteList) DeepCopy added in v1.128.0 

func (in *DiscoveryEngineDataStoreTargetSiteList) DeepCopy() *DiscoveryEngineDataStoreTargetSiteList

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

func (*DiscoveryEngineDataStoreTargetSiteList) DeepCopyInto added in v1.128.0 

func (in *DiscoveryEngineDataStoreTargetSiteList) DeepCopyInto(out *DiscoveryEngineDataStoreTargetSiteList)

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

func (*DiscoveryEngineDataStoreTargetSiteList) DeepCopyObject added in v1.128.0 

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

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

type DiscoveryEngineDataStoreTargetSiteObservedState added in v1.128.0 

type DiscoveryEngineDataStoreTargetSiteObservedState struct {
	// Output only. This is system-generated based on the provided_uri.
	GeneratedUriPattern *string `json:"generatedURIPattern,omitempty"`

	// Output only. Root domain of the provided_uri.
	RootDomainUri *string `json:"rootDomainURI,omitempty"`

	// Output only. Site ownership and validity verification status.
	SiteVerificationInfo *SiteVerificationInfo `json:"siteVerificationInfo,omitempty"`

	// Output only. Indexing status.
	IndexingStatus *string `json:"indexingStatus,omitempty"`

	// Output only. The target site's last updated time.
	UpdateTime *string `json:"updateTime,omitempty"`

	// Output only. Failure reason.
	FailureReason *TargetSite_FailureReason `json:"failureReason,omitempty"`
}

DiscoveryEngineDataStoreTargetSiteObservedState is the state of the DiscoveryEngineDataStoreTargetSite resource as most recently observed in GCP. +kcc:proto=google.cloud.discoveryengine.v1.TargetSite

func (*DiscoveryEngineDataStoreTargetSiteObservedState) DeepCopy added in v1.128.0 

func (in *DiscoveryEngineDataStoreTargetSiteObservedState) DeepCopy() *DiscoveryEngineDataStoreTargetSiteObservedState

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

func (*DiscoveryEngineDataStoreTargetSiteObservedState) DeepCopyInto added in v1.128.0 

func (in *DiscoveryEngineDataStoreTargetSiteObservedState) DeepCopyInto(out *DiscoveryEngineDataStoreTargetSiteObservedState)

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

type DiscoveryEngineDataStoreTargetSiteSpec added in v1.128.0 

type DiscoveryEngineDataStoreTargetSiteSpec struct {
	// The DataStore this target site should be part of.
	DataStoreRef *DiscoveryEngineDataStoreRef `json:"dataStoreRef,omitempty"`

	// Required. Input only. The user provided URI pattern from which the
	// `generated_uri_pattern` is generated.
	ProvidedUriPattern *string `json:"providedURIPattern,omitempty"`

	// The type of the target site, e.g., whether the site is to be included or
	// excluded.
	Type *string `json:"type,omitempty"`

	// Input only. If set to false, a uri_pattern is generated to include all
	// pages whose address contains the provided_uri_pattern. If set to true, an
	// uri_pattern is generated to try to be an exact match of the
	// provided_uri_pattern or just the specific page if the provided_uri_pattern
	// is a specific one. provided_uri_pattern is always normalized to
	// generate the URI pattern to be used by the search engine.
	ExactMatch *bool `json:"exactMatch,omitempty"`
}

DiscoveryEngineDataStoreTargetSiteSpec defines the desired state of DiscoveryEngineDataStoreTargetSite +kcc:proto=google.cloud.discoveryengine.v1.TargetSite

func (*DiscoveryEngineDataStoreTargetSiteSpec) DeepCopy added in v1.128.0 

func (in *DiscoveryEngineDataStoreTargetSiteSpec) DeepCopy() *DiscoveryEngineDataStoreTargetSiteSpec

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

func (*DiscoveryEngineDataStoreTargetSiteSpec) DeepCopyInto added in v1.128.0 

func (in *DiscoveryEngineDataStoreTargetSiteSpec) DeepCopyInto(out *DiscoveryEngineDataStoreTargetSiteSpec)

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

type DiscoveryEngineDataStoreTargetSiteStatus added in v1.128.0 

type DiscoveryEngineDataStoreTargetSiteStatus 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 DiscoveryEngineDataStoreTargetSite resource in GCP.
	ExternalRef *string `json:"externalRef,omitempty"`

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

DiscoveryEngineDataStoreTargetSiteStatus defines the config connector machine state of DiscoveryEngineDataStoreTargetSite

func (*DiscoveryEngineDataStoreTargetSiteStatus) DeepCopy added in v1.128.0 

func (in *DiscoveryEngineDataStoreTargetSiteStatus) DeepCopy() *DiscoveryEngineDataStoreTargetSiteStatus

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

func (*DiscoveryEngineDataStoreTargetSiteStatus) DeepCopyInto added in v1.128.0 

func (in *DiscoveryEngineDataStoreTargetSiteStatus) DeepCopyInto(out *DiscoveryEngineDataStoreTargetSiteStatus)

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

type DiscoveryEngineEngine added in v1.126.0 

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

	// +required
	Spec   DiscoveryEngineEngineSpec   `json:"spec,omitempty"`
	Status DiscoveryEngineEngineStatus `json:"status,omitempty"`
}

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

func (*DiscoveryEngineEngine) DeepCopy added in v1.126.0 

func (in *DiscoveryEngineEngine) DeepCopy() *DiscoveryEngineEngine

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

func (*DiscoveryEngineEngine) DeepCopyInto added in v1.126.0 

func (in *DiscoveryEngineEngine) DeepCopyInto(out *DiscoveryEngineEngine)

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

func (*DiscoveryEngineEngine) DeepCopyObject added in v1.126.0 

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

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

type DiscoveryEngineEngineID added in v1.126.0 

type DiscoveryEngineEngineID struct {
	*CollectionLink
	DataStore string
}

DiscoveryEngineEngineID is the resolved identifier for a DiscoveryEngineEngine

func NewDiscoveryEngineEngineRef added in v1.126.0 

func NewDiscoveryEngineEngineRef(ctx context.Context, reader client.Reader, obj *DiscoveryEngineEngine) (*DiscoveryEngineEngineID, error)

New builds a DiscoveryEngineEngineRef from the Config Connector DiscoveryEngineEngine object.

func (*DiscoveryEngineEngineID) DeepCopy added in v1.126.0 

func (in *DiscoveryEngineEngineID) DeepCopy() *DiscoveryEngineEngineID

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

func (*DiscoveryEngineEngineID) DeepCopyInto added in v1.126.0 

func (in *DiscoveryEngineEngineID) DeepCopyInto(out *DiscoveryEngineEngineID)

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

type DiscoveryEngineEngineList added in v1.126.0 

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

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

func (*DiscoveryEngineEngineList) DeepCopy added in v1.126.0 

func (in *DiscoveryEngineEngineList) DeepCopy() *DiscoveryEngineEngineList

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

func (*DiscoveryEngineEngineList) DeepCopyInto added in v1.126.0 

func (in *DiscoveryEngineEngineList) DeepCopyInto(out *DiscoveryEngineEngineList)

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

func (*DiscoveryEngineEngineList) DeepCopyObject added in v1.126.0 

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

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

type DiscoveryEngineEngineObservedState added in v1.126.0 

type DiscoveryEngineEngineObservedState struct {
}

DiscoveryEngineEngineObservedState is the state of the DiscoveryEngineEngine resource as most recently observed in GCP. +kcc:proto=google.cloud.discoveryengine.v1.Engine

func (*DiscoveryEngineEngineObservedState) DeepCopy added in v1.126.0 

func (in *DiscoveryEngineEngineObservedState) DeepCopy() *DiscoveryEngineEngineObservedState

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

func (*DiscoveryEngineEngineObservedState) DeepCopyInto added in v1.126.0 

func (in *DiscoveryEngineEngineObservedState) DeepCopyInto(out *DiscoveryEngineEngineObservedState)

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

type DiscoveryEngineEngineRef added in v1.126.0 

type DiscoveryEngineEngineRef struct {
	// A reference to an externally managed DiscoveryEngineEngine resource.
	// Should be in the format "projects/{{projectID}}/locations/{{location}}/engines/{{engineID}}".
	External string `json:"external,omitempty"`

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

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

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

func (*DiscoveryEngineEngineRef) DeepCopy added in v1.126.0 

func (in *DiscoveryEngineEngineRef) DeepCopy() *DiscoveryEngineEngineRef

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

func (*DiscoveryEngineEngineRef) DeepCopyInto added in v1.126.0 

func (in *DiscoveryEngineEngineRef) DeepCopyInto(out *DiscoveryEngineEngineRef)

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

func (*DiscoveryEngineEngineRef) NormalizedExternal added in v1.126.0 

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

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

type DiscoveryEngineEngineSpec added in v1.126.0 

type DiscoveryEngineEngineSpec struct {
	// Required. The display name of the engine. Should be human readable. UTF-8
	// encoded string with limit of 1024 characters.
	// +required
	DisplayName *string `json:"displayName,omitempty"`

	// The data stores associated with this engine.
	// For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of
	// engines, they can only associate with at most one data store.
	// If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the
	// same Collection can be associated here.
	// Note that when used in CreateEngineRequest, one DataStore must be
	// provided as the system will use it for necessary initializations.
	DataStoreRefs []*DiscoveryEngineDataStoreRef `json:"dataStoreRefs,omitempty"`

	// Required. The solutions of the engine.
	// +required
	SolutionType *string `json:"solutionType,omitempty"`

	// The industry vertical that the engine registers.
	// The restriction of the Engine industry vertical is based on
	// DataStore: If unspecified, default to `GENERIC`. Vertical on Engine
	// has to match vertical of the DataStore linked to the engine.
	IndustryVertical *string `json:"industryVertical,omitempty"`

	// Common config spec that specifies the metadata of the engine.
	CommonConfig *Engine_CommonConfig `json:"commonConfig,omitempty"`

	// Configurations for the Chat Engine. Only applicable if
	// solution_type is SOLUTION_TYPE_CHAT.
	ChatEngineConfig *Engine_ChatEngineConfig `json:"chatEngineConfig,omitempty"`

	// Configurations for the Search Engine. Only applicable if
	// solution_type is SOLUTION_TYPE_SEARCH.
	SearchEngineConfig *Engine_SearchEngineConfig `json:"searchEngineConfig,omitempty"`

	// Optional. Whether to disable analytics for searches performed on this
	//  engine.
	DisableAnalytics *bool `json:"disableAnalytics,omitempty"`

	/* Immutable. The Project that this resource belongs to. */
	ProjectRef *refs.ProjectRef `json:"projectRef"`

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

	// Immutable. The collection for the Engine.
	// +required
	Collection string `json:"collection"`

	// Immutable.
	// The DiscoveryEngineChatEngine name. If not given, the metadata.name will be used.
	ResourceID *string `json:"resourceID,omitempty"`
}

DiscoveryEngineEngineSpec defines the desired state of DiscoveryEngineEngine +kcc:proto=google.cloud.discoveryengine.v1.Engine

func (*DiscoveryEngineEngineSpec) DeepCopy added in v1.126.0 

func (in *DiscoveryEngineEngineSpec) DeepCopy() *DiscoveryEngineEngineSpec

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

func (*DiscoveryEngineEngineSpec) DeepCopyInto added in v1.126.0 

func (in *DiscoveryEngineEngineSpec) DeepCopyInto(out *DiscoveryEngineEngineSpec)

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

type DiscoveryEngineEngineStatus added in v1.126.0 

type DiscoveryEngineEngineStatus 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 DiscoveryEngineEngine resource in GCP.
	ExternalRef *string `json:"externalRef,omitempty"`

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

DiscoveryEngineEngineStatus defines the config connector machine state of DiscoveryEngineEngine

func (*DiscoveryEngineEngineStatus) DeepCopy added in v1.126.0 

func (in *DiscoveryEngineEngineStatus) DeepCopy() *DiscoveryEngineEngineStatus

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

func (*DiscoveryEngineEngineStatus) DeepCopyInto added in v1.126.0 

func (in *DiscoveryEngineEngineStatus) DeepCopyInto(out *DiscoveryEngineEngineStatus)

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`.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.name
	Name *string `json:"name,omitempty"`

	// Whether chunking mode is enabled.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.chunking_config
	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.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.default_parsing_config
	DefaultParsingConfig *DocumentProcessingConfig_ParsingConfig `json:"defaultParsingConfig,omitempty"`
}

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

func (*DocumentProcessingConfig) DeepCopy 

func (in *DocumentProcessingConfig) DeepCopy() *DocumentProcessingConfig

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.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ChunkingConfig.layout_based_chunking_config
	LayoutBasedChunkingConfig *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig `json:"layoutBasedChunkingConfig,omitempty"`
}

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

func (*DocumentProcessingConfig_ChunkingConfig) DeepCopy 

func (in *DocumentProcessingConfig_ChunkingConfig) DeepCopy() *DocumentProcessingConfig_ChunkingConfig

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

func (*DocumentProcessingConfig_ChunkingConfig) DeepCopyInto 

func (in *DocumentProcessingConfig_ChunkingConfig) DeepCopyInto(out *DocumentProcessingConfig_ChunkingConfig)

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.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.chunk_size
	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.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig.include_ancestor_headings
	IncludeAncestorHeadings *bool `json:"includeAncestorHeadings,omitempty"`
}

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

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) DeepCopy 

func (in *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) DeepCopy() *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig

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

func (*DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) DeepCopyInto 

func (in *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig) DeepCopyInto(out *DocumentProcessingConfig_ChunkingConfig_LayoutBasedChunkingConfig)

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.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ParsingConfig.digital_parsing_config
	DigitalParsingConfig *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig `json:"digitalParsingConfig,omitempty"`

	// Configurations applied to OCR parser. Currently it only applies to
	//  PDFs.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ParsingConfig.ocr_parsing_config
	OcrParsingConfig *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig `json:"ocrParsingConfig,omitempty"`

	// Configurations applied to layout parser.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ParsingConfig.layout_parsing_config
	LayoutParsingConfig *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig `json:"layoutParsingConfig,omitempty"`
}

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

func (*DocumentProcessingConfig_ParsingConfig) DeepCopy 

func (in *DocumentProcessingConfig_ParsingConfig) DeepCopy() *DocumentProcessingConfig_ParsingConfig

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

func (*DocumentProcessingConfig_ParsingConfig) DeepCopyInto 

func (in *DocumentProcessingConfig_ParsingConfig) DeepCopyInto(out *DocumentProcessingConfig_ParsingConfig)

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 

func (in *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) DeepCopy() *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig

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

func (*DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) DeepCopyInto 

func (in *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig) DeepCopyInto(out *DocumentProcessingConfig_ParsingConfig_DigitalParsingConfig)

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 

func (in *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) DeepCopy() *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig

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

func (*DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) DeepCopyInto 

func (in *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig) DeepCopyInto(out *DocumentProcessingConfig_ParsingConfig_LayoutParsingConfig)

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`.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ParsingConfig.OcrParsingConfig.enhanced_document_elements
	EnhancedDocumentElements []string `json:"enhancedDocumentElements,omitempty"`

	// If true, will use native text instead of OCR text on pages containing
	//  native text.
	// +kcc:proto=google.cloud.discoveryengine.v1.DocumentProcessingConfig.ParsingConfig.OcrParsingConfig.use_native_text
	UseNativeText *bool `json:"useNativeText,omitempty"`
}

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

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) DeepCopy 

func (in *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) DeepCopy() *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig

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

func (*DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) DeepCopyInto 

func (in *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig) DeepCopyInto(out *DocumentProcessingConfig_ParsingConfig_OcrParsingConfig)

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

type Engine_ChatEngineConfig added in v1.126.0 

type Engine_ChatEngineConfig struct {
	// The configurationt generate the Dialogflow agent that is associated to
	//  this Engine.
	//
	//  Note that these configurations are one-time consumed by
	//  and passed to Dialogflow service. It means they cannot be retrieved using
	//  [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine]
	//  or
	//  [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
	//  API after engine creation.
	// +kcc:proto=google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.agent_creation_config
	AgentCreationConfig *Engine_ChatEngineConfig_AgentCreationConfig `json:"agentCreationConfig,omitempty"`

	// The resource name of an exist Dialogflow agent to link to this Chat
	//  Engine. Customers can either provide `agent_creation_config` to create
	//  agent or provide an agent name that links the agent with the Chat engine.
	//
	//  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
	//  ID>`.
	//
	//  Note that the `dialogflow_agent_to_link` are one-time consumed by and
	//  passed to Dialogflow service. It means they cannot be retrieved using
	//  [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine]
	//  or
	//  [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
	//  API after engine creation. Use
	//  [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata.dialogflow_agent]
	//  for actual agent association after Engine is created.
	// +kcc:proto=google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.dialogflow_agent_to_link
	DialogflowAgentToLink *string `json:"dialogflowAgentToLink,omitempty"`
}

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

func (*Engine_ChatEngineConfig) DeepCopy added in v1.126.0 

func (in *Engine_ChatEngineConfig) DeepCopy() *Engine_ChatEngineConfig

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

func (*Engine_ChatEngineConfig) DeepCopyInto added in v1.126.0 

func (in *Engine_ChatEngineConfig) DeepCopyInto(out *Engine_ChatEngineConfig)

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

type Engine_ChatEngineConfig_AgentCreationConfig added in v1.126.0 

type Engine_ChatEngineConfig_AgentCreationConfig struct {
	// Name of the company, organization or other entity that the agent
	//  represents. Used for knowledge connector LLM prompt and for knowledge
	//  search.
	// +kcc:proto=google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.AgentCreationConfig.business
	Business *string `json:"business,omitempty"`

	// Required. The default language of the agent as a language tag.
	//  See [Language
	//  Support](https://cloud.google.com/dialogflow/docs/reference/language)
	//  for a list of the currently supported language codes.
	// +kcc:proto=google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.AgentCreationConfig.default_language_code
	DefaultLanguageCode *string `json:"defaultLanguageCode,omitempty"`

	// Required. The time zone of the agent from the [time zone
	//  database](https://www.iana.org/time-zones), e.g., America/New_York,
	//  Europe/Paris.
	// +kcc:proto=google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.AgentCreationConfig.time_zone
	TimeZone *string `json:"timeZone,omitempty"`

	// Agent location for Agent creation, supported values: global/us/eu.
	//  If not provided, us Engine will create Agent using us-central-1 by
	//  default; eu Engine will create Agent using eu-west-1 by default.
	// +kcc:proto=google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.AgentCreationConfig.location
	Location *string `json:"location,omitempty"`
}

+kcc:proto=google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.AgentCreationConfig

func (*Engine_ChatEngineConfig_AgentCreationConfig) DeepCopy added in v1.126.0 

func (in *Engine_ChatEngineConfig_AgentCreationConfig) DeepCopy() *Engine_ChatEngineConfig_AgentCreationConfig

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

func (*Engine_ChatEngineConfig_AgentCreationConfig) DeepCopyInto added in v1.126.0 

func (in *Engine_ChatEngineConfig_AgentCreationConfig) DeepCopyInto(out *Engine_ChatEngineConfig_AgentCreationConfig)

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

type Engine_ChatEngineMetadata added in v1.126.0 

type Engine_ChatEngineMetadata struct {
	// The resource name of a Dialogflow agent, that this Chat Engine refers
	//  to.
	//
	//  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
	//  ID>`.
	// +kcc:proto=google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata.dialogflow_agent
	DialogflowAgent *string `json:"dialogflowAgent,omitempty"`
}

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

func (*Engine_ChatEngineMetadata) DeepCopy added in v1.126.0 

func (in *Engine_ChatEngineMetadata) DeepCopy() *Engine_ChatEngineMetadata

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

func (*Engine_ChatEngineMetadata) DeepCopyInto added in v1.126.0 

func (in *Engine_ChatEngineMetadata) DeepCopyInto(out *Engine_ChatEngineMetadata)

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

type Engine_CommonConfig added in v1.126.0 

type Engine_CommonConfig struct {
	// The name of the company, business or entity that is associated with the
	//  engine. Setting this may help improve LLM related features.
	// +kcc:proto=google.cloud.discoveryengine.v1.Engine.CommonConfig.company_name
	CompanyName *string `json:"companyName,omitempty"`
}

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

func (*Engine_CommonConfig) DeepCopy added in v1.126.0 

func (in *Engine_CommonConfig) DeepCopy() *Engine_CommonConfig

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

func (*Engine_CommonConfig) DeepCopyInto added in v1.126.0 

func (in *Engine_CommonConfig) DeepCopyInto(out *Engine_CommonConfig)

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

type Engine_SearchEngineConfig added in v1.126.0 

type Engine_SearchEngineConfig struct {
	// The search feature tier of this engine.
	//
	//  Different tiers might have different
	//  pricing. To learn more, check the pricing documentation.
	//
	//  Defaults to
	//  [SearchTier.SEARCH_TIER_STANDARD][google.cloud.discoveryengine.v1.SearchTier.SEARCH_TIER_STANDARD]
	//  if not specified.
	// +kcc:proto=google.cloud.discoveryengine.v1.Engine.SearchEngineConfig.search_tier
	SearchTier *string `json:"searchTier,omitempty"`

	// The add-on that this search engine enables.
	// +kcc:proto=google.cloud.discoveryengine.v1.Engine.SearchEngineConfig.search_add_ons
	SearchAddOns []string `json:"searchAddOns,omitempty"`
}

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

func (*Engine_SearchEngineConfig) DeepCopy added in v1.126.0 

func (in *Engine_SearchEngineConfig) DeepCopy() *Engine_SearchEngineConfig

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

func (*Engine_SearchEngineConfig) DeepCopyInto added in v1.126.0 

func (in *Engine_SearchEngineConfig) DeepCopyInto(out *Engine_SearchEngineConfig)

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.
	// +kcc:proto=google.cloud.discoveryengine.v1.Schema.struct_schema
	StructSchema map[string]string `json:"structSchema,omitempty"`

	// The JSON representation of the schema.
	// +kcc:proto=google.cloud.discoveryengine.v1.Schema.json_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.
	// +kcc:proto=google.cloud.discoveryengine.v1.Schema.name
	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 SiteVerificationInfo added in v1.128.0 

type SiteVerificationInfo struct {
	// Site verification state indicating the ownership and validity.
	// +kcc:proto=google.cloud.discoveryengine.v1.SiteVerificationInfo.site_verification_state
	SiteVerificationState *string `json:"siteVerificationState,omitempty"`

	// Latest site verification time.
	// +kcc:proto=google.cloud.discoveryengine.v1.SiteVerificationInfo.verify_time
	VerifyTime *string `json:"verifyTime,omitempty"`
}

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

func (*SiteVerificationInfo) DeepCopy added in v1.128.0 

func (in *SiteVerificationInfo) DeepCopy() *SiteVerificationInfo

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

func (*SiteVerificationInfo) DeepCopyInto added in v1.128.0 

func (in *SiteVerificationInfo) DeepCopyInto(out *SiteVerificationInfo)

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

type TargetSiteIdentity added in v1.128.0 

type TargetSiteIdentity struct {
	*DiscoveryEngineDataStoreID
	TargetSite string
}

TargetSiteIdentity defines the full identity for a DataStoreTargetSite

+k8s:deepcopy-gen=false

func ParseTargetSiteExternal added in v1.128.0 

func ParseTargetSiteExternal(external string) (*TargetSiteIdentity, error)

func (*TargetSiteIdentity) String added in v1.128.0 

func (l *TargetSiteIdentity) String() string

type TargetSiteRef added in v1.128.0 

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

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

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

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

func (*TargetSiteRef) DeepCopy added in v1.128.0 

func (in *TargetSiteRef) DeepCopy() *TargetSiteRef

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

func (*TargetSiteRef) DeepCopyInto added in v1.128.0 

func (in *TargetSiteRef) DeepCopyInto(out *TargetSiteRef)

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

func (*TargetSiteRef) NormalizedExternal added in v1.128.0 

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

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

type TargetSite_FailureReason added in v1.128.0 

type TargetSite_FailureReason struct {
	// Failed due to insufficient quota.
	// +kcc:proto=google.cloud.discoveryengine.v1.TargetSite.FailureReason.quota_failure
	QuotaFailure *TargetSite_FailureReason_QuotaFailure `json:"quotaFailure,omitempty"`
}

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

func (*TargetSite_FailureReason) DeepCopy added in v1.128.0 

func (in *TargetSite_FailureReason) DeepCopy() *TargetSite_FailureReason

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

func (*TargetSite_FailureReason) DeepCopyInto added in v1.128.0 

func (in *TargetSite_FailureReason) DeepCopyInto(out *TargetSite_FailureReason)

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

type TargetSite_FailureReason_QuotaFailure added in v1.128.0 

type TargetSite_FailureReason_QuotaFailure struct {
	// This number is an estimation on how much total quota this project needs
	//  to successfully complete indexing.
	// +kcc:proto=google.cloud.discoveryengine.v1.TargetSite.FailureReason.QuotaFailure.total_required_quota
	TotalRequiredQuota *int64 `json:"totalRequiredQuota,omitempty"`
}

+kcc:proto=google.cloud.discoveryengine.v1.TargetSite.FailureReason.QuotaFailure

func (*TargetSite_FailureReason_QuotaFailure) DeepCopy added in v1.128.0 

func (in *TargetSite_FailureReason_QuotaFailure) DeepCopy() *TargetSite_FailureReason_QuotaFailure

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

func (*TargetSite_FailureReason_QuotaFailure) DeepCopyInto added in v1.128.0 

func (in *TargetSite_FailureReason_QuotaFailure) DeepCopyInto(out *TargetSite_FailureReason_QuotaFailure)

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.
	// +kcc:proto=google.cloud.discoveryengine.v1.WorkspaceConfig.type
	Type *string `json:"type,omitempty"`

	// Obfuscated Dasher customer ID.
	// +kcc:proto=google.cloud.discoveryengine.v1.WorkspaceConfig.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.
	// +kcc:proto=google.cloud.discoveryengine.v1.WorkspaceConfig.super_admin_service_account
	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.
	// +kcc:proto=google.cloud.discoveryengine.v1.WorkspaceConfig.super_admin_email_address
	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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.