Class CertificateAuthorityServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<CertificateAuthorityServiceSettings>
com.google.cloud.security.privateca.v1beta1.CertificateAuthorityServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class CertificateAuthorityServiceSettings
extends ClientSettings<CertificateAuthorityServiceSettings>
Settings class to configure an instance of
CertificateAuthorityServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (privateca.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 createCertificate:
// 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
CertificateAuthorityServiceSettings.Builder certificateAuthorityServiceSettingsBuilder =
CertificateAuthorityServiceSettings.newBuilder();
certificateAuthorityServiceSettingsBuilder
.createCertificateSettings()
.setRetrySettings(
certificateAuthorityServiceSettingsBuilder
.createCertificateSettings()
.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());
CertificateAuthorityServiceSettings certificateAuthorityServiceSettings =
certificateAuthorityServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 activateCertificateAuthority:
// 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
CertificateAuthorityServiceSettings.Builder certificateAuthorityServiceSettingsBuilder =
CertificateAuthorityServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
certificateAuthorityServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for CertificateAuthorityServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to activateCertificateAuthority.Returns the object with the settings used for calls to activateCertificateAuthority.static final CertificateAuthorityServiceSettingsReturns the object with the settings used for calls to createCertificateAuthority.Returns the object with the settings used for calls to createCertificateAuthority.Returns the object with the settings used for calls to createCertificate.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderReturns the object with the settings used for calls to disableCertificateAuthority.Returns the object with the settings used for calls to disableCertificateAuthority.Returns the object with the settings used for calls to enableCertificateAuthority.Returns the object with the settings used for calls to enableCertificateAuthority.Returns the object with the settings used for calls to fetchCertificateAuthorityCsr.Returns the object with the settings used for calls to getCertificateAuthority.Returns the object with the settings used for calls to getCertificateRevocationList.Returns the object with the settings used for calls to getCertificate.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getReusableConfig.PagedCallSettings<ListCertificateAuthoritiesRequest,ListCertificateAuthoritiesResponse, CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse> Returns the object with the settings used for calls to listCertificateAuthorities.PagedCallSettings<ListCertificateRevocationListsRequest,ListCertificateRevocationListsResponse, CertificateAuthorityServiceClient.ListCertificateRevocationListsPagedResponse> Returns the object with the settings used for calls to listCertificateRevocationLists.PagedCallSettings<ListCertificatesRequest,ListCertificatesResponse, CertificateAuthorityServiceClient.ListCertificatesPagedResponse> Returns the object with the settings used for calls to listCertificates.PagedCallSettings<ListReusableConfigsRequest,ListReusableConfigsResponse, CertificateAuthorityServiceClient.ListReusableConfigsPagedResponse> Returns the object with the settings used for calls to listReusableConfigs.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to restoreCertificateAuthority.Returns the object with the settings used for calls to restoreCertificateAuthority.Returns the object with the settings used for calls to revokeCertificate.OperationCallSettings<ScheduleDeleteCertificateAuthorityRequest,CertificateAuthority, OperationMetadata> Returns the object with the settings used for calls to scheduleDeleteCertificateAuthority.Returns the object with the settings used for calls to scheduleDeleteCertificateAuthority.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateCertificateAuthority.Returns the object with the settings used for calls to updateCertificateAuthority.OperationCallSettings<UpdateCertificateRevocationListRequest,CertificateRevocationList, OperationMetadata> Returns the object with the settings used for calls to updateCertificateRevocationList.Returns the object with the settings used for calls to updateCertificateRevocationList.Returns the object with the settings used for calls to updateCertificate.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
-
Constructor Details
-
CertificateAuthorityServiceSettings
protected CertificateAuthorityServiceSettings(CertificateAuthorityServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createCertificateSettings
Returns the object with the settings used for calls to createCertificate. -
getCertificateSettings
Returns the object with the settings used for calls to getCertificate. -
listCertificatesSettings
public PagedCallSettings<ListCertificatesRequest,ListCertificatesResponse, listCertificatesSettings()CertificateAuthorityServiceClient.ListCertificatesPagedResponse> Returns the object with the settings used for calls to listCertificates. -
revokeCertificateSettings
Returns the object with the settings used for calls to revokeCertificate. -
updateCertificateSettings
Returns the object with the settings used for calls to updateCertificate. -
activateCertificateAuthoritySettings
public UnaryCallSettings<ActivateCertificateAuthorityRequest,Operation> activateCertificateAuthoritySettings()Returns the object with the settings used for calls to activateCertificateAuthority. -
activateCertificateAuthorityOperationSettings
public OperationCallSettings<ActivateCertificateAuthorityRequest,CertificateAuthority, activateCertificateAuthorityOperationSettings()OperationMetadata> Returns the object with the settings used for calls to activateCertificateAuthority. -
createCertificateAuthoritySettings
public UnaryCallSettings<CreateCertificateAuthorityRequest,Operation> createCertificateAuthoritySettings()Returns the object with the settings used for calls to createCertificateAuthority. -
createCertificateAuthorityOperationSettings
public OperationCallSettings<CreateCertificateAuthorityRequest,CertificateAuthority, createCertificateAuthorityOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createCertificateAuthority. -
disableCertificateAuthoritySettings
public UnaryCallSettings<DisableCertificateAuthorityRequest,Operation> disableCertificateAuthoritySettings()Returns the object with the settings used for calls to disableCertificateAuthority. -
disableCertificateAuthorityOperationSettings
public OperationCallSettings<DisableCertificateAuthorityRequest,CertificateAuthority, disableCertificateAuthorityOperationSettings()OperationMetadata> Returns the object with the settings used for calls to disableCertificateAuthority. -
enableCertificateAuthoritySettings
public UnaryCallSettings<EnableCertificateAuthorityRequest,Operation> enableCertificateAuthoritySettings()Returns the object with the settings used for calls to enableCertificateAuthority. -
enableCertificateAuthorityOperationSettings
public OperationCallSettings<EnableCertificateAuthorityRequest,CertificateAuthority, enableCertificateAuthorityOperationSettings()OperationMetadata> Returns the object with the settings used for calls to enableCertificateAuthority. -
fetchCertificateAuthorityCsrSettings
public UnaryCallSettings<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse> fetchCertificateAuthorityCsrSettings()Returns the object with the settings used for calls to fetchCertificateAuthorityCsr. -
getCertificateAuthoritySettings
public UnaryCallSettings<GetCertificateAuthorityRequest,CertificateAuthority> getCertificateAuthoritySettings()Returns the object with the settings used for calls to getCertificateAuthority. -
listCertificateAuthoritiesSettings
public PagedCallSettings<ListCertificateAuthoritiesRequest,ListCertificateAuthoritiesResponse, listCertificateAuthoritiesSettings()CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse> Returns the object with the settings used for calls to listCertificateAuthorities. -
restoreCertificateAuthoritySettings
public UnaryCallSettings<RestoreCertificateAuthorityRequest,Operation> restoreCertificateAuthoritySettings()Returns the object with the settings used for calls to restoreCertificateAuthority. -
restoreCertificateAuthorityOperationSettings
public OperationCallSettings<RestoreCertificateAuthorityRequest,CertificateAuthority, restoreCertificateAuthorityOperationSettings()OperationMetadata> Returns the object with the settings used for calls to restoreCertificateAuthority. -
scheduleDeleteCertificateAuthoritySettings
public UnaryCallSettings<ScheduleDeleteCertificateAuthorityRequest,Operation> scheduleDeleteCertificateAuthoritySettings()Returns the object with the settings used for calls to scheduleDeleteCertificateAuthority. -
scheduleDeleteCertificateAuthorityOperationSettings
public OperationCallSettings<ScheduleDeleteCertificateAuthorityRequest,CertificateAuthority, scheduleDeleteCertificateAuthorityOperationSettings()OperationMetadata> Returns the object with the settings used for calls to scheduleDeleteCertificateAuthority. -
updateCertificateAuthoritySettings
public UnaryCallSettings<UpdateCertificateAuthorityRequest,Operation> updateCertificateAuthoritySettings()Returns the object with the settings used for calls to updateCertificateAuthority. -
updateCertificateAuthorityOperationSettings
public OperationCallSettings<UpdateCertificateAuthorityRequest,CertificateAuthority, updateCertificateAuthorityOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateCertificateAuthority. -
getCertificateRevocationListSettings
public UnaryCallSettings<GetCertificateRevocationListRequest,CertificateRevocationList> getCertificateRevocationListSettings()Returns the object with the settings used for calls to getCertificateRevocationList. -
listCertificateRevocationListsSettings
public PagedCallSettings<ListCertificateRevocationListsRequest,ListCertificateRevocationListsResponse, listCertificateRevocationListsSettings()CertificateAuthorityServiceClient.ListCertificateRevocationListsPagedResponse> Returns the object with the settings used for calls to listCertificateRevocationLists. -
updateCertificateRevocationListSettings
public UnaryCallSettings<UpdateCertificateRevocationListRequest,Operation> updateCertificateRevocationListSettings()Returns the object with the settings used for calls to updateCertificateRevocationList. -
updateCertificateRevocationListOperationSettings
public OperationCallSettings<UpdateCertificateRevocationListRequest,CertificateRevocationList, updateCertificateRevocationListOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateCertificateRevocationList. -
getReusableConfigSettings
Returns the object with the settings used for calls to getReusableConfig. -
listReusableConfigsSettings
public PagedCallSettings<ListReusableConfigsRequest,ListReusableConfigsResponse, listReusableConfigsSettings()CertificateAuthorityServiceClient.ListReusableConfigsPagedResponse> Returns the object with the settings used for calls to listReusableConfigs. -
create
public static final CertificateAuthorityServiceSettings create(CertificateAuthorityServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<CertificateAuthorityServiceSettings>
-