Class FirewallActivationSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<FirewallActivationSettings>
com.google.cloud.networksecurity.v1.FirewallActivationSettings
@Generated("by gapic-generator-java")
public class FirewallActivationSettings
extends ClientSettings<FirewallActivationSettings>
Settings class to configure an instance of
FirewallActivationClient.
The default instance has everything set to sensible defaults:
- The default service address (networksecurity.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 getFirewallEndpoint:
// 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
FirewallActivationSettings.Builder firewallActivationSettingsBuilder =
FirewallActivationSettings.newBuilder();
firewallActivationSettingsBuilder
.getFirewallEndpointSettings()
.setRetrySettings(
firewallActivationSettingsBuilder
.getFirewallEndpointSettings()
.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());
FirewallActivationSettings firewallActivationSettings =
firewallActivationSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 createFirewallEndpoint:
// 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
FirewallActivationSettings.Builder firewallActivationSettingsBuilder =
FirewallActivationSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
firewallActivationSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for FirewallActivationSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedFirewallActivationSettings(FirewallActivationSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final FirewallActivationSettingsOperationCallSettings<CreateFirewallEndpointAssociationRequest,FirewallEndpointAssociation, OperationMetadata> Returns the object with the settings used for calls to createFirewallEndpointAssociation.Returns the object with the settings used for calls to createFirewallEndpointAssociation.Returns the object with the settings used for calls to createFirewallEndpoint.Returns the object with the settings used for calls to createFirewallEndpoint.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteFirewallEndpointAssociationRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteFirewallEndpointAssociation.Returns the object with the settings used for calls to deleteFirewallEndpointAssociation.OperationCallSettings<DeleteFirewallEndpointRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteFirewallEndpoint.Returns the object with the settings used for calls to deleteFirewallEndpoint.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getFirewallEndpointAssociation.Returns the object with the settings used for calls to getFirewallEndpoint.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListFirewallEndpointAssociationsRequest,ListFirewallEndpointAssociationsResponse, FirewallActivationClient.ListFirewallEndpointAssociationsPagedResponse> Returns the object with the settings used for calls to listFirewallEndpointAssociations.PagedCallSettings<ListFirewallEndpointsRequest,ListFirewallEndpointsResponse, FirewallActivationClient.ListFirewallEndpointsPagedResponse> Returns the object with the settings used for calls to listFirewallEndpoints.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, FirewallActivationClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.OperationCallSettings<UpdateFirewallEndpointAssociationRequest,FirewallEndpointAssociation, OperationMetadata> Returns the object with the settings used for calls to updateFirewallEndpointAssociation.Returns the object with the settings used for calls to updateFirewallEndpointAssociation.Returns the object with the settings used for calls to updateFirewallEndpoint.Returns the object with the settings used for calls to updateFirewallEndpoint.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
FirewallActivationSettings
protected FirewallActivationSettings(FirewallActivationSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listFirewallEndpointsSettings
public PagedCallSettings<ListFirewallEndpointsRequest,ListFirewallEndpointsResponse, listFirewallEndpointsSettings()FirewallActivationClient.ListFirewallEndpointsPagedResponse> Returns the object with the settings used for calls to listFirewallEndpoints. -
getFirewallEndpointSettings
Returns the object with the settings used for calls to getFirewallEndpoint. -
createFirewallEndpointSettings
Returns the object with the settings used for calls to createFirewallEndpoint. -
createFirewallEndpointOperationSettings
public OperationCallSettings<CreateFirewallEndpointRequest,FirewallEndpoint, createFirewallEndpointOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createFirewallEndpoint. -
deleteFirewallEndpointSettings
Returns the object with the settings used for calls to deleteFirewallEndpoint. -
deleteFirewallEndpointOperationSettings
public OperationCallSettings<DeleteFirewallEndpointRequest,com.google.protobuf.Empty, deleteFirewallEndpointOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteFirewallEndpoint. -
updateFirewallEndpointSettings
Returns the object with the settings used for calls to updateFirewallEndpoint. -
updateFirewallEndpointOperationSettings
public OperationCallSettings<UpdateFirewallEndpointRequest,FirewallEndpoint, updateFirewallEndpointOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateFirewallEndpoint. -
listFirewallEndpointAssociationsSettings
public PagedCallSettings<ListFirewallEndpointAssociationsRequest,ListFirewallEndpointAssociationsResponse, listFirewallEndpointAssociationsSettings()FirewallActivationClient.ListFirewallEndpointAssociationsPagedResponse> Returns the object with the settings used for calls to listFirewallEndpointAssociations. -
getFirewallEndpointAssociationSettings
public UnaryCallSettings<GetFirewallEndpointAssociationRequest,FirewallEndpointAssociation> getFirewallEndpointAssociationSettings()Returns the object with the settings used for calls to getFirewallEndpointAssociation. -
createFirewallEndpointAssociationSettings
public UnaryCallSettings<CreateFirewallEndpointAssociationRequest,Operation> createFirewallEndpointAssociationSettings()Returns the object with the settings used for calls to createFirewallEndpointAssociation. -
createFirewallEndpointAssociationOperationSettings
public OperationCallSettings<CreateFirewallEndpointAssociationRequest,FirewallEndpointAssociation, createFirewallEndpointAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createFirewallEndpointAssociation. -
deleteFirewallEndpointAssociationSettings
public UnaryCallSettings<DeleteFirewallEndpointAssociationRequest,Operation> deleteFirewallEndpointAssociationSettings()Returns the object with the settings used for calls to deleteFirewallEndpointAssociation. -
deleteFirewallEndpointAssociationOperationSettings
public OperationCallSettings<DeleteFirewallEndpointAssociationRequest,com.google.protobuf.Empty, deleteFirewallEndpointAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteFirewallEndpointAssociation. -
updateFirewallEndpointAssociationSettings
public UnaryCallSettings<UpdateFirewallEndpointAssociationRequest,Operation> updateFirewallEndpointAssociationSettings()Returns the object with the settings used for calls to updateFirewallEndpointAssociation. -
updateFirewallEndpointAssociationOperationSettings
public OperationCallSettings<UpdateFirewallEndpointAssociationRequest,FirewallEndpointAssociation, updateFirewallEndpointAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateFirewallEndpointAssociation. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()FirewallActivationClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
public static final FirewallActivationSettings create(FirewallActivationStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<FirewallActivationSettings>
-