Package com.google.cloud.discoveryengine.v1alpha

Interface SetUriPatternDocumentDataRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SetUriPatternDocumentDataRequest, SetUriPatternDocumentDataRequest.Builder
@Generated public interface SetUriPatternDocumentDataRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getSiteSearchEngine

      String getSiteSearchEngine()
       Required. Full resource name of the
 [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
 such as
 `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
      string site_search_engine = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The siteSearchEngine.

    • getSiteSearchEngineBytes

      com.google.protobuf.ByteString getSiteSearchEngineBytes()
       Required. Full resource name of the
 [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
 such as
 `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
      string site_search_engine = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for siteSearchEngine.

    • getDocumentDataMapCount

      int getDocumentDataMapCount()
       Document data keyed by URI pattern. Each entry must be consistent with
 the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
 "type": "object",
 "properties": {
 "Categories": {
 "type": "array",
 "items": {
 "retrievable": true,
 "type": "string"
 }
 }
 }

 document_data_map = {
 "www.url1.com/*": {
 "Categories": ["category1", "category2"]
 },
 "www.url2.com/*": {
 "Categories": ["category3"]
 }
 }
      map<string, .google.protobuf.Struct> document_data_map = 2;

    • containsDocumentDataMap

      boolean containsDocumentDataMap(String key)
       Document data keyed by URI pattern. Each entry must be consistent with
 the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
 "type": "object",
 "properties": {
 "Categories": {
 "type": "array",
 "items": {
 "retrievable": true,
 "type": "string"
 }
 }
 }

 document_data_map = {
 "www.url1.com/*": {
 "Categories": ["category1", "category2"]
 },
 "www.url2.com/*": {
 "Categories": ["category3"]
 }
 }
      map<string, .google.protobuf.Struct> document_data_map = 2;

    • getDocumentDataMap

      @Deprecated Map<String,com.google.protobuf.Struct> getDocumentDataMap()
      Deprecated.
      Use getDocumentDataMapMap() instead.

    • getDocumentDataMapMap

      Map<String,com.google.protobuf.Struct> getDocumentDataMapMap()
       Document data keyed by URI pattern. Each entry must be consistent with
 the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
 "type": "object",
 "properties": {
 "Categories": {
 "type": "array",
 "items": {
 "retrievable": true,
 "type": "string"
 }
 }
 }

 document_data_map = {
 "www.url1.com/*": {
 "Categories": ["category1", "category2"]
 },
 "www.url2.com/*": {
 "Categories": ["category3"]
 }
 }
      map<string, .google.protobuf.Struct> document_data_map = 2;

    • getDocumentDataMapOrDefault

      com.google.protobuf.Struct getDocumentDataMapOrDefault(String key, com.google.protobuf.Struct defaultValue)
       Document data keyed by URI pattern. Each entry must be consistent with
 the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
 "type": "object",
 "properties": {
 "Categories": {
 "type": "array",
 "items": {
 "retrievable": true,
 "type": "string"
 }
 }
 }

 document_data_map = {
 "www.url1.com/*": {
 "Categories": ["category1", "category2"]
 },
 "www.url2.com/*": {
 "Categories": ["category3"]
 }
 }
      map<string, .google.protobuf.Struct> document_data_map = 2;

    • getDocumentDataMapOrThrow

      com.google.protobuf.Struct getDocumentDataMapOrThrow(String key)
       Document data keyed by URI pattern. Each entry must be consistent with
 the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
 "type": "object",
 "properties": {
 "Categories": {
 "type": "array",
 "items": {
 "retrievable": true,
 "type": "string"
 }
 }
 }

 document_data_map = {
 "www.url1.com/*": {
 "Categories": ["category1", "category2"]
 },
 "www.url2.com/*": {
 "Categories": ["category3"]
 }
 }
      map<string, .google.protobuf.Struct> document_data_map = 2;

    • getEmptyDocumentDataMap

      boolean getEmptyDocumentDataMap()
       If true, clears the document data map. If true,
 [SetUriPatternDocumentDataRequest.document_data_map][google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.document_data_map]
 must be empty.
      bool empty_document_data_map = 4;
      Returns:
      The emptyDocumentDataMap.

    • hasSchema

      boolean hasSchema()
       Optional. If not provided, the current
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] is used. If provided,
 validates and updates the
 [Schema][google.cloud.discoveryengine.v1alpha.Schema]. If validation fails,
 an error is returned.
      .google.protobuf.Struct schema = 3;
      Returns:
      Whether the schema field is set.

    • getSchema

      com.google.protobuf.Struct getSchema()
       Optional. If not provided, the current
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] is used. If provided,
 validates and updates the
 [Schema][google.cloud.discoveryengine.v1alpha.Schema]. If validation fails,
 an error is returned.
      .google.protobuf.Struct schema = 3;
      Returns:
      The schema.

    • getSchemaOrBuilder

      com.google.protobuf.StructOrBuilder getSchemaOrBuilder()
       Optional. If not provided, the current
 [Schema][google.cloud.discoveryengine.v1alpha.Schema] is used. If provided,
 validates and updates the
 [Schema][google.cloud.discoveryengine.v1alpha.Schema]. If validation fails,
 an error is returned.
      .google.protobuf.Struct schema = 3;