custom_nameservers

package
v2.0.0-beta.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 18, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CustomNameserverAvailabiltyParams 

type CustomNameserverAvailabiltyParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type CustomNameserverAvailabiltyResponseEnvelope 

type CustomNameserverAvailabiltyResponseEnvelope struct {
	Errors   []CustomNameserverAvailabiltyResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CustomNameserverAvailabiltyResponseEnvelopeMessages `json:"messages,required"`
	Result   []string                                              `json:"result,required,nullable" format:"hostname"`
	// Whether the API call was successful
	Success    CustomNameserverAvailabiltyResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo CustomNameserverAvailabiltyResponseEnvelopeResultInfo `json:"result_info"`
	JSON       customNameserverAvailabiltyResponseEnvelopeJSON       `json:"-"`
}

func (*CustomNameserverAvailabiltyResponseEnvelope) UnmarshalJSON 

func (r *CustomNameserverAvailabiltyResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type CustomNameserverAvailabiltyResponseEnvelopeErrors 

type CustomNameserverAvailabiltyResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    customNameserverAvailabiltyResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CustomNameserverAvailabiltyResponseEnvelopeErrors) UnmarshalJSON 

func (r *CustomNameserverAvailabiltyResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type CustomNameserverAvailabiltyResponseEnvelopeMessages 

type CustomNameserverAvailabiltyResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    customNameserverAvailabiltyResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CustomNameserverAvailabiltyResponseEnvelopeMessages) UnmarshalJSON 

func (r *CustomNameserverAvailabiltyResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type CustomNameserverAvailabiltyResponseEnvelopeResultInfo 

type CustomNameserverAvailabiltyResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                   `json:"total_count"`
	JSON       customNameserverAvailabiltyResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*CustomNameserverAvailabiltyResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *CustomNameserverAvailabiltyResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type CustomNameserverAvailabiltyResponseEnvelopeSuccess 

type CustomNameserverAvailabiltyResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CustomNameserverAvailabiltyResponseEnvelopeSuccessTrue CustomNameserverAvailabiltyResponseEnvelopeSuccess = true
)

type CustomNameserverDeleteParams 

type CustomNameserverDeleteParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type CustomNameserverDeleteResponse added in v2.2.0 

type CustomNameserverDeleteResponse interface {
	ImplementsCustomNameserversCustomNameserverDeleteResponse()
}

Union satisfied by custom_nameservers.CustomNameserverDeleteResponseUnknown, custom_nameservers.CustomNameserverDeleteResponseArray or shared.UnionString.

type CustomNameserverDeleteResponseArray 

type CustomNameserverDeleteResponseArray []interface{}

func (CustomNameserverDeleteResponseArray) ImplementsCustomNameserversCustomNameserverDeleteResponse 

func (r CustomNameserverDeleteResponseArray) ImplementsCustomNameserversCustomNameserverDeleteResponse()

type CustomNameserverDeleteResponseEnvelope 

type CustomNameserverDeleteResponseEnvelope struct {
	Errors   []CustomNameserverDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CustomNameserverDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   CustomNameserverDeleteResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    CustomNameserverDeleteResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo CustomNameserverDeleteResponseEnvelopeResultInfo `json:"result_info"`
	JSON       customNameserverDeleteResponseEnvelopeJSON       `json:"-"`
}

func (*CustomNameserverDeleteResponseEnvelope) UnmarshalJSON 

func (r *CustomNameserverDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type CustomNameserverDeleteResponseEnvelopeErrors 

type CustomNameserverDeleteResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    customNameserverDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CustomNameserverDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *CustomNameserverDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type CustomNameserverDeleteResponseEnvelopeMessages 

type CustomNameserverDeleteResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    customNameserverDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CustomNameserverDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *CustomNameserverDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type CustomNameserverDeleteResponseEnvelopeResultInfo 

type CustomNameserverDeleteResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                              `json:"total_count"`
	JSON       customNameserverDeleteResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*CustomNameserverDeleteResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *CustomNameserverDeleteResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type CustomNameserverDeleteResponseEnvelopeSuccess 

type CustomNameserverDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CustomNameserverDeleteResponseEnvelopeSuccessTrue CustomNameserverDeleteResponseEnvelopeSuccess = true
)

type CustomNameserverGetParams 

type CustomNameserverGetParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type CustomNameserverGetResponseEnvelope 

type CustomNameserverGetResponseEnvelope struct {
	Errors   []CustomNameserverGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CustomNameserverGetResponseEnvelopeMessages `json:"messages,required"`
	Result   []DNSCustomNameserversCustomNS                `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    CustomNameserverGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo CustomNameserverGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       customNameserverGetResponseEnvelopeJSON       `json:"-"`
}

func (*CustomNameserverGetResponseEnvelope) UnmarshalJSON 

func (r *CustomNameserverGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type CustomNameserverGetResponseEnvelopeErrors 

type CustomNameserverGetResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    customNameserverGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CustomNameserverGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *CustomNameserverGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type CustomNameserverGetResponseEnvelopeMessages 

type CustomNameserverGetResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    customNameserverGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CustomNameserverGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *CustomNameserverGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type CustomNameserverGetResponseEnvelopeResultInfo 

type CustomNameserverGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                           `json:"total_count"`
	JSON       customNameserverGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*CustomNameserverGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *CustomNameserverGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type CustomNameserverGetResponseEnvelopeSuccess 

type CustomNameserverGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CustomNameserverGetResponseEnvelopeSuccessTrue CustomNameserverGetResponseEnvelopeSuccess = true
)

type CustomNameserverNewParams 

type CustomNameserverNewParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// The FQDN of the name server.
	NSName param.Field[string] `json:"ns_name,required" format:"hostname"`
	// The number of the set that this name server belongs to.
	NSSet param.Field[float64] `json:"ns_set"`
}

func (CustomNameserverNewParams) MarshalJSON 

func (r CustomNameserverNewParams) MarshalJSON() (data []byte, err error)

type CustomNameserverNewResponseEnvelope 

type CustomNameserverNewResponseEnvelope struct {
	Errors   []CustomNameserverNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CustomNameserverNewResponseEnvelopeMessages `json:"messages,required"`
	// A single account custom nameserver.
	Result DNSCustomNameserversCustomNS `json:"result,required"`
	// Whether the API call was successful
	Success CustomNameserverNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    customNameserverNewResponseEnvelopeJSON    `json:"-"`
}

func (*CustomNameserverNewResponseEnvelope) UnmarshalJSON 

func (r *CustomNameserverNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type CustomNameserverNewResponseEnvelopeErrors 

type CustomNameserverNewResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    customNameserverNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CustomNameserverNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *CustomNameserverNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type CustomNameserverNewResponseEnvelopeMessages 

type CustomNameserverNewResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    customNameserverNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CustomNameserverNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *CustomNameserverNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type CustomNameserverNewResponseEnvelopeSuccess 

type CustomNameserverNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CustomNameserverNewResponseEnvelopeSuccessTrue CustomNameserverNewResponseEnvelopeSuccess = true
)

type CustomNameserverService 

type CustomNameserverService struct {
	Options []option.RequestOption
}

CustomNameserverService contains methods and other services that help with interacting with the cloudflare API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCustomNameserverService method instead.

func NewCustomNameserverService 

func NewCustomNameserverService(opts ...option.RequestOption) (r *CustomNameserverService)

NewCustomNameserverService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CustomNameserverService) Availabilty 

func (r *CustomNameserverService) Availabilty(ctx context.Context, query CustomNameserverAvailabiltyParams, opts ...option.RequestOption) (res *[]string, err error)

Get Eligible Zones for Account Custom Nameservers

func (*CustomNameserverService) Delete 

func (r *CustomNameserverService) Delete(ctx context.Context, customNSID string, body CustomNameserverDeleteParams, opts ...option.RequestOption) (res *CustomNameserverDeleteResponse, err error)

Delete Account Custom Nameserver

func (*CustomNameserverService) Get 

func (r *CustomNameserverService) Get(ctx context.Context, query CustomNameserverGetParams, opts ...option.RequestOption) (res *[]DNSCustomNameserversCustomNS, err error)

List an account's custom nameservers.

func (*CustomNameserverService) New 

func (r *CustomNameserverService) New(ctx context.Context, params CustomNameserverNewParams, opts ...option.RequestOption) (res *DNSCustomNameserversCustomNS, err error)

Add Account Custom Nameserver

func (*CustomNameserverService) Verify 

func (r *CustomNameserverService) Verify(ctx context.Context, body CustomNameserverVerifyParams, opts ...option.RequestOption) (res *[]DNSCustomNameserversCustomNS, err error)

Verify Account Custom Nameserver Glue Records

type CustomNameserverVerifyParams 

type CustomNameserverVerifyParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type CustomNameserverVerifyResponseEnvelope 

type CustomNameserverVerifyResponseEnvelope struct {
	Errors   []CustomNameserverVerifyResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CustomNameserverVerifyResponseEnvelopeMessages `json:"messages,required"`
	Result   []DNSCustomNameserversCustomNS                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    CustomNameserverVerifyResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo CustomNameserverVerifyResponseEnvelopeResultInfo `json:"result_info"`
	JSON       customNameserverVerifyResponseEnvelopeJSON       `json:"-"`
}

func (*CustomNameserverVerifyResponseEnvelope) UnmarshalJSON 

func (r *CustomNameserverVerifyResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type CustomNameserverVerifyResponseEnvelopeErrors 

type CustomNameserverVerifyResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    customNameserverVerifyResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CustomNameserverVerifyResponseEnvelopeErrors) UnmarshalJSON 

func (r *CustomNameserverVerifyResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type CustomNameserverVerifyResponseEnvelopeMessages 

type CustomNameserverVerifyResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    customNameserverVerifyResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CustomNameserverVerifyResponseEnvelopeMessages) UnmarshalJSON 

func (r *CustomNameserverVerifyResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type CustomNameserverVerifyResponseEnvelopeResultInfo 

type CustomNameserverVerifyResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                              `json:"total_count"`
	JSON       customNameserverVerifyResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*CustomNameserverVerifyResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *CustomNameserverVerifyResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type CustomNameserverVerifyResponseEnvelopeSuccess 

type CustomNameserverVerifyResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CustomNameserverVerifyResponseEnvelopeSuccessTrue CustomNameserverVerifyResponseEnvelopeSuccess = true
)

type DNSCustomNameserversCustomNS 

type DNSCustomNameserversCustomNS struct {
	// A and AAAA records associated with the nameserver.
	DNSRecords []DNSCustomNameserversCustomNSDNSRecord `json:"dns_records,required"`
	// The FQDN of the name server.
	NSName string `json:"ns_name,required" format:"hostname"`
	// Verification status of the nameserver.
	Status DNSCustomNameserversCustomNSStatus `json:"status,required"`
	// Identifier
	ZoneTag string `json:"zone_tag,required"`
	// The number of the set that this name server belongs to.
	NSSet float64                          `json:"ns_set"`
	JSON  dnsCustomNameserversCustomNSJSON `json:"-"`
}

A single account custom nameserver.

func (*DNSCustomNameserversCustomNS) UnmarshalJSON 

func (r *DNSCustomNameserversCustomNS) UnmarshalJSON(data []byte) (err error)

type DNSCustomNameserversCustomNSDNSRecord 

type DNSCustomNameserversCustomNSDNSRecord struct {
	// DNS record type.
	Type DNSCustomNameserversCustomNSDNSRecordsType `json:"type"`
	// DNS record contents (an IPv4 or IPv6 address).
	Value string                                    `json:"value"`
	JSON  dnsCustomNameserversCustomNsdnsRecordJSON `json:"-"`
}

func (*DNSCustomNameserversCustomNSDNSRecord) UnmarshalJSON 

func (r *DNSCustomNameserversCustomNSDNSRecord) UnmarshalJSON(data []byte) (err error)

type DNSCustomNameserversCustomNSDNSRecordsType 

type DNSCustomNameserversCustomNSDNSRecordsType string

DNS record type. 

const (
	DNSCustomNameserversCustomNSDNSRecordsTypeA    DNSCustomNameserversCustomNSDNSRecordsType = "A"
	DNSCustomNameserversCustomNSDNSRecordsTypeAAAA DNSCustomNameserversCustomNSDNSRecordsType = "AAAA"
)

type DNSCustomNameserversCustomNSStatus 

type DNSCustomNameserversCustomNSStatus string

Verification status of the nameserver. 

const (
	DNSCustomNameserversCustomNSStatusMoved    DNSCustomNameserversCustomNSStatus = "moved"
	DNSCustomNameserversCustomNSStatusPending  DNSCustomNameserversCustomNSStatus = "pending"
	DNSCustomNameserversCustomNSStatusVerified DNSCustomNameserversCustomNSStatus = "verified"
)

type Error 

type Error = apierror.Error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.