Class CertificateAuthorityServiceSettings (2.5.1)

Stay organized with collections Save and categorize content based on your preferences.
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 total timeout of createCertificate to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 CertificateAuthorityServiceSettings.Builder certificateAuthorityServiceSettingsBuilder =
     CertificateAuthorityServiceSettings.newBuilder();
 certificateAuthorityServiceSettingsBuilder
     .createCertificateSettings()
     .setRetrySettings(
         certificateAuthorityServiceSettingsBuilder
             .createCertificateSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CertificateAuthorityServiceSettings certificateAuthorityServiceSettings =
     certificateAuthorityServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > CertificateAuthorityServiceSettings

Static Methods

create(CertificateAuthorityServiceStubSettings stub)

public static final CertificateAuthorityServiceSettings create(CertificateAuthorityServiceStubSettings stub)
Parameter
NameDescription
stubCertificateAuthorityServiceStubSettings
Returns
TypeDescription
CertificateAuthorityServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static CertificateAuthorityServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
CertificateAuthorityServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static CertificateAuthorityServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CertificateAuthorityServiceSettings.Builder

newHttpJsonBuilder()

public static CertificateAuthorityServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
CertificateAuthorityServiceSettings.Builder

Constructors

CertificateAuthorityServiceSettings(CertificateAuthorityServiceSettings.Builder settingsBuilder)

protected CertificateAuthorityServiceSettings(CertificateAuthorityServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCertificateAuthorityServiceSettings.Builder

Methods

activateCertificateAuthorityOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ActivateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

activateCertificateAuthoritySettings()

public UnaryCallSettings<ActivateCertificateAuthorityRequest,Operation> activateCertificateAuthoritySettings()

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

Returns
TypeDescription
UnaryCallSettings<ActivateCertificateAuthorityRequest,Operation>

createCertificateAuthorityOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

createCertificateAuthoritySettings()

public UnaryCallSettings<CreateCertificateAuthorityRequest,Operation> createCertificateAuthoritySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCertificateAuthorityRequest,Operation>

createCertificateSettings()

public UnaryCallSettings<CreateCertificateRequest,Certificate> createCertificateSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCertificateRequest,Certificate>

disableCertificateAuthorityOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DisableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

disableCertificateAuthoritySettings()

public UnaryCallSettings<DisableCertificateAuthorityRequest,Operation> disableCertificateAuthoritySettings()

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

Returns
TypeDescription
UnaryCallSettings<DisableCertificateAuthorityRequest,Operation>

enableCertificateAuthorityOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<EnableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

enableCertificateAuthoritySettings()

public UnaryCallSettings<EnableCertificateAuthorityRequest,Operation> enableCertificateAuthoritySettings()

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

Returns
TypeDescription
UnaryCallSettings<EnableCertificateAuthorityRequest,Operation>

fetchCertificateAuthorityCsrSettings()

public UnaryCallSettings<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse> fetchCertificateAuthorityCsrSettings()

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

Returns
TypeDescription
UnaryCallSettings<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse>

getCertificateAuthoritySettings()

public UnaryCallSettings<GetCertificateAuthorityRequest,CertificateAuthority> getCertificateAuthoritySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCertificateAuthorityRequest,CertificateAuthority>

getCertificateRevocationListSettings()

public UnaryCallSettings<GetCertificateRevocationListRequest,CertificateRevocationList> getCertificateRevocationListSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCertificateRevocationListRequest,CertificateRevocationList>

getCertificateSettings()

public UnaryCallSettings<GetCertificateRequest,Certificate> getCertificateSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCertificateRequest,Certificate>

getReusableConfigSettings()

public UnaryCallSettings<GetReusableConfigRequest,ReusableConfig> getReusableConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetReusableConfigRequest,ReusableConfig>

listCertificateAuthoritiesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListCertificateAuthoritiesRequest,ListCertificateAuthoritiesResponse,ListCertificateAuthoritiesPagedResponse>

listCertificateRevocationListsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListCertificateRevocationListsRequest,ListCertificateRevocationListsResponse,ListCertificateRevocationListsPagedResponse>

listCertificatesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListCertificatesRequest,ListCertificatesResponse,ListCertificatesPagedResponse>

listReusableConfigsSettings()

public PagedCallSettings<ListReusableConfigsRequest,ListReusableConfigsResponse,CertificateAuthorityServiceClient.ListReusableConfigsPagedResponse> listReusableConfigsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListReusableConfigsRequest,ListReusableConfigsResponse,ListReusableConfigsPagedResponse>

restoreCertificateAuthorityOperationSettings()

public OperationCallSettings<RestoreCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> restoreCertificateAuthorityOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<RestoreCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

restoreCertificateAuthoritySettings()

public UnaryCallSettings<RestoreCertificateAuthorityRequest,Operation> restoreCertificateAuthoritySettings()

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

Returns
TypeDescription
UnaryCallSettings<RestoreCertificateAuthorityRequest,Operation>

revokeCertificateSettings()

public UnaryCallSettings<RevokeCertificateRequest,Certificate> revokeCertificateSettings()

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

Returns
TypeDescription
UnaryCallSettings<RevokeCertificateRequest,Certificate>

scheduleDeleteCertificateAuthorityOperationSettings()

public OperationCallSettings<ScheduleDeleteCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> scheduleDeleteCertificateAuthorityOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<ScheduleDeleteCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

scheduleDeleteCertificateAuthoritySettings()

public UnaryCallSettings<ScheduleDeleteCertificateAuthorityRequest,Operation> scheduleDeleteCertificateAuthoritySettings()

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

Returns
TypeDescription
UnaryCallSettings<ScheduleDeleteCertificateAuthorityRequest,Operation>

toBuilder()

public CertificateAuthorityServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
CertificateAuthorityServiceSettings.Builder
Overrides

updateCertificateAuthorityOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

updateCertificateAuthoritySettings()

public UnaryCallSettings<UpdateCertificateAuthorityRequest,Operation> updateCertificateAuthoritySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCertificateAuthorityRequest,Operation>

updateCertificateRevocationListOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateCertificateRevocationListRequest,CertificateRevocationList,OperationMetadata>

updateCertificateRevocationListSettings()

public UnaryCallSettings<UpdateCertificateRevocationListRequest,Operation> updateCertificateRevocationListSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCertificateRevocationListRequest,Operation>

updateCertificateSettings()

public UnaryCallSettings<UpdateCertificateRequest,Certificate> updateCertificateSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCertificateRequest,Certificate>