Struct google_api_proto::google::cloud::discoveryengine::v1alpha::DataStore

pub struct DataStore {
    pub name: String,
    pub display_name: String,
    pub industry_vertical: i32,
    pub solution_types: Vec<i32>,
    pub default_schema_id: String,
    pub content_config: i32,
    pub create_time: Option<Timestamp>,
    pub idp_config: Option<IdpConfig>,
    pub acl_enabled: bool,
    pub document_processing_config: Option<DocumentProcessingConfig>,
    pub starting_schema: Option<Schema>,
}

DataStore captures global settings and configs at the DataStore level.

Fields

name: String

Immutable. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

display_name: String

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.

industry_vertical: i32

Immutable. The industry vertical that the data store registers.

solution_types: Vec<i32>

The solutions that the data store enrolls. Available solutions for each [industry_vertical][google.cloud.discoveryengine.v1alpha.DataStore.industry_vertical]:

• MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
• SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.

default_schema_id: String

Output only. The id of the default [Schema][google.cloud.discoveryengine.v1alpha.Schema] asscociated to this data store.

content_config: i32

Immutable. The content config of the data store. If this field is unset, the server behavior defaults to [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.NO_CONTENT].

create_time: Option<Timestamp>

Output only. Timestamp the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] was created at.

idp_config: Option<IdpConfig>

Output only. Data store level identity provider config.

acl_enabled: bool

Immutable. Whether data in the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] has ACL information. If set to true, the source data must have ACL. ACL will be ingested when data is ingested by [DocumentService.ImportDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments] methods.

When ACL is enabled for the [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], [Document][google.cloud.discoveryengine.v1alpha.Document] can’t be accessed by calling [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments].

Currently ACL is only supported in GENERIC industry vertical with non-PUBLIC_WEBSITE content config.

document_processing_config: Option<DocumentProcessingConfig>

Configuration for Document understanding and enrichment.

starting_schema: Option<Schema>

The start schema to use for this [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] when provisioning it. If unset, a default vertical specialized schema will be used.

This field is only used by [CreateDataStore][] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [CreateDataStore][] API. To retrieve a schema of a [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], use [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema] API instead.

The provided schema will be validated against certain rules on schema. Learn more from this doc.

Implementations

impl DataStore

pub fn industry_vertical(&self) -> IndustryVertical

Returns the enum value of industry_vertical, or the default if the field is set to an invalid enum value.

pub fn set_industry_vertical(&mut self, value: IndustryVertical)

Sets industry_vertical to the provided enum value.

pub fn solution_types( &self ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<SolutionType>>

Returns an iterator which yields the valid enum values contained in solution_types.

pub fn push_solution_types(&mut self, value: SolutionType)

Appends the provided enum value to solution_types.

pub fn content_config(&self) -> ContentConfig

Returns the enum value of content_config, or the default if the field is set to an invalid enum value.

pub fn set_content_config(&mut self, value: ContentConfig)

Sets content_config to the provided enum value.

Trait Implementations

impl Clone for DataStore

fn clone(&self) -> DataStore

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataStore

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DataStore

fn default() -> Self

Returns the “default value” for a type.

impl Message for DataStore

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DataStore

fn eq(&self, other: &DataStore) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DataStore