instance_types

package

v1.79.0 Latest Latest Go to latest Published: May 5, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/nirvana-labs/nirvana-go

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Error
type InstanceType
- func (r InstanceType) RawJSON() string
- func (r *InstanceType) UnmarshalJSON(data []byte) error
type InstanceTypeGetParamsRegion
type InstanceTypeList
- func (r InstanceTypeList) RawJSON() string
- func (r *InstanceTypeList) UnmarshalJSON(data []byte) error
type InstanceTypeListParams
- func (r InstanceTypeListParams) URLQuery() (v url.Values, err error)
type InstanceTypeService
- func NewInstanceTypeService(opts ...option.RequestOption) (r InstanceTypeService)
type Pagination
type RegionName
type ResourceStatus
type SourceIPRuleParam
type SourceIPRuleResponse

Constants ¶

View Source

const RegionNameUsChi1 = shared.RegionNameUsChi1

Equals "us-chi-1"

View Source

const RegionNameUsSva1 = shared.RegionNameUsSva1

Equals "us-sva-1"

View Source

const RegionNameUsSva2 = shared.RegionNameUsSva2

Equals "us-sva-2"

View Source

const ResourceStatusCreating = shared.ResourceStatusCreating

Equals "creating"

View Source

const ResourceStatusDeleted = shared.ResourceStatusDeleted

Equals "deleted"

View Source

const ResourceStatusDeleting = shared.ResourceStatusDeleting

Equals "deleting"

View Source

const ResourceStatusError = shared.ResourceStatusError

Equals "error"

View Source

const ResourceStatusPending = shared.ResourceStatusPending

Equals "pending"

View Source

const ResourceStatusReady = shared.ResourceStatusReady

Equals "ready"

View Source

const ResourceStatusUpdating = shared.ResourceStatusUpdating

Equals "updating"

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Error ¶

type Error = apierror.Error

type InstanceType ¶ added in v1.64.0

type InstanceType struct {
	Chipset string `json:"chipset" api:"required"`
	// When the Instance Type was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	Family    string    `json:"family" api:"required"`
	MemoryGB  int64     `json:"memory_gb" api:"required"`
	Name      string    `json:"name" api:"required"`
	// Network bandwidth in Gbps.
	NetworkBandwidthGbps float64 `json:"network_bandwidth_gbps" api:"required"`
	// Region the resource is in.
	//
	// Any of "us-sva-1", "us-sva-2", "us-chi-1".
	Region shared.RegionName `json:"region" api:"required"`
	Series string            `json:"series" api:"required"`
	// When the Instance Type was updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	Vcpu      int64     `json:"vcpu" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Chipset              respjson.Field
		CreatedAt            respjson.Field
		Family               respjson.Field
		MemoryGB             respjson.Field
		Name                 respjson.Field
		NetworkBandwidthGbps respjson.Field
		Region               respjson.Field
		Series               respjson.Field
		UpdatedAt            respjson.Field
		Vcpu                 respjson.Field
		ExtraFields          map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Instance type.

func (InstanceType) RawJSON ¶ added in v1.64.0

func (r InstanceType) RawJSON() string

Returns the unmodified JSON received from the API

func (*InstanceType) UnmarshalJSON ¶ added in v1.64.0

func (r *InstanceType) UnmarshalJSON(data []byte) error

type InstanceTypeGetParamsRegion ¶ added in v1.64.0

type InstanceTypeGetParamsRegion string

const (
	InstanceTypeGetParamsRegionUsSva1 InstanceTypeGetParamsRegion = "us-sva-1"
	InstanceTypeGetParamsRegionUsSva2 InstanceTypeGetParamsRegion = "us-sva-2"
	InstanceTypeGetParamsRegionUsChi1 InstanceTypeGetParamsRegion = "us-chi-1"
)

type InstanceTypeList ¶

type InstanceTypeList struct {
	Items []InstanceType `json:"items" api:"required"`
	// Pagination response details.
	Pagination shared.Pagination `json:"pagination" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Items       respjson.Field
		Pagination  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (InstanceTypeList) RawJSON ¶

func (r InstanceTypeList) RawJSON() string

Returns the unmodified JSON received from the API

func (*InstanceTypeList) UnmarshalJSON ¶

func (r *InstanceTypeList) UnmarshalJSON(data []byte) error

type InstanceTypeListParams ¶

type InstanceTypeListParams struct {
	// Pagination cursor returned by a previous request
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of items to return
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (InstanceTypeListParams) URLQuery ¶

func (r InstanceTypeListParams) URLQuery() (v url.Values, err error)

URLQuery serializes InstanceTypeListParams's query parameters as `url.Values`.

type InstanceTypeService ¶

type InstanceTypeService struct {
	Options []option.RequestOption
}

InstanceTypeService 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 NewInstanceTypeService method instead.

func NewInstanceTypeService ¶

func NewInstanceTypeService(opts ...option.RequestOption) (r InstanceTypeService)

NewInstanceTypeService 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 (*InstanceTypeService) Get ¶ added in v1.64.0

func (r *InstanceTypeService) Get(ctx context.Context, region InstanceTypeGetParamsRegion, name string, opts ...option.RequestOption) (res *InstanceType, err error)

Get an instance type by region and name

func (*InstanceTypeService) List ¶

func (r *InstanceTypeService) List(ctx context.Context, query InstanceTypeListParams, opts ...option.RequestOption) (res *pagination.Cursor[InstanceType], err error)

List instance types

func (*InstanceTypeService) ListAutoPaging ¶

func (r *InstanceTypeService) ListAutoPaging(ctx context.Context, query InstanceTypeListParams, opts ...option.RequestOption) *pagination.CursorAutoPager[InstanceType]

List instance types

type Pagination = shared.Pagination

Pagination response details.