Class: Google::Cloud::DiscoveryEngine::V1beta::DataStore

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

Overview

DataStore captures global settings and configs at the DataStore level.

Defined Under Namespace

Modules: ContentConfig Classes: BillingEstimation, ServingConfigDataStore

Instance Attribute Summary collapse

Instance Attribute Details

#billing_estimation::Google::Cloud::DiscoveryEngine::V1beta::DataStore::BillingEstimation (readonly)

Returns Output only. Data size estimation for billing.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#content_config::Google::Cloud::DiscoveryEngine::V1beta::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:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

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

Returns Output only. Timestamp the DataStore was created at.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#default_schema_id::String (readonly)

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

Returns:

  • (::String)

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#document_processing_config::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig

Returns Configuration for Document understanding and enrichment.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#industry_vertical::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical

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

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#language_info::Google::Cloud::DiscoveryEngine::V1beta::LanguageInfo

Returns Language info for DataStore.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#name::String

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

Returns:

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#natural_language_query_understanding_config::Google::Cloud::DiscoveryEngine::V1beta::NaturalLanguageQueryUnderstandingConfig

Returns Optional. Configuration for Natural Language Query Understanding.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#serving_config_data_store::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ServingConfigDataStore

Returns Optional. Stores serving config at DataStore level.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#solution_types::Array<::Google::Cloud::DiscoveryEngine::V1beta::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:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#starting_schema::Google::Cloud::DiscoveryEngine::V1beta::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:

  • (::Google::Cloud::DiscoveryEngine::V1beta::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.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end

#workspace_config::Google::Cloud::DiscoveryEngine::V1beta::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:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 103

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

  # Stores information regarding the serving configurations at DataStore level.
  # @!attribute [rw] disabled_for_serving
  #   @return [::Boolean]
  #     If set true, the DataStore will not be available for serving search
  #     requests.
  class ServingConfigDataStore
    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::V1beta::Document#content Document.content}.
    NO_CONTENT = 1

    # Only contains documents with
    # {::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::WorkspaceConfig WorkspaceConfig}.
    GOOGLE_WORKSPACE = 4
  end
end