Class EnvironmentsSettings (0.62.0) 

public class EnvironmentsSettings extends ClientSettings<EnvironmentsSettings>

Settings class to configure an instance of EnvironmentsClient.

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


 // 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
 EnvironmentsSettings.Builder environmentsSettingsBuilder = EnvironmentsSettings.newBuilder();
 environmentsSettingsBuilder
     .getEnvironmentSettings()
     .setRetrySettings(
         environmentsSettingsBuilder
             .getEnvironmentSettings()
             .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());
 EnvironmentsSettings environmentsSettings = environmentsSettingsBuilder.build();

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

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createEnvironment:


 // 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
 EnvironmentsSettings.Builder environmentsSettingsBuilder = EnvironmentsSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 environmentsSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > EnvironmentsSettings

Static Methods

create(EnvironmentsStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
EnvironmentsSettings.Builder

newBuilder(ClientContext clientContext)

public static EnvironmentsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
EnvironmentsSettings.Builder

newHttpJsonBuilder()

public static EnvironmentsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
EnvironmentsSettings.Builder

Constructors

EnvironmentsSettings(EnvironmentsSettings.Builder settingsBuilder)

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

Methods

createEnvironmentOperationSettings()

public OperationCallSettings<CreateEnvironmentRequest,Environment,Struct> createEnvironmentOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateEnvironmentRequest,Environment,Struct>

createEnvironmentSettings()

public UnaryCallSettings<CreateEnvironmentRequest,Operation> createEnvironmentSettings()

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

Returns
Type Description
UnaryCallSettings<CreateEnvironmentRequest,Operation>

deleteEnvironmentSettings()

public UnaryCallSettings<DeleteEnvironmentRequest,Empty> deleteEnvironmentSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteEnvironmentRequest,Empty>

deployFlowOperationSettings()

public OperationCallSettings<DeployFlowRequest,DeployFlowResponse,DeployFlowMetadata> deployFlowOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeployFlowRequest,DeployFlowResponse,DeployFlowMetadata>

deployFlowSettings()

public UnaryCallSettings<DeployFlowRequest,Operation> deployFlowSettings()

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

Returns
Type Description
UnaryCallSettings<DeployFlowRequest,Operation>

getEnvironmentSettings()

public UnaryCallSettings<GetEnvironmentRequest,Environment> getEnvironmentSettings()

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

Returns
Type Description
UnaryCallSettings<GetEnvironmentRequest,Environment>

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>

listContinuousTestResultsSettings()

public PagedCallSettings<ListContinuousTestResultsRequest,ListContinuousTestResultsResponse,EnvironmentsClient.ListContinuousTestResultsPagedResponse> listContinuousTestResultsSettings()

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

Returns
Type Description
PagedCallSettings<ListContinuousTestResultsRequest,ListContinuousTestResultsResponse,ListContinuousTestResultsPagedResponse>

listEnvironmentsSettings()

public PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,EnvironmentsClient.ListEnvironmentsPagedResponse> listEnvironmentsSettings()

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

Returns
Type Description
PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,ListEnvironmentsPagedResponse>

listLocationsSettings()

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

lookupEnvironmentHistorySettings()

public PagedCallSettings<LookupEnvironmentHistoryRequest,LookupEnvironmentHistoryResponse,EnvironmentsClient.LookupEnvironmentHistoryPagedResponse> lookupEnvironmentHistorySettings()

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

Returns
Type Description
PagedCallSettings<LookupEnvironmentHistoryRequest,LookupEnvironmentHistoryResponse,LookupEnvironmentHistoryPagedResponse>

runContinuousTestOperationSettings()

public OperationCallSettings<RunContinuousTestRequest,RunContinuousTestResponse,RunContinuousTestMetadata> runContinuousTestOperationSettings()

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

Returns
Type Description
OperationCallSettings<RunContinuousTestRequest,RunContinuousTestResponse,RunContinuousTestMetadata>

runContinuousTestSettings()

public UnaryCallSettings<RunContinuousTestRequest,Operation> runContinuousTestSettings()

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

Returns
Type Description
UnaryCallSettings<RunContinuousTestRequest,Operation>

toBuilder()

public EnvironmentsSettings.Builder toBuilder()

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

Returns
Type Description
EnvironmentsSettings.Builder
Overrides

updateEnvironmentOperationSettings()

public OperationCallSettings<UpdateEnvironmentRequest,Environment,Struct> updateEnvironmentOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateEnvironmentRequest,Environment,Struct>

updateEnvironmentSettings()

public UnaryCallSettings<UpdateEnvironmentRequest,Operation> updateEnvironmentSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateEnvironmentRequest,Operation>