public class AccessPoliciesStubSettings extends StubSettings<AccessPoliciesStubSettings>Settings class to configure an instance of AccessPoliciesStub.
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 getAccessPolicy:
// 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
AccessPoliciesStubSettings.Builder accessPoliciesSettingsBuilder =
AccessPoliciesStubSettings.newBuilder();
accessPoliciesSettingsBuilder
.getAccessPolicySettings()
.setRetrySettings(
accessPoliciesSettingsBuilder
.getAccessPolicySettings()
.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());
AccessPoliciesStubSettings accessPoliciesSettings = accessPoliciesSettingsBuilder.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 createAccessPolicy:
// 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
AccessPoliciesStubSettings.Builder accessPoliciesSettingsBuilder =
AccessPoliciesStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
accessPoliciesSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
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 |
|
defaultGrpcApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()| 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 |
|
defaultHttpJsonApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()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 |
|
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()Returns the default mTLS 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 AccessPoliciesStubSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
AccessPoliciesStubSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static AccessPoliciesStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
AccessPoliciesStubSettings.Builder |
|
newHttpJsonBuilder()
public static AccessPoliciesStubSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
AccessPoliciesStubSettings.Builder |
|
Constructors
AccessPoliciesStubSettings(AccessPoliciesStubSettings.Builder settingsBuilder)
protected AccessPoliciesStubSettings(AccessPoliciesStubSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
AccessPoliciesStubSettings.Builder |
Methods
createAccessPolicyOperationSettings()
public OperationCallSettings<CreateAccessPolicyRequest,AccessPolicy,OperationMetadata> createAccessPolicyOperationSettings()Returns the object with the settings used for calls to createAccessPolicy.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateAccessPolicyRequest,AccessPolicy,OperationMetadata> |
|
createAccessPolicySettings()
public UnaryCallSettings<CreateAccessPolicyRequest,Operation> createAccessPolicySettings()Returns the object with the settings used for calls to createAccessPolicy.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateAccessPolicyRequest,Operation> |
|
createStub()
public AccessPoliciesStub createStub()| Returns | |
|---|---|
| Type | Description |
AccessPoliciesStub |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
deleteAccessPolicyOperationSettings()
public OperationCallSettings<DeleteAccessPolicyRequest,Empty,OperationMetadata> deleteAccessPolicyOperationSettings()Returns the object with the settings used for calls to deleteAccessPolicy.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteAccessPolicyRequest,Empty,OperationMetadata> |
|
deleteAccessPolicySettings()
public UnaryCallSettings<DeleteAccessPolicyRequest,Operation> deleteAccessPolicySettings()Returns the object with the settings used for calls to deleteAccessPolicy.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteAccessPolicyRequest,Operation> |
|
getAccessPolicySettings()
public UnaryCallSettings<GetAccessPolicyRequest,AccessPolicy> getAccessPolicySettings()Returns the object with the settings used for calls to getAccessPolicy.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetAccessPolicyRequest,AccessPolicy> |
|
getLibraryMetadata()
protected LibraryMetadata getLibraryMetadata()| Returns | |
|---|---|
| Type | Description |
LibraryMetadata |
|
getServiceName()
public String getServiceName()Returns the default service name.
| Returns | |
|---|---|
| Type | Description |
String |
|
listAccessPoliciesSettings()
public PagedCallSettings<ListAccessPoliciesRequest,ListAccessPoliciesResponse,AccessPoliciesClient.ListAccessPoliciesPagedResponse> listAccessPoliciesSettings()Returns the object with the settings used for calls to listAccessPolicies.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListAccessPoliciesRequest,ListAccessPoliciesResponse,ListAccessPoliciesPagedResponse> |
|
searchAccessPolicyBindingsSettings()
public PagedCallSettings<SearchAccessPolicyBindingsRequest,SearchAccessPolicyBindingsResponse,AccessPoliciesClient.SearchAccessPolicyBindingsPagedResponse> searchAccessPolicyBindingsSettings()Returns the object with the settings used for calls to searchAccessPolicyBindings.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<SearchAccessPolicyBindingsRequest,SearchAccessPolicyBindingsResponse,SearchAccessPolicyBindingsPagedResponse> |
|
toBuilder()
public AccessPoliciesStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
AccessPoliciesStubSettings.Builder |
|
updateAccessPolicyOperationSettings()
public OperationCallSettings<UpdateAccessPolicyRequest,AccessPolicy,OperationMetadata> updateAccessPolicyOperationSettings()Returns the object with the settings used for calls to updateAccessPolicy.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateAccessPolicyRequest,AccessPolicy,OperationMetadata> |
|
updateAccessPolicySettings()
public UnaryCallSettings<UpdateAccessPolicyRequest,Operation> updateAccessPolicySettings()Returns the object with the settings used for calls to updateAccessPolicy.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateAccessPolicyRequest,Operation> |
|