- 2.53.0 (latest)
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.4
- 2.4.0
- 2.3.0
- 2.2.5
GitHub Repository | Product Reference | REST Documentation | RPC Documentation |
Service Description: Certificate Authority Service manages private certificate authorities and issued certificates.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CertificateAuthorityName parent =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]");
Certificate certificate = Certificate.newBuilder().build();
String certificateId = "certificateId-644529902";
Certificate response =
certificateAuthorityServiceClient.createCertificate(parent, certificate, certificateId);
}
Note: close() needs to be called on the CertificateAuthorityServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
CreateCertificate |
Create a new Certificate in a given Project, Location from a particular CertificateAuthority. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetCertificate |
Returns a Certificate. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListCertificates |
Lists Certificates. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RevokeCertificate |
Revoke a Certificate. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateCertificate |
Update a Certificate. Currently, the only field you can update is the labels field. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ActivateCertificateAuthority |
Activate a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateCertificateAuthority |
Create a new CertificateAuthority in a given Project and Location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DisableCertificateAuthority |
Disable a CertificateAuthority. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
EnableCertificateAuthority |
Enable a CertificateAuthority. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
FetchCertificateAuthorityCsr |
Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetCertificateAuthority |
Returns a CertificateAuthority. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListCertificateAuthorities |
Lists CertificateAuthorities. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RestoreCertificateAuthority |
Restore a CertificateAuthority that is scheduled for deletion. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ScheduleDeleteCertificateAuthority |
Schedule a CertificateAuthority for deletion. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateCertificateAuthority |
Update a CertificateAuthority. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetCertificateRevocationList |
Returns a CertificateRevocationList. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListCertificateRevocationLists |
Lists CertificateRevocationLists. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateCertificateRevocationList |
Update a CertificateRevocationList. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetReusableConfig |
Returns a ReusableConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListReusableConfigs |
Lists ReusableConfigs. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of CertificateAuthorityServiceSettings to create(). For example:
To customize credentials:
// 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 certificateAuthorityServiceSettings =
CertificateAuthorityServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create(certificateAuthorityServiceSettings);
To customize the endpoint:
// 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 certificateAuthorityServiceSettings =
CertificateAuthorityServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create(certificateAuthorityServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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 certificateAuthorityServiceSettings =
CertificateAuthorityServiceSettings.newHttpJsonBuilder().build();
CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create(certificateAuthorityServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final CertificateAuthorityServiceClient create()
Constructs an instance of CertificateAuthorityServiceClient with default settings.
Returns | |
---|---|
Type | Description |
CertificateAuthorityServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(CertificateAuthorityServiceSettings settings)
public static final CertificateAuthorityServiceClient create(CertificateAuthorityServiceSettings settings)
Constructs an instance of CertificateAuthorityServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings |
CertificateAuthorityServiceSettings |
Returns | |
---|---|
Type | Description |
CertificateAuthorityServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(CertificateAuthorityServiceStub stub)
public static final CertificateAuthorityServiceClient create(CertificateAuthorityServiceStub stub)
Constructs an instance of CertificateAuthorityServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CertificateAuthorityServiceSettings).
Parameter | |
---|---|
Name | Description |
stub |
CertificateAuthorityServiceStub |
Returns | |
---|---|
Type | Description |
CertificateAuthorityServiceClient |
Constructors
CertificateAuthorityServiceClient(CertificateAuthorityServiceSettings settings)
protected CertificateAuthorityServiceClient(CertificateAuthorityServiceSettings settings)
Constructs an instance of CertificateAuthorityServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings |
CertificateAuthorityServiceSettings |
CertificateAuthorityServiceClient(CertificateAuthorityServiceStub stub)
protected CertificateAuthorityServiceClient(CertificateAuthorityServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
CertificateAuthorityServiceStub |
Methods
activateCertificateAuthorityAsync(ActivateCertificateAuthorityRequest request)
public final OperationFuture<CertificateAuthority,OperationMetadata> activateCertificateAuthorityAsync(ActivateCertificateAuthorityRequest request)
Activate a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
ActivateCertificateAuthorityRequest request =
ActivateCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setPemCaCertificate("pemCaCertificate2100567073")
.setSubordinateConfig(SubordinateConfig.newBuilder().build())
.setRequestId("requestId693933066")
.build();
CertificateAuthority response =
certificateAuthorityServiceClient.activateCertificateAuthorityAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
ActivateCertificateAuthorityRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
activateCertificateAuthorityAsync(CertificateAuthorityName name)
public final OperationFuture<CertificateAuthority,OperationMetadata> activateCertificateAuthorityAsync(CertificateAuthorityName name)
Activate a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CertificateAuthorityName name =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]");
CertificateAuthority response =
certificateAuthorityServiceClient.activateCertificateAuthorityAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
CertificateAuthorityName Required. The resource name for this
CertificateAuthority in the
format |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
activateCertificateAuthorityAsync(String name)
public final OperationFuture<CertificateAuthority,OperationMetadata> activateCertificateAuthorityAsync(String name)
Activate a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
String name =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString();
CertificateAuthority response =
certificateAuthorityServiceClient.activateCertificateAuthorityAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name for this
CertificateAuthority in the
format |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
activateCertificateAuthorityCallable()
public final UnaryCallable<ActivateCertificateAuthorityRequest,Operation> activateCertificateAuthorityCallable()
Activate a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
ActivateCertificateAuthorityRequest request =
ActivateCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setPemCaCertificate("pemCaCertificate2100567073")
.setSubordinateConfig(SubordinateConfig.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
certificateAuthorityServiceClient
.activateCertificateAuthorityCallable()
.futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ActivateCertificateAuthorityRequest,Operation> |
activateCertificateAuthorityOperationCallable()
public final OperationCallable<ActivateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> activateCertificateAuthorityOperationCallable()
Activate a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
ActivateCertificateAuthorityRequest request =
ActivateCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setPemCaCertificate("pemCaCertificate2100567073")
.setSubordinateConfig(SubordinateConfig.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<CertificateAuthority, OperationMetadata> future =
certificateAuthorityServiceClient
.activateCertificateAuthorityOperationCallable()
.futureCall(request);
// Do something.
CertificateAuthority response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ActivateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createCertificate(CertificateAuthorityName parent, Certificate certificate, String certificateId)
public final Certificate createCertificate(CertificateAuthorityName parent, Certificate certificate, String certificateId)
Create a new Certificate in a given Project, Location from a particular CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CertificateAuthorityName parent =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]");
Certificate certificate = Certificate.newBuilder().build();
String certificateId = "certificateId-644529902";
Certificate response =
certificateAuthorityServiceClient.createCertificate(parent, certificate, certificateId);
}
Parameters | |
---|---|
Name | Description |
parent |
CertificateAuthorityName Required. The resource name of the location and
CertificateAuthority
associated with the Certificate, in
the format |
certificate |
Certificate Required. A Certificate with initial field values. |
certificateId |
String Optional. It must be unique within a location and match the regular
expression |
Returns | |
---|---|
Type | Description |
Certificate |
createCertificate(CreateCertificateRequest request)
public final Certificate createCertificate(CreateCertificateRequest request)
Create a new Certificate in a given Project, Location from a particular CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CreateCertificateRequest request =
CreateCertificateRequest.newBuilder()
.setParent(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setCertificateId("certificateId-644529902")
.setCertificate(Certificate.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Certificate response = certificateAuthorityServiceClient.createCertificate(request);
}
Parameter | |
---|---|
Name | Description |
request |
CreateCertificateRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Certificate |
createCertificate(String parent, Certificate certificate, String certificateId)
public final Certificate createCertificate(String parent, Certificate certificate, String certificateId)
Create a new Certificate in a given Project, Location from a particular CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
String parent =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString();
Certificate certificate = Certificate.newBuilder().build();
String certificateId = "certificateId-644529902";
Certificate response =
certificateAuthorityServiceClient.createCertificate(parent, certificate, certificateId);
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The resource name of the location and
CertificateAuthority
associated with the Certificate, in
the format |
certificate |
Certificate Required. A Certificate with initial field values. |
certificateId |
String Optional. It must be unique within a location and match the regular
expression |
Returns | |
---|---|
Type | Description |
Certificate |
createCertificateAuthorityAsync(CreateCertificateAuthorityRequest request)
public final OperationFuture<CertificateAuthority,OperationMetadata> createCertificateAuthorityAsync(CreateCertificateAuthorityRequest request)
Create a new CertificateAuthority in a given Project and Location.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CreateCertificateAuthorityRequest request =
CreateCertificateAuthorityRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setCertificateAuthorityId("certificateAuthorityId-1652580953")
.setCertificateAuthority(CertificateAuthority.newBuilder().build())
.setRequestId("requestId693933066")
.build();
CertificateAuthority response =
certificateAuthorityServiceClient.createCertificateAuthorityAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreateCertificateAuthorityRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
createCertificateAuthorityAsync(LocationName parent, CertificateAuthority certificateAuthority, String certificateAuthorityId)
public final OperationFuture<CertificateAuthority,OperationMetadata> createCertificateAuthorityAsync(LocationName parent, CertificateAuthority certificateAuthority, String certificateAuthorityId)
Create a new CertificateAuthority in a given Project and Location.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
CertificateAuthority certificateAuthority = CertificateAuthority.newBuilder().build();
String certificateAuthorityId = "certificateAuthorityId-1652580953";
CertificateAuthority response =
certificateAuthorityServiceClient
.createCertificateAuthorityAsync(parent, certificateAuthority, certificateAuthorityId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The resource name of the location associated with the
CertificateAuthorities, in
the format |
certificateAuthority |
CertificateAuthority Required. A CertificateAuthority with initial field values. |
certificateAuthorityId |
String Required. It must be unique within a location and match the
regular expression |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
createCertificateAuthorityAsync(String parent, CertificateAuthority certificateAuthority, String certificateAuthorityId)
public final OperationFuture<CertificateAuthority,OperationMetadata> createCertificateAuthorityAsync(String parent, CertificateAuthority certificateAuthority, String certificateAuthorityId)
Create a new CertificateAuthority in a given Project and Location.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
CertificateAuthority certificateAuthority = CertificateAuthority.newBuilder().build();
String certificateAuthorityId = "certificateAuthorityId-1652580953";
CertificateAuthority response =
certificateAuthorityServiceClient
.createCertificateAuthorityAsync(parent, certificateAuthority, certificateAuthorityId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The resource name of the location associated with the
CertificateAuthorities, in
the format |
certificateAuthority |
CertificateAuthority Required. A CertificateAuthority with initial field values. |
certificateAuthorityId |
String Required. It must be unique within a location and match the
regular expression |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
createCertificateAuthorityCallable()
public final UnaryCallable<CreateCertificateAuthorityRequest,Operation> createCertificateAuthorityCallable()
Create a new CertificateAuthority in a given Project and Location.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CreateCertificateAuthorityRequest request =
CreateCertificateAuthorityRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setCertificateAuthorityId("certificateAuthorityId-1652580953")
.setCertificateAuthority(CertificateAuthority.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
certificateAuthorityServiceClient
.createCertificateAuthorityCallable()
.futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateCertificateAuthorityRequest,Operation> |
createCertificateAuthorityOperationCallable()
public final OperationCallable<CreateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> createCertificateAuthorityOperationCallable()
Create a new CertificateAuthority in a given Project and Location.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CreateCertificateAuthorityRequest request =
CreateCertificateAuthorityRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setCertificateAuthorityId("certificateAuthorityId-1652580953")
.setCertificateAuthority(CertificateAuthority.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<CertificateAuthority, OperationMetadata> future =
certificateAuthorityServiceClient
.createCertificateAuthorityOperationCallable()
.futureCall(request);
// Do something.
CertificateAuthority response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> |
createCertificateCallable()
public final UnaryCallable<CreateCertificateRequest,Certificate> createCertificateCallable()
Create a new Certificate in a given Project, Location from a particular CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CreateCertificateRequest request =
CreateCertificateRequest.newBuilder()
.setParent(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setCertificateId("certificateId-644529902")
.setCertificate(Certificate.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Certificate> future =
certificateAuthorityServiceClient.createCertificateCallable().futureCall(request);
// Do something.
Certificate response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateCertificateRequest,Certificate> |
disableCertificateAuthorityAsync(CertificateAuthorityName name)
public final OperationFuture<CertificateAuthority,OperationMetadata> disableCertificateAuthorityAsync(CertificateAuthorityName name)
Disable a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CertificateAuthorityName name =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]");
CertificateAuthority response =
certificateAuthorityServiceClient.disableCertificateAuthorityAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
CertificateAuthorityName Required. The resource name for this
CertificateAuthority in the
format |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
disableCertificateAuthorityAsync(DisableCertificateAuthorityRequest request)
public final OperationFuture<CertificateAuthority,OperationMetadata> disableCertificateAuthorityAsync(DisableCertificateAuthorityRequest request)
Disable a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
DisableCertificateAuthorityRequest request =
DisableCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setRequestId("requestId693933066")
.build();
CertificateAuthority response =
certificateAuthorityServiceClient.disableCertificateAuthorityAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DisableCertificateAuthorityRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
disableCertificateAuthorityAsync(String name)
public final OperationFuture<CertificateAuthority,OperationMetadata> disableCertificateAuthorityAsync(String name)
Disable a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
String name =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString();
CertificateAuthority response =
certificateAuthorityServiceClient.disableCertificateAuthorityAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name for this
CertificateAuthority in the
format |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
disableCertificateAuthorityCallable()
public final UnaryCallable<DisableCertificateAuthorityRequest,Operation> disableCertificateAuthorityCallable()
Disable a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
DisableCertificateAuthorityRequest request =
DisableCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
certificateAuthorityServiceClient
.disableCertificateAuthorityCallable()
.futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DisableCertificateAuthorityRequest,Operation> |
disableCertificateAuthorityOperationCallable()
public final OperationCallable<DisableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> disableCertificateAuthorityOperationCallable()
Disable a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
DisableCertificateAuthorityRequest request =
DisableCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<CertificateAuthority, OperationMetadata> future =
certificateAuthorityServiceClient
.disableCertificateAuthorityOperationCallable()
.futureCall(request);
// Do something.
CertificateAuthority response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DisableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> |
enableCertificateAuthorityAsync(CertificateAuthorityName name)
public final OperationFuture<CertificateAuthority,OperationMetadata> enableCertificateAuthorityAsync(CertificateAuthorityName name)
Enable a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CertificateAuthorityName name =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]");
CertificateAuthority response =
certificateAuthorityServiceClient.enableCertificateAuthorityAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
CertificateAuthorityName Required. The resource name for this
CertificateAuthority in the
format |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
enableCertificateAuthorityAsync(EnableCertificateAuthorityRequest request)
public final OperationFuture<CertificateAuthority,OperationMetadata> enableCertificateAuthorityAsync(EnableCertificateAuthorityRequest request)
Enable a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
EnableCertificateAuthorityRequest request =
EnableCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setRequestId("requestId693933066")
.build();
CertificateAuthority response =
certificateAuthorityServiceClient.enableCertificateAuthorityAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
EnableCertificateAuthorityRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
enableCertificateAuthorityAsync(String name)
public final OperationFuture<CertificateAuthority,OperationMetadata> enableCertificateAuthorityAsync(String name)
Enable a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
String name =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString();
CertificateAuthority response =
certificateAuthorityServiceClient.enableCertificateAuthorityAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name for this
CertificateAuthority in the
format |
Returns | |
---|---|
Type | Description |
OperationFuture<CertificateAuthority,OperationMetadata> |
enableCertificateAuthorityCallable()
public final UnaryCallable<EnableCertificateAuthorityRequest,Operation> enableCertificateAuthorityCallable()
Enable a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
EnableCertificateAuthorityRequest request =
EnableCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
certificateAuthorityServiceClient
.enableCertificateAuthorityCallable()
.futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<EnableCertificateAuthorityRequest,Operation> |
enableCertificateAuthorityOperationCallable()
public final OperationCallable<EnableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> enableCertificateAuthorityOperationCallable()
Enable a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
EnableCertificateAuthorityRequest request =
EnableCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<CertificateAuthority, OperationMetadata> future =
certificateAuthorityServiceClient
.enableCertificateAuthorityOperationCallable()
.futureCall(request);
// Do something.
CertificateAuthority response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<EnableCertificateAuthorityRequest,CertificateAuthority,OperationMetadata> |
fetchCertificateAuthorityCsr(CertificateAuthorityName name)
public final FetchCertificateAuthorityCsrResponse fetchCertificateAuthorityCsr(CertificateAuthorityName name)
Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CertificateAuthorityName name =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]");
FetchCertificateAuthorityCsrResponse response =
certificateAuthorityServiceClient.fetchCertificateAuthorityCsr(name);
}
Parameter | |
---|---|
Name | Description |
name |
CertificateAuthorityName Required. The resource name for this
CertificateAuthority in the
format |
Returns | |
---|---|
Type | Description |
FetchCertificateAuthorityCsrResponse |
fetchCertificateAuthorityCsr(FetchCertificateAuthorityCsrRequest request)
public final FetchCertificateAuthorityCsrResponse fetchCertificateAuthorityCsr(FetchCertificateAuthorityCsrRequest request)
Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
FetchCertificateAuthorityCsrRequest request =
FetchCertificateAuthorityCsrRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.build();
FetchCertificateAuthorityCsrResponse response =
certificateAuthorityServiceClient.fetchCertificateAuthorityCsr(request);
}
Parameter | |
---|---|
Name | Description |
request |
FetchCertificateAuthorityCsrRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
FetchCertificateAuthorityCsrResponse |
fetchCertificateAuthorityCsr(String name)
public final FetchCertificateAuthorityCsrResponse fetchCertificateAuthorityCsr(String name)
Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
String name =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString();
FetchCertificateAuthorityCsrResponse response =
certificateAuthorityServiceClient.fetchCertificateAuthorityCsr(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name for this
CertificateAuthority in the
format |
Returns | |
---|---|
Type | Description |
FetchCertificateAuthorityCsrResponse |
fetchCertificateAuthorityCsrCallable()
public final UnaryCallable<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse> fetchCertificateAuthorityCsrCallable()
Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
FetchCertificateAuthorityCsrRequest request =
FetchCertificateAuthorityCsrRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.build();
ApiFuture<FetchCertificateAuthorityCsrResponse> future =
certificateAuthorityServiceClient
.fetchCertificateAuthorityCsrCallable()
.futureCall(request);
// Do something.
FetchCertificateAuthorityCsrResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<FetchCertificateAuthorityCsrRequest,FetchCertificateAuthorityCsrResponse> |
getCertificate(CertificateName name)
public final Certificate getCertificate(CertificateName name)
Returns a Certificate.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CertificateName name =
CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]", "[CERTIFICATE]");
Certificate response = certificateAuthorityServiceClient.getCertificate(name);
}
Parameter | |
---|---|
Name | Description |
name |
CertificateName Required. The name of the Certificate to get. |
Returns | |
---|---|
Type | Description |
Certificate |
getCertificate(GetCertificateRequest request)
public final Certificate getCertificate(GetCertificateRequest request)
Returns a Certificate.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
GetCertificateRequest request =
GetCertificateRequest.newBuilder()
.setName(
CertificateName.of(
"[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]", "[CERTIFICATE]")
.toString())
.build();
Certificate response = certificateAuthorityServiceClient.getCertificate(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetCertificateRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Certificate |
getCertificate(String name)
public final Certificate getCertificate(String name)
Returns a Certificate.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
String name =
CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]", "[CERTIFICATE]")
.toString();
Certificate response = certificateAuthorityServiceClient.getCertificate(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the Certificate to get. |
Returns | |
---|---|
Type | Description |
Certificate |
getCertificateAuthority(CertificateAuthorityName name)
public final CertificateAuthority getCertificateAuthority(CertificateAuthorityName name)
Returns a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CertificateAuthorityName name =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]");
CertificateAuthority response =
certificateAuthorityServiceClient.getCertificateAuthority(name);
}
Parameter | |
---|---|
Name | Description |
name |
CertificateAuthorityName Required. The name of the CertificateAuthority to get. |
Returns | |
---|---|
Type | Description |
CertificateAuthority |
getCertificateAuthority(GetCertificateAuthorityRequest request)
public final CertificateAuthority getCertificateAuthority(GetCertificateAuthorityRequest request)
Returns a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
GetCertificateAuthorityRequest request =
GetCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.build();
CertificateAuthority response =
certificateAuthorityServiceClient.getCertificateAuthority(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetCertificateAuthorityRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
CertificateAuthority |
getCertificateAuthority(String name)
public final CertificateAuthority getCertificateAuthority(String name)
Returns a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
String name =
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString();
CertificateAuthority response =
certificateAuthorityServiceClient.getCertificateAuthority(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the CertificateAuthority to get. |
Returns | |
---|---|
Type | Description |
CertificateAuthority |
getCertificateAuthorityCallable()
public final UnaryCallable<GetCertificateAuthorityRequest,CertificateAuthority> getCertificateAuthorityCallable()
Returns a CertificateAuthority.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
GetCertificateAuthorityRequest request =
GetCertificateAuthorityRequest.newBuilder()
.setName(
CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]")
.toString())
.build();
ApiFuture<CertificateAuthority> future =
certificateAuthorityServiceClient.getCertificateAuthorityCallable().futureCall(request);
// Do something.
CertificateAuthority response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetCertificateAuthorityRequest,CertificateAuthority> |
getCertificateCallable()
public final UnaryCallable<GetCertificateRequest,Certificate> getCertificateCallable()
Returns a Certificate.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
GetCertificateRequest request =
GetCertificateRequest.newBuilder()
.setName(
CertificateName.of(
"[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]", "[CERTIFICATE]")
.toString())
.build();
ApiFuture<Certificate> future =
certificateAuthorityServiceClient.getCertificateCallable().futureCall(request);
// Do something.
Certificate response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetCertificateRequest,Certificate> |
getCertificateRevocationList(CertificateRevocationListName name)
public final CertificateRevocationList getCertificateRevocationList(CertificateRevocationListName name)
Returns a CertificateRevocationList.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
CertificateRevocationListName name =
CertificateRevocationListName.of(
"[PROJECT]",
"[LOCATION]",
"[CERTIFICATE_AUTHORITY]",
"[CERTIFICATE_REVOCATION_LIST]");
CertificateRevocationList response =
certificateAuthorityServiceClient.getCertificateRevocationList(name);
}
Parameter | |
---|---|
Name | Description |
name |
CertificateRevocationListName Required. The name of the CertificateRevocationList to get. |
Returns | |
---|---|
Type | Description |
CertificateRevocationList |
getCertificateRevocationList(GetCertificateRevocationListRequest request)
public final CertificateRevocationList getCertificateRevocationList(GetCertificateRevocationListRequest request)
Returns a CertificateRevocationList.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
GetCertificateRevocationListRequest request =
GetCertificateRevocationListRequest.newBuilder()
.setName(
CertificateRevocationListName.of(
"[PROJECT]",
"[LOCATION]",
"[CERTIFICATE_AUTHORITY]",
"[CERTIFICATE_REVOCATION_LIST]")
.toString())
.build();
CertificateRevocationList response =
certificateAuthorityServiceClient.getCertificateRevocationList(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetCertificateRevocationListRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
CertificateRevocationList |
getCertificateRevocationList(String name)
public final CertificateRevocationList getCertificateRevocationList(String name)
Returns a CertificateRevocationList.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
String name =
CertificateRevocationListName.of(
"[PROJECT]",
"[LOCATION]",
"[CERTIFICATE_AUTHORITY]",
"[CERTIFICATE_REVOCATION_LIST]")
.toString();
CertificateRevocationList response =
certificateAuthorityServiceClient.getCertificateRevocationList(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the CertificateRevocationList to get. |
Returns | |
---|---|
Type | Description |
CertificateRevocationList |
getCertificateRevocationListCallable()
public final UnaryCallable<GetCertificateRevocationListRequest,CertificateRevocationList> getCertificateRevocationListCallable()
Returns a CertificateRevocationList.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
GetCertificateRevocationListRequest request =
GetCertificateRevocationListRequest.newBuilder()
.setName(
CertificateRevocationListName.of(
"[PROJECT]",
"[LOCATION]",
"[CERTIFICATE_AUTHORITY]",
"[CERTIFICATE_REVOCATION_LIST]")
.toString())
.build();
ApiFuture<CertificateRevocationList> future =
certificateAuthorityServiceClient
.getCertificateRevocationListCallable()
.futureCall(request);
// Do something.
CertificateRevocationList response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetCertificateRevocationListRequest,CertificateRevocationList> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getReusableConfig(GetReusableConfigRequest request)
public final ReusableConfig getReusableConfig(GetReusableConfigRequest request)
Returns a ReusableConfig.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
GetReusableConfigRequest request =
GetReusableConfigRequest.newBuilder()
.setName(
ReusableConfigName.of("[PROJECT]", "[LOCATION]", "[REUSABLE_CONFIG]").toString())
.build();
ReusableConfig response = certificateAuthorityServiceClient.getReusableConfig(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetReusableConfigRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ReusableConfig |
getReusableConfig(ReusableConfigName name)
public final ReusableConfig getReusableConfig(ReusableConfigName name)
Returns a ReusableConfig.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
ReusableConfigName name =
ReusableConfigName.of("[PROJECT]", "[LOCATION]", "[REUSABLE_CONFIG]");
ReusableConfig response = certificateAuthorityServiceClient.getReusableConfig(name);
}
Parameter | |
---|---|
Name | Description |
name |
ReusableConfigName Required. The name of the [ReusableConfigs][] to get. |
Returns | |
---|---|
Type | Description |
ReusableConfig |
getReusableConfig(String name)
public final ReusableConfig getReusableConfig(String name)
Returns a ReusableConfig.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
String name =
ReusableConfigName.of("[PROJECT]", "[LOCATION]", "[REUSABLE_CONFIG]").toString();
ReusableConfig response = certificateAuthorityServiceClient.getReusableConfig(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the [ReusableConfigs][] to get. |
Returns | |
---|---|
Type | Description |
ReusableConfig |
getReusableConfigCallable()
public final UnaryCallable<GetReusableConfigRequest,ReusableConfig> getReusableConfigCallable()
Returns a ReusableConfig.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
GetReusableConfigRequest request =
GetReusableConfigRequest.newBuilder()
.setName(
ReusableConfigName.of("[PROJECT]", "[LOCATION]", "[REUSABLE_CONFIG]").toString())
.build();
ApiFuture<ReusableConfig> future =
certificateAuthorityServiceClient.getReusableConfigCallable().futureCall(request);
// Do something.
ReusableConfig response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetReusableConfigRequest,ReusableConfig> |
getSettings()
public final CertificateAuthorityServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
CertificateAuthorityServiceSettings |
getStub()
public CertificateAuthorityServiceStub getStub()
Returns | |
---|---|
Type | Description |
CertificateAuthorityServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listCertificateAuthorities(ListCertificateAuthoritiesRequest request)
public final CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse listCertificateAuthorities(ListCertificateAuthoritiesRequest request)
Lists CertificateAuthorities.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
ListCertificateAuthoritiesRequest request =
ListCertificateAuthoritiesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (CertificateAuthority element :
certificateAuthorityServiceClient.listCertificateAuthorities(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListCertificateAuthoritiesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse |
listCertificateAuthorities(LocationName parent)
public final CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse listCertificateAuthorities(LocationName parent)
Lists CertificateAuthorities.
Sample code:
// 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
try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
CertificateAuthorityServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (CertificateAuthority element :
certificateAuthorityServiceClient.listCertificateAuthorities(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
LocationName Required. The resource name of the location associated with the
CertificateAuthorities, in
the format |
Returns | |
---|---|
Type | Description |
CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse |