publicca
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
Stable versionWhen a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Package publicca provides access to the Public Certificate Authority API.
For product documentation, see:https://cloud.google.com/public-certificate-authority/docs
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/publicca/v1alpha1"...ctx := context.Background()publiccaService, err := publicca.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/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 OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)publiccaService, err := publicca.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- Constants
- type ExternalAccountKey
- 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
- type ProjectsLocationsService
- type ProjectsService
- type Service
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.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeExternalAccountKey¶
type ExternalAccountKey struct {// B64MacKey: Output only. Base64-URL-encoded HS256 key. It is generated by the// PublicCertificateAuthorityService when the ExternalAccountKey is createdB64MacKeystring `json:"b64MacKey,omitempty"`// KeyId: Output only. Key ID. It is generated by the// PublicCertificateAuthorityService when the ExternalAccountKey is createdKeyIdstring `json:"keyId,omitempty"`// Name: Output only. Resource name.// projects/{project}/locations/{location}/externalAccountKeys/{key_id}Namestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ExternalAccountKey: A representation of an ExternalAccountKey used forexternal account binding (https://tools.ietf.org/html/rfc8555#section-7.3.4)within ACME.
func (ExternalAccountKey)MarshalJSON¶
func (sExternalAccountKey) MarshalJSON() ([]byte,error)
typeProjectsLocationsExternalAccountKeysCreateCall¶
type ProjectsLocationsExternalAccountKeysCreateCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsExternalAccountKeysCreateCall)Context¶
func (c *ProjectsLocationsExternalAccountKeysCreateCall) Context(ctxcontext.Context) *ProjectsLocationsExternalAccountKeysCreateCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsExternalAccountKeysCreateCall)Do¶
func (c *ProjectsLocationsExternalAccountKeysCreateCall) Do(opts ...googleapi.CallOption) (*ExternalAccountKey,error)
Do executes the "publicca.projects.locations.externalAccountKeys.create" call.Any non-2xx status code is an error. Response headers are in either*ExternalAccountKey.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*ProjectsLocationsExternalAccountKeysCreateCall)Fields¶
func (c *ProjectsLocationsExternalAccountKeysCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsExternalAccountKeysCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsExternalAccountKeysCreateCall)Header¶
func (c *ProjectsLocationsExternalAccountKeysCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsLocationsExternalAccountKeysService¶
type ProjectsLocationsExternalAccountKeysService struct {// contains filtered or unexported fields}funcNewProjectsLocationsExternalAccountKeysService¶
func NewProjectsLocationsExternalAccountKeysService(s *Service) *ProjectsLocationsExternalAccountKeysService
func (*ProjectsLocationsExternalAccountKeysService)Create¶
func (r *ProjectsLocationsExternalAccountKeysService) Create(parentstring, externalaccountkey *ExternalAccountKey) *ProjectsLocationsExternalAccountKeysCreateCall
Create: Creates a new ExternalAccountKey bound to the project.
- parent: The parent resource where this external_account_key will becreated. Format: projects/[project_id]/locations/[location]. At presentonly the "global" location is supported.
typeProjectsLocationsService¶
type ProjectsLocationsService struct {ExternalAccountKeys *ProjectsLocationsExternalAccountKeysService// contains filtered or unexported fields}funcNewProjectsLocationsService¶
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
typeProjectsService¶
type ProjectsService struct {Locations *ProjectsLocationsService// contains filtered or unexported fields}funcNewProjectsService¶
func NewProjectsService(s *Service) *ProjectsService
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields} funcNewdeprecated
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.
funcNewService¶
NewService creates a new Service.
Source Files