publicca

Documentation

Overview

Package publicca is an auto-generated package for the Public Certificate Authority API.

The Public Certificate Authority API may be used to create and manage ACME external account binding keys associated with Google Trust Services’ publicly trusted certificate authority.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

• Authentication and Authorization
• Timeouts and Cancellation
• Testing against Client Libraries
• Debugging Client Libraries
• Inspecting errors

Example usage

To get started with this package, create a client.

ctx := context.Background()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := publicca.NewPublicCertificateAuthorityClient(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := publicca.NewPublicCertificateAuthorityClient(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

req := &publiccapb.CreateExternalAccountKeyRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.go.dev/cloud.google.com/go/security/publicca/apiv1beta1/publiccapb#CreateExternalAccountKeyRequest.
}
resp, err := c.CreateExternalAccountKey(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewPublicCertificateAuthorityClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Index

• func DefaultAuthScopes() []string
• type PublicCertificateAuthorityCallOptions
• type PublicCertificateAuthorityClient
  • func NewPublicCertificateAuthorityClient(ctx context.Context, opts ...option.ClientOption) (*PublicCertificateAuthorityClient, error)
  • func NewPublicCertificateAuthorityRESTClient(ctx context.Context, opts ...option.ClientOption) (*PublicCertificateAuthorityClient, error)
  • func (c *PublicCertificateAuthorityClient) Close() error
  • func (c *PublicCertificateAuthorityClient) Connection() *grpc.ClientConn
  • func (c *PublicCertificateAuthorityClient) CreateExternalAccountKey(ctx context.Context, req *publiccapb.CreateExternalAccountKeyRequest, ...) (*publiccapb.ExternalAccountKey, error)

Examples

• NewPublicCertificateAuthorityClient
• NewPublicCertificateAuthorityRESTClient
• PublicCertificateAuthorityClient.CreateExternalAccountKey

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

Types

type PublicCertificateAuthorityCallOptions

type PublicCertificateAuthorityCallOptions struct {
	CreateExternalAccountKey []gax.CallOption
}

PublicCertificateAuthorityCallOptions contains the retry settings for each method of PublicCertificateAuthorityClient.

type PublicCertificateAuthorityClient

type PublicCertificateAuthorityClient struct {

	// The call options for this service.
	CallOptions *PublicCertificateAuthorityCallOptions
	// contains filtered or unexported fields
}

PublicCertificateAuthorityClient is a client for interacting with Public Certificate Authority API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Manages the resources required for ACME external account binding (at https://tools.ietf.org/html/rfc8555#section-7.3.4) for the public certificate authority service.

func NewPublicCertificateAuthorityClient

func NewPublicCertificateAuthorityClient(ctx context.Context, opts ...option.ClientOption) (*PublicCertificateAuthorityClient, error)

NewPublicCertificateAuthorityClient creates a new public certificate authority service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Manages the resources required for ACME external account binding (at https://tools.ietf.org/html/rfc8555#section-7.3.4) for the public certificate authority service.

Example

package main

import (
	"context"

	publicca "cloud.google.com/go/security/publicca/apiv1beta1"
)

func main() {
	ctx := context.Background()
	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := publicca.NewPublicCertificateAuthorityClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewPublicCertificateAuthorityRESTClient

func NewPublicCertificateAuthorityRESTClient(ctx context.Context, opts ...option.ClientOption) (*PublicCertificateAuthorityClient, error)

NewPublicCertificateAuthorityRESTClient creates a new public certificate authority service rest client.

Manages the resources required for ACME external account binding (at https://tools.ietf.org/html/rfc8555#section-7.3.4) for the public certificate authority service.

Example

package main

import (
	"context"

	publicca "cloud.google.com/go/security/publicca/apiv1beta1"
)

func main() {
	ctx := context.Background()
	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := publicca.NewPublicCertificateAuthorityRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*PublicCertificateAuthorityClient) Close

func (c *PublicCertificateAuthorityClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*PublicCertificateAuthorityClient) Connection

func (c *PublicCertificateAuthorityClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

func (*PublicCertificateAuthorityClient) CreateExternalAccountKey

func (c *PublicCertificateAuthorityClient) CreateExternalAccountKey(ctx context.Context, req *publiccapb.CreateExternalAccountKeyRequest, opts ...gax.CallOption) (*publiccapb.ExternalAccountKey, error)

CreateExternalAccountKey creates a new ExternalAccountKey bound to the project.

Example

package main

import (
	"context"

	publicca "cloud.google.com/go/security/publicca/apiv1beta1"
	publiccapb "cloud.google.com/go/security/publicca/apiv1beta1/publiccapb"
)

func main() {
	ctx := context.Background()
	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := publicca.NewPublicCertificateAuthorityClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &publiccapb.CreateExternalAccountKeyRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/security/publicca/apiv1beta1/publiccapb#CreateExternalAccountKeyRequest.
	}
	resp, err := c.CreateExternalAccountKey(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}