com.google.cloud.compute.v1

Class RegionSettings

java.lang.Object

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

com.google.cloud.compute.v1.RegionSettings

@Generated(value="by gapic-generator")
 @BetaApi
public class RegionSettings
extends ClientSettings<RegionSettings>

Settings class to configure an instance of RegionClient.

The default instance has everything set to sensible defaults:

• The default service address (https://www.googleapis.com/compute/v1/projects/) 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 getRegion to 30 seconds:

 
 RegionSettings.Builder regionSettingsBuilder =
     RegionSettings.newBuilder();
 regionSettingsBuilder.getRegionSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 RegionSettings regionSettings = regionSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static RegionSettings	create(RegionStubSettings stub)
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
static String	getDefaultEndpoint() Returns the default service endpoint.
static int	getDefaultServicePort() Returns the default service port.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<GetRegionHttpRequest,Region>	getRegionSettings() Returns the object with the settings used for calls to getRegion.
PagedCallSettings<ListRegionsHttpRequest,RegionList,RegionClient.ListRegionsPagedResponse>	listRegionsSettings() Returns the object with the settings used for calls to listRegions.
static RegionSettings.Builder	newBuilder() Returns a new builder for this class.
static RegionSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
RegionSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

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

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionSettings

protected RegionSettings(RegionSettings.Builder settingsBuilder)
                  throws IOException

Throws:

IOException

Method Detail

getRegionSettings

public UnaryCallSettings<GetRegionHttpRequest,Region> getRegionSettings()

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

listRegionsSettings

public PagedCallSettings<ListRegionsHttpRequest,RegionList,RegionClient.ListRegionsPagedResponse> listRegionsSettings()

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

create

public static final RegionSettings create(RegionStubSettings stub)
                                   throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServicePort

public static int getDefaultServicePort()

Returns the default service port.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static RegionSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static RegionSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public RegionSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<RegionSettings>