Class ParticipantsClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable

    @BetaApi
    @Generated("by gapic-generator-java")
    public class ParticipantsClient
    extends Object
    implements com.google.api.gax.core.BackgroundResource
    Service Description: Service for managing [Participants][google.cloud.dialogflow.v2beta1.Participant].

    This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

    
     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
       ConversationName parent =
           ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]");
       Participant participant = Participant.newBuilder().build();
       Participant response = participantsClient.createParticipant(parent, participant);
     }
     

    Note: close() needs to be called on the ParticipantsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

    The surface of this class includes several types of Java methods for each of the API's methods:

    1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
    2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
    3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

    See the individual methods for example code.

    Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

    This class can be customized by passing in a custom instance of ParticipantsSettings to create(). For example:

    To customize credentials:

    
     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     ParticipantsSettings participantsSettings =
         ParticipantsSettings.newBuilder()
             .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
             .build();
     ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
     

    To customize the endpoint:

    
     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     ParticipantsSettings participantsSettings =
         ParticipantsSettings.newBuilder().setEndpoint(myEndpoint).build();
     ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
     

    To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

    
     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     ParticipantsSettings participantsSettings = ParticipantsSettings.newHttpJsonBuilder().build();
     ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
     

    Please refer to the GitHub repository's samples for more quickstart code snippets.

    • Constructor Detail

      • ParticipantsClient

        protected ParticipantsClient​(ParticipantsSettings settings)
                              throws IOException
        Constructs an instance of ParticipantsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
        Throws:
        IOException
    • Method Detail

      • create

        public static final ParticipantsClient create​(ParticipantsSettings settings)
                                               throws IOException
        Constructs an instance of ParticipantsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
        Throws:
        IOException
      • create

        public static final ParticipantsClient create​(ParticipantsStub stub)
        Constructs an instance of ParticipantsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ParticipantsSettings).
      • createParticipant

        public final Participant createParticipant​(ConversationName parent,
                                                   Participant participant)
        Creates a new participant in a conversation.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ConversationName parent =
               ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]");
           Participant participant = Participant.newBuilder().build();
           Participant response = participantsClient.createParticipant(parent, participant);
         }
         
        Parameters:
        parent - Required. Resource identifier of the conversation adding the participant. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`.
        participant - Required. The participant to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createParticipant

        public final Participant createParticipant​(String parent,
                                                   Participant participant)
        Creates a new participant in a conversation.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           String parent =
               ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]").toString();
           Participant participant = Participant.newBuilder().build();
           Participant response = participantsClient.createParticipant(parent, participant);
         }
         
        Parameters:
        parent - Required. Resource identifier of the conversation adding the participant. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`.
        participant - Required. The participant to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createParticipant

        public final Participant createParticipant​(CreateParticipantRequest request)
        Creates a new participant in a conversation.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           CreateParticipantRequest request =
               CreateParticipantRequest.newBuilder()
                   .setParent(
                       ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
                           .toString())
                   .setParticipant(Participant.newBuilder().build())
                   .build();
           Participant response = participantsClient.createParticipant(request);
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • createParticipantCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateParticipantRequest,​Participant> createParticipantCallable()
        Creates a new participant in a conversation.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           CreateParticipantRequest request =
               CreateParticipantRequest.newBuilder()
                   .setParent(
                       ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
                           .toString())
                   .setParticipant(Participant.newBuilder().build())
                   .build();
           ApiFuture<Participant> future =
               participantsClient.createParticipantCallable().futureCall(request);
           // Do something.
           Participant response = future.get();
         }
         
      • getParticipant

        public final Participant getParticipant​(ParticipantName name)
        Retrieves a conversation participant.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ParticipantName name =
               ParticipantName.ofProjectConversationParticipantName(
                   "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
           Participant response = participantsClient.getParticipant(name);
         }
         
        Parameters:
        name - Required. The name of the participant. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getParticipant

        public final Participant getParticipant​(String name)
        Retrieves a conversation participant.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           String name =
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString();
           Participant response = participantsClient.getParticipant(name);
         }
         
        Parameters:
        name - Required. The name of the participant. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getParticipant

        public final Participant getParticipant​(GetParticipantRequest request)
        Retrieves a conversation participant.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           GetParticipantRequest request =
               GetParticipantRequest.newBuilder()
                   .setName(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .build();
           Participant response = participantsClient.getParticipant(request);
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getParticipantCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetParticipantRequest,​Participant> getParticipantCallable()
        Retrieves a conversation participant.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           GetParticipantRequest request =
               GetParticipantRequest.newBuilder()
                   .setName(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .build();
           ApiFuture<Participant> future =
               participantsClient.getParticipantCallable().futureCall(request);
           // Do something.
           Participant response = future.get();
         }
         
      • listParticipants

        public final ParticipantsClient.ListParticipantsPagedResponse listParticipants​(ConversationName parent)
        Returns the list of all participants in the specified conversation.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ConversationName parent =
               ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]");
           for (Participant element : participantsClient.listParticipants(parent).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        parent - Required. The conversation to list all participants from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listParticipants

        public final ParticipantsClient.ListParticipantsPagedResponse listParticipants​(String parent)
        Returns the list of all participants in the specified conversation.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           String parent =
               ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]").toString();
           for (Participant element : participantsClient.listParticipants(parent).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        parent - Required. The conversation to list all participants from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listParticipants

        public final ParticipantsClient.ListParticipantsPagedResponse listParticipants​(ListParticipantsRequest request)
        Returns the list of all participants in the specified conversation.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ListParticipantsRequest request =
               ListParticipantsRequest.newBuilder()
                   .setParent(
                       ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
                           .toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           for (Participant element : participantsClient.listParticipants(request).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listParticipantsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListParticipantsRequest,​ParticipantsClient.ListParticipantsPagedResponse> listParticipantsPagedCallable()
        Returns the list of all participants in the specified conversation.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ListParticipantsRequest request =
               ListParticipantsRequest.newBuilder()
                   .setParent(
                       ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
                           .toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           ApiFuture<Participant> future =
               participantsClient.listParticipantsPagedCallable().futureCall(request);
           // Do something.
           for (Participant element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • listParticipantsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListParticipantsRequest,​ListParticipantsResponse> listParticipantsCallable()
        Returns the list of all participants in the specified conversation.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ListParticipantsRequest request =
               ListParticipantsRequest.newBuilder()
                   .setParent(
                       ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]")
                           .toString())
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           while (true) {
             ListParticipantsResponse response =
                 participantsClient.listParticipantsCallable().call(request);
             for (Participant element : response.getParticipantsList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • updateParticipant

        public final Participant updateParticipant​(Participant participant,
                                                   com.google.protobuf.FieldMask updateMask)
        Updates the specified participant.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           Participant participant = Participant.newBuilder().build();
           FieldMask updateMask = FieldMask.newBuilder().build();
           Participant response = participantsClient.updateParticipant(participant, updateMask);
         }
         
        Parameters:
        participant - Required. The participant to update.
        updateMask - Required. The mask to specify which fields to update.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • updateParticipant

        public final Participant updateParticipant​(UpdateParticipantRequest request)
        Updates the specified participant.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           UpdateParticipantRequest request =
               UpdateParticipantRequest.newBuilder()
                   .setParticipant(Participant.newBuilder().build())
                   .setUpdateMask(FieldMask.newBuilder().build())
                   .build();
           Participant response = participantsClient.updateParticipant(request);
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • updateParticipantCallable

        public final com.google.api.gax.rpc.UnaryCallable<UpdateParticipantRequest,​Participant> updateParticipantCallable()
        Updates the specified participant.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           UpdateParticipantRequest request =
               UpdateParticipantRequest.newBuilder()
                   .setParticipant(Participant.newBuilder().build())
                   .setUpdateMask(FieldMask.newBuilder().build())
                   .build();
           ApiFuture<Participant> future =
               participantsClient.updateParticipantCallable().futureCall(request);
           // Do something.
           Participant response = future.get();
         }
         
      • analyzeContent

        public final AnalyzeContentResponse analyzeContent​(ParticipantName participant,
                                                           AudioInput audioInput)
        Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

        Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ParticipantName participant =
               ParticipantName.ofProjectConversationParticipantName(
                   "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
           AudioInput audioInput = AudioInput.newBuilder().build();
           AnalyzeContentResponse response = participantsClient.analyzeContent(participant, audioInput);
         }
         
        Parameters:
        participant - Required. The name of the participant this text comes from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        audioInput - The natural language speech audio to be processed.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • analyzeContent

        public final AnalyzeContentResponse analyzeContent​(ParticipantName participant,
                                                           EventInput eventInput)
        Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

        Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ParticipantName participant =
               ParticipantName.ofProjectConversationParticipantName(
                   "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
           EventInput eventInput = EventInput.newBuilder().build();
           AnalyzeContentResponse response = participantsClient.analyzeContent(participant, eventInput);
         }
         
        Parameters:
        participant - Required. The name of the participant this text comes from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        eventInput - An input event to send to Dialogflow.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • analyzeContent

        public final AnalyzeContentResponse analyzeContent​(ParticipantName participant,
                                                           TextInput textInput)
        Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

        Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ParticipantName participant =
               ParticipantName.ofProjectConversationParticipantName(
                   "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
           TextInput textInput = TextInput.newBuilder().build();
           AnalyzeContentResponse response = participantsClient.analyzeContent(participant, textInput);
         }
         
        Parameters:
        participant - Required. The name of the participant this text comes from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        textInput - The natural language text to be processed.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • analyzeContent

        public final AnalyzeContentResponse analyzeContent​(String participant,
                                                           AudioInput audioInput)
        Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

        Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           String participant =
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString();
           AudioInput audioInput = AudioInput.newBuilder().build();
           AnalyzeContentResponse response = participantsClient.analyzeContent(participant, audioInput);
         }
         
        Parameters:
        participant - Required. The name of the participant this text comes from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        audioInput - The natural language speech audio to be processed.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • analyzeContent

        public final AnalyzeContentResponse analyzeContent​(String participant,
                                                           EventInput eventInput)
        Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

        Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           String participant =
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString();
           EventInput eventInput = EventInput.newBuilder().build();
           AnalyzeContentResponse response = participantsClient.analyzeContent(participant, eventInput);
         }
         
        Parameters:
        participant - Required. The name of the participant this text comes from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        eventInput - An input event to send to Dialogflow.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • analyzeContent

        public final AnalyzeContentResponse analyzeContent​(String participant,
                                                           TextInput textInput)
        Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

        Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           String participant =
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString();
           TextInput textInput = TextInput.newBuilder().build();
           AnalyzeContentResponse response = participantsClient.analyzeContent(participant, textInput);
         }
         
        Parameters:
        participant - Required. The name of the participant this text comes from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        textInput - The natural language text to be processed.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • analyzeContent

        public final AnalyzeContentResponse analyzeContent​(AnalyzeContentRequest request)
        Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

        Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           AnalyzeContentRequest request =
               AnalyzeContentRequest.newBuilder()
                   .setParticipant(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .setReplyAudioConfig(OutputAudioConfig.newBuilder().build())
                   .setQueryParams(QueryParameters.newBuilder().build())
                   .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
                   .setCxParameters(Struct.newBuilder().build())
                   .setCxCurrentPage("cxCurrentPage1596907507")
                   .setMessageSendTime(Timestamp.newBuilder().build())
                   .setRequestId("requestId693933066")
                   .build();
           AnalyzeContentResponse response = participantsClient.analyzeContent(request);
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • analyzeContentCallable

        public final com.google.api.gax.rpc.UnaryCallable<AnalyzeContentRequest,​AnalyzeContentResponse> analyzeContentCallable()
        Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

        Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           AnalyzeContentRequest request =
               AnalyzeContentRequest.newBuilder()
                   .setParticipant(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .setReplyAudioConfig(OutputAudioConfig.newBuilder().build())
                   .setQueryParams(QueryParameters.newBuilder().build())
                   .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
                   .setCxParameters(Struct.newBuilder().build())
                   .setCxCurrentPage("cxCurrentPage1596907507")
                   .setMessageSendTime(Timestamp.newBuilder().build())
                   .setRequestId("requestId693933066")
                   .build();
           ApiFuture<AnalyzeContentResponse> future =
               participantsClient.analyzeContentCallable().futureCall(request);
           // Do something.
           AnalyzeContentResponse response = future.get();
         }
         
      • streamingAnalyzeContentCallable

        public final com.google.api.gax.rpc.BidiStreamingCallable<StreamingAnalyzeContentRequest,​StreamingAnalyzeContentResponse> streamingAnalyzeContentCallable()
        Adds a text (e.g., chat) or audio (e.g., phone recording) message from a participant into the conversation. Note: This method is only available through the gRPC API (not REST).

        The top-level message sent to the client by the server is `StreamingAnalyzeContentResponse`. Multiple response messages can be returned in order. The first one or more messages contain the `recognition_result` field. Each result represents a more complete transcript of what the user said. The next message contains the `reply_text` field, and potentially the `reply_audio` and/or the `automated_agent_reply` fields.

        Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           BidiStream<StreamingAnalyzeContentRequest, StreamingAnalyzeContentResponse> bidiStream =
               participantsClient.streamingAnalyzeContentCallable().call();
           StreamingAnalyzeContentRequest request =
               StreamingAnalyzeContentRequest.newBuilder()
                   .setParticipant(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .setReplyAudioConfig(OutputAudioConfig.newBuilder().build())
                   .setQueryParams(QueryParameters.newBuilder().build())
                   .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
                   .setCxParameters(Struct.newBuilder().build())
                   .setCxCurrentPage("cxCurrentPage1596907507")
                   .setEnablePartialAutomatedAgentReply(true)
                   .setEnableDebuggingInfo(true)
                   .build();
           bidiStream.send(request);
           for (StreamingAnalyzeContentResponse response : bidiStream) {
             // Do something when a response is received.
           }
         }
         
      • suggestArticles

        public final SuggestArticlesResponse suggestArticles​(ParticipantName parent)
        Gets suggested articles for a participant based on specific historical messages.

        Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ParticipantName parent =
               ParticipantName.ofProjectConversationParticipantName(
                   "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
           SuggestArticlesResponse response = participantsClient.suggestArticles(parent);
         }
         
        Parameters:
        parent - Required. The name of the participant to fetch suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • suggestArticles

        public final SuggestArticlesResponse suggestArticles​(String parent)
        Gets suggested articles for a participant based on specific historical messages.

        Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           String parent =
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString();
           SuggestArticlesResponse response = participantsClient.suggestArticles(parent);
         }
         
        Parameters:
        parent - Required. The name of the participant to fetch suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • suggestArticles

        public final SuggestArticlesResponse suggestArticles​(SuggestArticlesRequest request)
        Gets suggested articles for a participant based on specific historical messages.

        Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           SuggestArticlesRequest request =
               SuggestArticlesRequest.newBuilder()
                   .setParent(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .setLatestMessage(
                       MessageName.ofProjectConversationMessageName(
                               "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                           .toString())
                   .setContextSize(1116903569)
                   .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
                   .build();
           SuggestArticlesResponse response = participantsClient.suggestArticles(request);
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • suggestArticlesCallable

        public final com.google.api.gax.rpc.UnaryCallable<SuggestArticlesRequest,​SuggestArticlesResponse> suggestArticlesCallable()
        Gets suggested articles for a participant based on specific historical messages.

        Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           SuggestArticlesRequest request =
               SuggestArticlesRequest.newBuilder()
                   .setParent(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .setLatestMessage(
                       MessageName.ofProjectConversationMessageName(
                               "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                           .toString())
                   .setContextSize(1116903569)
                   .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
                   .build();
           ApiFuture<SuggestArticlesResponse> future =
               participantsClient.suggestArticlesCallable().futureCall(request);
           // Do something.
           SuggestArticlesResponse response = future.get();
         }
         
      • suggestFaqAnswers

        public final SuggestFaqAnswersResponse suggestFaqAnswers​(ParticipantName parent)
        Gets suggested faq answers for a participant based on specific historical messages.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ParticipantName parent =
               ParticipantName.ofProjectConversationParticipantName(
                   "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
           SuggestFaqAnswersResponse response = participantsClient.suggestFaqAnswers(parent);
         }
         
        Parameters:
        parent - Required. The name of the participant to fetch suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • suggestFaqAnswers

        public final SuggestFaqAnswersResponse suggestFaqAnswers​(String parent)
        Gets suggested faq answers for a participant based on specific historical messages.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           String parent =
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString();
           SuggestFaqAnswersResponse response = participantsClient.suggestFaqAnswers(parent);
         }
         
        Parameters:
        parent - Required. The name of the participant to fetch suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • suggestFaqAnswers

        public final SuggestFaqAnswersResponse suggestFaqAnswers​(SuggestFaqAnswersRequest request)
        Gets suggested faq answers for a participant based on specific historical messages.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           SuggestFaqAnswersRequest request =
               SuggestFaqAnswersRequest.newBuilder()
                   .setParent(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .setLatestMessage(
                       MessageName.ofProjectConversationMessageName(
                               "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                           .toString())
                   .setContextSize(1116903569)
                   .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
                   .build();
           SuggestFaqAnswersResponse response = participantsClient.suggestFaqAnswers(request);
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • suggestFaqAnswersCallable

        public final com.google.api.gax.rpc.UnaryCallable<SuggestFaqAnswersRequest,​SuggestFaqAnswersResponse> suggestFaqAnswersCallable()
        Gets suggested faq answers for a participant based on specific historical messages.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           SuggestFaqAnswersRequest request =
               SuggestFaqAnswersRequest.newBuilder()
                   .setParent(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .setLatestMessage(
                       MessageName.ofProjectConversationMessageName(
                               "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                           .toString())
                   .setContextSize(1116903569)
                   .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
                   .build();
           ApiFuture<SuggestFaqAnswersResponse> future =
               participantsClient.suggestFaqAnswersCallable().futureCall(request);
           // Do something.
           SuggestFaqAnswersResponse response = future.get();
         }
         
      • suggestSmartReplies

        public final SuggestSmartRepliesResponse suggestSmartReplies​(ParticipantName parent)
        Gets smart replies for a participant based on specific historical messages.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ParticipantName parent =
               ParticipantName.ofProjectConversationParticipantName(
                   "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]");
           SuggestSmartRepliesResponse response = participantsClient.suggestSmartReplies(parent);
         }
         
        Parameters:
        parent - Required. The name of the participant to fetch suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • suggestSmartReplies

        public final SuggestSmartRepliesResponse suggestSmartReplies​(String parent)
        Gets smart replies for a participant based on specific historical messages.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           String parent =
               ParticipantName.ofProjectConversationParticipantName(
                       "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                   .toString();
           SuggestSmartRepliesResponse response = participantsClient.suggestSmartReplies(parent);
         }
         
        Parameters:
        parent - Required. The name of the participant to fetch suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • suggestSmartReplies

        public final SuggestSmartRepliesResponse suggestSmartReplies​(SuggestSmartRepliesRequest request)
        Gets smart replies for a participant based on specific historical messages.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           SuggestSmartRepliesRequest request =
               SuggestSmartRepliesRequest.newBuilder()
                   .setParent(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .setCurrentTextInput(TextInput.newBuilder().build())
                   .setLatestMessage(
                       MessageName.ofProjectConversationMessageName(
                               "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                           .toString())
                   .setContextSize(1116903569)
                   .build();
           SuggestSmartRepliesResponse response = participantsClient.suggestSmartReplies(request);
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • suggestSmartRepliesCallable

        public final com.google.api.gax.rpc.UnaryCallable<SuggestSmartRepliesRequest,​SuggestSmartRepliesResponse> suggestSmartRepliesCallable()
        Gets smart replies for a participant based on specific historical messages.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           SuggestSmartRepliesRequest request =
               SuggestSmartRepliesRequest.newBuilder()
                   .setParent(
                       ParticipantName.ofProjectConversationParticipantName(
                               "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                           .toString())
                   .setCurrentTextInput(TextInput.newBuilder().build())
                   .setLatestMessage(
                       MessageName.ofProjectConversationMessageName(
                               "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
                           .toString())
                   .setContextSize(1116903569)
                   .build();
           ApiFuture<SuggestSmartRepliesResponse> future =
               participantsClient.suggestSmartRepliesCallable().futureCall(request);
           // Do something.
           SuggestSmartRepliesResponse response = future.get();
         }
         
      • listSuggestions

        @Deprecated
        public final ParticipantsClient.ListSuggestionsPagedResponse listSuggestions​(ListSuggestionsRequest request)
        Deprecated.
        This method is deprecated and will be removed in the next major version update.
        Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more details. Removal Date: 2020-09-01.

        Retrieves suggestions for live agents.

        This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the [list pagination](https://cloud.google.com/apis/design/design_patterns#list_pagination) design pattern. The client app should use the `next_page_token` field to fetch the next batch of suggestions. `suggestions` are sorted by `create_time` in descending order. To fetch latest suggestion, just set `page_size` to 1. To fetch new suggestions without duplication, send request with filter `create_time_epoch_microseconds > [first item's create_time of previous request]` and empty page_token.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ListSuggestionsRequest request =
               ListSuggestionsRequest.newBuilder()
                   .setParent("parent-995424086")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setFilter("filter-1274492040")
                   .build();
           for (Suggestion element : participantsClient.listSuggestions(request).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listSuggestionsPagedCallable

        @Deprecated
        public final com.google.api.gax.rpc.UnaryCallable<ListSuggestionsRequest,​ParticipantsClient.ListSuggestionsPagedResponse> listSuggestionsPagedCallable()
        Deprecated.
        This method is deprecated and will be removed in the next major version update.
        Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more details. Removal Date: 2020-09-01.

        Retrieves suggestions for live agents.

        This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the [list pagination](https://cloud.google.com/apis/design/design_patterns#list_pagination) design pattern. The client app should use the `next_page_token` field to fetch the next batch of suggestions. `suggestions` are sorted by `create_time` in descending order. To fetch latest suggestion, just set `page_size` to 1. To fetch new suggestions without duplication, send request with filter `create_time_epoch_microseconds > [first item's create_time of previous request]` and empty page_token.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ListSuggestionsRequest request =
               ListSuggestionsRequest.newBuilder()
                   .setParent("parent-995424086")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setFilter("filter-1274492040")
                   .build();
           ApiFuture<Suggestion> future =
               participantsClient.listSuggestionsPagedCallable().futureCall(request);
           // Do something.
           for (Suggestion element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • listSuggestionsCallable

        @Deprecated
        public final com.google.api.gax.rpc.UnaryCallable<ListSuggestionsRequest,​ListSuggestionsResponse> listSuggestionsCallable()
        Deprecated.
        This method is deprecated and will be removed in the next major version update.
        Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more details. Removal Date: 2020-09-01.

        Retrieves suggestions for live agents.

        This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the [list pagination](https://cloud.google.com/apis/design/design_patterns#list_pagination) design pattern. The client app should use the `next_page_token` field to fetch the next batch of suggestions. `suggestions` are sorted by `create_time` in descending order. To fetch latest suggestion, just set `page_size` to 1. To fetch new suggestions without duplication, send request with filter `create_time_epoch_microseconds > [first item's create_time of previous request]` and empty page_token.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ListSuggestionsRequest request =
               ListSuggestionsRequest.newBuilder()
                   .setParent("parent-995424086")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .setFilter("filter-1274492040")
                   .build();
           while (true) {
             ListSuggestionsResponse response =
                 participantsClient.listSuggestionsCallable().call(request);
             for (Suggestion element : response.getSuggestionsList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • compileSuggestion

        @Deprecated
        public final CompileSuggestionResponse compileSuggestion​(CompileSuggestionRequest request)
        Deprecated.
        This method is deprecated and will be removed in the next major version update.
        Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead.

        Gets suggestions for a participant based on specific historical messages.

        Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           CompileSuggestionRequest request =
               CompileSuggestionRequest.newBuilder()
                   .setParent("parent-995424086")
                   .setLatestMessage("latestMessage-1424305536")
                   .setContextSize(1116903569)
                   .build();
           CompileSuggestionResponse response = participantsClient.compileSuggestion(request);
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • compileSuggestionCallable

        @Deprecated
        public final com.google.api.gax.rpc.UnaryCallable<CompileSuggestionRequest,​CompileSuggestionResponse> compileSuggestionCallable()
        Deprecated.
        This method is deprecated and will be removed in the next major version update.
        Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead.

        Gets suggestions for a participant based on specific historical messages.

        Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion based on the provided conversation context in the real time.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           CompileSuggestionRequest request =
               CompileSuggestionRequest.newBuilder()
                   .setParent("parent-995424086")
                   .setLatestMessage("latestMessage-1424305536")
                   .setContextSize(1116903569)
                   .build();
           ApiFuture<CompileSuggestionResponse> future =
               participantsClient.compileSuggestionCallable().futureCall(request);
           // Do something.
           CompileSuggestionResponse response = future.get();
         }
         
      • listLocations

        public final ParticipantsClient.ListLocationsPagedResponse listLocations​(com.google.cloud.location.ListLocationsRequest request)
        Lists information about the supported locations for this service.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ListLocationsRequest request =
               ListLocationsRequest.newBuilder()
                   .setName("name3373707")
                   .setFilter("filter-1274492040")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           for (Location element : participantsClient.listLocations(request).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • listLocationsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,​ParticipantsClient.ListLocationsPagedResponse> listLocationsPagedCallable()
        Lists information about the supported locations for this service.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ListLocationsRequest request =
               ListLocationsRequest.newBuilder()
                   .setName("name3373707")
                   .setFilter("filter-1274492040")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           ApiFuture<Location> future =
               participantsClient.listLocationsPagedCallable().futureCall(request);
           // Do something.
           for (Location element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • listLocationsCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.ListLocationsResponse> listLocationsCallable()
        Lists information about the supported locations for this service.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           ListLocationsRequest request =
               ListLocationsRequest.newBuilder()
                   .setName("name3373707")
                   .setFilter("filter-1274492040")
                   .setPageSize(883849137)
                   .setPageToken("pageToken873572522")
                   .build();
           while (true) {
             ListLocationsResponse response = participantsClient.listLocationsCallable().call(request);
             for (Location element : response.getLocationsList()) {
               // doThingsWith(element);
             }
             String nextPageToken = response.getNextPageToken();
             if (!Strings.isNullOrEmpty(nextPageToken)) {
               request = request.toBuilder().setPageToken(nextPageToken).build();
             } else {
               break;
             }
           }
         }
         
      • getLocation

        public final com.google.cloud.location.Location getLocation​(com.google.cloud.location.GetLocationRequest request)
        Gets information about a location.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
           Location response = participantsClient.getLocation(request);
         }
         
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getLocationCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.Location> getLocationCallable()
        Gets information about a location.

        Sample code:

        
         // This snippet has been automatically generated and should be regarded as a code template only.
         // It will require modifications to work:
         // - It may require correct/in-range values for request initialization.
         // - It may require specifying regional endpoints when creating the service client as shown in
         // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
         try (ParticipantsClient participantsClient = ParticipantsClient.create()) {
           GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
           ApiFuture<Location> future = participantsClient.getLocationCallable().futureCall(request);
           // Do something.
           Location response = future.get();
         }
         
      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource
      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource
      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource
      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource