rpc_nodes

package
v1.79.0 Latest Latest
Warning

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

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

Documentation

Index

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 Dedicated added in v1.15.0

type Dedicated struct {
	// Unique identifier for the RPC Node Dedicated.
	ID string `json:"id" api:"required"`
	// Blockchain type.
	Blockchain string `json:"blockchain" api:"required"`
	// When the RPC Node Dedicated was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// RPC endpoint URL.
	Endpoint string `json:"endpoint" api:"required"`
	// Name of the RPC Node Dedicated.
	Name string `json:"name" api:"required"`
	// Network type (e.g., mainnet, testnet).
	Network string `json:"network" api:"required"`
	// Project identifier associated with the RPC Node Dedicated.
	ProjectID string `json:"project_id" api:"required"`
	// Tags to attach to the RPC Node Dedicated.
	Tags []string `json:"tags" api:"required"`
	// When the RPC Node Dedicated was updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Blockchain  respjson.Field
		CreatedAt   respjson.Field
		Endpoint    respjson.Field
		Name        respjson.Field
		Network     respjson.Field
		ProjectID   respjson.Field
		Tags        respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

RPC Node Dedicated details.

func (Dedicated) RawJSON added in v1.15.0

func (r Dedicated) RawJSON() string

Returns the unmodified JSON received from the API

func (*Dedicated) UnmarshalJSON added in v1.15.0

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

type DedicatedBlockchain added in v1.15.0

type DedicatedBlockchain struct {
	// Blockchain type.
	Blockchain string `json:"blockchain" api:"required"`
	// Network type (e.g., mainnet, testnet).
	Network string `json:"network" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Blockchain  respjson.Field
		Network     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Blockchain supported by the RPC Node Dedicated.

func (DedicatedBlockchain) RawJSON added in v1.15.0

func (r DedicatedBlockchain) RawJSON() string

Returns the unmodified JSON received from the API

func (*DedicatedBlockchain) UnmarshalJSON added in v1.15.0

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

type DedicatedBlockchainList added in v1.15.0

type DedicatedBlockchainList struct {
	Items []DedicatedBlockchain `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 (DedicatedBlockchainList) RawJSON added in v1.15.0

func (r DedicatedBlockchainList) RawJSON() string

Returns the unmodified JSON received from the API

func (*DedicatedBlockchainList) UnmarshalJSON added in v1.15.0

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

type DedicatedBlockchainListParams added in v1.21.0

type DedicatedBlockchainListParams 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 (DedicatedBlockchainListParams) URLQuery added in v1.21.0

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

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

type DedicatedBlockchainService

type DedicatedBlockchainService struct {
	Options []option.RequestOption
}

DedicatedBlockchainService 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 NewDedicatedBlockchainService method instead.

func NewDedicatedBlockchainService

func NewDedicatedBlockchainService(opts ...option.RequestOption) (r DedicatedBlockchainService)

NewDedicatedBlockchainService 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 (*DedicatedBlockchainService) List

List all Dedicated Blockchains

func (*DedicatedBlockchainService) ListAutoPaging added in v1.21.0

List all Dedicated Blockchains

type DedicatedList added in v1.15.0

type DedicatedList struct {
	Items []Dedicated `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 (DedicatedList) RawJSON added in v1.15.0

func (r DedicatedList) RawJSON() string

Returns the unmodified JSON received from the API

func (*DedicatedList) UnmarshalJSON added in v1.15.0

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

type DedicatedListParams added in v1.21.0

type DedicatedListParams struct {
	// Project ID of resources to request
	ProjectID string `query:"project_id" api:"required" json:"-"`
	// 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 (DedicatedListParams) URLQuery added in v1.21.0

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

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

type DedicatedService

type DedicatedService struct {
	Options     []option.RequestOption
	Blockchains DedicatedBlockchainService
}

DedicatedService 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 NewDedicatedService method instead.

func NewDedicatedService

func NewDedicatedService(opts ...option.RequestOption) (r DedicatedService)

NewDedicatedService 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 (*DedicatedService) Get

func (r *DedicatedService) Get(ctx context.Context, nodeID string, opts ...option.RequestOption) (res *Dedicated, err error)

Get details about an RPC Node Dedicated

func (*DedicatedService) List

List all RPC Node Dedicated you created

func (*DedicatedService) ListAutoPaging added in v1.21.0

List all RPC Node Dedicated you created

type Error

type Error = apierror.Error

type Flex added in v1.15.0

type Flex struct {
	// Unique identifier for the RPC Node Flex.
	ID string `json:"id" api:"required"`
	// Blockchain type.
	Blockchain string `json:"blockchain" api:"required"`
	// When the RPC Node Flex was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// RPC endpoint URL.
	Endpoint string `json:"endpoint" api:"required"`
	// Name of the RPC Node Flex.
	Name string `json:"name" api:"required"`
	// Network type (e.g., mainnet, testnet).
	Network string `json:"network" api:"required"`
	// Project identifier associated with the RPC Node Flex.
	ProjectID string `json:"project_id" api:"required"`
	// Tags to attach to the RPC Node Flex.
	Tags []string `json:"tags" api:"required"`
	// When the RPC Node Flex was updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Blockchain  respjson.Field
		CreatedAt   respjson.Field
		Endpoint    respjson.Field
		Name        respjson.Field
		Network     respjson.Field
		ProjectID   respjson.Field
		Tags        respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

RPC Node Flex details.

func (Flex) RawJSON added in v1.15.0

func (r Flex) RawJSON() string

Returns the unmodified JSON received from the API

func (*Flex) UnmarshalJSON added in v1.15.0

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

type FlexBlockchain added in v1.15.0

type FlexBlockchain struct {
	// Blockchain type.
	Blockchain string `json:"blockchain" api:"required"`
	// Network type (e.g., mainnet, testnet).
	Network string `json:"network" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Blockchain  respjson.Field
		Network     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Blockchain supported by the RPC Node Flex.

func (FlexBlockchain) RawJSON added in v1.15.0

func (r FlexBlockchain) RawJSON() string

Returns the unmodified JSON received from the API

func (*FlexBlockchain) UnmarshalJSON added in v1.15.0

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

type FlexBlockchainList added in v1.15.0

type FlexBlockchainList struct {
	Items []FlexBlockchain `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 (FlexBlockchainList) RawJSON added in v1.15.0

func (r FlexBlockchainList) RawJSON() string

Returns the unmodified JSON received from the API

func (*FlexBlockchainList) UnmarshalJSON added in v1.15.0

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

type FlexBlockchainListParams added in v1.21.0

type FlexBlockchainListParams 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 (FlexBlockchainListParams) URLQuery added in v1.21.0

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

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

type FlexBlockchainService

type FlexBlockchainService struct {
	Options []option.RequestOption
}

FlexBlockchainService 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 NewFlexBlockchainService method instead.

func NewFlexBlockchainService

func NewFlexBlockchainService(opts ...option.RequestOption) (r FlexBlockchainService)

NewFlexBlockchainService 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 (*FlexBlockchainService) List

List all Flex Blockchains

func (*FlexBlockchainService) ListAutoPaging added in v1.21.0

List all Flex Blockchains

type FlexList added in v1.15.0

type FlexList struct {
	Items []Flex `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 (FlexList) RawJSON added in v1.15.0

func (r FlexList) RawJSON() string

Returns the unmodified JSON received from the API

func (*FlexList) UnmarshalJSON added in v1.15.0

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

type FlexListParams added in v1.21.0

type FlexListParams struct {
	// Project ID of resources to request
	ProjectID string `query:"project_id" api:"required" json:"-"`
	// 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 (FlexListParams) URLQuery added in v1.21.0

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

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

type FlexNewParams added in v1.20.0

type FlexNewParams struct {
	// Blockchain.
	Blockchain string `json:"blockchain" api:"required"`
	// Name of the RPC Node Flex.
	Name string `json:"name" api:"required"`
	// Network type (e.g., mainnet, testnet).
	Network string `json:"network" api:"required"`
	// Project ID to associate with the RPC Node Flex.
	ProjectID string `json:"project_id" api:"required"`
	// Tags to attach to the RPC Node Flex (optional, max 50).
	Tags []string `json:"tags,omitzero"`
	// contains filtered or unexported fields
}

func (FlexNewParams) MarshalJSON added in v1.20.0

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

func (*FlexNewParams) UnmarshalJSON added in v1.20.0

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

type FlexService

type FlexService struct {
	Options     []option.RequestOption
	Blockchains FlexBlockchainService
}

FlexService 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 NewFlexService method instead.

func NewFlexService

func NewFlexService(opts ...option.RequestOption) (r FlexService)

NewFlexService 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 (*FlexService) Delete added in v1.20.0

func (r *FlexService) Delete(ctx context.Context, nodeID string, opts ...option.RequestOption) (err error)

Delete an RPC Node Flex

func (*FlexService) Get

func (r *FlexService) Get(ctx context.Context, nodeID string, opts ...option.RequestOption) (res *Flex, err error)

Get details about an RPC Node Flex

func (*FlexService) List

func (r *FlexService) List(ctx context.Context, query FlexListParams, opts ...option.RequestOption) (res *pagination.Cursor[Flex], err error)

List all RPC Node Flex you created

func (*FlexService) ListAutoPaging added in v1.21.0

func (r *FlexService) ListAutoPaging(ctx context.Context, query FlexListParams, opts ...option.RequestOption) *pagination.CursorAutoPager[Flex]

List all RPC Node Flex you created

func (*FlexService) New added in v1.20.0

func (r *FlexService) New(ctx context.Context, body FlexNewParams, opts ...option.RequestOption) (res *Flex, err error)

Create a new RPC Node Flex

func (*FlexService) Update added in v1.20.0

func (r *FlexService) Update(ctx context.Context, nodeID string, body FlexUpdateParams, opts ...option.RequestOption) (res *Flex, err error)

Update an existing RPC Node Flex

type FlexUpdateParams added in v1.20.0

type FlexUpdateParams struct {
	// Name of the RPC Node Flex.
	Name param.Opt[string] `json:"name,omitzero"`
	// Tags to attach to the RPC Node Flex (optional, max 50).
	Tags []string `json:"tags,omitzero"`
	// contains filtered or unexported fields
}

func (FlexUpdateParams) MarshalJSON added in v1.20.0

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

func (*FlexUpdateParams) UnmarshalJSON added in v1.20.0

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

type Pagination added in v1.21.0

type Pagination = shared.Pagination

Pagination response details.

This is an alias to an internal type.

type RPCNodeService

type RPCNodeService struct {
	Options   []option.RequestOption
	Flex      FlexService
	Dedicated DedicatedService
}

RPCNodeService 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 NewRPCNodeService method instead.

func NewRPCNodeService

func NewRPCNodeService(opts ...option.RequestOption) (r RPCNodeService)

NewRPCNodeService 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

Region the resource is in.

This is an alias to an internal type.

type ResourceStatus

type ResourceStatus = shared.ResourceStatus

Status of the resource.

This is an alias to an internal type.

type SourceIPRuleParam added in v1.35.0

type SourceIPRuleParam = shared.SourceIPRuleParam

IP filter rules.

This is an alias to an internal type.

type SourceIPRuleResponse added in v1.54.0

type SourceIPRuleResponse = shared.SourceIPRuleResponse

IP filter rules.

This is an alias to an internal type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL