Class NetworksSettings (1.16.0)

Version 1.16.0

• 1.62.0 (latest)
• 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 NetworksSettings extends ClientSettings<NetworksSettings>

Settings class to configure an instance of NetworksClient.

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:

 // 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
 NetworksSettings.Builder networksSettingsBuilder = NetworksSettings.newBuilder();
 networksSettingsBuilder
     .getSettings()
     .setRetrySettings(
         networksSettingsBuilder.getSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 NetworksSettings networksSettings = networksSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > NetworksSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

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(NetworksStubSettings stub)

public static final NetworksSettings create(NetworksStubSettings stub)

Parameter

Name	Description
stub	NetworksStubSettings

Returns

Type	Description
NetworksSettings

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 NetworksSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
NetworksSettings.Builder

newBuilder(ClientContext clientContext)

public static NetworksSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	ClientContext

Returns

Type	Description
NetworksSettings.Builder

Constructors

NetworksSettings(NetworksSettings.Builder settingsBuilder)

protected NetworksSettings(NetworksSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	NetworksSettings.Builder

Methods

addPeeringOperationSettings()

public OperationCallSettings<AddPeeringNetworkRequest,Operation,Operation> addPeeringOperationSettings()

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

Returns

Type	Description
OperationCallSettings<AddPeeringNetworkRequest,Operation,Operation>

addPeeringSettings()

public UnaryCallSettings<AddPeeringNetworkRequest,Operation> addPeeringSettings()

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

Returns

Type	Description
UnaryCallSettings<AddPeeringNetworkRequest,Operation>

deleteOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteNetworkRequest,Operation,Operation>

deleteSettings()

public UnaryCallSettings<DeleteNetworkRequest,Operation> deleteSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteNetworkRequest,Operation>

getEffectiveFirewallsSettings()

public UnaryCallSettings<GetEffectiveFirewallsNetworkRequest,NetworksGetEffectiveFirewallsResponse> getEffectiveFirewallsSettings()

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

Returns

Type	Description
UnaryCallSettings<GetEffectiveFirewallsNetworkRequest,NetworksGetEffectiveFirewallsResponse>

getSettings()

public UnaryCallSettings<GetNetworkRequest,Network> getSettings()

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

Returns

Type	Description
UnaryCallSettings<GetNetworkRequest,Network>

insertOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<InsertNetworkRequest,Operation,Operation>

insertSettings()

public UnaryCallSettings<InsertNetworkRequest,Operation> insertSettings()

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

Returns

Type	Description
UnaryCallSettings<InsertNetworkRequest,Operation>

listPeeringRoutesSettings()

public PagedCallSettings<ListPeeringRoutesNetworksRequest,ExchangedPeeringRoutesList,NetworksClient.ListPeeringRoutesPagedResponse> listPeeringRoutesSettings()

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

Returns

Type	Description
PagedCallSettings<ListPeeringRoutesNetworksRequest,ExchangedPeeringRoutesList,ListPeeringRoutesPagedResponse>

listSettings()

public PagedCallSettings<ListNetworksRequest,NetworkList,NetworksClient.ListPagedResponse> listSettings()

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

Returns

Type	Description
PagedCallSettings<ListNetworksRequest,NetworkList,ListPagedResponse>

patchOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<PatchNetworkRequest,Operation,Operation>

patchSettings()

public UnaryCallSettings<PatchNetworkRequest,Operation> patchSettings()

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

Returns

Type	Description
UnaryCallSettings<PatchNetworkRequest,Operation>

removePeeringOperationSettings()

public OperationCallSettings<RemovePeeringNetworkRequest,Operation,Operation> removePeeringOperationSettings()

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

Returns

Type	Description
OperationCallSettings<RemovePeeringNetworkRequest,Operation,Operation>

removePeeringSettings()

public UnaryCallSettings<RemovePeeringNetworkRequest,Operation> removePeeringSettings()

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

Returns

Type	Description
UnaryCallSettings<RemovePeeringNetworkRequest,Operation>

switchToCustomModeOperationSettings()

public OperationCallSettings<SwitchToCustomModeNetworkRequest,Operation,Operation> switchToCustomModeOperationSettings()

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

Returns

Type	Description
OperationCallSettings<SwitchToCustomModeNetworkRequest,Operation,Operation>

switchToCustomModeSettings()

public UnaryCallSettings<SwitchToCustomModeNetworkRequest,Operation> switchToCustomModeSettings()

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

Returns

Type	Description
UnaryCallSettings<SwitchToCustomModeNetworkRequest,Operation>

toBuilder()

public NetworksSettings.Builder toBuilder()

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

Returns

Type	Description
NetworksSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updatePeeringOperationSettings()

public OperationCallSettings<UpdatePeeringNetworkRequest,Operation,Operation> updatePeeringOperationSettings()

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

Returns

Type	Description
OperationCallSettings<UpdatePeeringNetworkRequest,Operation,Operation>

updatePeeringSettings()

public UnaryCallSettings<UpdatePeeringNetworkRequest,Operation> updatePeeringSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdatePeeringNetworkRequest,Operation>