com.google.iam.v3

Class PolicyBindingsSettings

java.lang.Object

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

com.google.iam.v3.PolicyBindingsSettings

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

Settings class to configure an instance of PolicyBindingsClient.

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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getPolicyBinding:

 // 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
 PolicyBindingsSettings.Builder policyBindingsSettingsBuilder =
     PolicyBindingsSettings.newBuilder();
 policyBindingsSettingsBuilder
     .getPolicyBindingSettings()
     .setRetrySettings(
         policyBindingsSettingsBuilder
             .getPolicyBindingSettings()
             .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());
 PolicyBindingsSettings policyBindingsSettings = policyBindingsSettingsBuilder.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 createPolicyBinding:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static PolicyBindingsSettings	create(PolicyBindingsStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v3.CreatePolicyBindingRequest,com.google.iam.v3.PolicyBinding,com.google.iam.v3.OperationMetadata>	createPolicyBindingOperationSettings() Returns the object with the settings used for calls to createPolicyBinding.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v3.CreatePolicyBindingRequest,com.google.longrunning.Operation>	createPolicyBindingSettings() Returns the object with the settings used for calls to createPolicyBinding.
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.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v3.DeletePolicyBindingRequest,com.google.protobuf.Empty,com.google.iam.v3.OperationMetadata>	deletePolicyBindingOperationSettings() Returns the object with the settings used for calls to deletePolicyBinding.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v3.DeletePolicyBindingRequest,com.google.longrunning.Operation>	deletePolicyBindingSettings() Returns the object with the settings used for calls to deletePolicyBinding.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v3.GetPolicyBindingRequest,com.google.iam.v3.PolicyBinding>	getPolicyBindingSettings() Returns the object with the settings used for calls to getPolicyBinding.
com.google.api.gax.rpc.PagedCallSettings<com.google.iam.v3.ListPolicyBindingsRequest,com.google.iam.v3.ListPolicyBindingsResponse,PolicyBindingsClient.ListPolicyBindingsPagedResponse>	listPolicyBindingsSettings() Returns the object with the settings used for calls to listPolicyBindings.
static PolicyBindingsSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static PolicyBindingsSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static PolicyBindingsSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.PagedCallSettings<com.google.iam.v3.SearchTargetPolicyBindingsRequest,com.google.iam.v3.SearchTargetPolicyBindingsResponse,PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse>	searchTargetPolicyBindingsSettings() Returns the object with the settings used for calls to searchTargetPolicyBindings.
PolicyBindingsSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v3.UpdatePolicyBindingRequest,com.google.iam.v3.PolicyBinding,com.google.iam.v3.OperationMetadata>	updatePolicyBindingOperationSettings() Returns the object with the settings used for calls to updatePolicyBinding.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v3.UpdatePolicyBindingRequest,com.google.longrunning.Operation>	updatePolicyBindingSettings() Returns the object with the settings used for calls to updatePolicyBinding.

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

PolicyBindingsSettings

protected PolicyBindingsSettings(PolicyBindingsSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

createPolicyBindingSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v3.CreatePolicyBindingRequest,com.google.longrunning.Operation> createPolicyBindingSettings()

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

createPolicyBindingOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v3.CreatePolicyBindingRequest,com.google.iam.v3.PolicyBinding,com.google.iam.v3.OperationMetadata> createPolicyBindingOperationSettings()

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

getPolicyBindingSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v3.GetPolicyBindingRequest,com.google.iam.v3.PolicyBinding> getPolicyBindingSettings()

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

updatePolicyBindingSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v3.UpdatePolicyBindingRequest,com.google.longrunning.Operation> updatePolicyBindingSettings()

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

updatePolicyBindingOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v3.UpdatePolicyBindingRequest,com.google.iam.v3.PolicyBinding,com.google.iam.v3.OperationMetadata> updatePolicyBindingOperationSettings()

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

deletePolicyBindingSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v3.DeletePolicyBindingRequest,com.google.longrunning.Operation> deletePolicyBindingSettings()

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

deletePolicyBindingOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v3.DeletePolicyBindingRequest,com.google.protobuf.Empty,com.google.iam.v3.OperationMetadata> deletePolicyBindingOperationSettings()

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

listPolicyBindingsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.iam.v3.ListPolicyBindingsRequest,com.google.iam.v3.ListPolicyBindingsResponse,PolicyBindingsClient.ListPolicyBindingsPagedResponse> listPolicyBindingsSettings()

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

searchTargetPolicyBindingsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.iam.v3.SearchTargetPolicyBindingsRequest,com.google.iam.v3.SearchTargetPolicyBindingsResponse,PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse> searchTargetPolicyBindingsSettings()

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

create

public static final PolicyBindingsSettings create(PolicyBindingsStubSettings 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.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

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

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

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static PolicyBindingsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public PolicyBindingsSettings.Builder toBuilder()

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

Specified by:

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