Package com.google.cloud.discoveryengine.v1beta

Class ConverseConversationRequest.Builder

  • All Implemented Interfaces:
    ConverseConversationRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ConverseConversationRequest
    public static final class ConverseConversationRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ConverseConversationRequest.Builder>
implements ConverseConversationRequestOrBuilder
     Request message for
 [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation]
 method.
    Protobuf type google.cloud.discoveryengine.v1beta.ConverseConversationRequest

    • Method Detail

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<ConverseConversationRequest.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<ConverseConversationRequest.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ConverseConversationRequest.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.GeneratedMessageV3.Builder<ConverseConversationRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

        public ConverseConversationRequest.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<ConverseConversationRequest.Builder>
        Throws:
        IOException

      • getName

        public String getName()
         Required. The resource name of the Conversation to get. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
 Use
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
 to activate auto session mode, which automatically creates a new
 conversation inside a ConverseConversation session.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface ConverseConversationRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The resource name of the Conversation to get. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
 Use
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
 to activate auto session mode, which automatically creates a new
 conversation inside a ConverseConversation session.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface ConverseConversationRequestOrBuilder
        Returns:
        The bytes for name.

      • setName

        public ConverseConversationRequest.Builder setName​(String value)
         Required. The resource name of the Conversation to get. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
 Use
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
 to activate auto session mode, which automatically creates a new
 conversation inside a ConverseConversation session.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public ConverseConversationRequest.Builder clearName()
         Required. The resource name of the Conversation to get. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
 Use
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
 to activate auto session mode, which automatically creates a new
 conversation inside a ConverseConversation session.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setNameBytes

        public ConverseConversationRequest.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Required. The resource name of the Conversation to get. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
 Use
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
 to activate auto session mode, which automatically creates a new
 conversation inside a ConverseConversation session.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • hasQuery

        public boolean hasQuery()
         Required. Current user input.
        .google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasQuery in interface ConverseConversationRequestOrBuilder
        Returns:
        Whether the query field is set.

      • getQuery

        public TextInput getQuery()
         Required. Current user input.
        .google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getQuery in interface ConverseConversationRequestOrBuilder
        Returns:
        The query.

      • clearQuery

        public ConverseConversationRequest.Builder clearQuery()
         Required. Current user input.
        .google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

      • getQueryBuilder

        public TextInput.Builder getQueryBuilder()
         Required. Current user input.
        .google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

      • getServingConfig

        public String getServingConfig()
         The resource name of the Serving Config to use. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
 If this is not set, the default serving config will be used.
        string serving_config = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getServingConfig in interface ConverseConversationRequestOrBuilder
        Returns:
        The servingConfig.

      • getServingConfigBytes

        public com.google.protobuf.ByteString getServingConfigBytes()
         The resource name of the Serving Config to use. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
 If this is not set, the default serving config will be used.
        string serving_config = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getServingConfigBytes in interface ConverseConversationRequestOrBuilder
        Returns:
        The bytes for servingConfig.

      • setServingConfig

        public ConverseConversationRequest.Builder setServingConfig​(String value)
         The resource name of the Serving Config to use. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
 If this is not set, the default serving config will be used.
        string serving_config = 3 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The servingConfig to set.
        Returns:
        This builder for chaining.

      • clearServingConfig

        public ConverseConversationRequest.Builder clearServingConfig()
         The resource name of the Serving Config to use. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
 If this is not set, the default serving config will be used.
        string serving_config = 3 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setServingConfigBytes

        public ConverseConversationRequest.Builder setServingConfigBytes​(com.google.protobuf.ByteString value)
         The resource name of the Serving Config to use. Format:
 `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
 If this is not set, the default serving config will be used.
        string serving_config = 3 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for servingConfig to set.
        Returns:
        This builder for chaining.

      • hasConversation

        public boolean hasConversation()
         The conversation to be used by auto session only. The name field will be
 ignored as we automatically assign new name for the conversation in auto
 session.
        .google.cloud.discoveryengine.v1beta.Conversation conversation = 5;
        Specified by:
        hasConversation in interface ConverseConversationRequestOrBuilder
        Returns:
        Whether the conversation field is set.

      • getConversation

        public Conversation getConversation()
         The conversation to be used by auto session only. The name field will be
 ignored as we automatically assign new name for the conversation in auto
 session.
        .google.cloud.discoveryengine.v1beta.Conversation conversation = 5;
        Specified by:
        getConversation in interface ConverseConversationRequestOrBuilder
        Returns:
        The conversation.

      • setConversation

        public ConverseConversationRequest.Builder setConversation​(Conversation value)
         The conversation to be used by auto session only. The name field will be
 ignored as we automatically assign new name for the conversation in auto
 session.
        .google.cloud.discoveryengine.v1beta.Conversation conversation = 5;

      • setConversation

        public ConverseConversationRequest.Builder setConversation​(Conversation.Builder builderForValue)
         The conversation to be used by auto session only. The name field will be
 ignored as we automatically assign new name for the conversation in auto
 session.
        .google.cloud.discoveryengine.v1beta.Conversation conversation = 5;

      • mergeConversation

        public ConverseConversationRequest.Builder mergeConversation​(Conversation value)
         The conversation to be used by auto session only. The name field will be
 ignored as we automatically assign new name for the conversation in auto
 session.
        .google.cloud.discoveryengine.v1beta.Conversation conversation = 5;

      • clearConversation

        public ConverseConversationRequest.Builder clearConversation()
         The conversation to be used by auto session only. The name field will be
 ignored as we automatically assign new name for the conversation in auto
 session.
        .google.cloud.discoveryengine.v1beta.Conversation conversation = 5;

      • getConversationBuilder

        public Conversation.Builder getConversationBuilder()
         The conversation to be used by auto session only. The name field will be
 ignored as we automatically assign new name for the conversation in auto
 session.
        .google.cloud.discoveryengine.v1beta.Conversation conversation = 5;

      • setSafeSearch

        public ConverseConversationRequest.Builder setSafeSearch​(boolean value)
         Whether to turn on safe search.
        bool safe_search = 6;
        Parameters:
        value - The safeSearch to set.
        Returns:
        This builder for chaining.

      • getUserLabelsCount

        public int getUserLabelsCount()
        Description copied from interface: ConverseConversationRequestOrBuilder
         The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
        map<string, string> user_labels = 7;
        Specified by:
        getUserLabelsCount in interface ConverseConversationRequestOrBuilder

      • containsUserLabels

        public boolean containsUserLabels​(String key)
         The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
        map<string, string> user_labels = 7;
        Specified by:
        containsUserLabels in interface ConverseConversationRequestOrBuilder

      • getUserLabelsMap

        public Map<String,​String> getUserLabelsMap()
         The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
        map<string, string> user_labels = 7;
        Specified by:
        getUserLabelsMap in interface ConverseConversationRequestOrBuilder

      • getUserLabelsOrDefault

        public String getUserLabelsOrDefault​(String key,
                                     String defaultValue)
         The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
        map<string, string> user_labels = 7;
        Specified by:
        getUserLabelsOrDefault in interface ConverseConversationRequestOrBuilder

      • getUserLabelsOrThrow

        public String getUserLabelsOrThrow​(String key)
         The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
        map<string, string> user_labels = 7;
        Specified by:
        getUserLabelsOrThrow in interface ConverseConversationRequestOrBuilder

      • removeUserLabels

        public ConverseConversationRequest.Builder removeUserLabels​(String key)
         The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
        map<string, string> user_labels = 7;

      • getMutableUserLabels

        @Deprecated
public Map<String,​String> getMutableUserLabels()
        Deprecated.
        Use alternate mutation accessors instead.

      • putUserLabels

        public ConverseConversationRequest.Builder putUserLabels​(String key,
                                                         String value)
         The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
        map<string, string> user_labels = 7;

      • putAllUserLabels

        public ConverseConversationRequest.Builder putAllUserLabels​(Map<String,​String> values)
         The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
        map<string, string> user_labels = 7;

      • hasSummarySpec

        public boolean hasSummarySpec()
         A specification for configuring the summary returned in the response.
        .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;
        Specified by:
        hasSummarySpec in interface ConverseConversationRequestOrBuilder
        Returns:
        Whether the summarySpec field is set.

      • clearSummarySpec

        public ConverseConversationRequest.Builder clearSummarySpec()
         A specification for configuring the summary returned in the response.
        .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

      • getSummarySpecBuilder

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder getSummarySpecBuilder()
         A specification for configuring the summary returned in the response.
        .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

      • mergeUnknownFields

        public final ConverseConversationRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ConverseConversationRequest.Builder>