com.google.cloud.security.privateca.v1beta1

Class CertificateAuthorityServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<CertificateAuthorityServiceSettings>

com.google.cloud.security.privateca.v1beta1.CertificateAuthorityServiceSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class CertificateAuthorityServiceSettings
extends com.google.api.gax.rpc.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 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CertificateAuthorityServiceSettings certificateAuthorityServiceSettings =
     certificateAuthorityServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CertificateAuthorityServiceSettings.Builder Builder for CertificateAuthorityServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CertificateAuthorityServiceSettings(CertificateAuthorityServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<ActivateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>	activateCertificateAuthorityOperationSettings() Returns the object with the settings used for calls to activateCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<ActivateCertificateAuthorityRequest,com.google.longrunning.Operation>	activateCertificateAuthoritySettings() Returns the object with the settings used for calls to activateCertificateAuthority.
static CertificateAuthorityServiceSettings	create(CertificateAuthorityServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>	createCertificateAuthorityOperationSettings() Returns the object with the settings used for calls to createCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<CreateCertificateAuthorityRequest,com.google.longrunning.Operation>	createCertificateAuthoritySettings() Returns the object with the settings used for calls to createCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<CreateCertificateRequest,Certificate>	createCertificateSettings() Returns the object with the settings used for calls to createCertificate.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DisableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>	disableCertificateAuthorityOperationSettings() Returns the object with the settings used for calls to disableCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<DisableCertificateAuthorityRequest,com.google.longrunning.Operation>	disableCertificateAuthoritySettings() Returns the object with the settings used for calls to disableCertificateAuthority.
com.google.api.gax.rpc.OperationCallSettings<EnableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>	enableCertificateAuthorityOperationSettings() Returns the object with the settings used for calls to enableCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<EnableCertificateAuthorityRequest,com.google.longrunning.Operation>	enableCertificateAuthoritySettings() Returns the object with the settings used for calls to enableCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse>	fetchCertificateAuthorityCsrSettings() Returns the object with the settings used for calls to fetchCertificateAuthorityCsr.
com.google.api.gax.rpc.UnaryCallSettings<GetCertificateAuthorityRequest,CertificateAuthority>	getCertificateAuthoritySettings() Returns the object with the settings used for calls to getCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<GetCertificateRevocationListRequest,CertificateRevocationList>	getCertificateRevocationListSettings() Returns the object with the settings used for calls to getCertificateRevocationList.
com.google.api.gax.rpc.UnaryCallSettings<GetCertificateRequest,Certificate>	getCertificateSettings() Returns the object with the settings used for calls to getCertificate.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetReusableConfigRequest,ReusableConfig>	getReusableConfigSettings() Returns the object with the settings used for calls to getReusableConfig.
com.google.api.gax.rpc.PagedCallSettings<ListCertificateAuthoritiesRequest,ListCertificateAuthoritiesResponse,CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse>	listCertificateAuthoritiesSettings() Returns the object with the settings used for calls to listCertificateAuthorities.
com.google.api.gax.rpc.PagedCallSettings<ListCertificateRevocationListsRequest,ListCertificateRevocationListsResponse,CertificateAuthorityServiceClient.ListCertificateRevocationListsPagedResponse>	listCertificateRevocationListsSettings() Returns the object with the settings used for calls to listCertificateRevocationLists.
com.google.api.gax.rpc.PagedCallSettings<ListCertificatesRequest,ListCertificatesResponse,CertificateAuthorityServiceClient.ListCertificatesPagedResponse>	listCertificatesSettings() Returns the object with the settings used for calls to listCertificates.
com.google.api.gax.rpc.PagedCallSettings<ListReusableConfigsRequest,ListReusableConfigsResponse,CertificateAuthorityServiceClient.ListReusableConfigsPagedResponse>	listReusableConfigsSettings() Returns the object with the settings used for calls to listReusableConfigs.
static CertificateAuthorityServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static CertificateAuthorityServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static CertificateAuthorityServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.OperationCallSettings<RestoreCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>	restoreCertificateAuthorityOperationSettings() Returns the object with the settings used for calls to restoreCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<RestoreCertificateAuthorityRequest,com.google.longrunning.Operation>	restoreCertificateAuthoritySettings() Returns the object with the settings used for calls to restoreCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<RevokeCertificateRequest,Certificate>	revokeCertificateSettings() Returns the object with the settings used for calls to revokeCertificate.
com.google.api.gax.rpc.OperationCallSettings<ScheduleDeleteCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>	scheduleDeleteCertificateAuthorityOperationSettings() Returns the object with the settings used for calls to scheduleDeleteCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<ScheduleDeleteCertificateAuthorityRequest,com.google.longrunning.Operation>	scheduleDeleteCertificateAuthoritySettings() Returns the object with the settings used for calls to scheduleDeleteCertificateAuthority.
CertificateAuthorityServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata>	updateCertificateAuthorityOperationSettings() Returns the object with the settings used for calls to updateCertificateAuthority.
com.google.api.gax.rpc.UnaryCallSettings<UpdateCertificateAuthorityRequest,com.google.longrunning.Operation>	updateCertificateAuthoritySettings() Returns the object with the settings used for calls to updateCertificateAuthority.
com.google.api.gax.rpc.OperationCallSettings<UpdateCertificateRevocationListRequest,CertificateRevocationList,OperationMetadata>	updateCertificateRevocationListOperationSettings() Returns the object with the settings used for calls to updateCertificateRevocationList.
com.google.api.gax.rpc.UnaryCallSettings<UpdateCertificateRevocationListRequest,com.google.longrunning.Operation>	updateCertificateRevocationListSettings() Returns the object with the settings used for calls to updateCertificateRevocationList.
com.google.api.gax.rpc.UnaryCallSettings<UpdateCertificateRequest,Certificate>	updateCertificateSettings() Returns the object with the settings used for calls to updateCertificate.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CertificateAuthorityServiceSettings

protected CertificateAuthorityServiceSettings(CertificateAuthorityServiceSettings.Builder settingsBuilder)
                                       throws IOException

Throws:

IOException

Method Detail

createCertificateSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateCertificateRequest,Certificate> createCertificateSettings()

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

getCertificateSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetCertificateRequest,Certificate> getCertificateSettings()

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

listCertificatesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListCertificatesRequest,ListCertificatesResponse,CertificateAuthorityServiceClient.ListCertificatesPagedResponse> listCertificatesSettings()

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

revokeCertificateSettings

public com.google.api.gax.rpc.UnaryCallSettings<RevokeCertificateRequest,Certificate> revokeCertificateSettings()

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

updateCertificateSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateCertificateRequest,Certificate> updateCertificateSettings()

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

activateCertificateAuthoritySettings

public com.google.api.gax.rpc.UnaryCallSettings<ActivateCertificateAuthorityRequest,com.google.longrunning.Operation> activateCertificateAuthoritySettings()

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

activateCertificateAuthorityOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ActivateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> activateCertificateAuthorityOperationSettings()

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

createCertificateAuthoritySettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateCertificateAuthorityRequest,com.google.longrunning.Operation> createCertificateAuthoritySettings()

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

createCertificateAuthorityOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> createCertificateAuthorityOperationSettings()

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

disableCertificateAuthoritySettings

public com.google.api.gax.rpc.UnaryCallSettings<DisableCertificateAuthorityRequest,com.google.longrunning.Operation> disableCertificateAuthoritySettings()

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

disableCertificateAuthorityOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DisableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> disableCertificateAuthorityOperationSettings()

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

enableCertificateAuthoritySettings

public com.google.api.gax.rpc.UnaryCallSettings<EnableCertificateAuthorityRequest,com.google.longrunning.Operation> enableCertificateAuthoritySettings()

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

enableCertificateAuthorityOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<EnableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> enableCertificateAuthorityOperationSettings()

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

fetchCertificateAuthorityCsrSettings

public com.google.api.gax.rpc.UnaryCallSettings<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse> fetchCertificateAuthorityCsrSettings()

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

getCertificateAuthoritySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetCertificateAuthorityRequest,CertificateAuthority> getCertificateAuthoritySettings()

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

listCertificateAuthoritiesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListCertificateAuthoritiesRequest,ListCertificateAuthoritiesResponse,CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse> listCertificateAuthoritiesSettings()

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

restoreCertificateAuthoritySettings

public com.google.api.gax.rpc.UnaryCallSettings<RestoreCertificateAuthorityRequest,com.google.longrunning.Operation> restoreCertificateAuthoritySettings()

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

restoreCertificateAuthorityOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RestoreCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> restoreCertificateAuthorityOperationSettings()

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

scheduleDeleteCertificateAuthoritySettings

public com.google.api.gax.rpc.UnaryCallSettings<ScheduleDeleteCertificateAuthorityRequest,com.google.longrunning.Operation> scheduleDeleteCertificateAuthoritySettings()

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

scheduleDeleteCertificateAuthorityOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ScheduleDeleteCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> scheduleDeleteCertificateAuthorityOperationSettings()

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

updateCertificateAuthoritySettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateCertificateAuthorityRequest,com.google.longrunning.Operation> updateCertificateAuthoritySettings()

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

updateCertificateAuthorityOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> updateCertificateAuthorityOperationSettings()

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

getCertificateRevocationListSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetCertificateRevocationListRequest,CertificateRevocationList> getCertificateRevocationListSettings()

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

listCertificateRevocationListsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListCertificateRevocationListsRequest,ListCertificateRevocationListsResponse,CertificateAuthorityServiceClient.ListCertificateRevocationListsPagedResponse> listCertificateRevocationListsSettings()

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

updateCertificateRevocationListSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateCertificateRevocationListRequest,com.google.longrunning.Operation> updateCertificateRevocationListSettings()

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

updateCertificateRevocationListOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateCertificateRevocationListRequest,CertificateRevocationList,OperationMetadata> updateCertificateRevocationListOperationSettings()

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

getReusableConfigSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetReusableConfigRequest,ReusableConfig> getReusableConfigSettings()

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

listReusableConfigsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListReusableConfigsRequest,ListReusableConfigsResponse,CertificateAuthorityServiceClient.ListReusableConfigsPagedResponse> listReusableConfigsSettings()

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

create

public static final CertificateAuthorityServiceSettings create(CertificateAuthorityServiceStubSettings stub)
                                                        throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static CertificateAuthorityServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static CertificateAuthorityServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static CertificateAuthorityServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public CertificateAuthorityServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<CertificateAuthorityServiceSettings>