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

Instance Attribute Summary collapse

Instance Attribute Details

#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:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 84

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

  # 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
  end
end

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

Returns Output only. Timestamp the DataStore was created at.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 84

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

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 84

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

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 84

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

  # 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
  end
end

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

Returns Configuration for Document understanding and enrichment.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 84

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

  # 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
  end
end

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

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

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 84

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

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 84

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

  # 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
  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:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 84

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

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 84

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

  # 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
  end
end