Class CertificateManagerClient (0.3.1)

public class CertificateManagerClient implements BackgroundResource

Service Description: API Overview

Certificates Manager API allows customers to see and manage all their TLS certificates.

Certificates Manager API service provides methods to manage certificates, group them into collections, and create serving configuration that can be easily applied to other Cloud resources e.g. Target Proxies.

Data Model

The Certificates Manager service exposes the following resources:

  • Certificate which describes a single TLS certificate.
  • CertificateMap which describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry which describes a single configuration entry that consists of a SNI and a group of certificates. It's a subresource of CertificateMap.

Certificate, CertificateMap and CertificateMapEntry IDs have to match "^[a-z0-9-]{1,63}$" regexp, which means that - only lower case letters, digits, and hyphen are allowed - length of the resource ID has to be in [1,63] range.

Provides methods to manage Cloud Certificate Manager entities.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateName name = CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]");
   Certificate response = certificateManagerClient.getCertificate(name);
 }
 

Note: close() needs to be called on the CertificateManagerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns 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 CertificateManagerSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 CertificateManagerSettings certificateManagerSettings =
     CertificateManagerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CertificateManagerClient certificateManagerClient =
     CertificateManagerClient.create(certificateManagerSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 CertificateManagerSettings certificateManagerSettings =
     CertificateManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
 CertificateManagerClient certificateManagerClient =
     CertificateManagerClient.create(certificateManagerSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > CertificateManagerClient

Implements

BackgroundResource

Static Methods

create()

public static final CertificateManagerClient create()

Constructs an instance of CertificateManagerClient with default settings.

Returns
Type Description
CertificateManagerClient
Exceptions
Type Description
IOException

create(CertificateManagerSettings settings)

public static final CertificateManagerClient create(CertificateManagerSettings settings)

Constructs an instance of CertificateManagerClient, 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 CertificateManagerSettings
Returns
Type Description
CertificateManagerClient
Exceptions
Type Description
IOException

create(CertificateManagerStub stub)

public static final CertificateManagerClient create(CertificateManagerStub stub)

Constructs an instance of CertificateManagerClient, using the given stub for making calls. This is for advanced usage - prefer using create(CertificateManagerSettings).

Parameter
Name Description
stub CertificateManagerStub
Returns
Type Description
CertificateManagerClient

Constructors

CertificateManagerClient(CertificateManagerSettings settings)

protected CertificateManagerClient(CertificateManagerSettings settings)

Constructs an instance of CertificateManagerClient, 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 CertificateManagerSettings

CertificateManagerClient(CertificateManagerStub stub)

protected CertificateManagerClient(CertificateManagerStub stub)
Parameter
Name Description
stub CertificateManagerStub

Methods

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()

createCertificateAsync(CreateCertificateRequest request)

public final OperationFuture<Certificate,OperationMetadata> createCertificateAsync(CreateCertificateRequest request)

Creates a new Certificate in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateCertificateRequest request =
       CreateCertificateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCertificateId("certificateId-644529902")
           .setCertificate(Certificate.newBuilder().build())
           .build();
   Certificate response = certificateManagerClient.createCertificateAsync(request).get();
 }
 
Parameter
Name Description
request CreateCertificateRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Certificate,OperationMetadata>

createCertificateAsync(LocationName parent, Certificate certificate, String certificateId)

public final OperationFuture<Certificate,OperationMetadata> createCertificateAsync(LocationName parent, Certificate certificate, String certificateId)

Creates a new Certificate in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Certificate certificate = Certificate.newBuilder().build();
   String certificateId = "certificateId-644529902";
   Certificate response =
       certificateManagerClient.createCertificateAsync(parent, certificate, certificateId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. The parent resource of the certificate. Must be in the format projects/*/locations/*.

certificate Certificate

Required. A definition of the certificate to create.

certificateId String

Required. A user-provided name of the certificate.

Returns
Type Description
OperationFuture<Certificate,OperationMetadata>

createCertificateAsync(String parent, Certificate certificate, String certificateId)

public final OperationFuture<Certificate,OperationMetadata> createCertificateAsync(String parent, Certificate certificate, String certificateId)

Creates a new Certificate in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Certificate certificate = Certificate.newBuilder().build();
   String certificateId = "certificateId-644529902";
   Certificate response =
       certificateManagerClient.createCertificateAsync(parent, certificate, certificateId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent resource of the certificate. Must be in the format projects/*/locations/*.

certificate Certificate

Required. A definition of the certificate to create.

certificateId String

Required. A user-provided name of the certificate.

Returns
Type Description
OperationFuture<Certificate,OperationMetadata>

createCertificateCallable()

public final UnaryCallable<CreateCertificateRequest,Operation> createCertificateCallable()

Creates a new Certificate in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateCertificateRequest request =
       CreateCertificateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCertificateId("certificateId-644529902")
           .setCertificate(Certificate.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.createCertificateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateCertificateRequest,Operation>

createCertificateMapAsync(CreateCertificateMapRequest request)

public final OperationFuture<CertificateMap,OperationMetadata> createCertificateMapAsync(CreateCertificateMapRequest request)

Creates a new CertificateMap in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateCertificateMapRequest request =
       CreateCertificateMapRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCertificateMapId("certificateMapId1612184640")
           .setCertificateMap(CertificateMap.newBuilder().build())
           .build();
   CertificateMap response = certificateManagerClient.createCertificateMapAsync(request).get();
 }
 
Parameter
Name Description
request CreateCertificateMapRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<CertificateMap,OperationMetadata>

createCertificateMapAsync(LocationName parent, CertificateMap certificateMap, String certificateMapId)

public final OperationFuture<CertificateMap,OperationMetadata> createCertificateMapAsync(LocationName parent, CertificateMap certificateMap, String certificateMapId)

Creates a new CertificateMap in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   CertificateMap certificateMap = CertificateMap.newBuilder().build();
   String certificateMapId = "certificateMapId1612184640";
   CertificateMap response =
       certificateManagerClient
           .createCertificateMapAsync(parent, certificateMap, certificateMapId)
           .get();
 }
 
Parameters
Name Description
parent LocationName

Required. The parent resource of the certificate map. Must be in the format projects/*/locations/*.

certificateMap CertificateMap

Required. A definition of the certificate map to create.

certificateMapId String

Required. A user-provided name of the certificate map.

Returns
Type Description
OperationFuture<CertificateMap,OperationMetadata>

createCertificateMapAsync(String parent, CertificateMap certificateMap, String certificateMapId)

public final OperationFuture<CertificateMap,OperationMetadata> createCertificateMapAsync(String parent, CertificateMap certificateMap, String certificateMapId)

Creates a new CertificateMap in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   CertificateMap certificateMap = CertificateMap.newBuilder().build();
   String certificateMapId = "certificateMapId1612184640";
   CertificateMap response =
       certificateManagerClient
           .createCertificateMapAsync(parent, certificateMap, certificateMapId)
           .get();
 }
 
Parameters
Name Description
parent String

Required. The parent resource of the certificate map. Must be in the format projects/*/locations/*.

certificateMap CertificateMap

Required. A definition of the certificate map to create.

certificateMapId String

Required. A user-provided name of the certificate map.

Returns
Type Description
OperationFuture<CertificateMap,OperationMetadata>

createCertificateMapCallable()

public final UnaryCallable<CreateCertificateMapRequest,Operation> createCertificateMapCallable()

Creates a new CertificateMap in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateCertificateMapRequest request =
       CreateCertificateMapRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCertificateMapId("certificateMapId1612184640")
           .setCertificateMap(CertificateMap.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.createCertificateMapCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateCertificateMapRequest,Operation>

createCertificateMapEntryAsync(CertificateMapName parent, CertificateMapEntry certificateMapEntry, String certificateMapEntryId)

public final OperationFuture<CertificateMapEntry,OperationMetadata> createCertificateMapEntryAsync(CertificateMapName parent, CertificateMapEntry certificateMapEntry, String certificateMapEntryId)

Creates a new CertificateMapEntry in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateMapName parent =
       CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]");
   CertificateMapEntry certificateMapEntry = CertificateMapEntry.newBuilder().build();
   String certificateMapEntryId = "certificateMapEntryId-859079384";
   CertificateMapEntry response =
       certificateManagerClient
           .createCertificateMapEntryAsync(parent, certificateMapEntry, certificateMapEntryId)
           .get();
 }
 
Parameters
Name Description
parent CertificateMapName

Required. The parent resource of the certificate map entry. Must be in the format projects/*/locations/*/certificateMaps/*.

certificateMapEntry CertificateMapEntry

Required. A definition of the certificate map entry to create.

certificateMapEntryId String

Required. A user-provided name of the certificate map entry.

Returns
Type Description
OperationFuture<CertificateMapEntry,OperationMetadata>

createCertificateMapEntryAsync(CreateCertificateMapEntryRequest request)

public final OperationFuture<CertificateMapEntry,OperationMetadata> createCertificateMapEntryAsync(CreateCertificateMapEntryRequest request)

Creates a new CertificateMapEntry in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateCertificateMapEntryRequest request =
       CreateCertificateMapEntryRequest.newBuilder()
           .setParent(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .setCertificateMapEntryId("certificateMapEntryId-859079384")
           .setCertificateMapEntry(CertificateMapEntry.newBuilder().build())
           .build();
   CertificateMapEntry response =
       certificateManagerClient.createCertificateMapEntryAsync(request).get();
 }
 
Parameter
Name Description
request CreateCertificateMapEntryRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<CertificateMapEntry,OperationMetadata>

createCertificateMapEntryAsync(String parent, CertificateMapEntry certificateMapEntry, String certificateMapEntryId)

public final OperationFuture<CertificateMapEntry,OperationMetadata> createCertificateMapEntryAsync(String parent, CertificateMapEntry certificateMapEntry, String certificateMapEntryId)

Creates a new CertificateMapEntry in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String parent =
       CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString();
   CertificateMapEntry certificateMapEntry = CertificateMapEntry.newBuilder().build();
   String certificateMapEntryId = "certificateMapEntryId-859079384";
   CertificateMapEntry response =
       certificateManagerClient
           .createCertificateMapEntryAsync(parent, certificateMapEntry, certificateMapEntryId)
           .get();
 }
 
Parameters
Name Description
parent String

Required. The parent resource of the certificate map entry. Must be in the format projects/*/locations/*/certificateMaps/*.

certificateMapEntry CertificateMapEntry

Required. A definition of the certificate map entry to create.

certificateMapEntryId String

Required. A user-provided name of the certificate map entry.

Returns
Type Description
OperationFuture<CertificateMapEntry,OperationMetadata>

createCertificateMapEntryCallable()

public final UnaryCallable<CreateCertificateMapEntryRequest,Operation> createCertificateMapEntryCallable()

Creates a new CertificateMapEntry in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateCertificateMapEntryRequest request =
       CreateCertificateMapEntryRequest.newBuilder()
           .setParent(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .setCertificateMapEntryId("certificateMapEntryId-859079384")
           .setCertificateMapEntry(CertificateMapEntry.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.createCertificateMapEntryCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateCertificateMapEntryRequest,Operation>

createCertificateMapEntryOperationCallable()

public final OperationCallable<CreateCertificateMapEntryRequest,CertificateMapEntry,OperationMetadata> createCertificateMapEntryOperationCallable()

Creates a new CertificateMapEntry in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateCertificateMapEntryRequest request =
       CreateCertificateMapEntryRequest.newBuilder()
           .setParent(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .setCertificateMapEntryId("certificateMapEntryId-859079384")
           .setCertificateMapEntry(CertificateMapEntry.newBuilder().build())
           .build();
   OperationFuture<CertificateMapEntry, OperationMetadata> future =
       certificateManagerClient.createCertificateMapEntryOperationCallable().futureCall(request);
   // Do something.
   CertificateMapEntry response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateCertificateMapEntryRequest,CertificateMapEntry,OperationMetadata>

createCertificateMapOperationCallable()

public final OperationCallable<CreateCertificateMapRequest,CertificateMap,OperationMetadata> createCertificateMapOperationCallable()

Creates a new CertificateMap in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateCertificateMapRequest request =
       CreateCertificateMapRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCertificateMapId("certificateMapId1612184640")
           .setCertificateMap(CertificateMap.newBuilder().build())
           .build();
   OperationFuture<CertificateMap, OperationMetadata> future =
       certificateManagerClient.createCertificateMapOperationCallable().futureCall(request);
   // Do something.
   CertificateMap response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateCertificateMapRequest,CertificateMap,OperationMetadata>

createCertificateOperationCallable()

public final OperationCallable<CreateCertificateRequest,Certificate,OperationMetadata> createCertificateOperationCallable()

Creates a new Certificate in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateCertificateRequest request =
       CreateCertificateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCertificateId("certificateId-644529902")
           .setCertificate(Certificate.newBuilder().build())
           .build();
   OperationFuture<Certificate, OperationMetadata> future =
       certificateManagerClient.createCertificateOperationCallable().futureCall(request);
   // Do something.
   Certificate response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateCertificateRequest,Certificate,OperationMetadata>

createDnsAuthorizationAsync(CreateDnsAuthorizationRequest request)

public final OperationFuture<DnsAuthorization,OperationMetadata> createDnsAuthorizationAsync(CreateDnsAuthorizationRequest request)

Creates a new DnsAuthorization in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateDnsAuthorizationRequest request =
       CreateDnsAuthorizationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDnsAuthorizationId("dnsAuthorizationId-2054763765")
           .setDnsAuthorization(DnsAuthorization.newBuilder().build())
           .build();
   DnsAuthorization response =
       certificateManagerClient.createDnsAuthorizationAsync(request).get();
 }
 
Parameter
Name Description
request CreateDnsAuthorizationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<DnsAuthorization,OperationMetadata>

createDnsAuthorizationAsync(LocationName parent, DnsAuthorization dnsAuthorization, String dnsAuthorizationId)

public final OperationFuture<DnsAuthorization,OperationMetadata> createDnsAuthorizationAsync(LocationName parent, DnsAuthorization dnsAuthorization, String dnsAuthorizationId)

Creates a new DnsAuthorization in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DnsAuthorization dnsAuthorization = DnsAuthorization.newBuilder().build();
   String dnsAuthorizationId = "dnsAuthorizationId-2054763765";
   DnsAuthorization response =
       certificateManagerClient
           .createDnsAuthorizationAsync(parent, dnsAuthorization, dnsAuthorizationId)
           .get();
 }
 
Parameters
Name Description
parent LocationName

Required. The parent resource of the dns authorization. Must be in the format projects/*/locations/*.

dnsAuthorization DnsAuthorization

Required. A definition of the dns authorization to create.

dnsAuthorizationId String

Required. A user-provided name of the dns authorization.

Returns
Type Description
OperationFuture<DnsAuthorization,OperationMetadata>

createDnsAuthorizationAsync(String parent, DnsAuthorization dnsAuthorization, String dnsAuthorizationId)

public final OperationFuture<DnsAuthorization,OperationMetadata> createDnsAuthorizationAsync(String parent, DnsAuthorization dnsAuthorization, String dnsAuthorizationId)

Creates a new DnsAuthorization in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   DnsAuthorization dnsAuthorization = DnsAuthorization.newBuilder().build();
   String dnsAuthorizationId = "dnsAuthorizationId-2054763765";
   DnsAuthorization response =
       certificateManagerClient
           .createDnsAuthorizationAsync(parent, dnsAuthorization, dnsAuthorizationId)
           .get();
 }
 
Parameters
Name Description
parent String

Required. The parent resource of the dns authorization. Must be in the format projects/*/locations/*.

dnsAuthorization DnsAuthorization

Required. A definition of the dns authorization to create.

dnsAuthorizationId String

Required. A user-provided name of the dns authorization.

Returns
Type Description
OperationFuture<DnsAuthorization,OperationMetadata>

createDnsAuthorizationCallable()

public final UnaryCallable<CreateDnsAuthorizationRequest,Operation> createDnsAuthorizationCallable()

Creates a new DnsAuthorization in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateDnsAuthorizationRequest request =
       CreateDnsAuthorizationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDnsAuthorizationId("dnsAuthorizationId-2054763765")
           .setDnsAuthorization(DnsAuthorization.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.createDnsAuthorizationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateDnsAuthorizationRequest,Operation>

createDnsAuthorizationOperationCallable()

public final OperationCallable<CreateDnsAuthorizationRequest,DnsAuthorization,OperationMetadata> createDnsAuthorizationOperationCallable()

Creates a new DnsAuthorization in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CreateDnsAuthorizationRequest request =
       CreateDnsAuthorizationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDnsAuthorizationId("dnsAuthorizationId-2054763765")
           .setDnsAuthorization(DnsAuthorization.newBuilder().build())
           .build();
   OperationFuture<DnsAuthorization, OperationMetadata> future =
       certificateManagerClient.createDnsAuthorizationOperationCallable().futureCall(request);
   // Do something.
   DnsAuthorization response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateDnsAuthorizationRequest,DnsAuthorization,OperationMetadata>

deleteCertificateAsync(CertificateName name)

public final OperationFuture<Empty,OperationMetadata> deleteCertificateAsync(CertificateName name)

Deletes a single Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateName name = CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]");
   certificateManagerClient.deleteCertificateAsync(name).get();
 }
 
Parameter
Name Description
name CertificateName

Required. A name of the certificate to delete. Must be in the format projects/*/locations/*/certificates/*.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteCertificateAsync(DeleteCertificateRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteCertificateAsync(DeleteCertificateRequest request)

Deletes a single Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteCertificateRequest request =
       DeleteCertificateRequest.newBuilder()
           .setName(CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]").toString())
           .build();
   certificateManagerClient.deleteCertificateAsync(request).get();
 }
 
Parameter
Name Description
request DeleteCertificateRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteCertificateAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteCertificateAsync(String name)

Deletes a single Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String name = CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]").toString();
   certificateManagerClient.deleteCertificateAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. A name of the certificate to delete. Must be in the format projects/*/locations/*/certificates/*.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteCertificateCallable()

public final UnaryCallable<DeleteCertificateRequest,Operation> deleteCertificateCallable()

Deletes a single Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteCertificateRequest request =
       DeleteCertificateRequest.newBuilder()
           .setName(CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]").toString())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.deleteCertificateCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteCertificateRequest,Operation>

deleteCertificateMapAsync(CertificateMapName name)

public final OperationFuture<Empty,OperationMetadata> deleteCertificateMapAsync(CertificateMapName name)

Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateMapName name =
       CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]");
   certificateManagerClient.deleteCertificateMapAsync(name).get();
 }
 
Parameter
Name Description
name CertificateMapName

Required. A name of the certificate map to delete. Must be in the format projects/*/locations/*/certificateMaps/*.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteCertificateMapAsync(DeleteCertificateMapRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteCertificateMapAsync(DeleteCertificateMapRequest request)

Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteCertificateMapRequest request =
       DeleteCertificateMapRequest.newBuilder()
           .setName(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .build();
   certificateManagerClient.deleteCertificateMapAsync(request).get();
 }
 
Parameter
Name Description
request DeleteCertificateMapRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteCertificateMapAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteCertificateMapAsync(String name)

Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String name =
       CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString();
   certificateManagerClient.deleteCertificateMapAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. A name of the certificate map to delete. Must be in the format projects/*/locations/*/certificateMaps/*.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteCertificateMapCallable()

public final UnaryCallable<DeleteCertificateMapRequest,Operation> deleteCertificateMapCallable()

Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteCertificateMapRequest request =
       DeleteCertificateMapRequest.newBuilder()
           .setName(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.deleteCertificateMapCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteCertificateMapRequest,Operation>

deleteCertificateMapEntryAsync(CertificateMapEntryName name)

public final OperationFuture<Empty,OperationMetadata> deleteCertificateMapEntryAsync(CertificateMapEntryName name)

Deletes a single CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateMapEntryName name =
       CertificateMapEntryName.of(
           "[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]", "[CERTIFICATE_MAP_ENTRY]");
   certificateManagerClient.deleteCertificateMapEntryAsync(name).get();
 }
 
Parameter
Name Description
name CertificateMapEntryName

Required. A name of the certificate map entry to delete. Must be in the format projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteCertificateMapEntryAsync(DeleteCertificateMapEntryRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteCertificateMapEntryAsync(DeleteCertificateMapEntryRequest request)

Deletes a single CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteCertificateMapEntryRequest request =
       DeleteCertificateMapEntryRequest.newBuilder()
           .setName(
               CertificateMapEntryName.of(
                       "[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]", "[CERTIFICATE_MAP_ENTRY]")
                   .toString())
           .build();
   certificateManagerClient.deleteCertificateMapEntryAsync(request).get();
 }
 
Parameter
Name Description
request DeleteCertificateMapEntryRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteCertificateMapEntryAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteCertificateMapEntryAsync(String name)

Deletes a single CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String name =
       CertificateMapEntryName.of(
               "[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]", "[CERTIFICATE_MAP_ENTRY]")
           .toString();
   certificateManagerClient.deleteCertificateMapEntryAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. A name of the certificate map entry to delete. Must be in the format projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteCertificateMapEntryCallable()

public final UnaryCallable<DeleteCertificateMapEntryRequest,Operation> deleteCertificateMapEntryCallable()

Deletes a single CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteCertificateMapEntryRequest request =
       DeleteCertificateMapEntryRequest.newBuilder()
           .setName(
               CertificateMapEntryName.of(
                       "[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]", "[CERTIFICATE_MAP_ENTRY]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.deleteCertificateMapEntryCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteCertificateMapEntryRequest,Operation>

deleteCertificateMapEntryOperationCallable()

public final OperationCallable<DeleteCertificateMapEntryRequest,Empty,OperationMetadata> deleteCertificateMapEntryOperationCallable()

Deletes a single CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteCertificateMapEntryRequest request =
       DeleteCertificateMapEntryRequest.newBuilder()
           .setName(
               CertificateMapEntryName.of(
                       "[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]", "[CERTIFICATE_MAP_ENTRY]")
                   .toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       certificateManagerClient.deleteCertificateMapEntryOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteCertificateMapEntryRequest,Empty,OperationMetadata>

deleteCertificateMapOperationCallable()

public final OperationCallable<DeleteCertificateMapRequest,Empty,OperationMetadata> deleteCertificateMapOperationCallable()

Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteCertificateMapRequest request =
       DeleteCertificateMapRequest.newBuilder()
           .setName(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       certificateManagerClient.deleteCertificateMapOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteCertificateMapRequest,Empty,OperationMetadata>

deleteCertificateOperationCallable()

public final OperationCallable<DeleteCertificateRequest,Empty,OperationMetadata> deleteCertificateOperationCallable()

Deletes a single Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteCertificateRequest request =
       DeleteCertificateRequest.newBuilder()
           .setName(CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       certificateManagerClient.deleteCertificateOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteCertificateRequest,Empty,OperationMetadata>

deleteDnsAuthorizationAsync(DeleteDnsAuthorizationRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteDnsAuthorizationAsync(DeleteDnsAuthorizationRequest request)

Deletes a single DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteDnsAuthorizationRequest request =
       DeleteDnsAuthorizationRequest.newBuilder()
           .setName(
               DnsAuthorizationName.of("[PROJECT]", "[LOCATION]", "[DNS_AUTHORIZATION]")
                   .toString())
           .build();
   certificateManagerClient.deleteDnsAuthorizationAsync(request).get();
 }
 
Parameter
Name Description
request DeleteDnsAuthorizationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDnsAuthorizationAsync(DnsAuthorizationName name)

public final OperationFuture<Empty,OperationMetadata> deleteDnsAuthorizationAsync(DnsAuthorizationName name)

Deletes a single DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DnsAuthorizationName name =
       DnsAuthorizationName.of("[PROJECT]", "[LOCATION]", "[DNS_AUTHORIZATION]");
   certificateManagerClient.deleteDnsAuthorizationAsync(name).get();
 }
 
Parameter
Name Description
name DnsAuthorizationName

Required. A name of the dns authorization to delete. Must be in the format projects/*/locations/*/dnsAuthorizations/*.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDnsAuthorizationAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteDnsAuthorizationAsync(String name)

Deletes a single DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String name =
       DnsAuthorizationName.of("[PROJECT]", "[LOCATION]", "[DNS_AUTHORIZATION]").toString();
   certificateManagerClient.deleteDnsAuthorizationAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. A name of the dns authorization to delete. Must be in the format projects/*/locations/*/dnsAuthorizations/*.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDnsAuthorizationCallable()

public final UnaryCallable<DeleteDnsAuthorizationRequest,Operation> deleteDnsAuthorizationCallable()

Deletes a single DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteDnsAuthorizationRequest request =
       DeleteDnsAuthorizationRequest.newBuilder()
           .setName(
               DnsAuthorizationName.of("[PROJECT]", "[LOCATION]", "[DNS_AUTHORIZATION]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.deleteDnsAuthorizationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteDnsAuthorizationRequest,Operation>

deleteDnsAuthorizationOperationCallable()

public final OperationCallable<DeleteDnsAuthorizationRequest,Empty,OperationMetadata> deleteDnsAuthorizationOperationCallable()

Deletes a single DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DeleteDnsAuthorizationRequest request =
       DeleteDnsAuthorizationRequest.newBuilder()
           .setName(
               DnsAuthorizationName.of("[PROJECT]", "[LOCATION]", "[DNS_AUTHORIZATION]")
                   .toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       certificateManagerClient.deleteDnsAuthorizationOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteDnsAuthorizationRequest,Empty,OperationMetadata>

getCertificate(CertificateName name)

public final Certificate getCertificate(CertificateName name)

Gets details of a single Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateName name = CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]");
   Certificate response = certificateManagerClient.getCertificate(name);
 }
 
Parameter
Name Description
name CertificateName

Required. A name of the certificate to describe. Must be in the format projects/*/locations/*/certificates/*.

Returns
Type Description
Certificate

getCertificate(GetCertificateRequest request)

public final Certificate getCertificate(GetCertificateRequest request)

Gets details of a single Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   GetCertificateRequest request =
       GetCertificateRequest.newBuilder()
           .setName(CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]").toString())
           .build();
   Certificate response = certificateManagerClient.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)

Gets details of a single Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String name = CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]").toString();
   Certificate response = certificateManagerClient.getCertificate(name);
 }
 
Parameter
Name Description
name String

Required. A name of the certificate to describe. Must be in the format projects/*/locations/*/certificates/*.

Returns
Type Description
Certificate

getCertificateCallable()

public final UnaryCallable<GetCertificateRequest,Certificate> getCertificateCallable()

Gets details of a single Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   GetCertificateRequest request =
       GetCertificateRequest.newBuilder()
           .setName(CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]").toString())
           .build();
   ApiFuture<Certificate> future =
       certificateManagerClient.getCertificateCallable().futureCall(request);
   // Do something.
   Certificate response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetCertificateRequest,Certificate>

getCertificateMap(CertificateMapName name)

public final CertificateMap getCertificateMap(CertificateMapName name)

Gets details of a single CertificateMap.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateMapName name =
       CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]");
   CertificateMap response = certificateManagerClient.getCertificateMap(name);
 }
 
Parameter
Name Description
name CertificateMapName

Required. A name of the certificate map to describe. Must be in the format projects/*/locations/*/certificateMaps/*.

Returns
Type Description
CertificateMap

getCertificateMap(GetCertificateMapRequest request)

public final CertificateMap getCertificateMap(GetCertificateMapRequest request)

Gets details of a single CertificateMap.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   GetCertificateMapRequest request =
       GetCertificateMapRequest.newBuilder()
           .setName(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .build();
   CertificateMap response = certificateManagerClient.getCertificateMap(request);
 }
 
Parameter
Name Description
request GetCertificateMapRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CertificateMap

getCertificateMap(String name)

public final CertificateMap getCertificateMap(String name)

Gets details of a single CertificateMap.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String name =
       CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString();
   CertificateMap response = certificateManagerClient.getCertificateMap(name);
 }
 
Parameter
Name Description
name String

Required. A name of the certificate map to describe. Must be in the format projects/*/locations/*/certificateMaps/*.

Returns
Type Description
CertificateMap

getCertificateMapCallable()

public final UnaryCallable<GetCertificateMapRequest,CertificateMap> getCertificateMapCallable()

Gets details of a single CertificateMap.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   GetCertificateMapRequest request =
       GetCertificateMapRequest.newBuilder()
           .setName(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .build();
   ApiFuture<CertificateMap> future =
       certificateManagerClient.getCertificateMapCallable().futureCall(request);
   // Do something.
   CertificateMap response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetCertificateMapRequest,CertificateMap>

getCertificateMapEntry(CertificateMapEntryName name)

public final CertificateMapEntry getCertificateMapEntry(CertificateMapEntryName name)

Gets details of a single CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateMapEntryName name =
       CertificateMapEntryName.of(
           "[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]", "[CERTIFICATE_MAP_ENTRY]");
   CertificateMapEntry response = certificateManagerClient.getCertificateMapEntry(name);
 }
 
Parameter
Name Description
name CertificateMapEntryName

Required. A name of the certificate map entry to describe. Must be in the format projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.

Returns
Type Description
CertificateMapEntry

getCertificateMapEntry(GetCertificateMapEntryRequest request)

public final CertificateMapEntry getCertificateMapEntry(GetCertificateMapEntryRequest request)

Gets details of a single CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   GetCertificateMapEntryRequest request =
       GetCertificateMapEntryRequest.newBuilder()
           .setName(
               CertificateMapEntryName.of(
                       "[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]", "[CERTIFICATE_MAP_ENTRY]")
                   .toString())
           .build();
   CertificateMapEntry response = certificateManagerClient.getCertificateMapEntry(request);
 }
 
Parameter
Name Description
request GetCertificateMapEntryRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CertificateMapEntry

getCertificateMapEntry(String name)

public final CertificateMapEntry getCertificateMapEntry(String name)

Gets details of a single CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String name =
       CertificateMapEntryName.of(
               "[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]", "[CERTIFICATE_MAP_ENTRY]")
           .toString();
   CertificateMapEntry response = certificateManagerClient.getCertificateMapEntry(name);
 }
 
Parameter
Name Description
name String

Required. A name of the certificate map entry to describe. Must be in the format projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.

Returns
Type Description
CertificateMapEntry

getCertificateMapEntryCallable()

public final UnaryCallable<GetCertificateMapEntryRequest,CertificateMapEntry> getCertificateMapEntryCallable()

Gets details of a single CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   GetCertificateMapEntryRequest request =
       GetCertificateMapEntryRequest.newBuilder()
           .setName(
               CertificateMapEntryName.of(
                       "[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]", "[CERTIFICATE_MAP_ENTRY]")
                   .toString())
           .build();
   ApiFuture<CertificateMapEntry> future =
       certificateManagerClient.getCertificateMapEntryCallable().futureCall(request);
   // Do something.
   CertificateMapEntry response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetCertificateMapEntryRequest,CertificateMapEntry>

getDnsAuthorization(DnsAuthorizationName name)

public final DnsAuthorization getDnsAuthorization(DnsAuthorizationName name)

Gets details of a single DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DnsAuthorizationName name =
       DnsAuthorizationName.of("[PROJECT]", "[LOCATION]", "[DNS_AUTHORIZATION]");
   DnsAuthorization response = certificateManagerClient.getDnsAuthorization(name);
 }
 
Parameter
Name Description
name DnsAuthorizationName

Required. A name of the dns authorization to describe. Must be in the format projects/*/locations/*/dnsAuthorizations/*.

Returns
Type Description
DnsAuthorization

getDnsAuthorization(GetDnsAuthorizationRequest request)

public final DnsAuthorization getDnsAuthorization(GetDnsAuthorizationRequest request)

Gets details of a single DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   GetDnsAuthorizationRequest request =
       GetDnsAuthorizationRequest.newBuilder()
           .setName(
               DnsAuthorizationName.of("[PROJECT]", "[LOCATION]", "[DNS_AUTHORIZATION]")
                   .toString())
           .build();
   DnsAuthorization response = certificateManagerClient.getDnsAuthorization(request);
 }
 
Parameter
Name Description
request GetDnsAuthorizationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DnsAuthorization

getDnsAuthorization(String name)

public final DnsAuthorization getDnsAuthorization(String name)

Gets details of a single DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String name =
       DnsAuthorizationName.of("[PROJECT]", "[LOCATION]", "[DNS_AUTHORIZATION]").toString();
   DnsAuthorization response = certificateManagerClient.getDnsAuthorization(name);
 }
 
Parameter
Name Description
name String

Required. A name of the dns authorization to describe. Must be in the format projects/*/locations/*/dnsAuthorizations/*.

Returns
Type Description
DnsAuthorization

getDnsAuthorizationCallable()

public final UnaryCallable<GetDnsAuthorizationRequest,DnsAuthorization> getDnsAuthorizationCallable()

Gets details of a single DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   GetDnsAuthorizationRequest request =
       GetDnsAuthorizationRequest.newBuilder()
           .setName(
               DnsAuthorizationName.of("[PROJECT]", "[LOCATION]", "[DNS_AUTHORIZATION]")
                   .toString())
           .build();
   ApiFuture<DnsAuthorization> future =
       certificateManagerClient.getDnsAuthorizationCallable().futureCall(request);
   // Do something.
   DnsAuthorization response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetDnsAuthorizationRequest,DnsAuthorization>

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

getSettings()

public final CertificateManagerSettings getSettings()
Returns
Type Description
CertificateManagerSettings

getStub()

public CertificateManagerStub getStub()
Returns
Type Description
CertificateManagerStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listCertificateMapEntries(CertificateMapName parent)

public final CertificateManagerClient.ListCertificateMapEntriesPagedResponse listCertificateMapEntries(CertificateMapName parent)

Lists CertificateMapEntries in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateMapName parent =
       CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]");
   for (CertificateMapEntry element :
       certificateManagerClient.listCertificateMapEntries(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent CertificateMapName

Required. The project, location and certificate map from which the certificate map entries should be listed, specified in the format projects/*/locations/*/certificateMaps/*.

Returns
Type Description
CertificateManagerClient.ListCertificateMapEntriesPagedResponse

listCertificateMapEntries(ListCertificateMapEntriesRequest request)

public final CertificateManagerClient.ListCertificateMapEntriesPagedResponse listCertificateMapEntries(ListCertificateMapEntriesRequest request)

Lists CertificateMapEntries in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListCertificateMapEntriesRequest request =
       ListCertificateMapEntriesRequest.newBuilder()
           .setParent(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (CertificateMapEntry element :
       certificateManagerClient.listCertificateMapEntries(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListCertificateMapEntriesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CertificateManagerClient.ListCertificateMapEntriesPagedResponse

listCertificateMapEntries(String parent)

public final CertificateManagerClient.ListCertificateMapEntriesPagedResponse listCertificateMapEntries(String parent)

Lists CertificateMapEntries in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String parent =
       CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString();
   for (CertificateMapEntry element :
       certificateManagerClient.listCertificateMapEntries(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The project, location and certificate map from which the certificate map entries should be listed, specified in the format projects/*/locations/*/certificateMaps/*.

Returns
Type Description
CertificateManagerClient.ListCertificateMapEntriesPagedResponse

listCertificateMapEntriesCallable()

public final UnaryCallable<ListCertificateMapEntriesRequest,ListCertificateMapEntriesResponse> listCertificateMapEntriesCallable()

Lists CertificateMapEntries in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListCertificateMapEntriesRequest request =
       ListCertificateMapEntriesRequest.newBuilder()
           .setParent(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListCertificateMapEntriesResponse response =
         certificateManagerClient.listCertificateMapEntriesCallable().call(request);
     for (CertificateMapEntry element : response.getCertificateMapEntriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListCertificateMapEntriesRequest,ListCertificateMapEntriesResponse>

listCertificateMapEntriesPagedCallable()

public final UnaryCallable<ListCertificateMapEntriesRequest,CertificateManagerClient.ListCertificateMapEntriesPagedResponse> listCertificateMapEntriesPagedCallable()

Lists CertificateMapEntries in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListCertificateMapEntriesRequest request =
       ListCertificateMapEntriesRequest.newBuilder()
           .setParent(
               CertificateMapName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_MAP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<CertificateMapEntry> future =
       certificateManagerClient.listCertificateMapEntriesPagedCallable().futureCall(request);
   // Do something.
   for (CertificateMapEntry element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListCertificateMapEntriesRequest,ListCertificateMapEntriesPagedResponse>

listCertificateMaps(ListCertificateMapsRequest request)

public final CertificateManagerClient.ListCertificateMapsPagedResponse listCertificateMaps(ListCertificateMapsRequest request)

Lists CertificateMaps in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListCertificateMapsRequest request =
       ListCertificateMapsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (CertificateMap element :
       certificateManagerClient.listCertificateMaps(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListCertificateMapsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CertificateManagerClient.ListCertificateMapsPagedResponse

listCertificateMaps(LocationName parent)

public final CertificateManagerClient.ListCertificateMapsPagedResponse listCertificateMaps(LocationName parent)

Lists CertificateMaps in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (CertificateMap element :
       certificateManagerClient.listCertificateMaps(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The project and location from which the certificate maps should be listed, specified in the format projects/*/locations/*.

Returns
Type Description
CertificateManagerClient.ListCertificateMapsPagedResponse

listCertificateMaps(String parent)

public final CertificateManagerClient.ListCertificateMapsPagedResponse listCertificateMaps(String parent)

Lists CertificateMaps in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (CertificateMap element :
       certificateManagerClient.listCertificateMaps(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The project and location from which the certificate maps should be listed, specified in the format projects/*/locations/*.

Returns
Type Description
CertificateManagerClient.ListCertificateMapsPagedResponse

listCertificateMapsCallable()

public final UnaryCallable<ListCertificateMapsRequest,ListCertificateMapsResponse> listCertificateMapsCallable()

Lists CertificateMaps in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListCertificateMapsRequest request =
       ListCertificateMapsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListCertificateMapsResponse response =
         certificateManagerClient.listCertificateMapsCallable().call(request);
     for (CertificateMap element : response.getCertificateMapsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListCertificateMapsRequest,ListCertificateMapsResponse>

listCertificateMapsPagedCallable()

public final UnaryCallable<ListCertificateMapsRequest,CertificateManagerClient.ListCertificateMapsPagedResponse> listCertificateMapsPagedCallable()

Lists CertificateMaps in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListCertificateMapsRequest request =
       ListCertificateMapsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<CertificateMap> future =
       certificateManagerClient.listCertificateMapsPagedCallable().futureCall(request);
   // Do something.
   for (CertificateMap element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListCertificateMapsRequest,ListCertificateMapsPagedResponse>

listCertificates(ListCertificatesRequest request)

public final CertificateManagerClient.ListCertificatesPagedResponse listCertificates(ListCertificatesRequest request)

Lists Certificates in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListCertificatesRequest request =
       ListCertificatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Certificate element : certificateManagerClient.listCertificates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListCertificatesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CertificateManagerClient.ListCertificatesPagedResponse

listCertificates(LocationName parent)

public final CertificateManagerClient.ListCertificatesPagedResponse listCertificates(LocationName parent)

Lists Certificates in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Certificate element : certificateManagerClient.listCertificates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The project and location from which the certificate should be listed, specified in the format projects/*/locations/*.

Returns
Type Description
CertificateManagerClient.ListCertificatesPagedResponse

listCertificates(String parent)

public final CertificateManagerClient.ListCertificatesPagedResponse listCertificates(String parent)

Lists Certificates in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Certificate element : certificateManagerClient.listCertificates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The project and location from which the certificate should be listed, specified in the format projects/*/locations/*.

Returns
Type Description
CertificateManagerClient.ListCertificatesPagedResponse

listCertificatesCallable()

public final UnaryCallable<ListCertificatesRequest,ListCertificatesResponse> listCertificatesCallable()

Lists Certificates in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListCertificatesRequest request =
       ListCertificatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListCertificatesResponse response =
         certificateManagerClient.listCertificatesCallable().call(request);
     for (Certificate element : response.getCertificatesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListCertificatesRequest,ListCertificatesResponse>

listCertificatesPagedCallable()

public final UnaryCallable<ListCertificatesRequest,CertificateManagerClient.ListCertificatesPagedResponse> listCertificatesPagedCallable()

Lists Certificates in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListCertificatesRequest request =
       ListCertificatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Certificate> future =
       certificateManagerClient.listCertificatesPagedCallable().futureCall(request);
   // Do something.
   for (Certificate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListCertificatesRequest,ListCertificatesPagedResponse>

listDnsAuthorizations(ListDnsAuthorizationsRequest request)

public final CertificateManagerClient.ListDnsAuthorizationsPagedResponse listDnsAuthorizations(ListDnsAuthorizationsRequest request)

Lists DnsAuthorizations in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListDnsAuthorizationsRequest request =
       ListDnsAuthorizationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (DnsAuthorization element :
       certificateManagerClient.listDnsAuthorizations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListDnsAuthorizationsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CertificateManagerClient.ListDnsAuthorizationsPagedResponse

listDnsAuthorizations(LocationName parent)

public final CertificateManagerClient.ListDnsAuthorizationsPagedResponse listDnsAuthorizations(LocationName parent)

Lists DnsAuthorizations in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (DnsAuthorization element :
       certificateManagerClient.listDnsAuthorizations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The project and location from which the dns authorizations should be listed, specified in the format projects/*/locations/*.

Returns
Type Description
CertificateManagerClient.ListDnsAuthorizationsPagedResponse

listDnsAuthorizations(String parent)

public final CertificateManagerClient.ListDnsAuthorizationsPagedResponse listDnsAuthorizations(String parent)

Lists DnsAuthorizations in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (DnsAuthorization element :
       certificateManagerClient.listDnsAuthorizations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The project and location from which the dns authorizations should be listed, specified in the format projects/*/locations/*.

Returns
Type Description
CertificateManagerClient.ListDnsAuthorizationsPagedResponse

listDnsAuthorizationsCallable()

public final UnaryCallable<ListDnsAuthorizationsRequest,ListDnsAuthorizationsResponse> listDnsAuthorizationsCallable()

Lists DnsAuthorizations in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListDnsAuthorizationsRequest request =
       ListDnsAuthorizationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListDnsAuthorizationsResponse response =
         certificateManagerClient.listDnsAuthorizationsCallable().call(request);
     for (DnsAuthorization element : response.getDnsAuthorizationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListDnsAuthorizationsRequest,ListDnsAuthorizationsResponse>

listDnsAuthorizationsPagedCallable()

public final UnaryCallable<ListDnsAuthorizationsRequest,CertificateManagerClient.ListDnsAuthorizationsPagedResponse> listDnsAuthorizationsPagedCallable()

Lists DnsAuthorizations in a given project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   ListDnsAuthorizationsRequest request =
       ListDnsAuthorizationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<DnsAuthorization> future =
       certificateManagerClient.listDnsAuthorizationsPagedCallable().futureCall(request);
   // Do something.
   for (DnsAuthorization element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListDnsAuthorizationsRequest,ListDnsAuthorizationsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateCertificateAsync(Certificate certificate, FieldMask updateMask)

public final OperationFuture<Certificate,OperationMetadata> updateCertificateAsync(Certificate certificate, FieldMask updateMask)

Updates a Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   Certificate certificate = Certificate.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Certificate response =
       certificateManagerClient.updateCertificateAsync(certificate, updateMask).get();
 }
 
Parameters
Name Description
certificate Certificate

Required. A definition of the certificate to update.

updateMask FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

Returns
Type Description
OperationFuture<Certificate,OperationMetadata>

updateCertificateAsync(UpdateCertificateRequest request)

public final OperationFuture<Certificate,OperationMetadata> updateCertificateAsync(UpdateCertificateRequest request)

Updates a Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateCertificateRequest request =
       UpdateCertificateRequest.newBuilder()
           .setCertificate(Certificate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Certificate response = certificateManagerClient.updateCertificateAsync(request).get();
 }
 
Parameter
Name Description
request UpdateCertificateRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Certificate,OperationMetadata>

updateCertificateCallable()

public final UnaryCallable<UpdateCertificateRequest,Operation> updateCertificateCallable()

Updates a Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateCertificateRequest request =
       UpdateCertificateRequest.newBuilder()
           .setCertificate(Certificate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.updateCertificateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateCertificateRequest,Operation>

updateCertificateMapAsync(CertificateMap certificateMap, FieldMask updateMask)

public final OperationFuture<CertificateMap,OperationMetadata> updateCertificateMapAsync(CertificateMap certificateMap, FieldMask updateMask)

Updates a CertificateMap.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateMap certificateMap = CertificateMap.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CertificateMap response =
       certificateManagerClient.updateCertificateMapAsync(certificateMap, updateMask).get();
 }
 
Parameters
Name Description
certificateMap CertificateMap

Required. A definition of the certificate map to update.

updateMask FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

Returns
Type Description
OperationFuture<CertificateMap,OperationMetadata>

updateCertificateMapAsync(UpdateCertificateMapRequest request)

public final OperationFuture<CertificateMap,OperationMetadata> updateCertificateMapAsync(UpdateCertificateMapRequest request)

Updates a CertificateMap.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateCertificateMapRequest request =
       UpdateCertificateMapRequest.newBuilder()
           .setCertificateMap(CertificateMap.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   CertificateMap response = certificateManagerClient.updateCertificateMapAsync(request).get();
 }
 
Parameter
Name Description
request UpdateCertificateMapRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<CertificateMap,OperationMetadata>

updateCertificateMapCallable()

public final UnaryCallable<UpdateCertificateMapRequest,Operation> updateCertificateMapCallable()

Updates a CertificateMap.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateCertificateMapRequest request =
       UpdateCertificateMapRequest.newBuilder()
           .setCertificateMap(CertificateMap.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.updateCertificateMapCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateCertificateMapRequest,Operation>

updateCertificateMapEntryAsync(CertificateMapEntry certificateMapEntry, FieldMask updateMask)

public final OperationFuture<CertificateMapEntry,OperationMetadata> updateCertificateMapEntryAsync(CertificateMapEntry certificateMapEntry, FieldMask updateMask)

Updates a CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateMapEntry certificateMapEntry = CertificateMapEntry.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CertificateMapEntry response =
       certificateManagerClient
           .updateCertificateMapEntryAsync(certificateMapEntry, updateMask)
           .get();
 }
 
Parameters
Name Description
certificateMapEntry CertificateMapEntry

Required. A definition of the certificate map entry to create map entry.

updateMask FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

Returns
Type Description
OperationFuture<CertificateMapEntry,OperationMetadata>

updateCertificateMapEntryAsync(UpdateCertificateMapEntryRequest request)

public final OperationFuture<CertificateMapEntry,OperationMetadata> updateCertificateMapEntryAsync(UpdateCertificateMapEntryRequest request)

Updates a CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateCertificateMapEntryRequest request =
       UpdateCertificateMapEntryRequest.newBuilder()
           .setCertificateMapEntry(CertificateMapEntry.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   CertificateMapEntry response =
       certificateManagerClient.updateCertificateMapEntryAsync(request).get();
 }
 
Parameter
Name Description
request UpdateCertificateMapEntryRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<CertificateMapEntry,OperationMetadata>

updateCertificateMapEntryCallable()

public final UnaryCallable<UpdateCertificateMapEntryRequest,Operation> updateCertificateMapEntryCallable()

Updates a CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateCertificateMapEntryRequest request =
       UpdateCertificateMapEntryRequest.newBuilder()
           .setCertificateMapEntry(CertificateMapEntry.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.updateCertificateMapEntryCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateCertificateMapEntryRequest,Operation>

updateCertificateMapEntryOperationCallable()

public final OperationCallable<UpdateCertificateMapEntryRequest,CertificateMapEntry,OperationMetadata> updateCertificateMapEntryOperationCallable()

Updates a CertificateMapEntry.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateCertificateMapEntryRequest request =
       UpdateCertificateMapEntryRequest.newBuilder()
           .setCertificateMapEntry(CertificateMapEntry.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<CertificateMapEntry, OperationMetadata> future =
       certificateManagerClient.updateCertificateMapEntryOperationCallable().futureCall(request);
   // Do something.
   CertificateMapEntry response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateCertificateMapEntryRequest,CertificateMapEntry,OperationMetadata>

updateCertificateMapOperationCallable()

public final OperationCallable<UpdateCertificateMapRequest,CertificateMap,OperationMetadata> updateCertificateMapOperationCallable()

Updates a CertificateMap.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateCertificateMapRequest request =
       UpdateCertificateMapRequest.newBuilder()
           .setCertificateMap(CertificateMap.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<CertificateMap, OperationMetadata> future =
       certificateManagerClient.updateCertificateMapOperationCallable().futureCall(request);
   // Do something.
   CertificateMap response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateCertificateMapRequest,CertificateMap,OperationMetadata>

updateCertificateOperationCallable()

public final OperationCallable<UpdateCertificateRequest,Certificate,OperationMetadata> updateCertificateOperationCallable()

Updates a Certificate.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateCertificateRequest request =
       UpdateCertificateRequest.newBuilder()
           .setCertificate(Certificate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Certificate, OperationMetadata> future =
       certificateManagerClient.updateCertificateOperationCallable().futureCall(request);
   // Do something.
   Certificate response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateCertificateRequest,Certificate,OperationMetadata>

updateDnsAuthorizationAsync(DnsAuthorization dnsAuthorization, FieldMask updateMask)

public final OperationFuture<DnsAuthorization,OperationMetadata> updateDnsAuthorizationAsync(DnsAuthorization dnsAuthorization, FieldMask updateMask)

Updates a DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   DnsAuthorization dnsAuthorization = DnsAuthorization.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DnsAuthorization response =
       certificateManagerClient.updateDnsAuthorizationAsync(dnsAuthorization, updateMask).get();
 }
 
Parameters
Name Description
dnsAuthorization DnsAuthorization

Required. A definition of the dns authorization to update.

updateMask FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

Returns
Type Description
OperationFuture<DnsAuthorization,OperationMetadata>

updateDnsAuthorizationAsync(UpdateDnsAuthorizationRequest request)

public final OperationFuture<DnsAuthorization,OperationMetadata> updateDnsAuthorizationAsync(UpdateDnsAuthorizationRequest request)

Updates a DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateDnsAuthorizationRequest request =
       UpdateDnsAuthorizationRequest.newBuilder()
           .setDnsAuthorization(DnsAuthorization.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   DnsAuthorization response =
       certificateManagerClient.updateDnsAuthorizationAsync(request).get();
 }
 
Parameter
Name Description
request UpdateDnsAuthorizationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<DnsAuthorization,OperationMetadata>

updateDnsAuthorizationCallable()

public final UnaryCallable<UpdateDnsAuthorizationRequest,Operation> updateDnsAuthorizationCallable()

Updates a DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateDnsAuthorizationRequest request =
       UpdateDnsAuthorizationRequest.newBuilder()
           .setDnsAuthorization(DnsAuthorization.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       certificateManagerClient.updateDnsAuthorizationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateDnsAuthorizationRequest,Operation>

updateDnsAuthorizationOperationCallable()

public final OperationCallable<UpdateDnsAuthorizationRequest,DnsAuthorization,OperationMetadata> updateDnsAuthorizationOperationCallable()

Updates a DnsAuthorization.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   UpdateDnsAuthorizationRequest request =
       UpdateDnsAuthorizationRequest.newBuilder()
           .setDnsAuthorization(DnsAuthorization.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<DnsAuthorization, OperationMetadata> future =
       certificateManagerClient.updateDnsAuthorizationOperationCallable().futureCall(request);
   // Do something.
   DnsAuthorization response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateDnsAuthorizationRequest,DnsAuthorization,OperationMetadata>