public class SSERealmServiceSettings extends ClientSettings<SSERealmServiceSettings>Settings class to configure an instance of SSERealmServiceClient.
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 getSACRealm:
// 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
SSERealmServiceSettings.Builder sSERealmServiceSettingsBuilder =
SSERealmServiceSettings.newBuilder();
sSERealmServiceSettingsBuilder
.getSACRealmSettings()
.setRetrySettings(
sSERealmServiceSettingsBuilder
.getSACRealmSettings()
.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());
SSERealmServiceSettings sSERealmServiceSettings = sSERealmServiceSettingsBuilder.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 createSACRealm:
// 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
SSERealmServiceSettings.Builder sSERealmServiceSettingsBuilder =
SSERealmServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
sSERealmServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(SSERealmServiceStubSettings stub)
public static final SSERealmServiceSettings create(SSERealmServiceStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
SSERealmServiceStubSettings |
| Returns | |
|---|---|
| Type | Description |
SSERealmServiceSettings |
|
| 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 SSERealmServiceSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
SSERealmServiceSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static SSERealmServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
SSERealmServiceSettings.Builder |
|
Constructors
SSERealmServiceSettings(SSERealmServiceSettings.Builder settingsBuilder)
protected SSERealmServiceSettings(SSERealmServiceSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
SSERealmServiceSettings.Builder |
Methods
createSACAttachmentOperationSettings()
public OperationCallSettings<CreateSACAttachmentRequest,SACAttachment,OperationMetadata> createSACAttachmentOperationSettings()Returns the object with the settings used for calls to createSACAttachment.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateSACAttachmentRequest,SACAttachment,OperationMetadata> |
|
createSACAttachmentSettings()
public UnaryCallSettings<CreateSACAttachmentRequest,Operation> createSACAttachmentSettings()Returns the object with the settings used for calls to createSACAttachment.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSACAttachmentRequest,Operation> |
|
createSACRealmOperationSettings()
public OperationCallSettings<CreateSACRealmRequest,SACRealm,OperationMetadata> createSACRealmOperationSettings()Returns the object with the settings used for calls to createSACRealm.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateSACRealmRequest,SACRealm,OperationMetadata> |
|
createSACRealmSettings()
public UnaryCallSettings<CreateSACRealmRequest,Operation> createSACRealmSettings()Returns the object with the settings used for calls to createSACRealm.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSACRealmRequest,Operation> |
|
deleteSACAttachmentOperationSettings()
public OperationCallSettings<DeleteSACAttachmentRequest,Empty,OperationMetadata> deleteSACAttachmentOperationSettings()Returns the object with the settings used for calls to deleteSACAttachment.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteSACAttachmentRequest,Empty,OperationMetadata> |
|
deleteSACAttachmentSettings()
public UnaryCallSettings<DeleteSACAttachmentRequest,Operation> deleteSACAttachmentSettings()Returns the object with the settings used for calls to deleteSACAttachment.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteSACAttachmentRequest,Operation> |
|
deleteSACRealmOperationSettings()
public OperationCallSettings<DeleteSACRealmRequest,Empty,OperationMetadata> deleteSACRealmOperationSettings()Returns the object with the settings used for calls to deleteSACRealm.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteSACRealmRequest,Empty,OperationMetadata> |
|
deleteSACRealmSettings()
public UnaryCallSettings<DeleteSACRealmRequest,Operation> deleteSACRealmSettings()Returns the object with the settings used for calls to deleteSACRealm.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteSACRealmRequest,Operation> |
|
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> |
|
getSACAttachmentSettings()
public UnaryCallSettings<GetSACAttachmentRequest,SACAttachment> getSACAttachmentSettings()Returns the object with the settings used for calls to getSACAttachment.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSACAttachmentRequest,SACAttachment> |
|
getSACRealmSettings()
public UnaryCallSettings<GetSACRealmRequest,SACRealm> getSACRealmSettings()Returns the object with the settings used for calls to getSACRealm.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSACRealmRequest,SACRealm> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,SSERealmServiceClient.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> |
|
listSACAttachmentsSettings()
public PagedCallSettings<ListSACAttachmentsRequest,ListSACAttachmentsResponse,SSERealmServiceClient.ListSACAttachmentsPagedResponse> listSACAttachmentsSettings()Returns the object with the settings used for calls to listSACAttachments.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSACAttachmentsRequest,ListSACAttachmentsResponse,ListSACAttachmentsPagedResponse> |
|
listSACRealmsSettings()
public PagedCallSettings<ListSACRealmsRequest,ListSACRealmsResponse,SSERealmServiceClient.ListSACRealmsPagedResponse> listSACRealmsSettings()Returns the object with the settings used for calls to listSACRealms.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSACRealmsRequest,ListSACRealmsResponse,ListSACRealmsPagedResponse> |
|
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 SSERealmServiceSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
SSERealmServiceSettings.Builder |
|