Class ExperimentsSettings (0.66.0)

public class ExperimentsSettings extends ClientSettings<ExperimentsSettings>

Settings class to configure an instance of ExperimentsClient.

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 getExperiment:


 // 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
 ExperimentsSettings.Builder experimentsSettingsBuilder = ExperimentsSettings.newBuilder();
 experimentsSettingsBuilder
     .getExperimentSettings()
     .setRetrySettings(
         experimentsSettingsBuilder
             .getExperimentSettings()
             .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());
 ExperimentsSettings experimentsSettings = experimentsSettingsBuilder.build();
 

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

Inheritance

java.lang.Object > ClientSettings > ExperimentsSettings

Static Methods

create(ExperimentsStubSettings stub)

public static final ExperimentsSettings create(ExperimentsStubSettings stub)
Parameter
Name Description
stub ExperimentsStubSettings
Returns
Type Description
ExperimentsSettings
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 ExperimentsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
ExperimentsSettings.Builder

newBuilder(ClientContext clientContext)

public static ExperimentsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ExperimentsSettings.Builder

newHttpJsonBuilder()

public static ExperimentsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
ExperimentsSettings.Builder

Constructors

ExperimentsSettings(ExperimentsSettings.Builder settingsBuilder)

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

Methods

createExperimentSettings()

public UnaryCallSettings<CreateExperimentRequest,Experiment> createExperimentSettings()

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

Returns
Type Description
UnaryCallSettings<CreateExperimentRequest,Experiment>

deleteExperimentSettings()

public UnaryCallSettings<DeleteExperimentRequest,Empty> deleteExperimentSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteExperimentRequest,Empty>

getExperimentSettings()

public UnaryCallSettings<GetExperimentRequest,Experiment> getExperimentSettings()

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

Returns
Type Description
UnaryCallSettings<GetExperimentRequest,Experiment>

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>

listExperimentsSettings()

public PagedCallSettings<ListExperimentsRequest,ListExperimentsResponse,ExperimentsClient.ListExperimentsPagedResponse> listExperimentsSettings()

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

Returns
Type Description
PagedCallSettings<ListExperimentsRequest,ListExperimentsResponse,ListExperimentsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ExperimentsClient.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>

startExperimentSettings()

public UnaryCallSettings<StartExperimentRequest,Experiment> startExperimentSettings()

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

Returns
Type Description
UnaryCallSettings<StartExperimentRequest,Experiment>

stopExperimentSettings()

public UnaryCallSettings<StopExperimentRequest,Experiment> stopExperimentSettings()

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

Returns
Type Description
UnaryCallSettings<StopExperimentRequest,Experiment>

toBuilder()

public ExperimentsSettings.Builder toBuilder()

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

Returns
Type Description
ExperimentsSettings.Builder
Overrides

updateExperimentSettings()

public UnaryCallSettings<UpdateExperimentRequest,Experiment> updateExperimentSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateExperimentRequest,Experiment>