Class EnvironmentsSettings (4.6.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 total timeout of getEnvironment to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 EnvironmentsSettings.Builder environmentsSettingsBuilder = EnvironmentsSettings.newBuilder();
 environmentsSettingsBuilder
     .getEnvironmentSettings()
     .setRetrySettings(
         environmentsSettingsBuilder
             .getEnvironmentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EnvironmentsSettings environmentsSettings = environmentsSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > EnvironmentsSettings

Static Methods

create(EnvironmentsStubSettings stub)

public static final EnvironmentsSettings create(EnvironmentsStubSettings stub)
Parameter
NameDescription
stubEnvironmentsStubSettings
Returns
TypeDescription
EnvironmentsSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static EnvironmentsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
EnvironmentsSettings.Builder

newBuilder(ClientContext clientContext)

public static EnvironmentsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
EnvironmentsSettings.Builder

Constructors

EnvironmentsSettings(EnvironmentsSettings.Builder settingsBuilder)

protected EnvironmentsSettings(EnvironmentsSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderEnvironmentsSettings.Builder

Methods

createEnvironmentSettings()

public UnaryCallSettings<CreateEnvironmentRequest,Environment> createEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateEnvironmentRequest,Environment>

deleteEnvironmentSettings()

public UnaryCallSettings<DeleteEnvironmentRequest,Empty> deleteEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteEnvironmentRequest,Empty>

getEnvironmentHistorySettings()

public PagedCallSettings<GetEnvironmentHistoryRequest,EnvironmentHistory,EnvironmentsClient.GetEnvironmentHistoryPagedResponse> getEnvironmentHistorySettings()

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

Returns
TypeDescription
PagedCallSettings<GetEnvironmentHistoryRequest,EnvironmentHistory,GetEnvironmentHistoryPagedResponse>

getEnvironmentSettings()

public UnaryCallSettings<GetEnvironmentRequest,Environment> getEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEnvironmentRequest,Environment>

listEnvironmentsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,ListEnvironmentsPagedResponse>

toBuilder()

public EnvironmentsSettings.Builder toBuilder()

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

Returns
TypeDescription
EnvironmentsSettings.Builder
Overrides

updateEnvironmentSettings()

public UnaryCallSettings<UpdateEnvironmentRequest,Environment> updateEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateEnvironmentRequest,Environment>