dnszonesv1

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: 4

Documentation

Overview

Package dnszonesv1 : Operations and models for the DnsZonesV1 service

Index

Constants

View Source 
const (
	Dnszone_State_Active            = "active"
	Dnszone_State_Deleted           = "deleted"
	Dnszone_State_Disabled          = "disabled"
	Dnszone_State_PendingDelete     = "pending_delete"
	Dnszone_State_PendingNetworkAdd = "pending_network_add"
)

Constants associated with the Dnszone.State property. State of DNS zone.

View Source 
const DefaultServiceName = "dns_zones"

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

View Source 
const DefaultServiceURL = "https://api.dns-svcs.cloud.ibm.com/v1"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func UnmarshalDnszone 

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

UnmarshalDnszone unmarshals an instance of Dnszone from the specified map of raw messages.

func UnmarshalFirstHref 

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

UnmarshalFirstHref unmarshals an instance of FirstHref from the specified map of raw messages.

func UnmarshalListDnszones 

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

UnmarshalListDnszones unmarshals an instance of ListDnszones from the specified map of raw messages.

func UnmarshalNextHref 

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

UnmarshalNextHref unmarshals an instance of NextHref from the specified map of raw messages.

Types

type CreateDnszoneOptions 

type CreateDnszoneOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// Name of DNS zone.
	Name *string `json:"name,omitempty"`

	// The text describing the purpose of a DNS zone.
	Description *string `json:"description,omitempty"`

	// The label of a DNS zone.
	Label *string `json:"label,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

CreateDnszoneOptions : The CreateDnszone options.

func (*CreateDnszoneOptions) SetDescription 

func (options *CreateDnszoneOptions) SetDescription(description string) *CreateDnszoneOptions

SetDescription : Allow user to set Description

func (*CreateDnszoneOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateDnszoneOptions) SetInstanceID 

func (options *CreateDnszoneOptions) SetInstanceID(instanceID string) *CreateDnszoneOptions

SetInstanceID : Allow user to set InstanceID

func (*CreateDnszoneOptions) SetLabel 

func (options *CreateDnszoneOptions) SetLabel(label string) *CreateDnszoneOptions

SetLabel : Allow user to set Label

func (*CreateDnszoneOptions) SetName 

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

SetName : Allow user to set Name

func (*CreateDnszoneOptions) SetXCorrelationID 

func (options *CreateDnszoneOptions) SetXCorrelationID(xCorrelationID string) *CreateDnszoneOptions

SetXCorrelationID : Allow user to set XCorrelationID

type DeleteDnszoneOptions 

type DeleteDnszoneOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a DNS zone.
	DnszoneID *string `json:"dnszone_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

DeleteDnszoneOptions : The DeleteDnszone options.

func (*DeleteDnszoneOptions) SetDnszoneID 

func (options *DeleteDnszoneOptions) SetDnszoneID(dnszoneID string) *DeleteDnszoneOptions

SetDnszoneID : Allow user to set DnszoneID

func (*DeleteDnszoneOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteDnszoneOptions) SetInstanceID 

func (options *DeleteDnszoneOptions) SetInstanceID(instanceID string) *DeleteDnszoneOptions

SetInstanceID : Allow user to set InstanceID

func (*DeleteDnszoneOptions) SetXCorrelationID 

func (options *DeleteDnszoneOptions) SetXCorrelationID(xCorrelationID string) *DeleteDnszoneOptions

SetXCorrelationID : Allow user to set XCorrelationID

type DnsZonesV1 

type DnsZonesV1 struct {
	Service *core.BaseService
}

DnsZonesV1 : DNS Zones

Version: 1.0.0

func NewDnsZonesV1 

func NewDnsZonesV1(options *DnsZonesV1Options) (service *DnsZonesV1, err error)

NewDnsZonesV1 : constructs an instance of DnsZonesV1 with passed in options.

func NewDnsZonesV1UsingExternalConfig 

func NewDnsZonesV1UsingExternalConfig(options *DnsZonesV1Options) (dnsZones *DnsZonesV1, err error)

NewDnsZonesV1UsingExternalConfig : constructs an instance of DnsZonesV1 with passed in options and external configuration.

func (*DnsZonesV1) CreateDnszone 

func (dnsZones *DnsZonesV1) CreateDnszone(createDnszoneOptions *CreateDnszoneOptions) (result *Dnszone, response *core.DetailedResponse, err error)

CreateDnszone : Create a DNS zone Create a DNS zone for a given service instance.

func (*DnsZonesV1) DeleteDnszone 

func (dnsZones *DnsZonesV1) DeleteDnszone(deleteDnszoneOptions *DeleteDnszoneOptions) (response *core.DetailedResponse, err error)

DeleteDnszone : Delete a DNS zone Delete a DNS zone.

func (*DnsZonesV1) GetDnszone 

func (dnsZones *DnsZonesV1) GetDnszone(getDnszoneOptions *GetDnszoneOptions) (result *Dnszone, response *core.DetailedResponse, err error)

GetDnszone : Get a DNS zone Get details of a DNS zone.

func (*DnsZonesV1) ListDnszones 

func (dnsZones *DnsZonesV1) ListDnszones(listDnszonesOptions *ListDnszonesOptions) (result *ListDnszones, response *core.DetailedResponse, err error)

ListDnszones : List DNS zones List the DNS zones for a given service instance.

func (*DnsZonesV1) NewCreateDnszoneOptions 

func (*DnsZonesV1) NewCreateDnszoneOptions(instanceID string) *CreateDnszoneOptions

NewCreateDnszoneOptions : Instantiate CreateDnszoneOptions

func (*DnsZonesV1) NewDeleteDnszoneOptions 

func (*DnsZonesV1) NewDeleteDnszoneOptions(instanceID string, dnszoneID string) *DeleteDnszoneOptions

NewDeleteDnszoneOptions : Instantiate DeleteDnszoneOptions

func (*DnsZonesV1) NewGetDnszoneOptions 

func (*DnsZonesV1) NewGetDnszoneOptions(instanceID string, dnszoneID string) *GetDnszoneOptions

NewGetDnszoneOptions : Instantiate GetDnszoneOptions

func (*DnsZonesV1) NewListDnszonesOptions 

func (*DnsZonesV1) NewListDnszonesOptions(instanceID string) *ListDnszonesOptions

NewListDnszonesOptions : Instantiate ListDnszonesOptions

func (*DnsZonesV1) NewUpdateDnszoneOptions 

func (*DnsZonesV1) NewUpdateDnszoneOptions(instanceID string, dnszoneID string) *UpdateDnszoneOptions

NewUpdateDnszoneOptions : Instantiate UpdateDnszoneOptions

func (*DnsZonesV1) SetServiceURL 

func (dnsZones *DnsZonesV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*DnsZonesV1) UpdateDnszone 

func (dnsZones *DnsZonesV1) UpdateDnszone(updateDnszoneOptions *UpdateDnszoneOptions) (result *Dnszone, response *core.DetailedResponse, err error)

UpdateDnszone : Update the properties of a DNS zone Update the properties of a DNS zone.

type DnsZonesV1Options 

type DnsZonesV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

DnsZonesV1Options : Service options

type Dnszone 

type Dnszone struct {
	// Unique identifier of a DNS zone.
	ID *string `json:"id,omitempty"`

	// the time when a DNS zone is created.
	CreatedOn *string `json:"created_on,omitempty"`

	// the recent time when a DNS zone is modified.
	ModifiedOn *string `json:"modified_on,omitempty"`

	// Unique identifier of a service instance.
	InstanceID *string `json:"instance_id,omitempty"`

	// Name of DNS zone.
	Name *string `json:"name,omitempty"`

	// The text describing the purpose of a DNS zone.
	Description *string `json:"description,omitempty"`

	// State of DNS zone.
	State *string `json:"state,omitempty"`

	// The label of a DNS zone.
	Label *string `json:"label,omitempty"`
}

Dnszone : DNS zone details.

type FirstHref 

type FirstHref struct {
	// href.
	Href *string `json:"href,omitempty"`
}

FirstHref : href.

type GetDnszoneOptions 

type GetDnszoneOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a DNS zone.
	DnszoneID *string `json:"dnszone_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

GetDnszoneOptions : The GetDnszone options.

func (*GetDnszoneOptions) SetDnszoneID 

func (options *GetDnszoneOptions) SetDnszoneID(dnszoneID string) *GetDnszoneOptions

SetDnszoneID : Allow user to set DnszoneID

func (*GetDnszoneOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetDnszoneOptions) SetInstanceID 

func (options *GetDnszoneOptions) SetInstanceID(instanceID string) *GetDnszoneOptions

SetInstanceID : Allow user to set InstanceID

func (*GetDnszoneOptions) SetXCorrelationID 

func (options *GetDnszoneOptions) SetXCorrelationID(xCorrelationID string) *GetDnszoneOptions

SetXCorrelationID : Allow user to set XCorrelationID

type ListDnszones 

type ListDnszones struct {
	// An array of DNS zones.
	Dnszones []Dnszone `json:"dnszones" validate:"required"`

	// Specify how many DNS zones to skip over, the default value is 0.
	Offset *int64 `json:"offset" validate:"required"`

	// Specify how many DNS zones are returned, the default value is 10.
	Limit *int64 `json:"limit" validate:"required"`

	// Total number of DNS zones.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// href.
	First *FirstHref `json:"first" validate:"required"`

	// href.
	Next *NextHref `json:"next,omitempty"`
}

ListDnszones : List DNS zones response.

type ListDnszonesOptions 

type ListDnszonesOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Specify how many DNS zones to skip over, the default value is 0.
	Offset *int64 `json:"offset,omitempty"`

	// Specify how many DNS zones are returned, the default value is 10.
	Limit *int64 `json:"limit,omitempty"`

	// Specify the VPC instance id.
	VpcID *string `json:"vpc_id,omitempty"`

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

ListDnszonesOptions : The ListDnszones options.

func (*ListDnszonesOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListDnszonesOptions) SetInstanceID 

func (options *ListDnszonesOptions) SetInstanceID(instanceID string) *ListDnszonesOptions

SetInstanceID : Allow user to set InstanceID

func (*ListDnszonesOptions) SetLimit 

func (options *ListDnszonesOptions) SetLimit(limit int64) *ListDnszonesOptions

SetLimit : Allow user to set Limit

func (*ListDnszonesOptions) SetOffset 

func (options *ListDnszonesOptions) SetOffset(offset int64) *ListDnszonesOptions

SetOffset : Allow user to set Offset

func (*ListDnszonesOptions) SetVpcID 

func (options *ListDnszonesOptions) SetVpcID(vpcID string) *ListDnszonesOptions

SetVpcID : Allow user to set VpcID

func (*ListDnszonesOptions) SetXCorrelationID 

func (options *ListDnszonesOptions) SetXCorrelationID(xCorrelationID string) *ListDnszonesOptions

SetXCorrelationID : Allow user to set XCorrelationID

type NextHref 

type NextHref struct {
	// href.
	Href *string `json:"href,omitempty"`
}

NextHref : href.

type UpdateDnszoneOptions 

type UpdateDnszoneOptions struct {
	// The unique identifier of a service instance.
	InstanceID *string `json:"instance_id" validate:"required"`

	// The unique identifier of a DNS zone.
	DnszoneID *string `json:"dnszone_id" validate:"required"`

	// The text describing the purpose of a DNS zone.
	Description *string `json:"description,omitempty"`

	// The label of a DNS zone.
	Label *string `json:"label,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

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

UpdateDnszoneOptions : The UpdateDnszone options.

func (*UpdateDnszoneOptions) SetDescription 

func (options *UpdateDnszoneOptions) SetDescription(description string) *UpdateDnszoneOptions

SetDescription : Allow user to set Description

func (*UpdateDnszoneOptions) SetDnszoneID 

func (options *UpdateDnszoneOptions) SetDnszoneID(dnszoneID string) *UpdateDnszoneOptions

SetDnszoneID : Allow user to set DnszoneID

func (*UpdateDnszoneOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateDnszoneOptions) SetInstanceID 

func (options *UpdateDnszoneOptions) SetInstanceID(instanceID string) *UpdateDnszoneOptions

SetInstanceID : Allow user to set InstanceID

func (*UpdateDnszoneOptions) SetLabel 

func (options *UpdateDnszoneOptions) SetLabel(label string) *UpdateDnszoneOptions

SetLabel : Allow user to set Label

func (*UpdateDnszoneOptions) SetXCorrelationID 

func (options *UpdateDnszoneOptions) SetXCorrelationID(xCorrelationID string) *UpdateDnszoneOptions

SetXCorrelationID : Allow user to set XCorrelationID

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.