Package com.google.cloud.certificatemanager.v1 (0.24.0)

A client to Certificate Manager API

The interfaces provided are listed below, along with usage samples.

CertificateManagerClient

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 that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that 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 fully match the regexp [a-z0-9-]{1,63}. In other words, - 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.

Sample for CertificateManagerClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CertificateManagerClient certificateManagerClient = CertificateManagerClient.create()) {
   CertificateName name = CertificateName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE]");
   Certificate response = certificateManagerClient.getCertificate(name);
 }
 

Classes

Certificate

Defines TLS certificate.

Protobuf type google.cloud.certificatemanager.v1.Certificate

Certificate.Builder

Defines TLS certificate.

Protobuf type google.cloud.certificatemanager.v1.Certificate

Certificate.ManagedCertificate

Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so.

Protobuf type google.cloud.certificatemanager.v1.Certificate.ManagedCertificate

Certificate.ManagedCertificate.AuthorizationAttemptInfo

State of the latest attempt to authorize a domain for certificate issuance.

Protobuf type google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.AuthorizationAttemptInfo

Certificate.ManagedCertificate.AuthorizationAttemptInfo.Builder

State of the latest attempt to authorize a domain for certificate issuance.

Protobuf type google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.AuthorizationAttemptInfo

Certificate.ManagedCertificate.Builder

Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so.

Protobuf type google.cloud.certificatemanager.v1.Certificate.ManagedCertificate

Certificate.ManagedCertificate.ProvisioningIssue

Information about issues with provisioning a Managed Certificate.

Protobuf type google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.ProvisioningIssue

Certificate.ManagedCertificate.ProvisioningIssue.Builder

Information about issues with provisioning a Managed Certificate.

Protobuf type google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.ProvisioningIssue

Certificate.SelfManagedCertificate

Certificate data for a SelfManaged Certificate. SelfManaged Certificates are uploaded by the user. Updating such certificates before they expire remains the user's responsibility.

Protobuf type google.cloud.certificatemanager.v1.Certificate.SelfManagedCertificate

Certificate.SelfManagedCertificate.Builder

Certificate data for a SelfManaged Certificate. SelfManaged Certificates are uploaded by the user. Updating such certificates before they expire remains the user's responsibility.

Protobuf type google.cloud.certificatemanager.v1.Certificate.SelfManagedCertificate

CertificateIssuanceConfig

CertificateIssuanceConfig specifies how to issue and manage a certificate.

Protobuf type google.cloud.certificatemanager.v1.CertificateIssuanceConfig

CertificateIssuanceConfig.Builder

CertificateIssuanceConfig specifies how to issue and manage a certificate.

Protobuf type google.cloud.certificatemanager.v1.CertificateIssuanceConfig

CertificateIssuanceConfig.CertificateAuthorityConfig

The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc.

Protobuf type google.cloud.certificatemanager.v1.CertificateIssuanceConfig.CertificateAuthorityConfig

CertificateIssuanceConfig.CertificateAuthorityConfig.Builder

The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc.

Protobuf type google.cloud.certificatemanager.v1.CertificateIssuanceConfig.CertificateAuthorityConfig

CertificateIssuanceConfig.CertificateAuthorityConfig.CertificateAuthorityServiceConfig

Contains information required to contact CA service.

Protobuf type google.cloud.certificatemanager.v1.CertificateIssuanceConfig.CertificateAuthorityConfig.CertificateAuthorityServiceConfig

CertificateIssuanceConfig.CertificateAuthorityConfig.CertificateAuthorityServiceConfig.Builder

Contains information required to contact CA service.

Protobuf type google.cloud.certificatemanager.v1.CertificateIssuanceConfig.CertificateAuthorityConfig.CertificateAuthorityServiceConfig

CertificateIssuanceConfigName

CertificateIssuanceConfigName.Builder

Builder for projects/{project}/locations/{location}/certificateIssuanceConfigs/{certificate_issuance_config}.

CertificateIssuanceConfigProto

CertificateManagerClient

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 that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that 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 fully match the regexp [a-z0-9-]{1,63}. In other words, - 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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CertificateManagerSettings certificateManagerSettings =
     CertificateManagerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CertificateManagerClient certificateManagerClient =
     CertificateManagerClient.create(certificateManagerSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CertificateManagerSettings certificateManagerSettings =
     CertificateManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
 CertificateManagerClient certificateManagerClient =
     CertificateManagerClient.create(certificateManagerSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CertificateManagerSettings certificateManagerSettings =
     CertificateManagerSettings.newHttpJsonBuilder().build();
 CertificateManagerClient certificateManagerClient =
     CertificateManagerClient.create(certificateManagerSettings);
 

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

CertificateManagerClient.ListCertificateIssuanceConfigsFixedSizeCollection

CertificateManagerClient.ListCertificateIssuanceConfigsPage

CertificateManagerClient.ListCertificateIssuanceConfigsPagedResponse

CertificateManagerClient.ListCertificateMapEntriesFixedSizeCollection

CertificateManagerClient.ListCertificateMapEntriesPage

CertificateManagerClient.ListCertificateMapEntriesPagedResponse

CertificateManagerClient.ListCertificateMapsFixedSizeCollection

CertificateManagerClient.ListCertificateMapsPage

CertificateManagerClient.ListCertificateMapsPagedResponse

CertificateManagerClient.ListCertificatesFixedSizeCollection

CertificateManagerClient.ListCertificatesPage

CertificateManagerClient.ListCertificatesPagedResponse

CertificateManagerClient.ListDnsAuthorizationsFixedSizeCollection

CertificateManagerClient.ListDnsAuthorizationsPage

CertificateManagerClient.ListDnsAuthorizationsPagedResponse

CertificateManagerClient.ListLocationsFixedSizeCollection

CertificateManagerClient.ListLocationsPage

CertificateManagerClient.ListLocationsPagedResponse

CertificateManagerGrpc

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 that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that 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 fully match the regexp [a-z0-9-]{1,63}. In other words,
  • 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.

CertificateManagerGrpc.CertificateManagerBlockingStub

A stub to allow clients to do synchronous rpc calls to service CertificateManager.

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 that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that 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 fully match the regexp [a-z0-9-]{1,63}. In other words,
  • 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.

CertificateManagerGrpc.CertificateManagerFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service CertificateManager.

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 that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that 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 fully match the regexp [a-z0-9-]{1,63}. In other words,
  • 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.

CertificateManagerGrpc.CertificateManagerImplBase

Base class for the server implementation of the service CertificateManager.

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 that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that 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 fully match the regexp [a-z0-9-]{1,63}. In other words,
  • 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.

CertificateManagerGrpc.CertificateManagerStub

A stub to allow clients to do asynchronous rpc calls to service CertificateManager.

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 that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that 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 fully match the regexp [a-z0-9-]{1,63}. In other words,
  • 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.

CertificateManagerProto

CertificateManagerSettings

Settings class to configure an instance of CertificateManagerClient.

The default instance has everything set to sensible defaults:

  • The default service address (certificatemanager.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getCertificate to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CertificateManagerSettings.Builder certificateManagerSettingsBuilder =
     CertificateManagerSettings.newBuilder();
 certificateManagerSettingsBuilder
     .getCertificateSettings()
     .setRetrySettings(
         certificateManagerSettingsBuilder
             .getCertificateSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CertificateManagerSettings certificateManagerSettings =
     certificateManagerSettingsBuilder.build();
 

CertificateManagerSettings.Builder

Builder for CertificateManagerSettings.

CertificateMap

Defines a collection of certificate configurations.

Protobuf type google.cloud.certificatemanager.v1.CertificateMap

CertificateMap.Builder

Defines a collection of certificate configurations.

Protobuf type google.cloud.certificatemanager.v1.CertificateMap

CertificateMap.GclbTarget

Describes a Target Proxy that uses this Certificate Map.

Protobuf type google.cloud.certificatemanager.v1.CertificateMap.GclbTarget

CertificateMap.GclbTarget.Builder

Describes a Target Proxy that uses this Certificate Map.

Protobuf type google.cloud.certificatemanager.v1.CertificateMap.GclbTarget

CertificateMap.GclbTarget.IpConfig

Defines IP configuration where this Certificate Map is serving.

Protobuf type google.cloud.certificatemanager.v1.CertificateMap.GclbTarget.IpConfig

CertificateMap.GclbTarget.IpConfig.Builder

Defines IP configuration where this Certificate Map is serving.

Protobuf type google.cloud.certificatemanager.v1.CertificateMap.GclbTarget.IpConfig

CertificateMapEntry

Defines a certificate map entry.

Protobuf type google.cloud.certificatemanager.v1.CertificateMapEntry

CertificateMapEntry.Builder

Defines a certificate map entry.

Protobuf type google.cloud.certificatemanager.v1.CertificateMapEntry

CertificateMapEntryName

CertificateMapEntryName.Builder

Builder for projects/{project}/locations/{location}/certificateMaps/{certificate_map}/certificateMapEntries/{certificate_map_entry}.

CertificateMapName

CertificateMapName.Builder

Builder for projects/{project}/locations/{location}/certificateMaps/{certificate_map}.

CertificateName

CertificateName.Builder

Builder for projects/{project}/locations/{location}/certificates/{certificate}.

CreateCertificateIssuanceConfigRequest

Request for the CreateCertificateIssuanceConfig method.

Protobuf type google.cloud.certificatemanager.v1.CreateCertificateIssuanceConfigRequest

CreateCertificateIssuanceConfigRequest.Builder

Request for the CreateCertificateIssuanceConfig method.

Protobuf type google.cloud.certificatemanager.v1.CreateCertificateIssuanceConfigRequest

CreateCertificateMapEntryRequest

Request for the CreateCertificateMapEntry method.

Protobuf type google.cloud.certificatemanager.v1.CreateCertificateMapEntryRequest

CreateCertificateMapEntryRequest.Builder

Request for the CreateCertificateMapEntry method.

Protobuf type google.cloud.certificatemanager.v1.CreateCertificateMapEntryRequest

CreateCertificateMapRequest

Request for the CreateCertificateMap method.

Protobuf type google.cloud.certificatemanager.v1.CreateCertificateMapRequest

CreateCertificateMapRequest.Builder

Request for the CreateCertificateMap method.

Protobuf type google.cloud.certificatemanager.v1.CreateCertificateMapRequest

CreateCertificateRequest

Request for the CreateCertificate method.

Protobuf type google.cloud.certificatemanager.v1.CreateCertificateRequest

CreateCertificateRequest.Builder

Request for the CreateCertificate method.

Protobuf type google.cloud.certificatemanager.v1.CreateCertificateRequest

CreateDnsAuthorizationRequest

Request for the CreateDnsAuthorization method.

Protobuf type google.cloud.certificatemanager.v1.CreateDnsAuthorizationRequest

CreateDnsAuthorizationRequest.Builder

Request for the CreateDnsAuthorization method.

Protobuf type google.cloud.certificatemanager.v1.CreateDnsAuthorizationRequest

DeleteCertificateIssuanceConfigRequest

Request for the DeleteCertificateIssuanceConfig method.

Protobuf type google.cloud.certificatemanager.v1.DeleteCertificateIssuanceConfigRequest

DeleteCertificateIssuanceConfigRequest.Builder

Request for the DeleteCertificateIssuanceConfig method.

Protobuf type google.cloud.certificatemanager.v1.DeleteCertificateIssuanceConfigRequest

DeleteCertificateMapEntryRequest

Request for the DeleteCertificateMapEntry method.

Protobuf type google.cloud.certificatemanager.v1.DeleteCertificateMapEntryRequest

DeleteCertificateMapEntryRequest.Builder

Request for the DeleteCertificateMapEntry method.

Protobuf type google.cloud.certificatemanager.v1.DeleteCertificateMapEntryRequest

DeleteCertificateMapRequest

Request for the DeleteCertificateMap method.

Protobuf type google.cloud.certificatemanager.v1.DeleteCertificateMapRequest

DeleteCertificateMapRequest.Builder

Request for the DeleteCertificateMap method.

Protobuf type google.cloud.certificatemanager.v1.DeleteCertificateMapRequest

DeleteCertificateRequest

Request for the DeleteCertificate method.

Protobuf type google.cloud.certificatemanager.v1.DeleteCertificateRequest

DeleteCertificateRequest.Builder

Request for the DeleteCertificate method.

Protobuf type google.cloud.certificatemanager.v1.DeleteCertificateRequest

DeleteDnsAuthorizationRequest

Request for the DeleteDnsAuthorization method.

Protobuf type google.cloud.certificatemanager.v1.DeleteDnsAuthorizationRequest

DeleteDnsAuthorizationRequest.Builder

Request for the DeleteDnsAuthorization method.

Protobuf type google.cloud.certificatemanager.v1.DeleteDnsAuthorizationRequest

DnsAuthorization

A DnsAuthorization resource describes a way to perform domain authorization for certificate issuance.

Protobuf type google.cloud.certificatemanager.v1.DnsAuthorization

DnsAuthorization.Builder

A DnsAuthorization resource describes a way to perform domain authorization for certificate issuance.

Protobuf type google.cloud.certificatemanager.v1.DnsAuthorization

DnsAuthorization.DnsResourceRecord

The structure describing the DNS Resource Record that needs to be added to DNS configuration for the authorization to be usable by certificate.

Protobuf type google.cloud.certificatemanager.v1.DnsAuthorization.DnsResourceRecord

DnsAuthorization.DnsResourceRecord.Builder

The structure describing the DNS Resource Record that needs to be added to DNS configuration for the authorization to be usable by certificate.

Protobuf type google.cloud.certificatemanager.v1.DnsAuthorization.DnsResourceRecord

DnsAuthorizationName

DnsAuthorizationName.Builder

Builder for projects/{project}/locations/{location}/dnsAuthorizations/{dns_authorization}.

GetCertificateIssuanceConfigRequest

Request for the GetCertificateIssuanceConfig method.

Protobuf type google.cloud.certificatemanager.v1.GetCertificateIssuanceConfigRequest

GetCertificateIssuanceConfigRequest.Builder

Request for the GetCertificateIssuanceConfig method.

Protobuf type google.cloud.certificatemanager.v1.GetCertificateIssuanceConfigRequest

GetCertificateMapEntryRequest

Request for the GetCertificateMapEntry method.

Protobuf type google.cloud.certificatemanager.v1.GetCertificateMapEntryRequest

GetCertificateMapEntryRequest.Builder

Request for the GetCertificateMapEntry method.

Protobuf type google.cloud.certificatemanager.v1.GetCertificateMapEntryRequest

GetCertificateMapRequest

Request for the GetCertificateMap method.

Protobuf type google.cloud.certificatemanager.v1.GetCertificateMapRequest

GetCertificateMapRequest.Builder

Request for the GetCertificateMap method.

Protobuf type google.cloud.certificatemanager.v1.GetCertificateMapRequest

GetCertificateRequest

Request for the GetCertificate method.

Protobuf type google.cloud.certificatemanager.v1.GetCertificateRequest

GetCertificateRequest.Builder

Request for the GetCertificate method.

Protobuf type google.cloud.certificatemanager.v1.GetCertificateRequest

GetDnsAuthorizationRequest

Request for the GetDnsAuthorization method.

Protobuf type google.cloud.certificatemanager.v1.GetDnsAuthorizationRequest

GetDnsAuthorizationRequest.Builder

Request for the GetDnsAuthorization method.

Protobuf type google.cloud.certificatemanager.v1.GetDnsAuthorizationRequest

ListCertificateIssuanceConfigsRequest

Request for the ListCertificateIssuanceConfigs method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateIssuanceConfigsRequest

ListCertificateIssuanceConfigsRequest.Builder

Request for the ListCertificateIssuanceConfigs method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateIssuanceConfigsRequest

ListCertificateIssuanceConfigsResponse

Response for the ListCertificateIssuanceConfigs method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateIssuanceConfigsResponse

ListCertificateIssuanceConfigsResponse.Builder

Response for the ListCertificateIssuanceConfigs method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateIssuanceConfigsResponse

ListCertificateMapEntriesRequest

Request for the ListCertificateMapEntries method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateMapEntriesRequest

ListCertificateMapEntriesRequest.Builder

Request for the ListCertificateMapEntries method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateMapEntriesRequest

ListCertificateMapEntriesResponse

Response for the ListCertificateMapEntries method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateMapEntriesResponse

ListCertificateMapEntriesResponse.Builder

Response for the ListCertificateMapEntries method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateMapEntriesResponse

ListCertificateMapsRequest

Request for the ListCertificateMaps method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateMapsRequest

ListCertificateMapsRequest.Builder

Request for the ListCertificateMaps method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateMapsRequest

ListCertificateMapsResponse

Response for the ListCertificateMaps method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateMapsResponse

ListCertificateMapsResponse.Builder

Response for the ListCertificateMaps method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificateMapsResponse

ListCertificatesRequest

Request for the ListCertificates method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificatesRequest

ListCertificatesRequest.Builder

Request for the ListCertificates method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificatesRequest

ListCertificatesResponse

Response for the ListCertificates method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificatesResponse

ListCertificatesResponse.Builder

Response for the ListCertificates method.

Protobuf type google.cloud.certificatemanager.v1.ListCertificatesResponse

ListDnsAuthorizationsRequest

Request for the ListDnsAuthorizations method.

Protobuf type google.cloud.certificatemanager.v1.ListDnsAuthorizationsRequest

ListDnsAuthorizationsRequest.Builder

Request for the ListDnsAuthorizations method.

Protobuf type google.cloud.certificatemanager.v1.ListDnsAuthorizationsRequest

ListDnsAuthorizationsResponse

Response for the ListDnsAuthorizations method.

Protobuf type google.cloud.certificatemanager.v1.ListDnsAuthorizationsResponse

ListDnsAuthorizationsResponse.Builder

Response for the ListDnsAuthorizations method.

Protobuf type google.cloud.certificatemanager.v1.ListDnsAuthorizationsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

OperationMetadata

Represents the metadata of the long-running operation. Output only.

Protobuf type google.cloud.certificatemanager.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation. Output only.

Protobuf type google.cloud.certificatemanager.v1.OperationMetadata

UpdateCertificateMapEntryRequest

Request for the UpdateCertificateMapEntry method.

Protobuf type google.cloud.certificatemanager.v1.UpdateCertificateMapEntryRequest

UpdateCertificateMapEntryRequest.Builder

Request for the UpdateCertificateMapEntry method.

Protobuf type google.cloud.certificatemanager.v1.UpdateCertificateMapEntryRequest

UpdateCertificateMapRequest

Request for the UpdateCertificateMap method.

Protobuf type google.cloud.certificatemanager.v1.UpdateCertificateMapRequest

UpdateCertificateMapRequest.Builder

Request for the UpdateCertificateMap method.

Protobuf type google.cloud.certificatemanager.v1.UpdateCertificateMapRequest

UpdateCertificateRequest

Request for the UpdateCertificate method.

Protobuf type google.cloud.certificatemanager.v1.UpdateCertificateRequest

UpdateCertificateRequest.Builder

Request for the UpdateCertificate method.

Protobuf type google.cloud.certificatemanager.v1.UpdateCertificateRequest

UpdateDnsAuthorizationRequest

Request for the UpdateDnsAuthorization method.

Protobuf type google.cloud.certificatemanager.v1.UpdateDnsAuthorizationRequest

UpdateDnsAuthorizationRequest.Builder

Request for the UpdateDnsAuthorization method.

Protobuf type google.cloud.certificatemanager.v1.UpdateDnsAuthorizationRequest

Interfaces

Certificate.ManagedCertificate.AuthorizationAttemptInfoOrBuilder

Certificate.ManagedCertificate.ProvisioningIssueOrBuilder

Certificate.ManagedCertificateOrBuilder

Certificate.SelfManagedCertificateOrBuilder

CertificateIssuanceConfig.CertificateAuthorityConfig.CertificateAuthorityServiceConfigOrBuilder

CertificateIssuanceConfig.CertificateAuthorityConfigOrBuilder

CertificateIssuanceConfigOrBuilder

CertificateManagerGrpc.AsyncService

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 that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that 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 fully match the regexp [a-z0-9-]{1,63}. In other words,
  • 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.

CertificateMap.GclbTarget.IpConfigOrBuilder

CertificateMap.GclbTargetOrBuilder

CertificateMapEntryOrBuilder

CertificateMapOrBuilder

CertificateOrBuilder

CreateCertificateIssuanceConfigRequestOrBuilder

CreateCertificateMapEntryRequestOrBuilder

CreateCertificateMapRequestOrBuilder

CreateCertificateRequestOrBuilder

CreateDnsAuthorizationRequestOrBuilder

DeleteCertificateIssuanceConfigRequestOrBuilder

DeleteCertificateMapEntryRequestOrBuilder

DeleteCertificateMapRequestOrBuilder

DeleteCertificateRequestOrBuilder

DeleteDnsAuthorizationRequestOrBuilder

DnsAuthorization.DnsResourceRecordOrBuilder

DnsAuthorizationOrBuilder

GetCertificateIssuanceConfigRequestOrBuilder

GetCertificateMapEntryRequestOrBuilder

GetCertificateMapRequestOrBuilder

GetCertificateRequestOrBuilder

GetDnsAuthorizationRequestOrBuilder

ListCertificateIssuanceConfigsRequestOrBuilder

ListCertificateIssuanceConfigsResponseOrBuilder

ListCertificateMapEntriesRequestOrBuilder

ListCertificateMapEntriesResponseOrBuilder

ListCertificateMapsRequestOrBuilder

ListCertificateMapsResponseOrBuilder

ListCertificatesRequestOrBuilder

ListCertificatesResponseOrBuilder

ListDnsAuthorizationsRequestOrBuilder

ListDnsAuthorizationsResponseOrBuilder

OperationMetadataOrBuilder

UpdateCertificateMapEntryRequestOrBuilder

UpdateCertificateMapRequestOrBuilder

UpdateCertificateRequestOrBuilder

UpdateDnsAuthorizationRequestOrBuilder

Enums

Certificate.ManagedCertificate.AuthorizationAttemptInfo.FailureReason

Reason for failure of the authorization attempt for the domain.

Protobuf enum google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.AuthorizationAttemptInfo.FailureReason

Certificate.ManagedCertificate.AuthorizationAttemptInfo.State

State of the domain for managed certificate issuance.

Protobuf enum google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.AuthorizationAttemptInfo.State

Certificate.ManagedCertificate.ProvisioningIssue.Reason

Reason for provisioning failures.

Protobuf enum google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.ProvisioningIssue.Reason

Certificate.ManagedCertificate.State

State of the managed certificate resource.

Protobuf enum google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.State

Certificate.Scope

Certificate scope.

Protobuf enum google.cloud.certificatemanager.v1.Certificate.Scope

Certificate.TypeCase

CertificateIssuanceConfig.CertificateAuthorityConfig.KindCase

CertificateIssuanceConfig.KeyAlgorithm

The type of keypair to generate.

Protobuf enum google.cloud.certificatemanager.v1.CertificateIssuanceConfig.KeyAlgorithm

CertificateMap.GclbTarget.TargetProxyCase

CertificateMapEntry.MatchCase

CertificateMapEntry.Matcher

Defines predefined cases other than SNI-hostname match when this configuration should be applied.

Protobuf enum google.cloud.certificatemanager.v1.CertificateMapEntry.Matcher

ServingState

Defines set of serving states associated with a resource.

Protobuf enum google.cloud.certificatemanager.v1.ServingState