Class PoliciesSettings (1.51.0)

Version latest

• 1.51.0 (latest)
• 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.35.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.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.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public class PoliciesSettings extends ClientSettings<PoliciesSettings>

Settings class to configure an instance of PoliciesClient.

The default instance has everything set to sensible defaults:

• The default service address (iam.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 getPolicy:

 // 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
 PoliciesSettings.Builder policiesSettingsBuilder = PoliciesSettings.newBuilder();
 policiesSettingsBuilder
     .getPolicySettings()
     .setRetrySettings(
         policiesSettingsBuilder
             .getPolicySettings()
             .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());
 PoliciesSettings policiesSettings = policiesSettingsBuilder.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 createPolicy:

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

Inheritance

java.lang.Object > ClientSettings > PoliciesSettings

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

public static final PoliciesSettings create(PoliciesStubSettings stub)

Parameter
Name	Description
stub	PoliciesStubSettings

Returns
Type	Description
PoliciesSettings

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 gRPC ChannelProvider for this service.

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a builder for the default REST 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 PoliciesSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
PoliciesSettings.Builder

newBuilder(ClientContext clientContext)

public static PoliciesSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
PoliciesSettings.Builder

newHttpJsonBuilder()

public static PoliciesSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
PoliciesSettings.Builder

Constructors

PoliciesSettings(PoliciesSettings.Builder settingsBuilder)

protected PoliciesSettings(PoliciesSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	PoliciesSettings.Builder

Methods

createPolicyOperationSettings()

public OperationCallSettings<CreatePolicyRequest,Policy,PolicyOperationMetadata> createPolicyOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreatePolicyRequest,Policy,PolicyOperationMetadata>

createPolicySettings()

public UnaryCallSettings<CreatePolicyRequest,Operation> createPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<CreatePolicyRequest,Operation>

deletePolicyOperationSettings()

public OperationCallSettings<DeletePolicyRequest,Policy,PolicyOperationMetadata> deletePolicyOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeletePolicyRequest,Policy,PolicyOperationMetadata>

deletePolicySettings()

public UnaryCallSettings<DeletePolicyRequest,Operation> deletePolicySettings()

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

Returns
Type	Description
UnaryCallSettings<DeletePolicyRequest,Operation>

getPolicySettings()

public UnaryCallSettings<GetPolicyRequest,Policy> getPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<GetPolicyRequest,Policy>

listPoliciesSettings()

public PagedCallSettings<ListPoliciesRequest,ListPoliciesResponse,PoliciesClient.ListPoliciesPagedResponse> listPoliciesSettings()

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

Returns
Type	Description
PagedCallSettings<ListPoliciesRequest,ListPoliciesResponse,ListPoliciesPagedResponse>

toBuilder()

public PoliciesSettings.Builder toBuilder()

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

Returns
Type	Description
PoliciesSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updatePolicyOperationSettings()

public OperationCallSettings<UpdatePolicyRequest,Policy,PolicyOperationMetadata> updatePolicyOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdatePolicyRequest,Policy,PolicyOperationMetadata>

updatePolicySettings()

public UnaryCallSettings<UpdatePolicyRequest,Operation> updatePolicySettings()

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

Returns
Type	Description
UnaryCallSettings<UpdatePolicyRequest,Operation>