Class: Google::Cloud::DiscoveryEngine::V1::DataStore

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/data_store.rb

Overview

DataStore captures global settings and configs at the DataStore level.

Defined Under Namespace

Modules: ContentConfig Classes: BillingEstimation

Instance Attribute Summary collapse

Instance Attribute Details

#acl_enabled ⇒ ::Boolean

Returns 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.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#advanced_site_search_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::AdvancedSiteSearchConfig

Returns Optional. Configuration for advanced site search.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#billing_estimation ⇒ ::Google::Cloud::DiscoveryEngine::V1::DataStore::BillingEstimation (readonly)

Returns Output only. Data size estimation for billing.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#cmek_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::CmekConfig (readonly)

Returns Output only. CMEK-related information for the DataStore.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#content_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig

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

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp the DataStore was created at.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#default_schema_id ⇒ ::String (readonly)

Returns Output only. The id of the default Schema associated to this data store.

Returns:

  • (::String) —

    Output only. The id of the default Schema associated to this data store.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#display_name ⇒ ::String

Returns 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.

Returns:

  • (::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.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#document_processing_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::DocumentProcessingConfig

Returns Configuration for Document understanding and enrichment.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#healthcare_fhir_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig

Returns Optional. Configuration for HEALTHCARE_FHIR vertical.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#identity_mapping_store ⇒ ::String

Returns 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}.

Returns:

  • (::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}.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#industry_vertical ⇒ ::Google::Cloud::DiscoveryEngine::V1::IndustryVertical

Returns Immutable. The industry vertical that the data store registers.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#kms_key_name ⇒ ::String

Returns 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.

Returns:

  • (::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.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#name ⇒ ::String

Returns 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.

Returns:

  • (::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.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#solution_types ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::SolutionType>

Returns 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.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#starting_schema ⇒ ::Google::Cloud::DiscoveryEngine::V1::Schema

Returns 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.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#workspace_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig

Returns 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.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store.rb', line 141

class DataStore
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Estimation of data size per data store.
  # @!attribute [rw] structured_data_size
  #   @return [::Integer]
  #     Data size for structured data in terms of bytes.
  # @!attribute [rw] unstructured_data_size
  #   @return [::Integer]
  #     Data size for unstructured data in terms of bytes.
  # @!attribute [rw] website_data_size
  #   @return [::Integer]
  #     Data size for websites in terms of bytes.
  # @!attribute [rw] structured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for structured data.
  # @!attribute [rw] unstructured_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for unstructured data.
  # @!attribute [rw] website_data_update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Last updated timestamp for websites.
  class BillingEstimation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Content config of the data store.
  module ContentConfig
    # Default value.
    CONTENT_CONFIG_UNSPECIFIED = 0

    # Only contains documents without any
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1::Document#content Document.content}.
    CONTENT_REQUIRED = 2

    # The data store is used for public website search.
    PUBLIC_WEBSITE = 3

    # The data store is used for workspace search. Details of workspace
    # data store are specified in the
    # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end