...

Package acmedns

import "google.golang.org/api/acmedns/v1"
Overview
Index

Overview ▾

Package acmedns provides access to the ACME DNS API.

For product documentation, see: https://developers.google.com/domains/acme-dns/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any 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/acmedns/v1"
...
ctx := context.Background()
acmednsService, err := acmedns.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 google.golang.org/api/option.WithAPIKey:

acmednsService, err := acmedns.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

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

See google.golang.org/api/option.ClientOption for details on options.

Index ▾

type AcmeChallengeSet
    func (s *AcmeChallengeSet) MarshalJSON() ([]byte, error)
type AcmeChallengeSetsGetCall
    func (c *AcmeChallengeSetsGetCall) Context(ctx context.Context) *AcmeChallengeSetsGetCall
    func (c *AcmeChallengeSetsGetCall) Do(opts ...googleapi.CallOption) (*AcmeChallengeSet, error)
    func (c *AcmeChallengeSetsGetCall) Fields(s ...googleapi.Field) *AcmeChallengeSetsGetCall
    func (c *AcmeChallengeSetsGetCall) Header() http.Header
    func (c *AcmeChallengeSetsGetCall) IfNoneMatch(entityTag string) *AcmeChallengeSetsGetCall
type AcmeChallengeSetsRotateChallengesCall
    func (c *AcmeChallengeSetsRotateChallengesCall) Context(ctx context.Context) *AcmeChallengeSetsRotateChallengesCall
    func (c *AcmeChallengeSetsRotateChallengesCall) Do(opts ...googleapi.CallOption) (*AcmeChallengeSet, error)
    func (c *AcmeChallengeSetsRotateChallengesCall) Fields(s ...googleapi.Field) *AcmeChallengeSetsRotateChallengesCall
    func (c *AcmeChallengeSetsRotateChallengesCall) Header() http.Header
type AcmeChallengeSetsService
    func NewAcmeChallengeSetsService(s *Service) *AcmeChallengeSetsService
    func (r *AcmeChallengeSetsService) Get(rootDomain string) *AcmeChallengeSetsGetCall
    func (r *AcmeChallengeSetsService) RotateChallenges(rootDomain string, rotatechallengesrequest *RotateChallengesRequest) *AcmeChallengeSetsRotateChallengesCall
type AcmeTxtRecord
    func (s *AcmeTxtRecord) MarshalJSON() ([]byte, error)
type RotateChallengesRequest
    func (s *RotateChallengesRequest) MarshalJSON() ([]byte, error)
type Service
    func New(client *http.Client) (*Service, error)
    func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

Package files

acmedns-gen.go

type AcmeChallengeSet

AcmeChallengeSet: The up-to-date ACME challenge set on a domain for an RPC. This contains all of the ACME TXT records that exist on the domain.

type AcmeChallengeSet struct {
    // Record: The ACME challenges on the requested domain represented as
    // individual TXT records.
    Record []*AcmeTxtRecord `json:"record,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Record") 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. "Record") 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:"-"`
}

func (*AcmeChallengeSet) MarshalJSON

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

type AcmeChallengeSetsGetCall

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

func (*AcmeChallengeSetsGetCall) Context

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

Context sets the context to be used in this call's Do method.

func (*AcmeChallengeSetsGetCall) Do

func (c *AcmeChallengeSetsGetCall) Do(opts ...googleapi.CallOption) (*AcmeChallengeSet, error)

Do executes the "acmedns.acmeChallengeSets.get" call. Any non-2xx status code is an error. Response headers are in either *AcmeChallengeSet.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 (*AcmeChallengeSetsGetCall) Fields

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

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

func (*AcmeChallengeSetsGetCall) Header

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

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

func (*AcmeChallengeSetsGetCall) IfNoneMatch

func (c *AcmeChallengeSetsGetCall) IfNoneMatch(entityTag string) *AcmeChallengeSetsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type AcmeChallengeSetsRotateChallengesCall

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

func (*AcmeChallengeSetsRotateChallengesCall) Context

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

Context sets the context to be used in this call's Do method.

func (*AcmeChallengeSetsRotateChallengesCall) Do

func (c *AcmeChallengeSetsRotateChallengesCall) Do(opts ...googleapi.CallOption) (*AcmeChallengeSet, error)

Do executes the "acmedns.acmeChallengeSets.rotateChallenges" call. Any non-2xx status code is an error. Response headers are in either *AcmeChallengeSet.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 (*AcmeChallengeSetsRotateChallengesCall) Fields

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

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

func (*AcmeChallengeSetsRotateChallengesCall) Header

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

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

type AcmeChallengeSetsService

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

func NewAcmeChallengeSetsService

func NewAcmeChallengeSetsService(s *Service) *AcmeChallengeSetsService

func (*AcmeChallengeSetsService) Get

func (r *AcmeChallengeSetsService) Get(rootDomain string) *AcmeChallengeSetsGetCall

Get: Gets the ACME challenge set for a given domain name. Domain names must be provided in Punycode.

func (*AcmeChallengeSetsService) RotateChallenges

func (r *AcmeChallengeSetsService) RotateChallenges(rootDomain string, rotatechallengesrequest *RotateChallengesRequest) *AcmeChallengeSetsRotateChallengesCall

RotateChallenges: Rotate the ACME challenges for a given domain name. By default, removes any challenges that are older than 30 days. Domain names must be provided in Punycode.

type AcmeTxtRecord

AcmeTxtRecord: The TXT record message that represents an ACME DNS-01 challenge.

type AcmeTxtRecord struct {
    // Digest: Holds the ACME challenge data put in the TXT record. This will be
    // checked to be a valid TXT record data entry.
    Digest string `json:"digest,omitempty"`
    // Fqdn: The domain/subdomain for the record. In a request, this MAY be Unicode
    // or Punycode. In a response, this will be in Unicode. The fqdn MUST contain
    // the root_domain field on the request.
    Fqdn string `json:"fqdn,omitempty"`
    // UpdateTime: Output only. The time when this record was last updated. This
    // will be in UTC time.
    UpdateTime string `json:"updateTime,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Digest") 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. "Digest") 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:"-"`
}

func (*AcmeTxtRecord) MarshalJSON

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

type RotateChallengesRequest

RotateChallengesRequest: The request message for the RotateChallenges RPC. Requires an access token, a root domain, and either records_to_add or records_to_remove to be populated. Records may be set for multiple subdomains at once to support SAN requests for multiple subdomains in a single domain. By default, ACME TXT record challenges that are older than 30 days will be removed. Set `keep_expired_records` to false if this behavior is undesired. There is a record maximum of 100 records per domain including expired records. Any request sent that would exceed this maximum will result in a FAILED_PRECONDITION error. NEXT ID: 6

type RotateChallengesRequest struct {
    // AccessToken: Required. ACME DNS access token. This is a base64 token secret
    // that is procured from the Google Domains website. It authorizes ACME TXT
    // record updates for a domain.
    AccessToken string `json:"accessToken,omitempty"`
    // KeepExpiredRecords: Keep records older than 30 days that were used for
    // previous requests.
    KeepExpiredRecords bool `json:"keepExpiredRecords,omitempty"`
    // RecordsToAdd: ACME TXT record challenges to add. Supports multiple
    // challenges on the same FQDN.
    RecordsToAdd []*AcmeTxtRecord `json:"recordsToAdd,omitempty"`
    // RecordsToRemove: ACME TXT record challenges to remove.
    RecordsToRemove []*AcmeTxtRecord `json:"recordsToRemove,omitempty"`
    // ForceSendFields is a list of field names (e.g. "AccessToken") 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. "AccessToken") 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:"-"`
}

func (*RotateChallengesRequest) MarshalJSON

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

type Service

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

    AcmeChallengeSets *AcmeChallengeSetsService
    // 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.