Class ParticipantsSettings (4.61.0) 

public class ParticipantsSettings extends ClientSettings<ParticipantsSettings>

Settings class to configure an instance of ParticipantsClient.

The default instance has everything set to sensible defaults:

  • The default service address (dialogflow.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the RetrySettings of createParticipant:


 // 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.Builder participantsSettingsBuilder = ParticipantsSettings.newBuilder();
 participantsSettingsBuilder
     .createParticipantSettings()
     .setRetrySettings(
         participantsSettingsBuilder
             .createParticipantSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 ParticipantsSettings participantsSettings = participantsSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > ClientSettings > ParticipantsSettings

Static Methods

create(ParticipantsStubSettings stub)

public static final ParticipantsSettings create(ParticipantsStubSettings stub)
Parameter
Name Description
stub ParticipantsStubSettings
Returns
Type Description
ParticipantsSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static ParticipantsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
ParticipantsSettings.Builder

newBuilder(ClientContext clientContext)

public static ParticipantsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ParticipantsSettings.Builder

newHttpJsonBuilder()

public static ParticipantsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
ParticipantsSettings.Builder

Constructors

ParticipantsSettings(ParticipantsSettings.Builder settingsBuilder)

protected ParticipantsSettings(ParticipantsSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder ParticipantsSettings.Builder

Methods

analyzeContentSettings()

public UnaryCallSettings<AnalyzeContentRequest,AnalyzeContentResponse> analyzeContentSettings()

Returns the object with the settings used for calls to analyzeContent.

Returns
Type Description
UnaryCallSettings<AnalyzeContentRequest,AnalyzeContentResponse>

compileSuggestionSettings() (deprecated)

public UnaryCallSettings<CompileSuggestionRequest,CompileSuggestionResponse> compileSuggestionSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

Returns the object with the settings used for calls to compileSuggestion.

Returns
Type Description
UnaryCallSettings<CompileSuggestionRequest,CompileSuggestionResponse>

createParticipantSettings()

public UnaryCallSettings<CreateParticipantRequest,Participant> createParticipantSettings()

Returns the object with the settings used for calls to createParticipant.

Returns
Type Description
UnaryCallSettings<CreateParticipantRequest,Participant>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getParticipantSettings()

public UnaryCallSettings<GetParticipantRequest,Participant> getParticipantSettings()

Returns the object with the settings used for calls to getParticipant.

Returns
Type Description
UnaryCallSettings<GetParticipantRequest,Participant>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ParticipantsClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listParticipantsSettings()

public PagedCallSettings<ListParticipantsRequest,ListParticipantsResponse,ParticipantsClient.ListParticipantsPagedResponse> listParticipantsSettings()

Returns the object with the settings used for calls to listParticipants.

Returns
Type Description
PagedCallSettings<ListParticipantsRequest,ListParticipantsResponse,ListParticipantsPagedResponse>

listSuggestionsSettings() (deprecated)

public PagedCallSettings<ListSuggestionsRequest,ListSuggestionsResponse,ParticipantsClient.ListSuggestionsPagedResponse> listSuggestionsSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

Returns the object with the settings used for calls to listSuggestions.

Returns
Type Description
PagedCallSettings<ListSuggestionsRequest,ListSuggestionsResponse,ListSuggestionsPagedResponse>

streamingAnalyzeContentSettings()

public StreamingCallSettings<StreamingAnalyzeContentRequest,StreamingAnalyzeContentResponse> streamingAnalyzeContentSettings()

Returns the object with the settings used for calls to streamingAnalyzeContent.

Returns
Type Description
StreamingCallSettings<StreamingAnalyzeContentRequest,StreamingAnalyzeContentResponse>

suggestArticlesSettings()

public UnaryCallSettings<SuggestArticlesRequest,SuggestArticlesResponse> suggestArticlesSettings()

Returns the object with the settings used for calls to suggestArticles.

Returns
Type Description
UnaryCallSettings<SuggestArticlesRequest,SuggestArticlesResponse>

suggestFaqAnswersSettings()

public UnaryCallSettings<SuggestFaqAnswersRequest,SuggestFaqAnswersResponse> suggestFaqAnswersSettings()

Returns the object with the settings used for calls to suggestFaqAnswers.

Returns
Type Description
UnaryCallSettings<SuggestFaqAnswersRequest,SuggestFaqAnswersResponse>

suggestKnowledgeAssistSettings()

public UnaryCallSettings<SuggestKnowledgeAssistRequest,SuggestKnowledgeAssistResponse> suggestKnowledgeAssistSettings()

Returns the object with the settings used for calls to suggestKnowledgeAssist.

Returns
Type Description
UnaryCallSettings<SuggestKnowledgeAssistRequest,SuggestKnowledgeAssistResponse>

suggestSmartRepliesSettings()

public UnaryCallSettings<SuggestSmartRepliesRequest,SuggestSmartRepliesResponse> suggestSmartRepliesSettings()

Returns the object with the settings used for calls to suggestSmartReplies.

Returns
Type Description
UnaryCallSettings<SuggestSmartRepliesRequest,SuggestSmartRepliesResponse>

toBuilder()

public ParticipantsSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
ParticipantsSettings.Builder
Overrides

updateParticipantSettings()

public UnaryCallSettings<UpdateParticipantRequest,Participant> updateParticipantSettings()

Returns the object with the settings used for calls to updateParticipant.

Returns
Type Description
UnaryCallSettings<UpdateParticipantRequest,Participant>