networking

package
v0.1.0-alpha.52 Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const RegionNameApMum1 = shared.RegionNameApMum1

This is an alias to an internal value.

View Source 
const RegionNameApSeo1 = shared.RegionNameApSeo1

This is an alias to an internal value.

View Source 
const RegionNameApSin1 = shared.RegionNameApSin1

This is an alias to an internal value.

View Source 
const RegionNameApTyo1 = shared.RegionNameApTyo1

This is an alias to an internal value.

View Source 
const RegionNameEuAms1 = shared.RegionNameEuAms1

This is an alias to an internal value.

View Source 
const RegionNameEuFrk1 = shared.RegionNameEuFrk1

This is an alias to an internal value.

View Source 
const RegionNameEuLon1 = shared.RegionNameEuLon1

This is an alias to an internal value.

View Source 
const RegionNameUsChi1 = shared.RegionNameUsChi1

This is an alias to an internal value.

View Source 
const RegionNameUsSea1 = shared.RegionNameUsSea1

This is an alias to an internal value.

View Source 
const RegionNameUsSva1 = shared.RegionNameUsSva1

This is an alias to an internal value.

View Source 
const RegionNameUsWdc1 = shared.RegionNameUsWdc1

This is an alias to an internal value.

View Source 
const ResourceStatusCreating = shared.ResourceStatusCreating

This is an alias to an internal value.

View Source 
const ResourceStatusDeleted = shared.ResourceStatusDeleted

This is an alias to an internal value.

View Source 
const ResourceStatusDeleting = shared.ResourceStatusDeleting

This is an alias to an internal value.

View Source 
const ResourceStatusFailed = shared.ResourceStatusFailed

This is an alias to an internal value.

View Source 
const ResourceStatusPending = shared.ResourceStatusPending

This is an alias to an internal value.

View Source 
const ResourceStatusReady = shared.ResourceStatusReady

This is an alias to an internal value.

View Source 
const ResourceStatusUpdating = shared.ResourceStatusUpdating

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type Error 

type Error = apierror.Error

type FirewallRule 

type FirewallRule struct {
	ID                 string    `json:"id,required"`
	CreatedAt          time.Time `json:"created_at,required" format:"date-time"`
	DestinationAddress string    `json:"destination_address,required"`
	DestinationPorts   []string  `json:"destination_ports,required"`
	Name               string    `json:"name,required"`
	// Supported Firewall Rule protocols.
	Protocol      FirewallRuleProtocol  `json:"protocol,required"`
	SourceAddress string                `json:"source_address,required"`
	Status        shared.ResourceStatus `json:"status,required"`
	UpdatedAt     time.Time             `json:"updated_at,required" format:"date-time"`
	VPCID         string                `json:"vpc_id,required"`
	JSON          firewallRuleJSON      `json:"-"`
}

Firewall rule details.

func (*FirewallRule) UnmarshalJSON 

func (r *FirewallRule) UnmarshalJSON(data []byte) (err error)

type FirewallRuleList 

type FirewallRuleList struct {
	Items []FirewallRule       `json:"items,required"`
	JSON  firewallRuleListJSON `json:"-"`
}

func (*FirewallRuleList) UnmarshalJSON 

func (r *FirewallRuleList) UnmarshalJSON(data []byte) (err error)

type FirewallRuleNewParams 

type FirewallRuleNewParams struct {
	DestinationAddress param.Field[string]   `json:"destination_address,required"`
	DestinationPorts   param.Field[[]string] `json:"destination_ports,required"`
	Name               param.Field[string]   `json:"name,required"`
	// Supported Firewall Rule protocols.
	Protocol      param.Field[string] `json:"protocol,required"`
	SourceAddress param.Field[string] `json:"source_address,required"`
}

func (FirewallRuleNewParams) MarshalJSON 

func (r FirewallRuleNewParams) MarshalJSON() (data []byte, err error)

type FirewallRuleProtocol 

type FirewallRuleProtocol string

Supported Firewall Rule protocols. 

const (
	FirewallRuleProtocolTcp FirewallRuleProtocol = "tcp"
	FirewallRuleProtocolUdp FirewallRuleProtocol = "udp"
)

func (FirewallRuleProtocol) IsKnown 

func (r FirewallRuleProtocol) IsKnown() bool

type FirewallRuleService 

type FirewallRuleService struct {
	Options []option.RequestOption
}

FirewallRuleService contains methods and other services that help with interacting with the Nirvana Labs API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewFirewallRuleService method instead.

func NewFirewallRuleService 

func NewFirewallRuleService(opts ...option.RequestOption) (r *FirewallRuleService)

NewFirewallRuleService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*FirewallRuleService) Delete 

func (r *FirewallRuleService) Delete(ctx context.Context, vpcID string, firewallRuleID string, opts ...option.RequestOption) (res *operations.Operation, err error)

Delete a firewall rule

func (*FirewallRuleService) Get 

func (r *FirewallRuleService) Get(ctx context.Context, vpcID string, firewallRuleID string, opts ...option.RequestOption) (res *FirewallRule, err error)

Get details about a firewall rule

func (*FirewallRuleService) List 

func (r *FirewallRuleService) List(ctx context.Context, vpcID string, opts ...option.RequestOption) (res *FirewallRuleList, err error)

List all firewall rules

func (*FirewallRuleService) New 

func (r *FirewallRuleService) New(ctx context.Context, vpcID string, body FirewallRuleNewParams, opts ...option.RequestOption) (res *operations.Operation, err error)

Create a firewall rule

func (*FirewallRuleService) Update 

func (r *FirewallRuleService) Update(ctx context.Context, vpcID string, firewallRuleID string, body FirewallRuleUpdateParams, opts ...option.RequestOption) (res *operations.Operation, err error)

Update a firewall rule

type FirewallRuleUpdateParams 

type FirewallRuleUpdateParams struct {
	DestinationAddress param.Field[string]   `json:"destination_address"`
	DestinationPorts   param.Field[[]string] `json:"destination_ports"`
	Name               param.Field[string]   `json:"name"`
	// Supported Firewall Rule protocols.
	Protocol      param.Field[FirewallRuleUpdateParamsProtocol] `json:"protocol"`
	SourceAddress param.Field[string]                           `json:"source_address"`
}

func (FirewallRuleUpdateParams) MarshalJSON 

func (r FirewallRuleUpdateParams) MarshalJSON() (data []byte, err error)

type FirewallRuleUpdateParamsProtocol 

type FirewallRuleUpdateParamsProtocol string

Supported Firewall Rule protocols. 

const (
	FirewallRuleUpdateParamsProtocolTcp FirewallRuleUpdateParamsProtocol = "tcp"
	FirewallRuleUpdateParamsProtocolUdp FirewallRuleUpdateParamsProtocol = "udp"
)

func (FirewallRuleUpdateParamsProtocol) IsKnown 

func (r FirewallRuleUpdateParamsProtocol) IsKnown() bool

type NetworkingService 

type NetworkingService struct {
	Options       []option.RequestOption
	VPCs          *VPCService
	FirewallRules *FirewallRuleService
}

NetworkingService contains methods and other services that help with interacting with the Nirvana Labs API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewNetworkingService method instead.

func NewNetworkingService 

func NewNetworkingService(opts ...option.RequestOption) (r *NetworkingService)

NewNetworkingService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type RegionName 

type RegionName = shared.RegionName

This is an alias to an internal type.

type ResourceStatus 

type ResourceStatus = shared.ResourceStatus

This is an alias to an internal type.

type Subnet 

type Subnet struct {
	ID        string     `json:"id,required"`
	Cidr      string     `json:"cidr,required"`
	CreatedAt time.Time  `json:"created_at,required" format:"date-time"`
	Name      string     `json:"name,required"`
	UpdatedAt time.Time  `json:"updated_at,required" format:"date-time"`
	JSON      subnetJSON `json:"-"`
}

Subnet details.

func (*Subnet) UnmarshalJSON 

func (r *Subnet) UnmarshalJSON(data []byte) (err error)

type VPC 

type VPC struct {
	ID              string                `json:"id,required"`
	CreatedAt       time.Time             `json:"created_at,required" format:"date-time"`
	FirewallRuleIDs []string              `json:"firewall_rule_ids,required"`
	Name            string                `json:"name,required"`
	Region          shared.RegionName     `json:"region,required"`
	Status          shared.ResourceStatus `json:"status,required"`
	// Subnet details.
	Subnet    Subnet    `json:"subnet,required"`
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	JSON      vpcJSON   `json:"-"`
}

VPC details.

func (*VPC) UnmarshalJSON 

func (r *VPC) UnmarshalJSON(data []byte) (err error)

type VPCList 

type VPCList struct {
	Items []VPC       `json:"items,required"`
	JSON  vpcListJSON `json:"-"`
}

func (*VPCList) UnmarshalJSON 

func (r *VPCList) UnmarshalJSON(data []byte) (err error)

type VPCNewParams 

type VPCNewParams struct {
	Name       param.Field[string]            `json:"name,required"`
	Region     param.Field[shared.RegionName] `json:"region,required"`
	SubnetName param.Field[string]            `json:"subnet_name,required"`
}

func (VPCNewParams) MarshalJSON 

func (r VPCNewParams) MarshalJSON() (data []byte, err error)

type VPCService 

type VPCService struct {
	Options []option.RequestOption
}

VPCService contains methods and other services that help with interacting with the Nirvana Labs API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewVPCService method instead.

func NewVPCService 

func NewVPCService(opts ...option.RequestOption) (r *VPCService)

NewVPCService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*VPCService) Delete 

func (r *VPCService) Delete(ctx context.Context, vpcID string, opts ...option.RequestOption) (res *operations.Operation, err error)

Delete a VPC

func (*VPCService) Get 

func (r *VPCService) Get(ctx context.Context, vpcID string, opts ...option.RequestOption) (res *VPC, err error)

Get details about a VPC

func (*VPCService) List 

func (r *VPCService) List(ctx context.Context, opts ...option.RequestOption) (res *VPCList, err error)

List all VPCs

func (*VPCService) New 

func (r *VPCService) New(ctx context.Context, body VPCNewParams, opts ...option.RequestOption) (res *operations.Operation, err error)

Create a VPC

func (*VPCService) Update 

func (r *VPCService) Update(ctx context.Context, vpcID string, body VPCUpdateParams, opts ...option.RequestOption) (res *operations.Operation, err error)

Update a VPC

type VPCUpdateParams 

type VPCUpdateParams struct {
	Name       param.Field[string] `json:"name"`
	SubnetName param.Field[string] `json:"subnet_name"`
}

func (VPCUpdateParams) MarshalJSON 

func (r VPCUpdateParams) MarshalJSON() (data []byte, err error)

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.