permittednetworksfordnszonesv1

package
v0.16.0 Latest Latest
Warning

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

 Go to latest Published: Jun 9, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package permittednetworksfordnszonesv1 : Operations and models for the PermittedNetworksForDnsZonesV1 service Deprecated: This module is deprecated. For more detail https://github.com/IBM/networking-go-sdk/blob/master/DEPRECATION-NOTICE.md

Index

Constants

View Source 
const (
	PermittedNetwork_State_Active            = "ACTIVE"
	PermittedNetwork_State_RemovalInProgress = "REMOVAL_IN_PROGRESS"
)

Constants associated with the PermittedNetwork.State property. The state of a permitted network.

View Source 
const (
	CreatePermittedNetworkOptions_Type_Vpc = "vpc"
)

Constants associated with the CreatePermittedNetworkOptions.Type property. The type of a permitted network.

View Source 
const DefaultServiceName = "permitted_networks_for_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.

View Source 
const (
	PermittedNetwork_Type_Vpc = "vpc"
)

Constants associated with the PermittedNetwork.Type property. The type of a permitted network.

Variables

This section is empty.

Functions

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 UnmarshalListPermittedNetworks 

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

UnmarshalListPermittedNetworks unmarshals an instance of ListPermittedNetworks 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.

func UnmarshalPermittedNetwork 

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

UnmarshalPermittedNetwork unmarshals an instance of PermittedNetwork from the specified map of raw messages.

func UnmarshalPermittedNetworkVpc 

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

UnmarshalPermittedNetworkVpc unmarshals an instance of PermittedNetworkVpc from the specified map of raw messages.

Types

type CreatePermittedNetworkOptions 

type CreatePermittedNetworkOptions 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 type of a permitted network.
	Type *string `json:"type,omitempty"`

	// Permitted network data for VPC.
	PermittedNetwork *PermittedNetworkVpc `json:"permitted_network,omitempty"`

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

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

CreatePermittedNetworkOptions : The CreatePermittedNetwork options.

func (*CreatePermittedNetworkOptions) SetDnszoneID 

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

SetDnszoneID : Allow user to set DnszoneID

func (*CreatePermittedNetworkOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreatePermittedNetworkOptions) SetInstanceID 

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

SetInstanceID : Allow user to set InstanceID

func (*CreatePermittedNetworkOptions) SetPermittedNetwork 

func (options *CreatePermittedNetworkOptions) SetPermittedNetwork(permittedNetwork *PermittedNetworkVpc) *CreatePermittedNetworkOptions

SetPermittedNetwork : Allow user to set PermittedNetwork

func (*CreatePermittedNetworkOptions) SetType 

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

SetType : Allow user to set Type

func (*CreatePermittedNetworkOptions) SetXCorrelationID 

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

SetXCorrelationID : Allow user to set XCorrelationID

type DeletePermittedNetworkOptions 

type DeletePermittedNetworkOptions 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 unique identifier of a permitted network.
	PermittedNetworkID *string `json:"permitted_network_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
}

DeletePermittedNetworkOptions : The DeletePermittedNetwork options.

func (*DeletePermittedNetworkOptions) SetDnszoneID 

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

SetDnszoneID : Allow user to set DnszoneID

func (*DeletePermittedNetworkOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeletePermittedNetworkOptions) SetInstanceID 

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

SetInstanceID : Allow user to set InstanceID

func (*DeletePermittedNetworkOptions) SetPermittedNetworkID 

func (options *DeletePermittedNetworkOptions) SetPermittedNetworkID(permittedNetworkID string) *DeletePermittedNetworkOptions

SetPermittedNetworkID : Allow user to set PermittedNetworkID

func (*DeletePermittedNetworkOptions) SetXCorrelationID 

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

SetXCorrelationID : Allow user to set XCorrelationID

type FirstHref 

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

FirstHref : href.

type GetPermittedNetworkOptions 

type GetPermittedNetworkOptions 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 unique identifier of a permitted network.
	PermittedNetworkID *string `json:"permitted_network_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
}

GetPermittedNetworkOptions : The GetPermittedNetwork options.

func (*GetPermittedNetworkOptions) SetDnszoneID 

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

SetDnszoneID : Allow user to set DnszoneID

func (*GetPermittedNetworkOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetPermittedNetworkOptions) SetInstanceID 

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

SetInstanceID : Allow user to set InstanceID

func (*GetPermittedNetworkOptions) SetPermittedNetworkID 

func (options *GetPermittedNetworkOptions) SetPermittedNetworkID(permittedNetworkID string) *GetPermittedNetworkOptions

SetPermittedNetworkID : Allow user to set PermittedNetworkID

func (*GetPermittedNetworkOptions) SetXCorrelationID 

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

SetXCorrelationID : Allow user to set XCorrelationID

type ListPermittedNetworks 

type ListPermittedNetworks struct {
	// An array of permitted networks.
	PermittedNetworks []PermittedNetwork `json:"permitted_networks" validate:"required"`

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

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

	// Total number of permitted networks.
	TotalCount *int64 `json:"total_count" validate:"required"`

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

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

ListPermittedNetworks : List permitted networks response.

type ListPermittedNetworksOptions 

type ListPermittedNetworksOptions 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"`

	// Specify how many permitted networks to skip over, the default value is 0.
	Offset *string `json:"offset,omitempty"`

	// Specify how many permitted networks are returned, the default value is 10.
	Limit *string `json:"limit,omitempty"`

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

ListPermittedNetworksOptions : The ListPermittedNetworks options.

func (*ListPermittedNetworksOptions) SetDnszoneID 

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

SetDnszoneID : Allow user to set DnszoneID

func (*ListPermittedNetworksOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListPermittedNetworksOptions) SetInstanceID 

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

SetInstanceID : Allow user to set InstanceID

func (*ListPermittedNetworksOptions) SetLimit 

func (options *ListPermittedNetworksOptions) SetLimit(limit string) *ListPermittedNetworksOptions

SetLimit : Allow user to set Limit

func (*ListPermittedNetworksOptions) SetOffset 

func (options *ListPermittedNetworksOptions) SetOffset(offset string) *ListPermittedNetworksOptions

SetOffset : Allow user to set Offset

func (*ListPermittedNetworksOptions) SetXCorrelationID 

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

SetXCorrelationID : Allow user to set XCorrelationID

type NextHref 

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

NextHref : href.

type PermittedNetwork 

type PermittedNetwork struct {
	// Unique identifier of a permitted network.
	ID *string `json:"id,omitempty"`

	// The time when a permitted network is created.
	CreatedOn *string `json:"created_on,omitempty"`

	// The recent time when a permitted network is modified.
	ModifiedOn *string `json:"modified_on,omitempty"`

	// Permitted network data for VPC.
	PermittedNetwork *PermittedNetworkVpc `json:"permitted_network,omitempty"`

	// The type of a permitted network.
	Type *string `json:"type,omitempty"`

	// The state of a permitted network.
	State *string `json:"state,omitempty"`
}

PermittedNetwork : Permitted network details.

type PermittedNetworkVpc 

type PermittedNetworkVpc struct {
	// CRN string uniquely identifies a VPC.
	VpcCrn *string `json:"vpc_crn" validate:"required"`
}

PermittedNetworkVpc : Permitted network data for VPC.

type PermittedNetworksForDnsZonesV1 

type PermittedNetworksForDnsZonesV1 struct {
	Service *core.BaseService
}

PermittedNetworksForDnsZonesV1 : Permitted Networks for DNS Zones

Version: 1.0.0

func NewPermittedNetworksForDnsZonesV1 

func NewPermittedNetworksForDnsZonesV1(options *PermittedNetworksForDnsZonesV1Options) (service *PermittedNetworksForDnsZonesV1, err error)

NewPermittedNetworksForDnsZonesV1 : constructs an instance of PermittedNetworksForDnsZonesV1 with passed in options.

func NewPermittedNetworksForDnsZonesV1UsingExternalConfig 

func NewPermittedNetworksForDnsZonesV1UsingExternalConfig(options *PermittedNetworksForDnsZonesV1Options) (permittedNetworksForDnsZones *PermittedNetworksForDnsZonesV1, err error)

NewPermittedNetworksForDnsZonesV1UsingExternalConfig : constructs an instance of PermittedNetworksForDnsZonesV1 with passed in options and external configuration.

func (*PermittedNetworksForDnsZonesV1) CreatePermittedNetwork 

func (permittedNetworksForDnsZones *PermittedNetworksForDnsZonesV1) CreatePermittedNetwork(createPermittedNetworkOptions *CreatePermittedNetworkOptions) (result *PermittedNetwork, response *core.DetailedResponse, err error)

CreatePermittedNetwork : Create a permitted network Create a permitted network for a given DNS zone.

func (*PermittedNetworksForDnsZonesV1) DeletePermittedNetwork 

func (permittedNetworksForDnsZones *PermittedNetworksForDnsZonesV1) DeletePermittedNetwork(deletePermittedNetworkOptions *DeletePermittedNetworkOptions) (result *PermittedNetwork, response *core.DetailedResponse, err error)

DeletePermittedNetwork : Remove a permitted network Remove a permitted network.

func (*PermittedNetworksForDnsZonesV1) GetPermittedNetwork 

func (permittedNetworksForDnsZones *PermittedNetworksForDnsZonesV1) GetPermittedNetwork(getPermittedNetworkOptions *GetPermittedNetworkOptions) (result *PermittedNetwork, response *core.DetailedResponse, err error)

GetPermittedNetwork : Get a permitted network Get details of a permitted network.

func (*PermittedNetworksForDnsZonesV1) ListPermittedNetworks 

func (permittedNetworksForDnsZones *PermittedNetworksForDnsZonesV1) ListPermittedNetworks(listPermittedNetworksOptions *ListPermittedNetworksOptions) (result *ListPermittedNetworks, response *core.DetailedResponse, err error)

ListPermittedNetworks : List permitted networks List the permitted networks for a given DNS zone.

func (*PermittedNetworksForDnsZonesV1) NewCreatePermittedNetworkOptions 

func (*PermittedNetworksForDnsZonesV1) NewCreatePermittedNetworkOptions(instanceID string, dnszoneID string) *CreatePermittedNetworkOptions

NewCreatePermittedNetworkOptions : Instantiate CreatePermittedNetworkOptions

func (*PermittedNetworksForDnsZonesV1) NewDeletePermittedNetworkOptions 

func (*PermittedNetworksForDnsZonesV1) NewDeletePermittedNetworkOptions(instanceID string, dnszoneID string, permittedNetworkID string) *DeletePermittedNetworkOptions

NewDeletePermittedNetworkOptions : Instantiate DeletePermittedNetworkOptions

func (*PermittedNetworksForDnsZonesV1) NewGetPermittedNetworkOptions 

func (*PermittedNetworksForDnsZonesV1) NewGetPermittedNetworkOptions(instanceID string, dnszoneID string, permittedNetworkID string) *GetPermittedNetworkOptions

NewGetPermittedNetworkOptions : Instantiate GetPermittedNetworkOptions

func (*PermittedNetworksForDnsZonesV1) NewListPermittedNetworksOptions 

func (*PermittedNetworksForDnsZonesV1) NewListPermittedNetworksOptions(instanceID string, dnszoneID string) *ListPermittedNetworksOptions

NewListPermittedNetworksOptions : Instantiate ListPermittedNetworksOptions

func (*PermittedNetworksForDnsZonesV1) NewPermittedNetworkVpc 

func (*PermittedNetworksForDnsZonesV1) NewPermittedNetworkVpc(vpcCrn string) (model *PermittedNetworkVpc, err error)

NewPermittedNetworkVpc : Instantiate PermittedNetworkVpc (Generic Model Constructor)

func (*PermittedNetworksForDnsZonesV1) SetServiceURL 

func (permittedNetworksForDnsZones *PermittedNetworksForDnsZonesV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type PermittedNetworksForDnsZonesV1Options 

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

PermittedNetworksForDnsZonesV1Options : Service options

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.