com.google.cloud.compute.v1.stub

Class RoutersStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<RoutersStubSettings>

com.google.cloud.compute.v1.stub.RoutersStubSettings

@Generated(value="by gapic-generator-java")
public class RoutersStubSettings
extends com.google.api.gax.rpc.StubSettings<RoutersStubSettings>

Settings class to configure an instance of RoutersStub.

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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
 RoutersStubSettings.Builder routersSettingsBuilder = RoutersStubSettings.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());
 RoutersStubSettings routersSettings = routersSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) 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
 RoutersStubSettings.Builder routersSettingsBuilder = RoutersStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 routersSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.PagedCallSettings<AggregatedListRoutersRequest,RouterAggregatedList,RoutersClient.AggregatedListPagedResponse>	aggregatedListSettings() Returns the object with the settings used for calls to aggregatedList.
RoutersStub	createStub()
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()
com.google.api.gax.rpc.OperationCallSettings<DeleteRouterRequest,Operation,Operation>	deleteOperationSettings() Returns the object with the settings used for calls to delete.
com.google.api.gax.rpc.OperationCallSettings<DeleteRoutePolicyRouterRequest,Operation,Operation>	deleteRoutePolicyOperationSettings() Returns the object with the settings used for calls to deleteRoutePolicy.
com.google.api.gax.rpc.UnaryCallSettings<DeleteRoutePolicyRouterRequest,Operation>	deleteRoutePolicySettings() Returns the object with the settings used for calls to deleteRoutePolicy.
com.google.api.gax.rpc.UnaryCallSettings<DeleteRouterRequest,Operation>	deleteSettings() Returns the object with the settings used for calls to delete.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetNatIpInfoRouterRequest,NatIpInfoResponse>	getNatIpInfoSettings() Returns the object with the settings used for calls to getNatIpInfo.
com.google.api.gax.rpc.PagedCallSettings<GetNatMappingInfoRoutersRequest,VmEndpointNatMappingsList,RoutersClient.GetNatMappingInfoPagedResponse>	getNatMappingInfoSettings() Returns the object with the settings used for calls to getNatMappingInfo.
com.google.api.gax.rpc.UnaryCallSettings<GetRoutePolicyRouterRequest,RoutersGetRoutePolicyResponse>	getRoutePolicySettings() Returns the object with the settings used for calls to getRoutePolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetRouterStatusRouterRequest,RouterStatusResponse>	getRouterStatusSettings() Returns the object with the settings used for calls to getRouterStatus.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.UnaryCallSettings<GetRouterRequest,Router>	getSettings() Returns the object with the settings used for calls to get.
com.google.api.gax.rpc.OperationCallSettings<InsertRouterRequest,Operation,Operation>	insertOperationSettings() Returns the object with the settings used for calls to insert.
com.google.api.gax.rpc.UnaryCallSettings<InsertRouterRequest,Operation>	insertSettings() Returns the object with the settings used for calls to insert.
com.google.api.gax.rpc.PagedCallSettings<ListBgpRoutesRoutersRequest,RoutersListBgpRoutes,RoutersClient.ListBgpRoutesPagedResponse>	listBgpRoutesSettings() Returns the object with the settings used for calls to listBgpRoutes.
com.google.api.gax.rpc.PagedCallSettings<ListRoutePoliciesRoutersRequest,RoutersListRoutePolicies,RoutersClient.ListRoutePoliciesPagedResponse>	listRoutePoliciesSettings() Returns the object with the settings used for calls to listRoutePolicies.
com.google.api.gax.rpc.PagedCallSettings<ListRoutersRequest,RouterList,RoutersClient.ListPagedResponse>	listSettings() Returns the object with the settings used for calls to list.
static RoutersStubSettings.Builder	newBuilder() Returns a new builder for this class.
static RoutersStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.OperationCallSettings<PatchRouterRequest,Operation,Operation>	patchOperationSettings() Returns the object with the settings used for calls to patch.
com.google.api.gax.rpc.OperationCallSettings<PatchRoutePolicyRouterRequest,Operation,Operation>	patchRoutePolicyOperationSettings() Returns the object with the settings used for calls to patchRoutePolicy.
com.google.api.gax.rpc.UnaryCallSettings<PatchRoutePolicyRouterRequest,Operation>	patchRoutePolicySettings() Returns the object with the settings used for calls to patchRoutePolicy.
com.google.api.gax.rpc.UnaryCallSettings<PatchRouterRequest,Operation>	patchSettings() Returns the object with the settings used for calls to patch.
com.google.api.gax.rpc.UnaryCallSettings<PreviewRouterRequest,RoutersPreviewResponse>	previewSettings() Returns the object with the settings used for calls to preview.
RoutersStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateRouterRequest,Operation,Operation>	updateOperationSettings() Returns the object with the settings used for calls to update.
com.google.api.gax.rpc.OperationCallSettings<UpdateRoutePolicyRouterRequest,Operation,Operation>	updateRoutePolicyOperationSettings() Returns the object with the settings used for calls to updateRoutePolicy.
com.google.api.gax.rpc.UnaryCallSettings<UpdateRoutePolicyRouterRequest,Operation>	updateRoutePolicySettings() Returns the object with the settings used for calls to updateRoutePolicy.
com.google.api.gax.rpc.UnaryCallSettings<UpdateRouterRequest,Operation>	updateSettings() Returns the object with the settings used for calls to update.

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

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RoutersStubSettings

protected RoutersStubSettings(RoutersStubSettings.Builder settingsBuilder)
                       throws IOException

Throws:

IOException

Method Detail

aggregatedListSettings

public com.google.api.gax.rpc.PagedCallSettings<AggregatedListRoutersRequest,RouterAggregatedList,RoutersClient.AggregatedListPagedResponse> aggregatedListSettings()

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

deleteSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteRouterRequest,Operation> deleteSettings()

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

deleteOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteRouterRequest,Operation,Operation> deleteOperationSettings()

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

deleteRoutePolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteRoutePolicyRouterRequest,Operation> deleteRoutePolicySettings()

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

deleteRoutePolicyOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteRoutePolicyRouterRequest,Operation,Operation> deleteRoutePolicyOperationSettings()

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

getSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetRouterRequest,Router> getSettings()

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

getNatIpInfoSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetNatIpInfoRouterRequest,NatIpInfoResponse> getNatIpInfoSettings()

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

getNatMappingInfoSettings

public com.google.api.gax.rpc.PagedCallSettings<GetNatMappingInfoRoutersRequest,VmEndpointNatMappingsList,RoutersClient.GetNatMappingInfoPagedResponse> getNatMappingInfoSettings()

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

getRoutePolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetRoutePolicyRouterRequest,RoutersGetRoutePolicyResponse> getRoutePolicySettings()

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

getRouterStatusSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetRouterStatusRouterRequest,RouterStatusResponse> getRouterStatusSettings()

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

insertSettings

public com.google.api.gax.rpc.UnaryCallSettings<InsertRouterRequest,Operation> insertSettings()

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

insertOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<InsertRouterRequest,Operation,Operation> insertOperationSettings()

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

listSettings

public com.google.api.gax.rpc.PagedCallSettings<ListRoutersRequest,RouterList,RoutersClient.ListPagedResponse> listSettings()

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

listBgpRoutesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListBgpRoutesRoutersRequest,RoutersListBgpRoutes,RoutersClient.ListBgpRoutesPagedResponse> listBgpRoutesSettings()

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

listRoutePoliciesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListRoutePoliciesRoutersRequest,RoutersListRoutePolicies,RoutersClient.ListRoutePoliciesPagedResponse> listRoutePoliciesSettings()

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

patchSettings

public com.google.api.gax.rpc.UnaryCallSettings<PatchRouterRequest,Operation> patchSettings()

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

patchOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<PatchRouterRequest,Operation,Operation> patchOperationSettings()

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

patchRoutePolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<PatchRoutePolicyRouterRequest,Operation> patchRoutePolicySettings()

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

patchRoutePolicyOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<PatchRoutePolicyRouterRequest,Operation,Operation> patchRoutePolicyOperationSettings()

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

previewSettings

public com.google.api.gax.rpc.UnaryCallSettings<PreviewRouterRequest,RoutersPreviewResponse> previewSettings()

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

updateSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateRouterRequest,Operation> updateSettings()

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

updateOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateRouterRequest,Operation,Operation> updateOperationSettings()

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

updateRoutePolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateRoutePolicyRouterRequest,Operation> updateRoutePolicySettings()

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

updateRoutePolicyOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateRoutePolicyRouterRequest,Operation,Operation> updateRoutePolicyOperationSettings()

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

createStub

public RoutersStub createStub()
                       throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<RoutersStubSettings>

defaultExecutorProviderBuilder

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

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

@ObsoleteApi(value="Use getEndpoint() instead")
public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 RoutersStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public RoutersStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<RoutersStubSettings>