Class CertificateAuthorityServiceSettings (2.57.0) 

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 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 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();

Inheritance

java.lang.Object > ClientSettings > CertificateAuthorityServiceSettings

Static Methods

create(CertificateAuthorityServiceStubSettings stub)

public static final CertificateAuthorityServiceSettings create(CertificateAuthorityServiceStubSettings stub)
Parameter
Name Description
stub CertificateAuthorityServiceStubSettings
Returns
Type Description
CertificateAuthorityServiceSettings
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()

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 CertificateAuthorityServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
CertificateAuthorityServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static CertificateAuthorityServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
CertificateAuthorityServiceSettings.Builder

newHttpJsonBuilder()

public static CertificateAuthorityServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
CertificateAuthorityServiceSettings.Builder

Constructors

CertificateAuthorityServiceSettings(CertificateAuthorityServiceSettings.Builder settingsBuilder)

protected CertificateAuthorityServiceSettings(CertificateAuthorityServiceSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder CertificateAuthorityServiceSettings.Builder

Methods

activateCertificateAuthorityOperationSettings()

public OperationCallSettings<ActivateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> activateCertificateAuthorityOperationSettings()

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

Returns
Type Description
OperationCallSettings<ActivateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

activateCertificateAuthoritySettings()

public UnaryCallSettings<ActivateCertificateAuthorityRequest,Operation> activateCertificateAuthoritySettings()

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

Returns
Type Description
UnaryCallSettings<ActivateCertificateAuthorityRequest,Operation>

createCaPoolOperationSettings()

public OperationCallSettings<CreateCaPoolRequest,CaPool,OperationMetadata> createCaPoolOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateCaPoolRequest,CaPool,OperationMetadata>

createCaPoolSettings()

public UnaryCallSettings<CreateCaPoolRequest,Operation> createCaPoolSettings()

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

Returns
Type Description
UnaryCallSettings<CreateCaPoolRequest,Operation>

createCertificateAuthorityOperationSettings()

public OperationCallSettings<CreateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> createCertificateAuthorityOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

createCertificateAuthoritySettings()

public UnaryCallSettings<CreateCertificateAuthorityRequest,Operation> createCertificateAuthoritySettings()

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

Returns
Type Description
UnaryCallSettings<CreateCertificateAuthorityRequest,Operation>

createCertificateSettings()

public UnaryCallSettings<CreateCertificateRequest,Certificate> createCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<CreateCertificateRequest,Certificate>

createCertificateTemplateOperationSettings()

public OperationCallSettings<CreateCertificateTemplateRequest,CertificateTemplate,OperationMetadata> createCertificateTemplateOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateCertificateTemplateRequest,CertificateTemplate,OperationMetadata>

createCertificateTemplateSettings()

public UnaryCallSettings<CreateCertificateTemplateRequest,Operation> createCertificateTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<CreateCertificateTemplateRequest,Operation>

deleteCaPoolOperationSettings()

public OperationCallSettings<DeleteCaPoolRequest,Empty,OperationMetadata> deleteCaPoolOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteCaPoolRequest,Empty,OperationMetadata>

deleteCaPoolSettings()

public UnaryCallSettings<DeleteCaPoolRequest,Operation> deleteCaPoolSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteCaPoolRequest,Operation>

deleteCertificateAuthorityOperationSettings()

public OperationCallSettings<DeleteCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> deleteCertificateAuthorityOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

deleteCertificateAuthoritySettings()

public UnaryCallSettings<DeleteCertificateAuthorityRequest,Operation> deleteCertificateAuthoritySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteCertificateAuthorityRequest,Operation>

deleteCertificateTemplateOperationSettings()

public OperationCallSettings<DeleteCertificateTemplateRequest,Empty,OperationMetadata> deleteCertificateTemplateOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteCertificateTemplateRequest,Empty,OperationMetadata>

deleteCertificateTemplateSettings()

public UnaryCallSettings<DeleteCertificateTemplateRequest,Operation> deleteCertificateTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteCertificateTemplateRequest,Operation>

disableCertificateAuthorityOperationSettings()

public OperationCallSettings<DisableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> disableCertificateAuthorityOperationSettings()

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

Returns
Type Description
OperationCallSettings<DisableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

disableCertificateAuthoritySettings()

public UnaryCallSettings<DisableCertificateAuthorityRequest,Operation> disableCertificateAuthoritySettings()

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

Returns
Type Description
UnaryCallSettings<DisableCertificateAuthorityRequest,Operation>

enableCertificateAuthorityOperationSettings()

public OperationCallSettings<EnableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> enableCertificateAuthorityOperationSettings()

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

Returns
Type Description
OperationCallSettings<EnableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

enableCertificateAuthoritySettings()

public UnaryCallSettings<EnableCertificateAuthorityRequest,Operation> enableCertificateAuthoritySettings()

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

Returns
Type Description
UnaryCallSettings<EnableCertificateAuthorityRequest,Operation>

fetchCaCertsSettings()

public UnaryCallSettings<FetchCaCertsRequest,FetchCaCertsResponse> fetchCaCertsSettings()

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

Returns
Type Description
UnaryCallSettings<FetchCaCertsRequest,FetchCaCertsResponse>

fetchCertificateAuthorityCsrSettings()

public UnaryCallSettings<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse> fetchCertificateAuthorityCsrSettings()

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

Returns
Type Description
UnaryCallSettings<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse>

getCaPoolSettings()

public UnaryCallSettings<GetCaPoolRequest,CaPool> getCaPoolSettings()

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

Returns
Type Description
UnaryCallSettings<GetCaPoolRequest,CaPool>

getCertificateAuthoritySettings()

public UnaryCallSettings<GetCertificateAuthorityRequest,CertificateAuthority> getCertificateAuthoritySettings()

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

Returns
Type Description
UnaryCallSettings<GetCertificateAuthorityRequest,CertificateAuthority>

getCertificateRevocationListSettings()

public UnaryCallSettings<GetCertificateRevocationListRequest,CertificateRevocationList> getCertificateRevocationListSettings()

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

Returns
Type Description
UnaryCallSettings<GetCertificateRevocationListRequest,CertificateRevocationList>

getCertificateSettings()

public UnaryCallSettings<GetCertificateRequest,Certificate> getCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<GetCertificateRequest,Certificate>

getCertificateTemplateSettings()

public UnaryCallSettings<GetCertificateTemplateRequest,CertificateTemplate> getCertificateTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<GetCertificateTemplateRequest,CertificateTemplate>

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>

listCaPoolsSettings()

public PagedCallSettings<ListCaPoolsRequest,ListCaPoolsResponse,CertificateAuthorityServiceClient.ListCaPoolsPagedResponse> listCaPoolsSettings()

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

Returns
Type Description
PagedCallSettings<ListCaPoolsRequest,ListCaPoolsResponse,ListCaPoolsPagedResponse>

listCertificateAuthoritiesSettings()

public PagedCallSettings<ListCertificateAuthoritiesRequest,ListCertificateAuthoritiesResponse,CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse> listCertificateAuthoritiesSettings()

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

Returns
Type Description
PagedCallSettings<ListCertificateAuthoritiesRequest,ListCertificateAuthoritiesResponse,ListCertificateAuthoritiesPagedResponse>

listCertificateRevocationListsSettings()

public PagedCallSettings<ListCertificateRevocationListsRequest,ListCertificateRevocationListsResponse,CertificateAuthorityServiceClient.ListCertificateRevocationListsPagedResponse> listCertificateRevocationListsSettings()

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

Returns
Type Description
PagedCallSettings<ListCertificateRevocationListsRequest,ListCertificateRevocationListsResponse,ListCertificateRevocationListsPagedResponse>

listCertificateTemplatesSettings()

public PagedCallSettings<ListCertificateTemplatesRequest,ListCertificateTemplatesResponse,CertificateAuthorityServiceClient.ListCertificateTemplatesPagedResponse> listCertificateTemplatesSettings()

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

Returns
Type Description
PagedCallSettings<ListCertificateTemplatesRequest,ListCertificateTemplatesResponse,ListCertificateTemplatesPagedResponse>

listCertificatesSettings()

public PagedCallSettings<ListCertificatesRequest,ListCertificatesResponse,CertificateAuthorityServiceClient.ListCertificatesPagedResponse> listCertificatesSettings()

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

Returns
Type Description
PagedCallSettings<ListCertificatesRequest,ListCertificatesResponse,ListCertificatesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,CertificateAuthorityServiceClient.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>

revokeCertificateSettings()

public UnaryCallSettings<RevokeCertificateRequest,Certificate> revokeCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<RevokeCertificateRequest,Certificate>

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 CertificateAuthorityServiceSettings.Builder toBuilder()

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

Returns
Type Description
CertificateAuthorityServiceSettings.Builder
Overrides

undeleteCertificateAuthorityOperationSettings()

public OperationCallSettings<UndeleteCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> undeleteCertificateAuthorityOperationSettings()

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

Returns
Type Description
OperationCallSettings<UndeleteCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

undeleteCertificateAuthoritySettings()

public UnaryCallSettings<UndeleteCertificateAuthorityRequest,Operation> undeleteCertificateAuthoritySettings()

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

Returns
Type Description
UnaryCallSettings<UndeleteCertificateAuthorityRequest,Operation>

updateCaPoolOperationSettings()

public OperationCallSettings<UpdateCaPoolRequest,CaPool,OperationMetadata> updateCaPoolOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateCaPoolRequest,CaPool,OperationMetadata>

updateCaPoolSettings()

public UnaryCallSettings<UpdateCaPoolRequest,Operation> updateCaPoolSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateCaPoolRequest,Operation>

updateCertificateAuthorityOperationSettings()

public OperationCallSettings<UpdateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> updateCertificateAuthorityOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

updateCertificateAuthoritySettings()

public UnaryCallSettings<UpdateCertificateAuthorityRequest,Operation> updateCertificateAuthoritySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateCertificateAuthorityRequest,Operation>

updateCertificateRevocationListOperationSettings()

public OperationCallSettings<UpdateCertificateRevocationListRequest,CertificateRevocationList,OperationMetadata> updateCertificateRevocationListOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateCertificateRevocationListRequest,CertificateRevocationList,OperationMetadata>

updateCertificateRevocationListSettings()

public UnaryCallSettings<UpdateCertificateRevocationListRequest,Operation> updateCertificateRevocationListSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateCertificateRevocationListRequest,Operation>

updateCertificateSettings()

public UnaryCallSettings<UpdateCertificateRequest,Certificate> updateCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateCertificateRequest,Certificate>

updateCertificateTemplateOperationSettings()

public OperationCallSettings<UpdateCertificateTemplateRequest,CertificateTemplate,OperationMetadata> updateCertificateTemplateOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateCertificateTemplateRequest,CertificateTemplate,OperationMetadata>

updateCertificateTemplateSettings()

public UnaryCallSettings<UpdateCertificateTemplateRequest,Operation> updateCertificateTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateCertificateTemplateRequest,Operation>