Class BranchServiceSettings (2.55.0) 

public class BranchServiceSettings extends ClientSettings<BranchServiceSettings>

Settings class to configure an instance of BranchServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (retail.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 listBranches:


 // 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
 BranchServiceSettings.Builder branchServiceSettingsBuilder = BranchServiceSettings.newBuilder();
 branchServiceSettingsBuilder
     .listBranchesSettings()
     .setRetrySettings(
         branchServiceSettingsBuilder
             .listBranchesSettings()
             .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());
 BranchServiceSettings branchServiceSettings = branchServiceSettingsBuilder.build();

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

Inheritance

java.lang.Object > ClientSettings > BranchServiceSettings

Static Methods

create(BranchServiceStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
BranchServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static BranchServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
BranchServiceSettings.Builder

newHttpJsonBuilder()

public static BranchServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
BranchServiceSettings.Builder

Constructors

BranchServiceSettings(BranchServiceSettings.Builder settingsBuilder)

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

Methods

getBranchSettings()

public UnaryCallSettings<GetBranchRequest,Branch> getBranchSettings()

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

Returns
Type Description
UnaryCallSettings<GetBranchRequest,Branch>

listBranchesSettings()

public UnaryCallSettings<ListBranchesRequest,ListBranchesResponse> listBranchesSettings()

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

Returns
Type Description
UnaryCallSettings<ListBranchesRequest,ListBranchesResponse>

toBuilder()

public BranchServiceSettings.Builder toBuilder()

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

Returns
Type Description
BranchServiceSettings.Builder
Overrides