Class CertificateManagerSettings (0.56.0) 

public class CertificateManagerSettings extends ClientSettings<CertificateManagerSettings>

Settings class to configure an instance of CertificateManagerClient.

The default instance has everything set to sensible defaults:

  • The default service address (certificatemanager.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 getCertificate:


 // 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
 CertificateManagerSettings.Builder certificateManagerSettingsBuilder =
     CertificateManagerSettings.newBuilder();
 certificateManagerSettingsBuilder
     .getCertificateSettings()
     .setRetrySettings(
         certificateManagerSettingsBuilder
             .getCertificateSettings()
             .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());
 CertificateManagerSettings certificateManagerSettings =
     certificateManagerSettingsBuilder.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 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
 CertificateManagerSettings.Builder certificateManagerSettingsBuilder =
     CertificateManagerSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 certificateManagerSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > CertificateManagerSettings

Static Methods

create(CertificateManagerStubSettings stub)

public static final CertificateManagerSettings create(CertificateManagerStubSettings stub)
Parameter
Name Description
stub CertificateManagerStubSettings
Returns
Type Description
CertificateManagerSettings
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 CertificateManagerSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
CertificateManagerSettings.Builder

newBuilder(ClientContext clientContext)

public static CertificateManagerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
CertificateManagerSettings.Builder

newHttpJsonBuilder()

public static CertificateManagerSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
CertificateManagerSettings.Builder

Constructors

CertificateManagerSettings(CertificateManagerSettings.Builder settingsBuilder)

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

Methods

createCertificateIssuanceConfigOperationSettings()

public OperationCallSettings<CreateCertificateIssuanceConfigRequest,CertificateIssuanceConfig,OperationMetadata> createCertificateIssuanceConfigOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateCertificateIssuanceConfigRequest,CertificateIssuanceConfig,OperationMetadata>

createCertificateIssuanceConfigSettings()

public UnaryCallSettings<CreateCertificateIssuanceConfigRequest,Operation> createCertificateIssuanceConfigSettings()

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

Returns
Type Description
UnaryCallSettings<CreateCertificateIssuanceConfigRequest,Operation>

createCertificateMapEntryOperationSettings()

public OperationCallSettings<CreateCertificateMapEntryRequest,CertificateMapEntry,OperationMetadata> createCertificateMapEntryOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateCertificateMapEntryRequest,CertificateMapEntry,OperationMetadata>

createCertificateMapEntrySettings()

public UnaryCallSettings<CreateCertificateMapEntryRequest,Operation> createCertificateMapEntrySettings()

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

Returns
Type Description
UnaryCallSettings<CreateCertificateMapEntryRequest,Operation>

createCertificateMapOperationSettings()

public OperationCallSettings<CreateCertificateMapRequest,CertificateMap,OperationMetadata> createCertificateMapOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateCertificateMapRequest,CertificateMap,OperationMetadata>

createCertificateMapSettings()

public UnaryCallSettings<CreateCertificateMapRequest,Operation> createCertificateMapSettings()

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

Returns
Type Description
UnaryCallSettings<CreateCertificateMapRequest,Operation>

createCertificateOperationSettings()

public OperationCallSettings<CreateCertificateRequest,Certificate,OperationMetadata> createCertificateOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateCertificateRequest,Certificate,OperationMetadata>

createCertificateSettings()

public UnaryCallSettings<CreateCertificateRequest,Operation> createCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<CreateCertificateRequest,Operation>

createDnsAuthorizationOperationSettings()

public OperationCallSettings<CreateDnsAuthorizationRequest,DnsAuthorization,OperationMetadata> createDnsAuthorizationOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateDnsAuthorizationRequest,DnsAuthorization,OperationMetadata>

createDnsAuthorizationSettings()

public UnaryCallSettings<CreateDnsAuthorizationRequest,Operation> createDnsAuthorizationSettings()

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

Returns
Type Description
UnaryCallSettings<CreateDnsAuthorizationRequest,Operation>

createTrustConfigOperationSettings()

public OperationCallSettings<CreateTrustConfigRequest,TrustConfig,OperationMetadata> createTrustConfigOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateTrustConfigRequest,TrustConfig,OperationMetadata>

createTrustConfigSettings()

public UnaryCallSettings<CreateTrustConfigRequest,Operation> createTrustConfigSettings()

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

Returns
Type Description
UnaryCallSettings<CreateTrustConfigRequest,Operation>

deleteCertificateIssuanceConfigOperationSettings()

public OperationCallSettings<DeleteCertificateIssuanceConfigRequest,Empty,OperationMetadata> deleteCertificateIssuanceConfigOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteCertificateIssuanceConfigRequest,Empty,OperationMetadata>

deleteCertificateIssuanceConfigSettings()

public UnaryCallSettings<DeleteCertificateIssuanceConfigRequest,Operation> deleteCertificateIssuanceConfigSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteCertificateIssuanceConfigRequest,Operation>

deleteCertificateMapEntryOperationSettings()

public OperationCallSettings<DeleteCertificateMapEntryRequest,Empty,OperationMetadata> deleteCertificateMapEntryOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteCertificateMapEntryRequest,Empty,OperationMetadata>

deleteCertificateMapEntrySettings()

public UnaryCallSettings<DeleteCertificateMapEntryRequest,Operation> deleteCertificateMapEntrySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteCertificateMapEntryRequest,Operation>

deleteCertificateMapOperationSettings()

public OperationCallSettings<DeleteCertificateMapRequest,Empty,OperationMetadata> deleteCertificateMapOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteCertificateMapRequest,Empty,OperationMetadata>

deleteCertificateMapSettings()

public UnaryCallSettings<DeleteCertificateMapRequest,Operation> deleteCertificateMapSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteCertificateMapRequest,Operation>

deleteCertificateOperationSettings()

public OperationCallSettings<DeleteCertificateRequest,Empty,OperationMetadata> deleteCertificateOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteCertificateRequest,Empty,OperationMetadata>

deleteCertificateSettings()

public UnaryCallSettings<DeleteCertificateRequest,Operation> deleteCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteCertificateRequest,Operation>

deleteDnsAuthorizationOperationSettings()

public OperationCallSettings<DeleteDnsAuthorizationRequest,Empty,OperationMetadata> deleteDnsAuthorizationOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteDnsAuthorizationRequest,Empty,OperationMetadata>

deleteDnsAuthorizationSettings()

public UnaryCallSettings<DeleteDnsAuthorizationRequest,Operation> deleteDnsAuthorizationSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDnsAuthorizationRequest,Operation>

deleteTrustConfigOperationSettings()

public OperationCallSettings<DeleteTrustConfigRequest,Empty,OperationMetadata> deleteTrustConfigOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteTrustConfigRequest,Empty,OperationMetadata>

deleteTrustConfigSettings()

public UnaryCallSettings<DeleteTrustConfigRequest,Operation> deleteTrustConfigSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteTrustConfigRequest,Operation>

getCertificateIssuanceConfigSettings()

public UnaryCallSettings<GetCertificateIssuanceConfigRequest,CertificateIssuanceConfig> getCertificateIssuanceConfigSettings()

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

Returns
Type Description
UnaryCallSettings<GetCertificateIssuanceConfigRequest,CertificateIssuanceConfig>

getCertificateMapEntrySettings()

public UnaryCallSettings<GetCertificateMapEntryRequest,CertificateMapEntry> getCertificateMapEntrySettings()

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

Returns
Type Description
UnaryCallSettings<GetCertificateMapEntryRequest,CertificateMapEntry>

getCertificateMapSettings()

public UnaryCallSettings<GetCertificateMapRequest,CertificateMap> getCertificateMapSettings()

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

Returns
Type Description
UnaryCallSettings<GetCertificateMapRequest,CertificateMap>

getCertificateSettings()

public UnaryCallSettings<GetCertificateRequest,Certificate> getCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<GetCertificateRequest,Certificate>

getDnsAuthorizationSettings()

public UnaryCallSettings<GetDnsAuthorizationRequest,DnsAuthorization> getDnsAuthorizationSettings()

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

Returns
Type Description
UnaryCallSettings<GetDnsAuthorizationRequest,DnsAuthorization>

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>

getTrustConfigSettings()

public UnaryCallSettings<GetTrustConfigRequest,TrustConfig> getTrustConfigSettings()

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

Returns
Type Description
UnaryCallSettings<GetTrustConfigRequest,TrustConfig>

listCertificateIssuanceConfigsSettings()

public PagedCallSettings<ListCertificateIssuanceConfigsRequest,ListCertificateIssuanceConfigsResponse,CertificateManagerClient.ListCertificateIssuanceConfigsPagedResponse> listCertificateIssuanceConfigsSettings()

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

Returns
Type Description
PagedCallSettings<ListCertificateIssuanceConfigsRequest,ListCertificateIssuanceConfigsResponse,ListCertificateIssuanceConfigsPagedResponse>

listCertificateMapEntriesSettings()

public PagedCallSettings<ListCertificateMapEntriesRequest,ListCertificateMapEntriesResponse,CertificateManagerClient.ListCertificateMapEntriesPagedResponse> listCertificateMapEntriesSettings()

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

Returns
Type Description
PagedCallSettings<ListCertificateMapEntriesRequest,ListCertificateMapEntriesResponse,ListCertificateMapEntriesPagedResponse>

listCertificateMapsSettings()

public PagedCallSettings<ListCertificateMapsRequest,ListCertificateMapsResponse,CertificateManagerClient.ListCertificateMapsPagedResponse> listCertificateMapsSettings()

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

Returns
Type Description
PagedCallSettings<ListCertificateMapsRequest,ListCertificateMapsResponse,ListCertificateMapsPagedResponse>

listCertificatesSettings()

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

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

Returns
Type Description
PagedCallSettings<ListCertificatesRequest,ListCertificatesResponse,ListCertificatesPagedResponse>

listDnsAuthorizationsSettings()

public PagedCallSettings<ListDnsAuthorizationsRequest,ListDnsAuthorizationsResponse,CertificateManagerClient.ListDnsAuthorizationsPagedResponse> listDnsAuthorizationsSettings()

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

Returns
Type Description
PagedCallSettings<ListDnsAuthorizationsRequest,ListDnsAuthorizationsResponse,ListDnsAuthorizationsPagedResponse>

listLocationsSettings()

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

listTrustConfigsSettings()

public PagedCallSettings<ListTrustConfigsRequest,ListTrustConfigsResponse,CertificateManagerClient.ListTrustConfigsPagedResponse> listTrustConfigsSettings()

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

Returns
Type Description
PagedCallSettings<ListTrustConfigsRequest,ListTrustConfigsResponse,ListTrustConfigsPagedResponse>

toBuilder()

public CertificateManagerSettings.Builder toBuilder()

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

Returns
Type Description
CertificateManagerSettings.Builder
Overrides

updateCertificateMapEntryOperationSettings()

public OperationCallSettings<UpdateCertificateMapEntryRequest,CertificateMapEntry,OperationMetadata> updateCertificateMapEntryOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateCertificateMapEntryRequest,CertificateMapEntry,OperationMetadata>

updateCertificateMapEntrySettings()

public UnaryCallSettings<UpdateCertificateMapEntryRequest,Operation> updateCertificateMapEntrySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateCertificateMapEntryRequest,Operation>

updateCertificateMapOperationSettings()

public OperationCallSettings<UpdateCertificateMapRequest,CertificateMap,OperationMetadata> updateCertificateMapOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateCertificateMapRequest,CertificateMap,OperationMetadata>

updateCertificateMapSettings()

public UnaryCallSettings<UpdateCertificateMapRequest,Operation> updateCertificateMapSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateCertificateMapRequest,Operation>

updateCertificateOperationSettings()

public OperationCallSettings<UpdateCertificateRequest,Certificate,OperationMetadata> updateCertificateOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateCertificateRequest,Certificate,OperationMetadata>

updateCertificateSettings()

public UnaryCallSettings<UpdateCertificateRequest,Operation> updateCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateCertificateRequest,Operation>

updateDnsAuthorizationOperationSettings()

public OperationCallSettings<UpdateDnsAuthorizationRequest,DnsAuthorization,OperationMetadata> updateDnsAuthorizationOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateDnsAuthorizationRequest,DnsAuthorization,OperationMetadata>

updateDnsAuthorizationSettings()

public UnaryCallSettings<UpdateDnsAuthorizationRequest,Operation> updateDnsAuthorizationSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateDnsAuthorizationRequest,Operation>

updateTrustConfigOperationSettings()

public OperationCallSettings<UpdateTrustConfigRequest,TrustConfig,OperationMetadata> updateTrustConfigOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateTrustConfigRequest,TrustConfig,OperationMetadata>

updateTrustConfigSettings()

public UnaryCallSettings<UpdateTrustConfigRequest,Operation> updateTrustConfigSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateTrustConfigRequest,Operation>