Struct DataStore

#[non_exhaustive]
pub struct DataStore {

    pub name: String,
    pub display_name: String,
    pub industry_vertical: IndustryVertical,
    pub solution_types: Vec<SolutionType>,
    pub default_schema_id: String,
    pub content_config: ContentConfig,
    pub create_time: Option<Timestamp>,
    pub advanced_site_search_config: Option<AdvancedSiteSearchConfig>,
    pub kms_key_name: String,
    pub cmek_config: Option<CmekConfig>,
    pub billing_estimation: Option<BillingEstimation>,
    pub acl_enabled: bool,
    pub workspace_config: Option<WorkspaceConfig>,
    pub document_processing_config: Option<DocumentProcessingConfig>,
    pub starting_schema: Option<Schema>,
    pub healthcare_fhir_config: Option<HealthcareFhirConfig>,
    pub identity_mapping_store: String,
    /* private fields */
}

DataStore captures global settings and configs at the DataStore level.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Immutable. Identifier. 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: IndustryVertical

Immutable. The industry vertical that the data store registers.

solution_types: Vec<SolutionType>

The solutions that the data store enrolls. Available solutions for each 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 associated to this data store.

content_config: ContentConfig

Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.

create_time: Option<Timestamp>

Output only. Timestamp the DataStore was created at.

advanced_site_search_config: Option<AdvancedSiteSearchConfig>

Optional. Configuration for advanced site search.

kms_key_name: String

Input only. The KMS key to be used to protect this DataStore at creation time.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.

cmek_config: Option<CmekConfig>

Output only. CMEK-related information for the DataStore.

billing_estimation: Option<BillingEstimation>

Output only. Data size estimation for billing.

acl_enabled: bool

Immutable. Whether data in the 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 methods.

When ACL is enabled for the DataStore, Document can’t be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments.

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

workspace_config: Option<WorkspaceConfig>

Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.

document_processing_config: Option<DocumentProcessingConfig>

Configuration for Document understanding and enrichment.

starting_schema: Option<Schema>

The start schema to use for this 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, use SchemaService.GetSchema API instead.

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

healthcare_fhir_config: Option<HealthcareFhirConfig>

Optional. Configuration for HEALTHCARE_FHIR vertical.

identity_mapping_store: String

Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with THIRD_PARTY or GSUITE IdP. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.

Implementations

impl DataStore

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_industry_vertical<T: Into<IndustryVertical>>(self, v: T) -> Self

Sets the value of industry_vertical.

pub fn set_solution_types<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<SolutionType>,

Sets the value of solution_types.

pub fn set_default_schema_id<T: Into<String>>(self, v: T) -> Self

Sets the value of default_schema_id.

pub fn set_content_config<T: Into<ContentConfig>>(self, v: T) -> Self

Sets the value of content_config.

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

pub fn set_advanced_site_search_config<T>(self, v: T) -> Self

where T: Into<AdvancedSiteSearchConfig>,

Sets the value of advanced_site_search_config.

pub fn set_or_clear_advanced_site_search_config<T>(self, v: Option<T>) -> Self

where T: Into<AdvancedSiteSearchConfig>,

Sets or clears the value of advanced_site_search_config.

pub fn set_kms_key_name<T: Into<String>>(self, v: T) -> Self

Sets the value of kms_key_name.

pub fn set_cmek_config<T>(self, v: T) -> Self

where T: Into<CmekConfig>,

Sets the value of cmek_config.

pub fn set_or_clear_cmek_config<T>(self, v: Option<T>) -> Self

where T: Into<CmekConfig>,

Sets or clears the value of cmek_config.

pub fn set_billing_estimation<T>(self, v: T) -> Self

where T: Into<BillingEstimation>,

Sets the value of billing_estimation.

pub fn set_or_clear_billing_estimation<T>(self, v: Option<T>) -> Self

where T: Into<BillingEstimation>,

Sets or clears the value of billing_estimation.

pub fn set_acl_enabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of acl_enabled.

pub fn set_workspace_config<T>(self, v: T) -> Self

where T: Into<WorkspaceConfig>,

Sets the value of workspace_config.

pub fn set_or_clear_workspace_config<T>(self, v: Option<T>) -> Self

where T: Into<WorkspaceConfig>,

Sets or clears the value of workspace_config.

pub fn set_document_processing_config<T>(self, v: T) -> Self

where T: Into<DocumentProcessingConfig>,

Sets the value of document_processing_config.

pub fn set_or_clear_document_processing_config<T>(self, v: Option<T>) -> Self

where T: Into<DocumentProcessingConfig>,

Sets or clears the value of document_processing_config.

pub fn set_starting_schema<T>(self, v: T) -> Self

where T: Into<Schema>,

Sets the value of starting_schema.

pub fn set_or_clear_starting_schema<T>(self, v: Option<T>) -> Self

where T: Into<Schema>,

Sets or clears the value of starting_schema.

pub fn set_healthcare_fhir_config<T>(self, v: T) -> Self

where T: Into<HealthcareFhirConfig>,

Sets the value of healthcare_fhir_config.

pub fn set_or_clear_healthcare_fhir_config<T>(self, v: Option<T>) -> Self

where T: Into<HealthcareFhirConfig>,

Sets or clears the value of healthcare_fhir_config.

pub fn set_identity_mapping_store<T: Into<String>>(self, v: T) -> Self

Sets the value of identity_mapping_store.

Trait Implementations

impl Clone for DataStore

fn clone(&self) -> DataStore

Returns a duplicate of the value.

const 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() -> DataStore

Returns the “default value” for a type.

impl Message for DataStore

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DataStore

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DataStore