Class FirewallActivationSettings (0.94.0)

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 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 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();
 

Inheritance

java.lang.Object > ClientSettings > FirewallActivationSettings

Static Methods

create(FirewallActivationStubSettings stub)

public static final FirewallActivationSettings create(FirewallActivationStubSettings stub)
Parameter
Name Description
stub FirewallActivationStubSettings
Returns
Type Description
FirewallActivationSettings
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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns a new builder for this class.

Returns
Type Description
FirewallActivationSettings.Builder

newBuilder(ClientContext clientContext)

public static FirewallActivationSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
FirewallActivationSettings.Builder

Constructors

FirewallActivationSettings(FirewallActivationSettings.Builder settingsBuilder)

protected FirewallActivationSettings(FirewallActivationSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder FirewallActivationSettings.Builder

Methods

createFirewallEndpointAssociationOperationSettings()

public OperationCallSettings<CreateFirewallEndpointAssociationRequest,FirewallEndpointAssociation,OperationMetadata> createFirewallEndpointAssociationOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateFirewallEndpointAssociationRequest,FirewallEndpointAssociation,OperationMetadata>

createFirewallEndpointAssociationSettings()

public UnaryCallSettings<CreateFirewallEndpointAssociationRequest,Operation> createFirewallEndpointAssociationSettings()

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

Returns
Type Description
UnaryCallSettings<CreateFirewallEndpointAssociationRequest,Operation>

createFirewallEndpointOperationSettings()

public OperationCallSettings<CreateFirewallEndpointRequest,FirewallEndpoint,OperationMetadata> createFirewallEndpointOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateFirewallEndpointRequest,FirewallEndpoint,OperationMetadata>

createFirewallEndpointSettings()

public UnaryCallSettings<CreateFirewallEndpointRequest,Operation> createFirewallEndpointSettings()

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

Returns
Type Description
UnaryCallSettings<CreateFirewallEndpointRequest,Operation>

deleteFirewallEndpointAssociationOperationSettings()

public OperationCallSettings<DeleteFirewallEndpointAssociationRequest,Empty,OperationMetadata> deleteFirewallEndpointAssociationOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteFirewallEndpointAssociationRequest,Empty,OperationMetadata>

deleteFirewallEndpointAssociationSettings()

public UnaryCallSettings<DeleteFirewallEndpointAssociationRequest,Operation> deleteFirewallEndpointAssociationSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteFirewallEndpointAssociationRequest,Operation>

deleteFirewallEndpointOperationSettings()

public OperationCallSettings<DeleteFirewallEndpointRequest,Empty,OperationMetadata> deleteFirewallEndpointOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteFirewallEndpointRequest,Empty,OperationMetadata>

deleteFirewallEndpointSettings()

public UnaryCallSettings<DeleteFirewallEndpointRequest,Operation> deleteFirewallEndpointSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteFirewallEndpointRequest,Operation>

getFirewallEndpointAssociationSettings()

public UnaryCallSettings<GetFirewallEndpointAssociationRequest,FirewallEndpointAssociation> getFirewallEndpointAssociationSettings()

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

Returns
Type Description
UnaryCallSettings<GetFirewallEndpointAssociationRequest,FirewallEndpointAssociation>

getFirewallEndpointSettings()

public UnaryCallSettings<GetFirewallEndpointRequest,FirewallEndpoint> getFirewallEndpointSettings()

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

Returns
Type Description
UnaryCallSettings<GetFirewallEndpointRequest,FirewallEndpoint>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

listFirewallEndpointAssociationsSettings()

public PagedCallSettings<ListFirewallEndpointAssociationsRequest,ListFirewallEndpointAssociationsResponse,FirewallActivationClient.ListFirewallEndpointAssociationsPagedResponse> listFirewallEndpointAssociationsSettings()

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

Returns
Type Description
PagedCallSettings<ListFirewallEndpointAssociationsRequest,ListFirewallEndpointAssociationsResponse,ListFirewallEndpointAssociationsPagedResponse>

listFirewallEndpointsSettings()

public PagedCallSettings<ListFirewallEndpointsRequest,ListFirewallEndpointsResponse,FirewallActivationClient.ListFirewallEndpointsPagedResponse> listFirewallEndpointsSettings()

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

Returns
Type Description
PagedCallSettings<ListFirewallEndpointsRequest,ListFirewallEndpointsResponse,ListFirewallEndpointsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,FirewallActivationClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public FirewallActivationSettings.Builder toBuilder()

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

Returns
Type Description
FirewallActivationSettings.Builder
Overrides

updateFirewallEndpointAssociationOperationSettings()

public OperationCallSettings<UpdateFirewallEndpointAssociationRequest,FirewallEndpointAssociation,OperationMetadata> updateFirewallEndpointAssociationOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateFirewallEndpointAssociationRequest,FirewallEndpointAssociation,OperationMetadata>

updateFirewallEndpointAssociationSettings()

public UnaryCallSettings<UpdateFirewallEndpointAssociationRequest,Operation> updateFirewallEndpointAssociationSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateFirewallEndpointAssociationRequest,Operation>

updateFirewallEndpointOperationSettings()

public OperationCallSettings<UpdateFirewallEndpointRequest,FirewallEndpoint,OperationMetadata> updateFirewallEndpointOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateFirewallEndpointRequest,FirewallEndpoint,OperationMetadata>

updateFirewallEndpointSettings()

public UnaryCallSettings<UpdateFirewallEndpointRequest,Operation> updateFirewallEndpointSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateFirewallEndpointRequest,Operation>