Package com.google.cloud.dialogflow.v2

Class DetectIntentRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DetectIntentRequest.Builder>
com.google.cloud.dialogflow.v2.DetectIntentRequest.Builder
All Implemented Interfaces:
DetectIntentRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
DetectIntentRequest
public static final class DetectIntentRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<DetectIntentRequest.Builder> implements DetectIntentRequestOrBuilder
 The request to detect user's intent.
Protobuf type google.cloud.dialogflow.v2.DetectIntentRequest

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • clear

      public DetectIntentRequest.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<DetectIntentRequest.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<DetectIntentRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public DetectIntentRequest.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<DetectIntentRequest.Builder>

    • mergeFrom

      public DetectIntentRequest.Builder mergeFrom(DetectIntentRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getSession

      public String getSession()
       Required. The name of the session this query is sent to. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>`, or
 `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume
 default 'draft' environment (`Environment ID` might be referred to as
 environment name at some places). If `User ID` is not specified, we are
 using "-". It's up to the API caller to choose an appropriate `Session ID`
 and `User Id`. They can be a random number or some type of user and session
 identifiers (preferably hashed). The length of the `Session ID` and
 `User ID` must not exceed 36 characters.

 For more information, see the [API interactions
 guide](https://cloud.google.com/dialogflow/docs/api-overview).

 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
      string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getSession in interface DetectIntentRequestOrBuilder
      Returns:
      The session.

    • getSessionBytes

      public com.google.protobuf.ByteString getSessionBytes()
       Required. The name of the session this query is sent to. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>`, or
 `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume
 default 'draft' environment (`Environment ID` might be referred to as
 environment name at some places). If `User ID` is not specified, we are
 using "-". It's up to the API caller to choose an appropriate `Session ID`
 and `User Id`. They can be a random number or some type of user and session
 identifiers (preferably hashed). The length of the `Session ID` and
 `User ID` must not exceed 36 characters.

 For more information, see the [API interactions
 guide](https://cloud.google.com/dialogflow/docs/api-overview).

 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
      string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getSessionBytes in interface DetectIntentRequestOrBuilder
      Returns:
      The bytes for session.

    • setSession

      public DetectIntentRequest.Builder setSession(String value)
       Required. The name of the session this query is sent to. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>`, or
 `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume
 default 'draft' environment (`Environment ID` might be referred to as
 environment name at some places). If `User ID` is not specified, we are
 using "-". It's up to the API caller to choose an appropriate `Session ID`
 and `User Id`. They can be a random number or some type of user and session
 identifiers (preferably hashed). The length of the `Session ID` and
 `User ID` must not exceed 36 characters.

 For more information, see the [API interactions
 guide](https://cloud.google.com/dialogflow/docs/api-overview).

 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
      string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The session to set.
      Returns:
      This builder for chaining.

    • clearSession

      public DetectIntentRequest.Builder clearSession()
       Required. The name of the session this query is sent to. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>`, or
 `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume
 default 'draft' environment (`Environment ID` might be referred to as
 environment name at some places). If `User ID` is not specified, we are
 using "-". It's up to the API caller to choose an appropriate `Session ID`
 and `User Id`. They can be a random number or some type of user and session
 identifiers (preferably hashed). The length of the `Session ID` and
 `User ID` must not exceed 36 characters.

 For more information, see the [API interactions
 guide](https://cloud.google.com/dialogflow/docs/api-overview).

 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
      string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setSessionBytes

      public DetectIntentRequest.Builder setSessionBytes(com.google.protobuf.ByteString value)
       Required. The name of the session this query is sent to. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>`, or
 `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
 ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume
 default 'draft' environment (`Environment ID` might be referred to as
 environment name at some places). If `User ID` is not specified, we are
 using "-". It's up to the API caller to choose an appropriate `Session ID`
 and `User Id`. They can be a random number or some type of user and session
 identifiers (preferably hashed). The length of the `Session ID` and
 `User ID` must not exceed 36 characters.

 For more information, see the [API interactions
 guide](https://cloud.google.com/dialogflow/docs/api-overview).

 Note: Always use agent versions for production traffic.
 See [Versions and
 environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
      string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for session to set.
      Returns:
      This builder for chaining.

    • hasQueryParams

      public boolean hasQueryParams()
       The parameters of this query.
      .google.cloud.dialogflow.v2.QueryParameters query_params = 2;
      Specified by:
      hasQueryParams in interface DetectIntentRequestOrBuilder
      Returns:
      Whether the queryParams field is set.

    • getQueryParams

      public QueryParameters getQueryParams()
       The parameters of this query.
      .google.cloud.dialogflow.v2.QueryParameters query_params = 2;
      Specified by:
      getQueryParams in interface DetectIntentRequestOrBuilder
      Returns:
      The queryParams.

    • setQueryParams

      public DetectIntentRequest.Builder setQueryParams(QueryParameters value)
       The parameters of this query.
      .google.cloud.dialogflow.v2.QueryParameters query_params = 2;

    • setQueryParams

      public DetectIntentRequest.Builder setQueryParams(QueryParameters.Builder builderForValue)
       The parameters of this query.
      .google.cloud.dialogflow.v2.QueryParameters query_params = 2;

    • mergeQueryParams

      public DetectIntentRequest.Builder mergeQueryParams(QueryParameters value)
       The parameters of this query.
      .google.cloud.dialogflow.v2.QueryParameters query_params = 2;

    • clearQueryParams

      public DetectIntentRequest.Builder clearQueryParams()
       The parameters of this query.
      .google.cloud.dialogflow.v2.QueryParameters query_params = 2;

    • getQueryParamsBuilder

      public QueryParameters.Builder getQueryParamsBuilder()
       The parameters of this query.
      .google.cloud.dialogflow.v2.QueryParameters query_params = 2;

    • getQueryParamsOrBuilder

      public QueryParametersOrBuilder getQueryParamsOrBuilder()
       The parameters of this query.
      .google.cloud.dialogflow.v2.QueryParameters query_params = 2;
      Specified by:
      getQueryParamsOrBuilder in interface DetectIntentRequestOrBuilder

    • hasQueryInput

      public boolean hasQueryInput()
       Required. The input specification. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasQueryInput in interface DetectIntentRequestOrBuilder
      Returns:
      Whether the queryInput field is set.

    • getQueryInput

      public QueryInput getQueryInput()
       Required. The input specification. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryInput in interface DetectIntentRequestOrBuilder
      Returns:
      The queryInput.

    • setQueryInput

      public DetectIntentRequest.Builder setQueryInput(QueryInput value)
       Required. The input specification. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

    • setQueryInput

      public DetectIntentRequest.Builder setQueryInput(QueryInput.Builder builderForValue)
       Required. The input specification. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

    • mergeQueryInput

      public DetectIntentRequest.Builder mergeQueryInput(QueryInput value)
       Required. The input specification. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

    • clearQueryInput

      public DetectIntentRequest.Builder clearQueryInput()
       Required. The input specification. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

    • getQueryInputBuilder

      public QueryInput.Builder getQueryInputBuilder()
       Required. The input specification. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];

    • getQueryInputOrBuilder

      public QueryInputOrBuilder getQueryInputOrBuilder()
       Required. The input specification. It can be set to:

 1. an audio config which instructs the speech recognizer how to process
 the speech audio,

 2. a conversational query in the form of text, or

 3. an event that specifies which intent to trigger.
      .google.cloud.dialogflow.v2.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryInputOrBuilder in interface DetectIntentRequestOrBuilder

    • hasOutputAudioConfig

      public boolean hasOutputAudioConfig()
       Instructs the speech synthesizer how to generate the output
 audio. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 4;
      Specified by:
      hasOutputAudioConfig in interface DetectIntentRequestOrBuilder
      Returns:
      Whether the outputAudioConfig field is set.

    • getOutputAudioConfig

      public OutputAudioConfig getOutputAudioConfig()
       Instructs the speech synthesizer how to generate the output
 audio. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 4;
      Specified by:
      getOutputAudioConfig in interface DetectIntentRequestOrBuilder
      Returns:
      The outputAudioConfig.

    • setOutputAudioConfig

      public DetectIntentRequest.Builder setOutputAudioConfig(OutputAudioConfig value)
       Instructs the speech synthesizer how to generate the output
 audio. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 4;

    • setOutputAudioConfig

      public DetectIntentRequest.Builder setOutputAudioConfig(OutputAudioConfig.Builder builderForValue)
       Instructs the speech synthesizer how to generate the output
 audio. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 4;

    • mergeOutputAudioConfig

      public DetectIntentRequest.Builder mergeOutputAudioConfig(OutputAudioConfig value)
       Instructs the speech synthesizer how to generate the output
 audio. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 4;

    • clearOutputAudioConfig

      public DetectIntentRequest.Builder clearOutputAudioConfig()
       Instructs the speech synthesizer how to generate the output
 audio. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 4;

    • getOutputAudioConfigBuilder

      public OutputAudioConfig.Builder getOutputAudioConfigBuilder()
       Instructs the speech synthesizer how to generate the output
 audio. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 4;

    • getOutputAudioConfigOrBuilder

      public OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()
       Instructs the speech synthesizer how to generate the output
 audio. If this field is not set and agent-level speech synthesizer is not
 configured, no output audio is generated.
      .google.cloud.dialogflow.v2.OutputAudioConfig output_audio_config = 4;
      Specified by:
      getOutputAudioConfigOrBuilder in interface DetectIntentRequestOrBuilder

    • hasOutputAudioConfigMask

      public boolean hasOutputAudioConfigMask()
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;
      Specified by:
      hasOutputAudioConfigMask in interface DetectIntentRequestOrBuilder
      Returns:
      Whether the outputAudioConfigMask field is set.

    • getOutputAudioConfigMask

      public com.google.protobuf.FieldMask getOutputAudioConfigMask()
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;
      Specified by:
      getOutputAudioConfigMask in interface DetectIntentRequestOrBuilder
      Returns:
      The outputAudioConfigMask.

    • setOutputAudioConfigMask

      public DetectIntentRequest.Builder setOutputAudioConfigMask(com.google.protobuf.FieldMask value)
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;

    • setOutputAudioConfigMask

      public DetectIntentRequest.Builder setOutputAudioConfigMask(com.google.protobuf.FieldMask.Builder builderForValue)
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;

    • mergeOutputAudioConfigMask

      public DetectIntentRequest.Builder mergeOutputAudioConfigMask(com.google.protobuf.FieldMask value)
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;

    • clearOutputAudioConfigMask

      public DetectIntentRequest.Builder clearOutputAudioConfigMask()
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;

    • getOutputAudioConfigMaskBuilder

      public com.google.protobuf.FieldMask.Builder getOutputAudioConfigMaskBuilder()
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;

    • getOutputAudioConfigMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getOutputAudioConfigMaskOrBuilder()
       Mask for
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 indicating which settings in this request-level config should override
 speech synthesizer settings defined at agent-level.

 If unspecified or empty,
 [output_audio_config][google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config]
 replaces the agent-level config in its entirety.
      .google.protobuf.FieldMask output_audio_config_mask = 7;
      Specified by:
      getOutputAudioConfigMaskOrBuilder in interface DetectIntentRequestOrBuilder

    • getInputAudio

      public com.google.protobuf.ByteString getInputAudio()
       The natural language speech audio to be processed. This field
 should be populated iff `query_input` is set to an input audio config.
 A single request can contain up to 1 minute of speech audio data.
      bytes input_audio = 5;
      Specified by:
      getInputAudio in interface DetectIntentRequestOrBuilder
      Returns:
      The inputAudio.

    • setInputAudio

      public DetectIntentRequest.Builder setInputAudio(com.google.protobuf.ByteString value)
       The natural language speech audio to be processed. This field
 should be populated iff `query_input` is set to an input audio config.
 A single request can contain up to 1 minute of speech audio data.
      bytes input_audio = 5;
      Parameters:
      value - The inputAudio to set.
      Returns:
      This builder for chaining.

    • clearInputAudio

      public DetectIntentRequest.Builder clearInputAudio()
       The natural language speech audio to be processed. This field
 should be populated iff `query_input` is set to an input audio config.
 A single request can contain up to 1 minute of speech audio data.
      bytes input_audio = 5;
      Returns:
      This builder for chaining.