Class RegionsSettings (1.6.0-beta) 

public class RegionsSettings extends ClientSettings<RegionsSettings>

Settings class to configure an instance of RegionsClient.

The default instance has everything set to sensible defaults:

  • The default service address (compute.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 get to 30 seconds:


 RegionsSettings.Builder regionsSettingsBuilder = RegionsSettings.newBuilder();
 regionsSettingsBuilder
     .getSettings()
     .setRetrySettings(
         regionsSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RegionsSettings regionsSettings = regionsSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > RegionsSettings

Constructors

RegionsSettings(RegionsSettings.Builder settingsBuilder)

protected RegionsSettings(RegionsSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderRegionsSettings.Builder

Methods

create(RegionsStubSettings stub)

public static final RegionsSettings create(RegionsStubSettings stub)
Parameter
NameDescription
stubRegionsStubSettings
Returns
TypeDescription
RegionsSettings
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

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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>

getSettings()

public UnaryCallSettings<GetRegionRequest,Region> getSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetRegionRequest,Region>

listSettings()

public PagedCallSettings<ListRegionsRequest,RegionList,RegionsClient.ListPagedResponse> listSettings()

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

Returns
TypeDescription
PagedCallSettings<ListRegionsRequest,RegionList,ListPagedResponse>

newBuilder()

public static RegionsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
RegionsSettings.Builder

newBuilder(ClientContext clientContext)

public static RegionsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
RegionsSettings.Builder

toBuilder()

public RegionsSettings.Builder toBuilder()

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

Returns
TypeDescription
RegionsSettings.Builder
Overrides