Package com.google.cloud.discoveryengine.v1alpha

Class SetUriPatternDocumentDataRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SetUriPatternDocumentDataRequest.Builder>
com.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.Builder
All Implemented Interfaces:
SetUriPatternDocumentDataRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SetUriPatternDocumentDataRequest
public static final class SetUriPatternDocumentDataRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SetUriPatternDocumentDataRequest.Builder> implements SetUriPatternDocumentDataRequestOrBuilder
 Request message for
 [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
 method.
Protobuf type google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SetUriPatternDocumentDataRequest.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SetUriPatternDocumentDataRequest.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SetUriPatternDocumentDataRequest.Builder>

    • clear

      public SetUriPatternDocumentDataRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SetUriPatternDocumentDataRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SetUriPatternDocumentDataRequest.Builder>

    • getDefaultInstanceForType

      public SetUriPatternDocumentDataRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SetUriPatternDocumentDataRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SetUriPatternDocumentDataRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SetUriPatternDocumentDataRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SetUriPatternDocumentDataRequest.Builder>

    • mergeFrom

      public SetUriPatternDocumentDataRequest.Builder mergeFrom(SetUriPatternDocumentDataRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SetUriPatternDocumentDataRequest.Builder>

    • mergeFrom

      public SetUriPatternDocumentDataRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SetUriPatternDocumentDataRequest.Builder>
      Throws:
      IOException

    • getSiteSearchEngine

      public 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) = { ... }
      Specified by:
      getSiteSearchEngine in interface SetUriPatternDocumentDataRequestOrBuilder
      Returns:
      The siteSearchEngine.

    • getSiteSearchEngineBytes

      public 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) = { ... }
      Specified by:
      getSiteSearchEngineBytes in interface SetUriPatternDocumentDataRequestOrBuilder
      Returns:
      The bytes for siteSearchEngine.

    • setSiteSearchEngine

      public SetUriPatternDocumentDataRequest.Builder setSiteSearchEngine(String value)
       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) = { ... }
      Parameters:
      value - The siteSearchEngine to set.
      Returns:
      This builder for chaining.

    • clearSiteSearchEngine

      public SetUriPatternDocumentDataRequest.Builder clearSiteSearchEngine()
       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:
      This builder for chaining.

    • setSiteSearchEngineBytes

      public SetUriPatternDocumentDataRequest.Builder setSiteSearchEngineBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for siteSearchEngine to set.
      Returns:
      This builder for chaining.

    • getDocumentDataMapCount

      public int getDocumentDataMapCount()
      Description copied from interface: SetUriPatternDocumentDataRequestOrBuilder
       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;
      Specified by:
      getDocumentDataMapCount in interface SetUriPatternDocumentDataRequestOrBuilder

    • containsDocumentDataMap

      public 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;
      Specified by:
      containsDocumentDataMap in interface SetUriPatternDocumentDataRequestOrBuilder

    • getDocumentDataMap

      @Deprecated public Map<String,com.google.protobuf.Struct> getDocumentDataMap()
      Deprecated.
      Use getDocumentDataMapMap() instead.
      Specified by:
      getDocumentDataMap in interface SetUriPatternDocumentDataRequestOrBuilder

    • getDocumentDataMapMap

      public 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;
      Specified by:
      getDocumentDataMapMap in interface SetUriPatternDocumentDataRequestOrBuilder

    • getDocumentDataMapOrDefault

      public 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;
      Specified by:
      getDocumentDataMapOrDefault in interface SetUriPatternDocumentDataRequestOrBuilder

    • getDocumentDataMapOrThrow

      public 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;
      Specified by:
      getDocumentDataMapOrThrow in interface SetUriPatternDocumentDataRequestOrBuilder

    • clearDocumentDataMap

      public SetUriPatternDocumentDataRequest.Builder clearDocumentDataMap()

    • removeDocumentDataMap

      public SetUriPatternDocumentDataRequest.Builder removeDocumentDataMap(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;

    • getMutableDocumentDataMap

      @Deprecated public Map<String,com.google.protobuf.Struct> getMutableDocumentDataMap()
      Deprecated.
      Use alternate mutation accessors instead.

    • putDocumentDataMap

      public SetUriPatternDocumentDataRequest.Builder putDocumentDataMap(String key, com.google.protobuf.Struct value)
       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;

    • putAllDocumentDataMap

      public SetUriPatternDocumentDataRequest.Builder putAllDocumentDataMap(Map<String,com.google.protobuf.Struct> values)
       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;

    • putDocumentDataMapBuilderIfAbsent

      public com.google.protobuf.Struct.Builder putDocumentDataMapBuilderIfAbsent(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

      public 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;
      Specified by:
      getEmptyDocumentDataMap in interface SetUriPatternDocumentDataRequestOrBuilder
      Returns:
      The emptyDocumentDataMap.

    • setEmptyDocumentDataMap

      public SetUriPatternDocumentDataRequest.Builder setEmptyDocumentDataMap(boolean value)
       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;
      Parameters:
      value - The emptyDocumentDataMap to set.
      Returns:
      This builder for chaining.

    • clearEmptyDocumentDataMap

      public SetUriPatternDocumentDataRequest.Builder clearEmptyDocumentDataMap()
       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:
      This builder for chaining.

    • hasSchema

      public 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;
      Specified by:
      hasSchema in interface SetUriPatternDocumentDataRequestOrBuilder
      Returns:
      Whether the schema field is set.

    • getSchema

      public 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;
      Specified by:
      getSchema in interface SetUriPatternDocumentDataRequestOrBuilder
      Returns:
      The schema.

    • setSchema

      public SetUriPatternDocumentDataRequest.Builder setSchema(com.google.protobuf.Struct value)
       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;

    • setSchema

      public SetUriPatternDocumentDataRequest.Builder setSchema(com.google.protobuf.Struct.Builder builderForValue)
       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;

    • mergeSchema

      public SetUriPatternDocumentDataRequest.Builder mergeSchema(com.google.protobuf.Struct value)
       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;

    • clearSchema

      public SetUriPatternDocumentDataRequest.Builder clearSchema()
       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;

    • getSchemaBuilder

      public com.google.protobuf.Struct.Builder getSchemaBuilder()
       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;

    • getSchemaOrBuilder

      public 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;
      Specified by:
      getSchemaOrBuilder in interface SetUriPatternDocumentDataRequestOrBuilder