dnsrecordsv1

package
v0.11.4 Latest Latest
Warning

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

 Go to latest Published: Nov 10, 2020 License: Apache-2.0 Imports: 5 Imported by: 19

Documentation

Overview

Package dnsrecordsv1 : Operations and models for the DnsRecordsV1 service

Index

Constants

View Source 
const (
	CreateDnsRecordOptions_Type_A     = "A"
	CreateDnsRecordOptions_Type_Aaaa  = "AAAA"
	CreateDnsRecordOptions_Type_Caa   = "CAA"
	CreateDnsRecordOptions_Type_Cname = "CNAME"
	CreateDnsRecordOptions_Type_Loc   = "LOC"
	CreateDnsRecordOptions_Type_Mx    = "MX"
	CreateDnsRecordOptions_Type_Ns    = "NS"
	CreateDnsRecordOptions_Type_Spf   = "SPF"
	CreateDnsRecordOptions_Type_Srv   = "SRV"
	CreateDnsRecordOptions_Type_Txt   = "TXT"
)

Constants associated with the CreateDnsRecordOptions.Type property. dns record type.

View Source 
const (
	ListAllDnsRecordsOptions_Order_Content = "content"
	ListAllDnsRecordsOptions_Order_Name    = "name"
	ListAllDnsRecordsOptions_Order_Proxied = "proxied"
	ListAllDnsRecordsOptions_Order_TTL     = "ttl"
	ListAllDnsRecordsOptions_Order_Type    = "type"
)

Constants associated with the ListAllDnsRecordsOptions.Order property. Field by which to order list of DNS records.

View Source 
const (
	ListAllDnsRecordsOptions_Direction_Asc  = "asc"
	ListAllDnsRecordsOptions_Direction_Desc = "desc"
)

Constants associated with the ListAllDnsRecordsOptions.Direction property. Direction in which to order results [ascending/descending order].

View Source 
const (
	ListAllDnsRecordsOptions_Match_All = "all"
	ListAllDnsRecordsOptions_Match_Any = "any"
)

Constants associated with the ListAllDnsRecordsOptions.Match property. Whether to match all (all) or atleast one search parameter (any).

View Source 
const (
	UpdateDnsRecordOptions_Type_A     = "A"
	UpdateDnsRecordOptions_Type_Aaaa  = "AAAA"
	UpdateDnsRecordOptions_Type_Caa   = "CAA"
	UpdateDnsRecordOptions_Type_Cname = "CNAME"
	UpdateDnsRecordOptions_Type_Loc   = "LOC"
	UpdateDnsRecordOptions_Type_Mx    = "MX"
	UpdateDnsRecordOptions_Type_Ns    = "NS"
	UpdateDnsRecordOptions_Type_Spf   = "SPF"
	UpdateDnsRecordOptions_Type_Srv   = "SRV"
	UpdateDnsRecordOptions_Type_Txt   = "TXT"
)

Constants associated with the UpdateDnsRecordOptions.Type property. dns record type.

View Source 
const (
	DnsrecordDetails_Type_A     = "A"
	DnsrecordDetails_Type_Aaaa  = "AAAA"
	DnsrecordDetails_Type_Caa   = "CAA"
	DnsrecordDetails_Type_Cname = "CNAME"
	DnsrecordDetails_Type_Loc   = "LOC"
	DnsrecordDetails_Type_Mx    = "MX"
	DnsrecordDetails_Type_Ns    = "NS"
	DnsrecordDetails_Type_Spf   = "SPF"
	DnsrecordDetails_Type_Srv   = "SRV"
	DnsrecordDetails_Type_Txt   = "TXT"
)

Constants associated with the DnsrecordDetails.Type property. dns record type.

View Source 
const DefaultServiceName = "dns_records"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://api.cis.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func UnmarshalDeleteDnsrecordResp 

func UnmarshalDeleteDnsrecordResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteDnsrecordResp unmarshals an instance of DeleteDnsrecordResp from the specified map of raw messages.

func UnmarshalDeleteDnsrecordRespResult 

func UnmarshalDeleteDnsrecordRespResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteDnsrecordRespResult unmarshals an instance of DeleteDnsrecordRespResult from the specified map of raw messages.

func UnmarshalDnsrecordDetails 

func UnmarshalDnsrecordDetails(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDnsrecordDetails unmarshals an instance of DnsrecordDetails from the specified map of raw messages.

func UnmarshalDnsrecordResp 

func UnmarshalDnsrecordResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDnsrecordResp unmarshals an instance of DnsrecordResp from the specified map of raw messages.

func UnmarshalListDnsrecordsResp 

func UnmarshalListDnsrecordsResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListDnsrecordsResp unmarshals an instance of ListDnsrecordsResp from the specified map of raw messages.

func UnmarshalResultInfo 

func UnmarshalResultInfo(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResultInfo unmarshals an instance of ResultInfo from the specified map of raw messages.

Types

type CreateDnsRecordOptions 

type CreateDnsRecordOptions struct {
	// Required for all record types except SRV.
	Name *string `json:"name,omitempty"`

	// dns record type.
	Type *string `json:"type,omitempty"`

	// dns record ttl value.
	TTL *int64 `json:"ttl,omitempty"`

	// dns record content.
	Content *string `json:"content,omitempty"`

	// For MX records only.
	Priority *int64 `json:"priority,omitempty"`

	// For LOC, SRV and CAA records only.
	Data interface{} `json:"data,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateDnsRecordOptions : The CreateDnsRecord options.

func (*CreateDnsRecordOptions) SetContent 

func (options *CreateDnsRecordOptions) SetContent(content string) *CreateDnsRecordOptions

SetContent : Allow user to set Content

func (*CreateDnsRecordOptions) SetData 

func (options *CreateDnsRecordOptions) SetData(data interface{}) *CreateDnsRecordOptions

SetData : Allow user to set Data

func (*CreateDnsRecordOptions) SetHeaders 

func (options *CreateDnsRecordOptions) SetHeaders(param map[string]string) *CreateDnsRecordOptions

SetHeaders : Allow user to set Headers

func (*CreateDnsRecordOptions) SetName 

func (options *CreateDnsRecordOptions) SetName(name string) *CreateDnsRecordOptions

SetName : Allow user to set Name

func (*CreateDnsRecordOptions) SetPriority 

func (options *CreateDnsRecordOptions) SetPriority(priority int64) *CreateDnsRecordOptions

SetPriority : Allow user to set Priority

func (*CreateDnsRecordOptions) SetTTL added in v0.4.0 

func (options *CreateDnsRecordOptions) SetTTL(ttl int64) *CreateDnsRecordOptions

SetTTL : Allow user to set TTL

func (*CreateDnsRecordOptions) SetType 

func (options *CreateDnsRecordOptions) SetType(typeVar string) *CreateDnsRecordOptions

SetType : Allow user to set Type

type DeleteDnsRecordOptions 

type DeleteDnsRecordOptions struct {
	// Identifier of DNS record.
	DnsrecordIdentifier *string `json:"dnsrecord_identifier" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteDnsRecordOptions : The DeleteDnsRecord options.

func (*DeleteDnsRecordOptions) SetDnsrecordIdentifier 

func (options *DeleteDnsRecordOptions) SetDnsrecordIdentifier(dnsrecordIdentifier string) *DeleteDnsRecordOptions

SetDnsrecordIdentifier : Allow user to set DnsrecordIdentifier

func (*DeleteDnsRecordOptions) SetHeaders 

func (options *DeleteDnsRecordOptions) SetHeaders(param map[string]string) *DeleteDnsRecordOptions

SetHeaders : Allow user to set Headers

type DeleteDnsrecordResp 

type DeleteDnsrecordResp struct {
	// success response.
	Success *bool `json:"success" validate:"required"`

	// errors.
	Errors [][]string `json:"errors" validate:"required"`

	// messages.
	Messages [][]string `json:"messages" validate:"required"`

	// result.
	Result *DeleteDnsrecordRespResult `json:"result" validate:"required"`
}

DeleteDnsrecordResp : dns record delete response.

type DeleteDnsrecordRespResult 

type DeleteDnsrecordRespResult struct {
	// dns record id.
	ID *string `json:"id" validate:"required"`
}

DeleteDnsrecordRespResult : result.

type DnsRecordsV1 

type DnsRecordsV1 struct {
	Service *core.BaseService

	// Full crn of the service instance.
	Crn *string

	// Zone identifier (zone id).
	ZoneIdentifier *string
}

DnsRecordsV1 : DNS records

Version: 1.0.1

func NewDnsRecordsV1 

func NewDnsRecordsV1(options *DnsRecordsV1Options) (service *DnsRecordsV1, err error)

NewDnsRecordsV1 : constructs an instance of DnsRecordsV1 with passed in options.

func NewDnsRecordsV1UsingExternalConfig 

func NewDnsRecordsV1UsingExternalConfig(options *DnsRecordsV1Options) (dnsRecords *DnsRecordsV1, err error)

NewDnsRecordsV1UsingExternalConfig : constructs an instance of DnsRecordsV1 with passed in options and external configuration.

func (*DnsRecordsV1) CreateDnsRecord 

func (dnsRecords *DnsRecordsV1) CreateDnsRecord(createDnsRecordOptions *CreateDnsRecordOptions) (result *DnsrecordResp, response *core.DetailedResponse, err error)

CreateDnsRecord : Create DNS record Add a new DNS record for a given zone for a given service instance.

func (*DnsRecordsV1) DeleteDnsRecord 

func (dnsRecords *DnsRecordsV1) DeleteDnsRecord(deleteDnsRecordOptions *DeleteDnsRecordOptions) (result *DeleteDnsrecordResp, response *core.DetailedResponse, err error)

DeleteDnsRecord : Delete DNS record Delete a DNS record given its id.

func (*DnsRecordsV1) GetDnsRecord 

func (dnsRecords *DnsRecordsV1) GetDnsRecord(getDnsRecordOptions *GetDnsRecordOptions) (result *DnsrecordResp, response *core.DetailedResponse, err error)

GetDnsRecord : Get DNS record Get the details of a DNS record for a given zone under a given service instance.

func (*DnsRecordsV1) ListAllDnsRecords 

func (dnsRecords *DnsRecordsV1) ListAllDnsRecords(listAllDnsRecordsOptions *ListAllDnsRecordsOptions) (result *ListDnsrecordsResp, response *core.DetailedResponse, err error)

ListAllDnsRecords : List all DNS records List all DNS records for a given zone of a service instance.

func (*DnsRecordsV1) NewCreateDnsRecordOptions 

func (*DnsRecordsV1) NewCreateDnsRecordOptions() *CreateDnsRecordOptions

NewCreateDnsRecordOptions : Instantiate CreateDnsRecordOptions

func (*DnsRecordsV1) NewDeleteDnsRecordOptions 

func (*DnsRecordsV1) NewDeleteDnsRecordOptions(dnsrecordIdentifier string) *DeleteDnsRecordOptions

NewDeleteDnsRecordOptions : Instantiate DeleteDnsRecordOptions

func (*DnsRecordsV1) NewGetDnsRecordOptions 

func (*DnsRecordsV1) NewGetDnsRecordOptions(dnsrecordIdentifier string) *GetDnsRecordOptions

NewGetDnsRecordOptions : Instantiate GetDnsRecordOptions

func (*DnsRecordsV1) NewListAllDnsRecordsOptions 

func (*DnsRecordsV1) NewListAllDnsRecordsOptions() *ListAllDnsRecordsOptions

NewListAllDnsRecordsOptions : Instantiate ListAllDnsRecordsOptions

func (*DnsRecordsV1) NewUpdateDnsRecordOptions 

func (*DnsRecordsV1) NewUpdateDnsRecordOptions(dnsrecordIdentifier string) *UpdateDnsRecordOptions

NewUpdateDnsRecordOptions : Instantiate UpdateDnsRecordOptions

func (*DnsRecordsV1) SetServiceURL 

func (dnsRecords *DnsRecordsV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*DnsRecordsV1) UpdateDnsRecord 

func (dnsRecords *DnsRecordsV1) UpdateDnsRecord(updateDnsRecordOptions *UpdateDnsRecordOptions) (result *DnsrecordResp, response *core.DetailedResponse, err error)

UpdateDnsRecord : Update DNS record Update an existing DNS record for a given zone under a given service instance.

type DnsRecordsV1Options 

type DnsRecordsV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Full crn of the service instance.
	Crn *string `validate:"required"`

	// Zone identifier (zone id).
	ZoneIdentifier *string `validate:"required"`
}

DnsRecordsV1Options : Service options

type DnsrecordDetails 

type DnsrecordDetails struct {
	// dns record identifier.
	ID *string `json:"id,omitempty"`

	// created on.
	CreatedOn *string `json:"created_on,omitempty"`

	// modified date.
	ModifiedOn *string `json:"modified_on,omitempty"`

	// dns record name.
	Name *string `json:"name,omitempty"`

	// dns record type.
	Type *string `json:"type,omitempty"`

	// dns record content.
	Content *string `json:"content,omitempty"`

	// zone identifier.
	ZoneID *string `json:"zone_id,omitempty"`

	// zone name.
	ZoneName *string `json:"zone_name,omitempty"`

	// proxiable.
	Proxiable *bool `json:"proxiable,omitempty"`

	// proxied.
	Proxied *bool `json:"proxied,omitempty"`

	// dns record ttl value.
	TTL *int64 `json:"ttl,omitempty"`

	// Relevant only to MX type records.
	Priority *int64 `json:"priority,omitempty"`

	// Data details for the DNS record. Only for LOC, SRV, CAA records.
	Data interface{} `json:"data,omitempty"`
}

DnsrecordDetails : dns record details.

type DnsrecordResp 

type DnsrecordResp struct {
	// success response.
	Success *bool `json:"success" validate:"required"`

	// errors.
	Errors [][]string `json:"errors" validate:"required"`

	// messages.
	Messages [][]string `json:"messages" validate:"required"`

	// dns record details.
	Result *DnsrecordDetails `json:"result" validate:"required"`
}

DnsrecordResp : dns record response.

type GetDnsRecordOptions 

type GetDnsRecordOptions struct {
	// Identifier of DNS record.
	DnsrecordIdentifier *string `json:"dnsrecord_identifier" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDnsRecordOptions : The GetDnsRecord options.

func (*GetDnsRecordOptions) SetDnsrecordIdentifier 

func (options *GetDnsRecordOptions) SetDnsrecordIdentifier(dnsrecordIdentifier string) *GetDnsRecordOptions

SetDnsrecordIdentifier : Allow user to set DnsrecordIdentifier

func (*GetDnsRecordOptions) SetHeaders 

func (options *GetDnsRecordOptions) SetHeaders(param map[string]string) *GetDnsRecordOptions

SetHeaders : Allow user to set Headers

type ListAllDnsRecordsOptions 

type ListAllDnsRecordsOptions struct {
	// Type of DNS records to display.
	Type *string `json:"type,omitempty"`

	// Value of name field to filter by.
	Name *string `json:"name,omitempty"`

	// Value of content field to filter by.
	Content *string `json:"content,omitempty"`

	// Page number of paginated results.
	Page *int64 `json:"page,omitempty"`

	// Maximum number of DNS records per page.
	PerPage *int64 `json:"per_page,omitempty"`

	// Field by which to order list of DNS records.
	Order *string `json:"order,omitempty"`

	// Direction in which to order results [ascending/descending order].
	Direction *string `json:"direction,omitempty"`

	// Whether to match all (all) or atleast one search parameter (any).
	Match *string `json:"match,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAllDnsRecordsOptions : The ListAllDnsRecords options.

func (*ListAllDnsRecordsOptions) SetContent 

func (options *ListAllDnsRecordsOptions) SetContent(content string) *ListAllDnsRecordsOptions

SetContent : Allow user to set Content

func (*ListAllDnsRecordsOptions) SetDirection 

func (options *ListAllDnsRecordsOptions) SetDirection(direction string) *ListAllDnsRecordsOptions

SetDirection : Allow user to set Direction

func (*ListAllDnsRecordsOptions) SetHeaders 

func (options *ListAllDnsRecordsOptions) SetHeaders(param map[string]string) *ListAllDnsRecordsOptions

SetHeaders : Allow user to set Headers

func (*ListAllDnsRecordsOptions) SetMatch 

func (options *ListAllDnsRecordsOptions) SetMatch(match string) *ListAllDnsRecordsOptions

SetMatch : Allow user to set Match

func (*ListAllDnsRecordsOptions) SetName 

func (options *ListAllDnsRecordsOptions) SetName(name string) *ListAllDnsRecordsOptions

SetName : Allow user to set Name

func (*ListAllDnsRecordsOptions) SetOrder 

func (options *ListAllDnsRecordsOptions) SetOrder(order string) *ListAllDnsRecordsOptions

SetOrder : Allow user to set Order

func (*ListAllDnsRecordsOptions) SetPage 

func (options *ListAllDnsRecordsOptions) SetPage(page int64) *ListAllDnsRecordsOptions

SetPage : Allow user to set Page

func (*ListAllDnsRecordsOptions) SetPerPage 

func (options *ListAllDnsRecordsOptions) SetPerPage(perPage int64) *ListAllDnsRecordsOptions

SetPerPage : Allow user to set PerPage

func (*ListAllDnsRecordsOptions) SetType 

func (options *ListAllDnsRecordsOptions) SetType(typeVar string) *ListAllDnsRecordsOptions

SetType : Allow user to set Type

type ListDnsrecordsResp 

type ListDnsrecordsResp struct {
	// success response.
	Success *bool `json:"success" validate:"required"`

	// errors.
	Errors [][]string `json:"errors" validate:"required"`

	// messages.
	Messages [][]string `json:"messages" validate:"required"`

	// dns record list.
	Result []DnsrecordDetails `json:"result" validate:"required"`

	// result information.
	ResultInfo *ResultInfo `json:"result_info" validate:"required"`
}

ListDnsrecordsResp : dns records list response.

type ResultInfo 

type ResultInfo struct {
	// page.
	Page *int64 `json:"page" validate:"required"`

	// per page.
	PerPage *int64 `json:"per_page" validate:"required"`

	// count.
	Count *int64 `json:"count" validate:"required"`

	// total count.
	TotalCount *int64 `json:"total_count" validate:"required"`
}

ResultInfo : result information.

type UpdateDnsRecordOptions 

type UpdateDnsRecordOptions struct {
	// Identifier of DNS record.
	DnsrecordIdentifier *string `json:"dnsrecord_identifier" validate:"required"`

	// Required for all record types except SRV.
	Name *string `json:"name,omitempty"`

	// dns record type.
	Type *string `json:"type,omitempty"`

	// dns record ttl value.
	TTL *int64 `json:"ttl,omitempty"`

	// content of dns record.
	Content *string `json:"content,omitempty"`

	// For MX records only.
	Priority *int64 `json:"priority,omitempty"`

	// proxied.
	Proxied *bool `json:"proxied,omitempty"`

	// For LOC, SRV and CAA records only.
	Data interface{} `json:"data,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateDnsRecordOptions : The UpdateDnsRecord options.

func (*UpdateDnsRecordOptions) SetContent 

func (options *UpdateDnsRecordOptions) SetContent(content string) *UpdateDnsRecordOptions

SetContent : Allow user to set Content

func (*UpdateDnsRecordOptions) SetData 

func (options *UpdateDnsRecordOptions) SetData(data interface{}) *UpdateDnsRecordOptions

SetData : Allow user to set Data

func (*UpdateDnsRecordOptions) SetDnsrecordIdentifier 

func (options *UpdateDnsRecordOptions) SetDnsrecordIdentifier(dnsrecordIdentifier string) *UpdateDnsRecordOptions

SetDnsrecordIdentifier : Allow user to set DnsrecordIdentifier

func (*UpdateDnsRecordOptions) SetHeaders 

func (options *UpdateDnsRecordOptions) SetHeaders(param map[string]string) *UpdateDnsRecordOptions

SetHeaders : Allow user to set Headers

func (*UpdateDnsRecordOptions) SetName 

func (options *UpdateDnsRecordOptions) SetName(name string) *UpdateDnsRecordOptions

SetName : Allow user to set Name

func (*UpdateDnsRecordOptions) SetPriority 

func (options *UpdateDnsRecordOptions) SetPriority(priority int64) *UpdateDnsRecordOptions

SetPriority : Allow user to set Priority

func (*UpdateDnsRecordOptions) SetProxied 

func (options *UpdateDnsRecordOptions) SetProxied(proxied bool) *UpdateDnsRecordOptions

SetProxied : Allow user to set Proxied

func (*UpdateDnsRecordOptions) SetTTL added in v0.4.0 

func (options *UpdateDnsRecordOptions) SetTTL(ttl int64) *UpdateDnsRecordOptions

SetTTL : Allow user to set TTL

func (*UpdateDnsRecordOptions) SetType 

func (options *UpdateDnsRecordOptions) SetType(typeVar string) *UpdateDnsRecordOptions

SetType : Allow user to set Type

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.