dnsrecordbulkv1

Documentation

Overview

Package dnsrecordbulkv1 : Operations and models for the DnsRecordBulkV1 service

Index

• Constants
• func UnmarshalDnsRecordsObject(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalDnsRecordsObjectMessagesItem(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalDnsRecordsObjectResult(m map[string]json.RawMessage, result interface{}) (err error)
• func UnmarshalDnsRecordsObjectTiming(m map[string]json.RawMessage, result interface{}) (err error)
• type DnsRecordBulkV1
  • func NewDnsRecordBulkV1(options *DnsRecordBulkV1Options) (service *DnsRecordBulkV1, err error)
  • func NewDnsRecordBulkV1UsingExternalConfig(options *DnsRecordBulkV1Options) (dnsRecordBulk *DnsRecordBulkV1, err error)
  • func (dnsRecordBulk *DnsRecordBulkV1) GetDnsRecordsBulk(getDnsRecordsBulkOptions *GetDnsRecordsBulkOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)
  • func (*DnsRecordBulkV1) NewGetDnsRecordsBulkOptions() *GetDnsRecordsBulkOptions
  • func (*DnsRecordBulkV1) NewPostDnsRecordsBulkOptions() *PostDnsRecordsBulkOptions
  • func (dnsRecordBulk *DnsRecordBulkV1) PostDnsRecordsBulk(postDnsRecordsBulkOptions *PostDnsRecordsBulkOptions) (result *DnsRecordsObject, response *core.DetailedResponse, err error)
  • func (dnsRecordBulk *DnsRecordBulkV1) SetServiceURL(url string) error
• type DnsRecordBulkV1Options
• type DnsRecordsObject
• type DnsRecordsObjectMessagesItem
• type DnsRecordsObjectResult
• type DnsRecordsObjectTiming
• type GetDnsRecordsBulkOptions
  • func (options *GetDnsRecordsBulkOptions) SetHeaders(param map[string]string) *GetDnsRecordsBulkOptions
• type PostDnsRecordsBulkOptions
  • func (options *PostDnsRecordsBulkOptions) SetFile(file io.ReadCloser) *PostDnsRecordsBulkOptions
  • func (options *PostDnsRecordsBulkOptions) SetFileContentType(fileContentType string) *PostDnsRecordsBulkOptions
  • func (options *PostDnsRecordsBulkOptions) SetHeaders(param map[string]string) *PostDnsRecordsBulkOptions

Constants

const DefaultServiceName = "dns_record_bulk"

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

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

DefaultServiceURL is the default URL to make service requests to.

Functions

func UnmarshalDnsRecordsObject

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

UnmarshalDnsRecordsObject unmarshals an instance of DnsRecordsObject from the specified map of raw messages.

func UnmarshalDnsRecordsObjectMessagesItem

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

UnmarshalDnsRecordsObjectMessagesItem unmarshals an instance of DnsRecordsObjectMessagesItem from the specified map of raw messages.

func UnmarshalDnsRecordsObjectResult

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

UnmarshalDnsRecordsObjectResult unmarshals an instance of DnsRecordsObjectResult from the specified map of raw messages.

func UnmarshalDnsRecordsObjectTiming

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

UnmarshalDnsRecordsObjectTiming unmarshals an instance of DnsRecordsObjectTiming from the specified map of raw messages.

Types

type DnsRecordBulkV1

type DnsRecordBulkV1 struct {
	Service *core.BaseService

	// Full url-encoded CRN of the service instance.
	Crn *string

	// Identifier of zone.
	ZoneIdentifier *string
}

DnsRecordBulkV1 : Import/Export zone files

Version: 1.0.0

func NewDnsRecordBulkV1

func NewDnsRecordBulkV1(options *DnsRecordBulkV1Options) (service *DnsRecordBulkV1, err error)

NewDnsRecordBulkV1 : constructs an instance of DnsRecordBulkV1 with passed in options.

func NewDnsRecordBulkV1UsingExternalConfig

func NewDnsRecordBulkV1UsingExternalConfig(options *DnsRecordBulkV1Options) (dnsRecordBulk *DnsRecordBulkV1, err error)

NewDnsRecordBulkV1UsingExternalConfig : constructs an instance of DnsRecordBulkV1 with passed in options and external configuration.

func (*DnsRecordBulkV1) GetDnsRecordsBulk

func (dnsRecordBulk *DnsRecordBulkV1) GetDnsRecordsBulk(getDnsRecordsBulkOptions *GetDnsRecordsBulkOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetDnsRecordsBulk : Export zone file Export zone file.

func (*DnsRecordBulkV1) NewGetDnsRecordsBulkOptions

func (*DnsRecordBulkV1) NewGetDnsRecordsBulkOptions() *GetDnsRecordsBulkOptions

NewGetDnsRecordsBulkOptions : Instantiate GetDnsRecordsBulkOptions

func (*DnsRecordBulkV1) NewPostDnsRecordsBulkOptions

func (*DnsRecordBulkV1) NewPostDnsRecordsBulkOptions() *PostDnsRecordsBulkOptions

NewPostDnsRecordsBulkOptions : Instantiate PostDnsRecordsBulkOptions

func (*DnsRecordBulkV1) PostDnsRecordsBulk

func (dnsRecordBulk *DnsRecordBulkV1) PostDnsRecordsBulk(postDnsRecordsBulkOptions *PostDnsRecordsBulkOptions) (result *DnsRecordsObject, response *core.DetailedResponse, err error)

PostDnsRecordsBulk : Import zone file Import zone file.

func (*DnsRecordBulkV1) SetServiceURL

func (dnsRecordBulk *DnsRecordBulkV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type DnsRecordBulkV1Options

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

	// Full url-encoded CRN of the service instance.
	Crn *string `validate:"required"`

	// Identifier of zone.
	ZoneIdentifier *string `validate:"required"`
}

DnsRecordBulkV1Options : Service options

type DnsRecordsObject

type DnsRecordsObject struct {
	// Operation success flag.
	Success *bool `json:"success" validate:"required"`

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

	// Array of messages returned.
	Messages []DnsRecordsObjectMessagesItem `json:"messages" validate:"required"`

	// DNS record.
	Result *DnsRecordsObjectResult `json:"result" validate:"required"`

	// timing object.
	Timing *DnsRecordsObjectTiming `json:"timing,omitempty"`
}

DnsRecordsObject : dns records objects.

type DnsRecordsObjectMessagesItem

type DnsRecordsObjectMessagesItem struct {
	// Message code.
	Code *int64 `json:"code,omitempty"`

	// Message corresponding to the code.
	Message *string `json:"message,omitempty"`
}

DnsRecordsObjectMessagesItem : DnsRecordsObjectMessagesItem struct

type DnsRecordsObjectResult

type DnsRecordsObjectResult struct {
	// total records added.
	RecsAdded *int64 `json:"recs_added" validate:"required"`

	// total records parsed.
	TotalRecordsParsed *int64 `json:"total_records_parsed" validate:"required"`
}

DnsRecordsObjectResult : DNS record.

type DnsRecordsObjectTiming

type DnsRecordsObjectTiming struct {
	// start time.
	StartTime *string `json:"start_time,omitempty"`

	// end time.
	EndTime *string `json:"end_time,omitempty"`

	// process time.
	ProcessTime *int64 `json:"process_time,omitempty"`
}

DnsRecordsObjectTiming : timing object.

type GetDnsRecordsBulkOptions

type GetDnsRecordsBulkOptions struct {

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

GetDnsRecordsBulkOptions : The GetDnsRecordsBulk options.

func (*GetDnsRecordsBulkOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type PostDnsRecordsBulkOptions

type PostDnsRecordsBulkOptions struct {
	// file to upload.
	File io.ReadCloser `json:"file,omitempty"`

	// The content type of file.
	FileContentType *string `json:"file_content_type,omitempty"`

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

PostDnsRecordsBulkOptions : The PostDnsRecordsBulk options.

func (*PostDnsRecordsBulkOptions) SetFile

func (options *PostDnsRecordsBulkOptions) SetFile(file io.ReadCloser) *PostDnsRecordsBulkOptions

SetFile : Allow user to set File

func (*PostDnsRecordsBulkOptions) SetFileContentType

func (options *PostDnsRecordsBulkOptions) SetFileContentType(fileContentType string) *PostDnsRecordsBulkOptions

SetFileContentType : Allow user to set FileContentType

func (*PostDnsRecordsBulkOptions) SetHeaders

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

SetHeaders : Allow user to set Headers