Class NetworkFirewallPoliciesSettings (1.63.0)

public class NetworkFirewallPoliciesSettings extends ClientSettings<NetworkFirewallPoliciesSettings>

Settings class to configure an instance of NetworkFirewallPoliciesClient.

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
 NetworkFirewallPoliciesSettings.Builder networkFirewallPoliciesSettingsBuilder =
     NetworkFirewallPoliciesSettings.newBuilder();
 networkFirewallPoliciesSettingsBuilder
     .getSettings()
     .setRetrySettings(
         networkFirewallPoliciesSettingsBuilder
             .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());
 NetworkFirewallPoliciesSettings networkFirewallPoliciesSettings =
     networkFirewallPoliciesSettingsBuilder.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 addAssociation:


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

Inheritance

java.lang.Object > ClientSettings > NetworkFirewallPoliciesSettings

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

public static final NetworkFirewallPoliciesSettings create(NetworkFirewallPoliciesStubSettings stub)

Parameter
Name	Description
`stub`	`NetworkFirewallPoliciesStubSettings`

Returns
Type	Description
`NetworkFirewallPoliciesSettings`

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

Returns a new builder for this class.

Returns
Type	Description
`NetworkFirewallPoliciesSettings.Builder`

newBuilder(ClientContext clientContext)

public static NetworkFirewallPoliciesSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`NetworkFirewallPoliciesSettings.Builder`

Constructors

NetworkFirewallPoliciesSettings(NetworkFirewallPoliciesSettings.Builder settingsBuilder)

protected NetworkFirewallPoliciesSettings(NetworkFirewallPoliciesSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`NetworkFirewallPoliciesSettings.Builder`

Methods

addAssociationOperationSettings()

public OperationCallSettings<AddAssociationNetworkFirewallPolicyRequest,Operation,Operation> addAssociationOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<AddAssociationNetworkFirewallPolicyRequest,Operation,Operation>`

addAssociationSettings()

public UnaryCallSettings<AddAssociationNetworkFirewallPolicyRequest,Operation> addAssociationSettings()

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

Returns
Type	Description
`UnaryCallSettings<AddAssociationNetworkFirewallPolicyRequest,Operation>`

addRuleOperationSettings()

public OperationCallSettings<AddRuleNetworkFirewallPolicyRequest,Operation,Operation> addRuleOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<AddRuleNetworkFirewallPolicyRequest,Operation,Operation>`

addRuleSettings()

public UnaryCallSettings<AddRuleNetworkFirewallPolicyRequest,Operation> addRuleSettings()

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

Returns
Type	Description
`UnaryCallSettings<AddRuleNetworkFirewallPolicyRequest,Operation>`

cloneRulesOperationSettings()

public OperationCallSettings<CloneRulesNetworkFirewallPolicyRequest,Operation,Operation> cloneRulesOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CloneRulesNetworkFirewallPolicyRequest,Operation,Operation>`

cloneRulesSettings()

public UnaryCallSettings<CloneRulesNetworkFirewallPolicyRequest,Operation> cloneRulesSettings()

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

Returns
Type	Description
`UnaryCallSettings<CloneRulesNetworkFirewallPolicyRequest,Operation>`

deleteOperationSettings()

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

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

Returns
Type	Description
`OperationCallSettings<DeleteNetworkFirewallPolicyRequest,Operation,Operation>`

deleteSettings()

public UnaryCallSettings<DeleteNetworkFirewallPolicyRequest,Operation> deleteSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteNetworkFirewallPolicyRequest,Operation>`

getAssociationSettings()

public UnaryCallSettings<GetAssociationNetworkFirewallPolicyRequest,FirewallPolicyAssociation> getAssociationSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetAssociationNetworkFirewallPolicyRequest,FirewallPolicyAssociation>`

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyNetworkFirewallPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<GetIamPolicyNetworkFirewallPolicyRequest,Policy>`

getRuleSettings()

public UnaryCallSettings<GetRuleNetworkFirewallPolicyRequest,FirewallPolicyRule> getRuleSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetRuleNetworkFirewallPolicyRequest,FirewallPolicyRule>`

getSettings()

public UnaryCallSettings<GetNetworkFirewallPolicyRequest,FirewallPolicy> getSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetNetworkFirewallPolicyRequest,FirewallPolicy>`

insertOperationSettings()

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

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

Returns
Type	Description
`OperationCallSettings<InsertNetworkFirewallPolicyRequest,Operation,Operation>`

insertSettings()

public UnaryCallSettings<InsertNetworkFirewallPolicyRequest,Operation> insertSettings()

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

Returns
Type	Description
`UnaryCallSettings<InsertNetworkFirewallPolicyRequest,Operation>`

listSettings()

public PagedCallSettings<ListNetworkFirewallPoliciesRequest,FirewallPolicyList,NetworkFirewallPoliciesClient.ListPagedResponse> listSettings()

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

Returns
Type	Description
`PagedCallSettings<ListNetworkFirewallPoliciesRequest,FirewallPolicyList,ListPagedResponse>`

patchOperationSettings()

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

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

Returns
Type	Description
`OperationCallSettings<PatchNetworkFirewallPolicyRequest,Operation,Operation>`

patchRuleOperationSettings()

public OperationCallSettings<PatchRuleNetworkFirewallPolicyRequest,Operation,Operation> patchRuleOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<PatchRuleNetworkFirewallPolicyRequest,Operation,Operation>`

patchRuleSettings()

public UnaryCallSettings<PatchRuleNetworkFirewallPolicyRequest,Operation> patchRuleSettings()

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

Returns
Type	Description
`UnaryCallSettings<PatchRuleNetworkFirewallPolicyRequest,Operation>`

patchSettings()

public UnaryCallSettings<PatchNetworkFirewallPolicyRequest,Operation> patchSettings()

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

Returns
Type	Description
`UnaryCallSettings<PatchNetworkFirewallPolicyRequest,Operation>`

removeAssociationOperationSettings()

public OperationCallSettings<RemoveAssociationNetworkFirewallPolicyRequest,Operation,Operation> removeAssociationOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<RemoveAssociationNetworkFirewallPolicyRequest,Operation,Operation>`

removeAssociationSettings()

public UnaryCallSettings<RemoveAssociationNetworkFirewallPolicyRequest,Operation> removeAssociationSettings()

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

Returns
Type	Description
`UnaryCallSettings<RemoveAssociationNetworkFirewallPolicyRequest,Operation>`

removeRuleOperationSettings()

public OperationCallSettings<RemoveRuleNetworkFirewallPolicyRequest,Operation,Operation> removeRuleOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<RemoveRuleNetworkFirewallPolicyRequest,Operation,Operation>`

removeRuleSettings()

public UnaryCallSettings<RemoveRuleNetworkFirewallPolicyRequest,Operation> removeRuleSettings()

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

Returns
Type	Description
`UnaryCallSettings<RemoveRuleNetworkFirewallPolicyRequest,Operation>`

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyNetworkFirewallPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<SetIamPolicyNetworkFirewallPolicyRequest,Policy>`

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsNetworkFirewallPolicyRequest,TestPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
`UnaryCallSettings<TestIamPermissionsNetworkFirewallPolicyRequest,TestPermissionsResponse>`

toBuilder()

public NetworkFirewallPoliciesSettings.Builder toBuilder()

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

Returns
Type	Description
`NetworkFirewallPoliciesSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()