Class RoutersSettings (1.63.0)

Version latest

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class RoutersSettings extends ClientSettings<RoutersSettings>

Settings class to configure an instance of RoutersClient.

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 RetrySettings of get:

 // 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
 RoutersSettings.Builder routersSettingsBuilder = RoutersSettings.newBuilder();
 routersSettingsBuilder
     .getSettings()
     .setRetrySettings(
         routersSettingsBuilder
             .getSettings()
             .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());
 RoutersSettings routersSettings = routersSettingsBuilder.build();
 

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

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for delete:

 // 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
 RoutersSettings.Builder routersSettingsBuilder = RoutersSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 routersSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > ClientSettings > RoutersSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(RoutersStubSettings stub)

public static final RoutersSettings create(RoutersStubSettings stub)

Parameter
Name	Description
stub	RoutersStubSettings

Returns
Type	Description
RoutersSettings

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

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default 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 RoutersSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
RoutersSettings.Builder

newBuilder(ClientContext clientContext)

public static RoutersSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
RoutersSettings.Builder

Constructors

RoutersSettings(RoutersSettings.Builder settingsBuilder)

protected RoutersSettings(RoutersSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	RoutersSettings.Builder

Methods

aggregatedListSettings()

public PagedCallSettings<AggregatedListRoutersRequest,RouterAggregatedList,RoutersClient.AggregatedListPagedResponse> aggregatedListSettings()

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

Returns
Type	Description
PagedCallSettings<AggregatedListRoutersRequest,RouterAggregatedList,AggregatedListPagedResponse>

deleteOperationSettings()

public OperationCallSettings<DeleteRouterRequest,Operation,Operation> deleteOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteRouterRequest,Operation,Operation>

deleteSettings()

public UnaryCallSettings<DeleteRouterRequest,Operation> deleteSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteRouterRequest,Operation>

getNatIpInfoSettings()

public UnaryCallSettings<GetNatIpInfoRouterRequest,NatIpInfoResponse> getNatIpInfoSettings()

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

Returns
Type	Description
UnaryCallSettings<GetNatIpInfoRouterRequest,NatIpInfoResponse>

getNatMappingInfoSettings()

public PagedCallSettings<GetNatMappingInfoRoutersRequest,VmEndpointNatMappingsList,RoutersClient.GetNatMappingInfoPagedResponse> getNatMappingInfoSettings()

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

Returns
Type	Description
PagedCallSettings<GetNatMappingInfoRoutersRequest,VmEndpointNatMappingsList,GetNatMappingInfoPagedResponse>

getRouterStatusSettings()

public UnaryCallSettings<GetRouterStatusRouterRequest,RouterStatusResponse> getRouterStatusSettings()

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

Returns
Type	Description
UnaryCallSettings<GetRouterStatusRouterRequest,RouterStatusResponse>

getSettings()

public UnaryCallSettings<GetRouterRequest,Router> getSettings()

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

Returns
Type	Description
UnaryCallSettings<GetRouterRequest,Router>

insertOperationSettings()

public OperationCallSettings<InsertRouterRequest,Operation,Operation> insertOperationSettings()

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

Returns
Type	Description
OperationCallSettings<InsertRouterRequest,Operation,Operation>

insertSettings()

public UnaryCallSettings<InsertRouterRequest,Operation> insertSettings()

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

Returns
Type	Description
UnaryCallSettings<InsertRouterRequest,Operation>

listSettings()

public PagedCallSettings<ListRoutersRequest,RouterList,RoutersClient.ListPagedResponse> listSettings()

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

Returns
Type	Description
PagedCallSettings<ListRoutersRequest,RouterList,ListPagedResponse>

patchOperationSettings()

public OperationCallSettings<PatchRouterRequest,Operation,Operation> patchOperationSettings()

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

Returns
Type	Description
OperationCallSettings<PatchRouterRequest,Operation,Operation>

patchSettings()

public UnaryCallSettings<PatchRouterRequest,Operation> patchSettings()

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

Returns
Type	Description
UnaryCallSettings<PatchRouterRequest,Operation>

previewSettings()

public UnaryCallSettings<PreviewRouterRequest,RoutersPreviewResponse> previewSettings()

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

Returns
Type	Description
UnaryCallSettings<PreviewRouterRequest,RoutersPreviewResponse>

toBuilder()

public RoutersSettings.Builder toBuilder()

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

Returns
Type	Description
RoutersSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateOperationSettings()

public OperationCallSettings<UpdateRouterRequest,Operation,Operation> updateOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdateRouterRequest,Operation,Operation>

updateSettings()

public UnaryCallSettings<UpdateRouterRequest,Operation> updateSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateRouterRequest,Operation>