com.google.cloud.compute.v1

Class RouterSettings

java.lang.Object

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

com.google.cloud.compute.v1.RouterSettings

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

Settings class to configure an instance of RouterClient.

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 deleteRouter to 30 seconds:

 
 RouterSettings.Builder routerSettingsBuilder =
     RouterSettings.newBuilder();
 routerSettingsBuilder.deleteRouterSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 RouterSettings routerSettings = routerSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PagedCallSettings<AggregatedListRoutersHttpRequest,RouterAggregatedList,RouterClient.AggregatedListRoutersPagedResponse>	aggregatedListRoutersSettings() Returns the object with the settings used for calls to aggregatedListRouters.
static RouterSettings	create(RouterStubSettings 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()
UnaryCallSettings<DeleteRouterHttpRequest,Operation>	deleteRouterSettings() Returns the object with the settings used for calls to deleteRouter.
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.
PagedCallSettings<GetNatMappingInfoRoutersHttpRequest,VmEndpointNatMappingsList,RouterClient.GetNatMappingInfoRoutersPagedResponse>	getNatMappingInfoRoutersSettings() Returns the object with the settings used for calls to getNatMappingInfoRouters.
UnaryCallSettings<GetRouterHttpRequest,Router>	getRouterSettings() Returns the object with the settings used for calls to getRouter.
UnaryCallSettings<GetRouterStatusRouterHttpRequest,RouterStatusResponse>	getRouterStatusRouterSettings() Returns the object with the settings used for calls to getRouterStatusRouter.
UnaryCallSettings<InsertRouterHttpRequest,Operation>	insertRouterSettings() Returns the object with the settings used for calls to insertRouter.
PagedCallSettings<ListRoutersHttpRequest,RouterList,RouterClient.ListRoutersPagedResponse>	listRoutersSettings() Returns the object with the settings used for calls to listRouters.
static RouterSettings.Builder	newBuilder() Returns a new builder for this class.
static RouterSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<PatchRouterHttpRequest,Operation>	patchRouterSettings() Returns the object with the settings used for calls to patchRouter.
UnaryCallSettings<PreviewRouterHttpRequest,RoutersPreviewResponse>	previewRouterSettings() Returns the object with the settings used for calls to previewRouter.
RouterSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UpdateRouterHttpRequest,Operation>	updateRouterSettings() Returns the object with the settings used for calls to updateRouter.

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

RouterSettings

protected RouterSettings(RouterSettings.Builder settingsBuilder)
                  throws IOException

Throws:

IOException

Method Detail

aggregatedListRoutersSettings

public PagedCallSettings<AggregatedListRoutersHttpRequest,RouterAggregatedList,RouterClient.AggregatedListRoutersPagedResponse> aggregatedListRoutersSettings()

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

deleteRouterSettings

public UnaryCallSettings<DeleteRouterHttpRequest,Operation> deleteRouterSettings()

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

getRouterSettings

public UnaryCallSettings<GetRouterHttpRequest,Router> getRouterSettings()

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

getNatMappingInfoRoutersSettings

public PagedCallSettings<GetNatMappingInfoRoutersHttpRequest,VmEndpointNatMappingsList,RouterClient.GetNatMappingInfoRoutersPagedResponse> getNatMappingInfoRoutersSettings()

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

getRouterStatusRouterSettings

public UnaryCallSettings<GetRouterStatusRouterHttpRequest,RouterStatusResponse> getRouterStatusRouterSettings()

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

insertRouterSettings

public UnaryCallSettings<InsertRouterHttpRequest,Operation> insertRouterSettings()

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

listRoutersSettings

public PagedCallSettings<ListRoutersHttpRequest,RouterList,RouterClient.ListRoutersPagedResponse> listRoutersSettings()

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

patchRouterSettings

public UnaryCallSettings<PatchRouterHttpRequest,Operation> patchRouterSettings()

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

previewRouterSettings

public UnaryCallSettings<PreviewRouterHttpRequest,RoutersPreviewResponse> previewRouterSettings()

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

updateRouterSettings

public UnaryCallSettings<UpdateRouterHttpRequest,Operation> updateRouterSettings()

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

create

public static final RouterSettings create(RouterStubSettings 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 RouterSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static RouterSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public RouterSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<RouterSettings>