dnsrecordbulkv1

package
v0.49.0 Latest Latest
Warning

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

 Go to latest Published: Jul 12, 2024 License: Apache-2.0 Imports: 9 Imported by: 1

Documentation

Overview

Package dnsrecordbulkv1 : Operations and models for the DnsRecordBulkV1 service

Index

Constants

View Source 
const DefaultServiceName = "dns_record_bulk"

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 GetServiceURLForRegion added in v0.12.1 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

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) Clone added in v0.12.1 

func (dnsRecordBulk *DnsRecordBulkV1) Clone() *DnsRecordBulkV1

Clone makes a copy of "dnsRecordBulk" suitable for processing requests.

func (*DnsRecordBulkV1) DisableRetries added in v0.12.1 

func (dnsRecordBulk *DnsRecordBulkV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*DnsRecordBulkV1) EnableRetries added in v0.12.1 

func (dnsRecordBulk *DnsRecordBulkV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

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) GetDnsRecordsBulkWithContext added in v0.12.1 

func (dnsRecordBulk *DnsRecordBulkV1) GetDnsRecordsBulkWithContext(ctx context.Context, getDnsRecordsBulkOptions *GetDnsRecordsBulkOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

GetDnsRecordsBulkWithContext is an alternate form of the GetDnsRecordsBulk method which supports a Context parameter

func (*DnsRecordBulkV1) GetEnableGzipCompression added in v0.12.1 

func (dnsRecordBulk *DnsRecordBulkV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*DnsRecordBulkV1) GetServiceURL added in v0.12.1 

func (dnsRecordBulk *DnsRecordBulkV1) GetServiceURL() string

GetServiceURL returns the service URL

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) PostDnsRecordsBulkWithContext added in v0.12.1 

func (dnsRecordBulk *DnsRecordBulkV1) PostDnsRecordsBulkWithContext(ctx context.Context, postDnsRecordsBulkOptions *PostDnsRecordsBulkOptions) (result *DnsRecordsObject, response *core.DetailedResponse, err error)

PostDnsRecordsBulkWithContext is an alternate form of the PostDnsRecordsBulk method which supports a Context parameter

func (*DnsRecordBulkV1) SetDefaultHeaders added in v0.12.1 

func (dnsRecordBulk *DnsRecordBulkV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*DnsRecordBulkV1) SetEnableGzipCompression added in v0.12.1 

func (dnsRecordBulk *DnsRecordBulkV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

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

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.