publicca

Documentation

Overview

Package publicca provides access to the Public Certificate Authority API.

For product documentation, see: https://cloud.google.com/public-certificate-authority/docs

Creating a client

Usage example:

import "google.golang.org/api/publicca/v1beta1"
...
ctx := context.Background()
publiccaService, err := publicca.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

publiccaService, err := publicca.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
publiccaService, err := publicca.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

• Constants
• type ExternalAccountKey
  • func (s *ExternalAccountKey) MarshalJSON() ([]byte, error)
• type ProjectsLocationsExternalAccountKeysCreateCall
  • func (c *ProjectsLocationsExternalAccountKeysCreateCall) Context(ctx context.Context) *ProjectsLocationsExternalAccountKeysCreateCall
  • func (c *ProjectsLocationsExternalAccountKeysCreateCall) Do(opts ...googleapi.CallOption) (*ExternalAccountKey, error)
  • func (c *ProjectsLocationsExternalAccountKeysCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsExternalAccountKeysCreateCall
  • func (c *ProjectsLocationsExternalAccountKeysCreateCall) Header() http.Header
• type ProjectsLocationsExternalAccountKeysService
  • func NewProjectsLocationsExternalAccountKeysService(s *Service) *ProjectsLocationsExternalAccountKeysService
  • func (r *ProjectsLocationsExternalAccountKeysService) Create(parent string, externalaccountkey *ExternalAccountKey) *ProjectsLocationsExternalAccountKeysCreateCall
• type ProjectsLocationsService
  • func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
• type ProjectsService
  • func NewProjectsService(s *Service) *ProjectsService
• type Service
  • func New(client *http.Client) (*Service, error)
  • func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

Constants

const (
	// See, edit, configure, and delete your Google Cloud data and see the
	// email address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Types

type ExternalAccountKey

type ExternalAccountKey struct {
	// B64MacKey: Output only. Base64-URL-encoded HS256 key. It is generated
	// by the PublicCertificateAuthorityService when the ExternalAccountKey
	// is created
	B64MacKey string `json:"b64MacKey,omitempty"`

	// KeyId: Output only. Key ID. It is generated by the
	// PublicCertificateAuthorityService when the ExternalAccountKey is
	// created
	KeyId string `json:"keyId,omitempty"`

	// Name: Output only. Resource name.
	// projects/{project}/locations/{location}/externalAccountKeys/{key_id}
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "B64MacKey") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "B64MacKey") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ExternalAccountKey: A representation of an ExternalAccountKey used for external account binding (https://tools.ietf.org/html/rfc8555#section-7.3.4) within ACME.

func (*ExternalAccountKey) MarshalJSON

func (s *ExternalAccountKey) MarshalJSON() ([]byte, error)

type ProjectsLocationsExternalAccountKeysCreateCall

type ProjectsLocationsExternalAccountKeysCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsExternalAccountKeysCreateCall) Context

func (c *ProjectsLocationsExternalAccountKeysCreateCall) Context(ctx context.Context) *ProjectsLocationsExternalAccountKeysCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsExternalAccountKeysCreateCall) Do

func (c *ProjectsLocationsExternalAccountKeysCreateCall) Do(opts ...googleapi.CallOption) (*ExternalAccountKey, error)

Do executes the "publicca.projects.locations.externalAccountKeys.create" call. Exactly one of *ExternalAccountKey or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ExternalAccountKey.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsExternalAccountKeysCreateCall) Fields

func (c *ProjectsLocationsExternalAccountKeysCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsExternalAccountKeysCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsExternalAccountKeysCreateCall) Header

func (c *ProjectsLocationsExternalAccountKeysCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsExternalAccountKeysService

type ProjectsLocationsExternalAccountKeysService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsExternalAccountKeysService

func NewProjectsLocationsExternalAccountKeysService(s *Service) *ProjectsLocationsExternalAccountKeysService

func (*ProjectsLocationsExternalAccountKeysService) Create

func (r *ProjectsLocationsExternalAccountKeysService) Create(parent string, externalaccountkey *ExternalAccountKey) *ProjectsLocationsExternalAccountKeysCreateCall

Create: Creates a new ExternalAccountKey bound to the project.

• parent: The parent resource where this external_account_key will be created. Format: projects/[project_id]/locations/[location]. At present only the "global" location is supported.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	ExternalAccountKeys *ProjectsLocationsExternalAccountKeysService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.