Class CertificateAuthorityServiceStubSettings (2.3.0)

public class CertificateAuthorityServiceStubSettings extends StubSettings<CertificateAuthorityServiceStubSettings>

Settings class to configure an instance of CertificateAuthorityServiceStub.

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:


 CertificateAuthorityServiceStubSettings.Builder certificateAuthorityServiceSettingsBuilder =
     CertificateAuthorityServiceStubSettings.newBuilder();
 certificateAuthorityServiceSettingsBuilder
     .createCertificateSettings()
     .setRetrySettings(
         certificateAuthorityServiceSettingsBuilder
             .createCertificateSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CertificateAuthorityServiceStubSettings certificateAuthorityServiceSettings =
     certificateAuthorityServiceSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > CertificateAuthorityServiceStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 CertificateAuthorityServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
CertificateAuthorityServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CertificateAuthorityServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
CertificateAuthorityServiceStubSettings.Builder

Constructors

CertificateAuthorityServiceStubSettings(CertificateAuthorityServiceStubSettings.Builder settingsBuilder)

protected CertificateAuthorityServiceStubSettings(CertificateAuthorityServiceStubSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`CertificateAuthorityServiceStubSettings.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>

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>

createStub()

public CertificateAuthorityServiceStub createStub()

Returns

Type	Description
CertificateAuthorityServiceStub

Exceptions

Type	Description
IOException

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>

fetchCertificateAuthorityCsrSettings()

public UnaryCallSettings<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse> fetchCertificateAuthorityCsrSettings()

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

Returns

Type	Description
UnaryCallSettings<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse>

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>

getReusableConfigSettings()

public UnaryCallSettings<GetReusableConfigRequest,ReusableConfig> getReusableConfigSettings()

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

Returns

Type	Description
UnaryCallSettings<GetReusableConfigRequest,ReusableConfig>

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>

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>

listReusableConfigsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListReusableConfigsRequest,ListReusableConfigsResponse,ListReusableConfigsPagedResponse>

restoreCertificateAuthorityOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<RestoreCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

restoreCertificateAuthoritySettings()

public UnaryCallSettings<RestoreCertificateAuthorityRequest,Operation> restoreCertificateAuthoritySettings()

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

Returns

Type	Description
UnaryCallSettings<RestoreCertificateAuthorityRequest,Operation>

revokeCertificateSettings()

public UnaryCallSettings<RevokeCertificateRequest,Certificate> revokeCertificateSettings()

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

Returns

Type	Description
UnaryCallSettings<RevokeCertificateRequest,Certificate>

scheduleDeleteCertificateAuthorityOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<ScheduleDeleteCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>

scheduleDeleteCertificateAuthoritySettings()

public UnaryCallSettings<ScheduleDeleteCertificateAuthorityRequest,Operation> scheduleDeleteCertificateAuthoritySettings()

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

Returns

Type	Description
UnaryCallSettings<ScheduleDeleteCertificateAuthorityRequest,Operation>

toBuilder()

public CertificateAuthorityServiceStubSettings.Builder toBuilder()

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

Returns

Type	Description
CertificateAuthorityServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()

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>