Class RoutersSettings (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 total timeout of get to 30 seconds:


 RoutersSettings.Builder routersSettingsBuilder = RoutersSettings.newBuilder();
 routersSettingsBuilder
     .getSettings()
     .setRetrySettings(
         routersSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RoutersSettings routersSettings = routersSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > RoutersSettings

Constructors

RoutersSettings(RoutersSettings.Builder settingsBuilder)

protected RoutersSettings(RoutersSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderRoutersSettings.Builder

Methods

aggregatedListSettings()

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

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

Returns
TypeDescription
PagedCallSettings<AggregatedListRoutersRequest,RouterAggregatedList,AggregatedListPagedResponse>

create(RoutersStubSettings stub)

public static final RoutersSettings create(RoutersStubSettings stub)
Parameter
NameDescription
stubRoutersStubSettings
Returns
TypeDescription
RoutersSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteRouterRequest,Operation,Operation>

deleteSettings()

public UnaryCallSettings<DeleteRouterRequest,Operation> deleteSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteRouterRequest,Operation>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getNatMappingInfoSettings()

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

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

Returns
TypeDescription
PagedCallSettings<GetNatMappingInfoRoutersRequest,VmEndpointNatMappingsList,GetNatMappingInfoPagedResponse>

getRouterStatusSettings()

public UnaryCallSettings<GetRouterStatusRouterRequest,RouterStatusResponse> getRouterStatusSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetRouterStatusRouterRequest,RouterStatusResponse>

getSettings()

public UnaryCallSettings<GetRouterRequest,Router> getSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetRouterRequest,Router>

insertOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<InsertRouterRequest,Operation,Operation>

insertSettings()

public UnaryCallSettings<InsertRouterRequest,Operation> insertSettings()

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

Returns
TypeDescription
UnaryCallSettings<InsertRouterRequest,Operation>

listSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListRoutersRequest,RouterList,ListPagedResponse>

newBuilder()

public static RoutersSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
RoutersSettings.Builder

newBuilder(ClientContext clientContext)

public static RoutersSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
RoutersSettings.Builder

patchOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<PatchRouterRequest,Operation,Operation>

patchSettings()

public UnaryCallSettings<PatchRouterRequest,Operation> patchSettings()

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

Returns
TypeDescription
UnaryCallSettings<PatchRouterRequest,Operation>

previewSettings()

public UnaryCallSettings<PreviewRouterRequest,RoutersPreviewResponse> previewSettings()

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

Returns
TypeDescription
UnaryCallSettings<PreviewRouterRequest,RoutersPreviewResponse>

toBuilder()

public RoutersSettings.Builder toBuilder()

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

Returns
TypeDescription
RoutersSettings.Builder
Overrides

updateOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateRouterRequest,Operation,Operation>

updateSettings()

public UnaryCallSettings<UpdateRouterRequest,Operation> updateSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateRouterRequest,Operation>