com.google.cloud.compute.v1

Class SecurityPoliciesSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<SecurityPoliciesSettings>

com.google.cloud.compute.v1.SecurityPoliciesSettings

@Generated(value="by gapic-generator-java")
public class SecurityPoliciesSettings
extends com.google.api.gax.rpc.ClientSettings<SecurityPoliciesSettings>

Settings class to configure an instance of SecurityPoliciesClient.

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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
 SecurityPoliciesSettings.Builder securityPoliciesSettingsBuilder =
     SecurityPoliciesSettings.newBuilder();
 securityPoliciesSettingsBuilder
     .getSettings()
     .setRetrySettings(
         securityPoliciesSettingsBuilder
             .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());
 SecurityPoliciesSettings securityPoliciesSettings = securityPoliciesSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) 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 addRule:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecurityPoliciesSettings.Builder Builder for SecurityPoliciesSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SecurityPoliciesSettings(SecurityPoliciesSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<AddRuleSecurityPolicyRequest,Operation,Operation>	addRuleOperationSettings() Returns the object with the settings used for calls to addRule.
com.google.api.gax.rpc.UnaryCallSettings<AddRuleSecurityPolicyRequest,Operation>	addRuleSettings() Returns the object with the settings used for calls to addRule.
com.google.api.gax.rpc.PagedCallSettings<AggregatedListSecurityPoliciesRequest,SecurityPoliciesAggregatedList,SecurityPoliciesClient.AggregatedListPagedResponse>	aggregatedListSettings() Returns the object with the settings used for calls to aggregatedList.
static SecurityPoliciesSettings	create(SecurityPoliciesStubSettings stub)
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteSecurityPolicyRequest,Operation,Operation>	deleteOperationSettings() Returns the object with the settings used for calls to delete.
com.google.api.gax.rpc.UnaryCallSettings<DeleteSecurityPolicyRequest,Operation>	deleteSettings() Returns the object with the settings used for calls to delete.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetRuleSecurityPolicyRequest,SecurityPolicyRule>	getRuleSettings() Returns the object with the settings used for calls to getRule.
com.google.api.gax.rpc.UnaryCallSettings<GetSecurityPolicyRequest,SecurityPolicy>	getSettings() Returns the object with the settings used for calls to get.
com.google.api.gax.rpc.OperationCallSettings<InsertSecurityPolicyRequest,Operation,Operation>	insertOperationSettings() Returns the object with the settings used for calls to insert.
com.google.api.gax.rpc.UnaryCallSettings<InsertSecurityPolicyRequest,Operation>	insertSettings() Returns the object with the settings used for calls to insert.
com.google.api.gax.rpc.UnaryCallSettings<ListPreconfiguredExpressionSetsSecurityPoliciesRequest,SecurityPoliciesListPreconfiguredExpressionSetsResponse>	listPreconfiguredExpressionSetsSettings() Returns the object with the settings used for calls to listPreconfiguredExpressionSets.
com.google.api.gax.rpc.PagedCallSettings<ListSecurityPoliciesRequest,SecurityPolicyList,SecurityPoliciesClient.ListPagedResponse>	listSettings() Returns the object with the settings used for calls to list.
static SecurityPoliciesSettings.Builder	newBuilder() Returns a new builder for this class.
static SecurityPoliciesSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.OperationCallSettings<PatchSecurityPolicyRequest,Operation,Operation>	patchOperationSettings() Returns the object with the settings used for calls to patch.
com.google.api.gax.rpc.OperationCallSettings<PatchRuleSecurityPolicyRequest,Operation,Operation>	patchRuleOperationSettings() Returns the object with the settings used for calls to patchRule.
com.google.api.gax.rpc.UnaryCallSettings<PatchRuleSecurityPolicyRequest,Operation>	patchRuleSettings() Returns the object with the settings used for calls to patchRule.
com.google.api.gax.rpc.UnaryCallSettings<PatchSecurityPolicyRequest,Operation>	patchSettings() Returns the object with the settings used for calls to patch.
com.google.api.gax.rpc.OperationCallSettings<RemoveRuleSecurityPolicyRequest,Operation,Operation>	removeRuleOperationSettings() Returns the object with the settings used for calls to removeRule.
com.google.api.gax.rpc.UnaryCallSettings<RemoveRuleSecurityPolicyRequest,Operation>	removeRuleSettings() Returns the object with the settings used for calls to removeRule.
com.google.api.gax.rpc.OperationCallSettings<SetLabelsSecurityPolicyRequest,Operation,Operation>	setLabelsOperationSettings() Returns the object with the settings used for calls to setLabels.
com.google.api.gax.rpc.UnaryCallSettings<SetLabelsSecurityPolicyRequest,Operation>	setLabelsSettings() Returns the object with the settings used for calls to setLabels.
SecurityPoliciesSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurityPoliciesSettings

protected SecurityPoliciesSettings(SecurityPoliciesSettings.Builder settingsBuilder)
                            throws IOException

Throws:

IOException

Method Detail

addRuleSettings

public com.google.api.gax.rpc.UnaryCallSettings<AddRuleSecurityPolicyRequest,Operation> addRuleSettings()

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

addRuleOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<AddRuleSecurityPolicyRequest,Operation,Operation> addRuleOperationSettings()

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

aggregatedListSettings

public com.google.api.gax.rpc.PagedCallSettings<AggregatedListSecurityPoliciesRequest,SecurityPoliciesAggregatedList,SecurityPoliciesClient.AggregatedListPagedResponse> aggregatedListSettings()

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

deleteSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteSecurityPolicyRequest,Operation> deleteSettings()

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

deleteOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteSecurityPolicyRequest,Operation,Operation> deleteOperationSettings()

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

getSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetSecurityPolicyRequest,SecurityPolicy> getSettings()

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

getRuleSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetRuleSecurityPolicyRequest,SecurityPolicyRule> getRuleSettings()

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

insertSettings

public com.google.api.gax.rpc.UnaryCallSettings<InsertSecurityPolicyRequest,Operation> insertSettings()

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

insertOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<InsertSecurityPolicyRequest,Operation,Operation> insertOperationSettings()

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

listSettings

public com.google.api.gax.rpc.PagedCallSettings<ListSecurityPoliciesRequest,SecurityPolicyList,SecurityPoliciesClient.ListPagedResponse> listSettings()

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

listPreconfiguredExpressionSetsSettings

public com.google.api.gax.rpc.UnaryCallSettings<ListPreconfiguredExpressionSetsSecurityPoliciesRequest,SecurityPoliciesListPreconfiguredExpressionSetsResponse> listPreconfiguredExpressionSetsSettings()

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

patchSettings

public com.google.api.gax.rpc.UnaryCallSettings<PatchSecurityPolicyRequest,Operation> patchSettings()

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

patchOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<PatchSecurityPolicyRequest,Operation,Operation> patchOperationSettings()

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

patchRuleSettings

public com.google.api.gax.rpc.UnaryCallSettings<PatchRuleSecurityPolicyRequest,Operation> patchRuleSettings()

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

patchRuleOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<PatchRuleSecurityPolicyRequest,Operation,Operation> patchRuleOperationSettings()

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

removeRuleSettings

public com.google.api.gax.rpc.UnaryCallSettings<RemoveRuleSecurityPolicyRequest,Operation> removeRuleSettings()

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

removeRuleOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RemoveRuleSecurityPolicyRequest,Operation,Operation> removeRuleOperationSettings()

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

setLabelsSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetLabelsSecurityPolicyRequest,Operation> setLabelsSettings()

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

setLabelsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SetLabelsSecurityPolicyRequest,Operation,Operation> setLabelsOperationSettings()

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

create

public static final SecurityPoliciesSettings create(SecurityPoliciesStubSettings stub)
                                             throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static SecurityPoliciesSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static SecurityPoliciesSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public SecurityPoliciesSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<SecurityPoliciesSettings>