Documentation
¶
Index ¶
- Constants
- type Dedicated
- type DedicatedBlockchain
- type DedicatedBlockchainList
- type DedicatedBlockchainService
- type DedicatedList
- type DedicatedService
- type Error
- type Flex
- type FlexBlockchain
- type FlexBlockchainList
- type FlexBlockchainService
- type FlexList
- type FlexService
- type RPCNodeService
- type RegionName
- type ResourceStatus
Constants ¶
const RegionNameApSeo1 = shared.RegionNameApSeo1
Equals "ap-seo-1"
const RegionNameApSin1 = shared.RegionNameApSin1
Equals "ap-sin-1"
const RegionNameApTyo1 = shared.RegionNameApTyo1
Equals "ap-tyo-1"
const RegionNameEuFrk1 = shared.RegionNameEuFrk1
Equals "eu-frk-1"
const RegionNameUsChi1 = shared.RegionNameUsChi1
Equals "us-chi-1"
const RegionNameUsSea1 = shared.RegionNameUsSea1
Equals "us-sea-1"
const RegionNameUsSva1 = shared.RegionNameUsSva1
Equals "us-sva-1"
const RegionNameUsWdc1 = shared.RegionNameUsWdc1
Equals "us-wdc-1"
const ResourceStatusCreating = shared.ResourceStatusCreating
Equals "creating"
const ResourceStatusDeleted = shared.ResourceStatusDeleted
Equals "deleted"
const ResourceStatusDeleting = shared.ResourceStatusDeleting
Equals "deleting"
const ResourceStatusError = shared.ResourceStatusError
Equals "error"
const ResourceStatusPending = shared.ResourceStatusPending
Equals "pending"
const ResourceStatusReady = shared.ResourceStatusReady
Equals "ready"
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,required"`
// Blockchain type.
Blockchain string `json:"blockchain,required"`
// When the RPC Node Dedicated was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// RPC endpoint URL.
Endpoint string `json:"endpoint,required"`
// Name of the RPC Node Dedicated.
Name string `json:"name,required"`
// Network type (e.g., mainnet, testnet).
Network string `json:"network,required"`
// When the RPC Node Dedicated was updated.
UpdatedAt time.Time `json:"updated_at,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
UpdatedAt respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
RPC Node Dedicated details.
func (*Dedicated) UnmarshalJSON ¶ added in v1.15.0
type DedicatedBlockchain ¶ added in v1.15.0
type DedicatedBlockchain struct {
// Blockchain type.
Blockchain string `json:"blockchain,required"`
// Network type (e.g., mainnet, testnet).
Network string `json:"network,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,required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Items 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 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 ¶
func (r *DedicatedBlockchainService) List(ctx context.Context, opts ...option.RequestOption) (res *DedicatedBlockchainList, err error)
List all Dedicated Blockchains
type DedicatedList ¶ added in v1.15.0
type DedicatedList struct {
Items []Dedicated `json:"items,required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Items 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 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 ¶
func (r *DedicatedService) List(ctx context.Context, opts ...option.RequestOption) (res *DedicatedList, err error)
List all RPC Node Dedicated you created
type Flex ¶ added in v1.15.0
type Flex struct {
// Unique identifier for the RPC Node Flex.
ID string `json:"id,required"`
// Blockchain type.
Blockchain string `json:"blockchain,required"`
// When the RPC Node Flex was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// RPC endpoint URL.
Endpoint string `json:"endpoint,required"`
// Name of the RPC Node Flex.
Name string `json:"name,required"`
// Network type (e.g., mainnet, testnet).
Network string `json:"network,required"`
// When the RPC Node Flex was updated.
UpdatedAt time.Time `json:"updated_at,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
UpdatedAt respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
RPC Node Flex details.
func (*Flex) UnmarshalJSON ¶ added in v1.15.0
type FlexBlockchain ¶ added in v1.15.0
type FlexBlockchain struct {
// Blockchain type.
Blockchain string `json:"blockchain,required"`
// Network type (e.g., mainnet, testnet).
Network string `json:"network,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,required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Items 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 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 ¶
func (r *FlexBlockchainService) List(ctx context.Context, opts ...option.RequestOption) (res *FlexBlockchainList, err error)
List all Flex Blockchains
type FlexList ¶ added in v1.15.0
type FlexList struct {
Items []Flex `json:"items,required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Items respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
func (*FlexList) UnmarshalJSON ¶ added in v1.15.0
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) 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, opts ...option.RequestOption) (res *FlexList, err error)
List all RPC Node Flex you created
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.