com.google.cloud.compute.v1

Class RegionsSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<RegionsSettings>

com.google.cloud.compute.v1.RegionsSettings

@Generated(value="by gapic-generator-java")
public class RegionsSettings
extends com.google.api.gax.rpc.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:

 // 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
 RegionsSettings.Builder regionsSettingsBuilder = RegionsSettings.newBuilder();
 regionsSettingsBuilder
     .getSettings()
     .setRetrySettings(
         regionsSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RegionsSettings regionsSettings = regionsSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionsSettings.Builder Builder for RegionsSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionsSettings(RegionsSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static RegionsSettings	create(RegionsStubSettings stub)
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetRegionRequest,Region>	getSettings() Returns the object with the settings used for calls to get.
com.google.api.gax.rpc.PagedCallSettings<ListRegionsRequest,RegionList,RegionsClient.ListPagedResponse>	listSettings() Returns the object with the settings used for calls to list.
static RegionsSettings.Builder	newBuilder() Returns a new builder for this class.
static RegionsSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
RegionsSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RegionsSettings

protected RegionsSettings(RegionsSettings.Builder settingsBuilder)
                   throws IOException

Throws:

IOException

Method Detail

getSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetRegionRequest,Region> getSettings()

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

listSettings

public com.google.api.gax.rpc.PagedCallSettings<ListRegionsRequest,RegionList,RegionsClient.ListPagedResponse> listSettings()

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

create

public static final RegionsSettings create(RegionsStubSettings stub)
                                    throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static RegionsSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static RegionsSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public RegionsSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<RegionsSettings>