acmedns
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 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, 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/acmedns/v1"...ctx := context.Background()acmednsService, err := acmedns.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:
acmednsService, err := acmedns.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, ...)acmednsService, err := acmedns.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- type AcmeChallengeSet
- 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
- type AcmeTxtRecord
- type RotateChallengesRequest
- type Service
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAcmeChallengeSet¶
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:"-"`}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.
func (AcmeChallengeSet)MarshalJSON¶
func (sAcmeChallengeSet) MarshalJSON() ([]byte,error)
typeAcmeChallengeSetsGetCall¶
type AcmeChallengeSetsGetCall struct {// contains filtered or unexported fields}func (*AcmeChallengeSetsGetCall)Context¶
func (c *AcmeChallengeSetsGetCall) Context(ctxcontext.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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*AcmeChallengeSetsGetCall)Fields¶
func (c *AcmeChallengeSetsGetCall) Fields(s ...googleapi.Field) *AcmeChallengeSetsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*AcmeChallengeSetsGetCall)Header¶
func (c *AcmeChallengeSetsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*AcmeChallengeSetsGetCall)IfNoneMatch¶
func (c *AcmeChallengeSetsGetCall) IfNoneMatch(entityTagstring) *AcmeChallengeSetsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeAcmeChallengeSetsRotateChallengesCall¶
type AcmeChallengeSetsRotateChallengesCall struct {// contains filtered or unexported fields}func (*AcmeChallengeSetsRotateChallengesCall)Context¶
func (c *AcmeChallengeSetsRotateChallengesCall) Context(ctxcontext.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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*AcmeChallengeSetsRotateChallengesCall)Fields¶
func (c *AcmeChallengeSetsRotateChallengesCall) Fields(s ...googleapi.Field) *AcmeChallengeSetsRotateChallengesCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*AcmeChallengeSetsRotateChallengesCall)Header¶
func (c *AcmeChallengeSetsRotateChallengesCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeAcmeChallengeSetsService¶
type AcmeChallengeSetsService struct {// contains filtered or unexported fields}funcNewAcmeChallengeSetsService¶
func NewAcmeChallengeSetsService(s *Service) *AcmeChallengeSetsService
func (*AcmeChallengeSetsService)Get¶
func (r *AcmeChallengeSetsService) Get(rootDomainstring) *AcmeChallengeSetsGetCall
Get: Gets the ACME challenge set for a given domain name. Domain names mustbe provided in Punycode.
- rootDomain: SLD + TLD domain name to list challenges. For example, thiswould be "google.com" for any FQDN under "google.com". That includeschallenges for "subdomain.google.com". This MAY be Unicode or Punycode.
func (*AcmeChallengeSetsService)RotateChallenges¶
func (r *AcmeChallengeSetsService) RotateChallenges(rootDomainstring, rotatechallengesrequest *RotateChallengesRequest) *AcmeChallengeSetsRotateChallengesCall
RotateChallenges: Rotate the ACME challenges for a given domain name. Bydefault, removes any challenges that are older than 30 days. Domain namesmust be provided in Punycode.
- rootDomain: SLD + TLD domain name to update records for. For example, thiswould be "google.com" for any FQDN under "google.com". That includeschallenges for "subdomain.google.com". This MAY be Unicode or Punycode.
typeAcmeTxtRecord¶
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.Digeststring `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.Fqdnstring `json:"fqdn,omitempty"`// UpdateTime: Output only. The time when this record was last updated. This// will be in UTC time.UpdateTimestring `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:"-"`}AcmeTxtRecord: The TXT record message that represents an ACME DNS-01challenge.
func (AcmeTxtRecord)MarshalJSON¶
func (sAcmeTxtRecord) MarshalJSON() ([]byte,error)
typeRotateChallengesRequest¶
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.AccessTokenstring `json:"accessToken,omitempty"`// KeepExpiredRecords: Keep records older than 30 days that were used for// previous requests.KeepExpiredRecordsbool `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:"-"`}RotateChallengesRequest: The request message for the RotateChallenges RPC.Requires an access token, a root domain, and either records_to_add orrecords_to_remove to be populated. Records may be set for multiplesubdomains at once to support SAN requests for multiple subdomains in asingle domain. By default, ACME TXT record challenges that are older than 30days will be removed. Set `keep_expired_records` to false if this behavioris undesired. There is a record maximum of 100 records per domain includingexpired records. Any request sent that would exceed this maximum will resultin a FAILED_PRECONDITION error. NEXT ID: 6
func (RotateChallengesRequest)MarshalJSON¶
func (sRotateChallengesRequest) MarshalJSON() ([]byte,error)
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentAcmeChallengeSets *AcmeChallengeSetsService// 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