Documentation
¶
Index ¶
- Constants
- type DedicatedBlockchainService
- type DedicatedService
- type Error
- type FlexBlockchainService
- type FlexService
- type RPCNodeService
- type RPCNodesDedicated
- type RPCNodesDedicatedBlockchain
- type RPCNodesDedicatedBlockchainList
- type RPCNodesDedicatedList
- type RPCNodesFlex
- type RPCNodesFlexBlockchain
- type RPCNodesFlexBlockchainList
- type RPCNodesFlexList
- 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 RegionNameEuAms1 = shared.RegionNameEuAms1
Equals "eu-ams-1"
const RegionNameEuFrk1 = shared.RegionNameEuFrk1
Equals "eu-frk-1"
const RegionNameEuLon1 = shared.RegionNameEuLon1
Equals "eu-lon-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 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 *RPCNodesDedicatedBlockchainList, err error)
List all Dedicated Blockchains
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 *RPCNodesDedicated, err error)
Get details about an RPC Node Dedicated
func (*DedicatedService) List ¶
func (r *DedicatedService) List(ctx context.Context, opts ...option.RequestOption) (res *RPCNodesDedicatedList, err error)
List all RPC Node Dedicated you created
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 *RPCNodesFlexBlockchainList, err error)
List all Flex Blockchains
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 *RPCNodesFlex, err error)
Get details about an RPC Node Flex
func (*FlexService) List ¶
func (r *FlexService) List(ctx context.Context, opts ...option.RequestOption) (res *RPCNodesFlexList, 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 RPCNodesDedicated ¶
type RPCNodesDedicated struct {
ID string `json:"id,required"`
Blockchain string `json:"blockchain,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
Endpoint string `json:"endpoint,required"`
Name string `json:"name,required"`
Network string `json:"network,required"`
UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
UserID string `json:"user_id,required"`
// 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
UserID respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
func (RPCNodesDedicated) RawJSON ¶
func (r RPCNodesDedicated) RawJSON() string
Returns the unmodified JSON received from the API
func (*RPCNodesDedicated) UnmarshalJSON ¶
func (r *RPCNodesDedicated) UnmarshalJSON(data []byte) error
type RPCNodesDedicatedBlockchain ¶
type RPCNodesDedicatedBlockchain struct {
Blockchain string `json:"blockchain,required"`
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 a dedicated node.
func (RPCNodesDedicatedBlockchain) RawJSON ¶
func (r RPCNodesDedicatedBlockchain) RawJSON() string
Returns the unmodified JSON received from the API
func (*RPCNodesDedicatedBlockchain) UnmarshalJSON ¶
func (r *RPCNodesDedicatedBlockchain) UnmarshalJSON(data []byte) error
type RPCNodesDedicatedBlockchainList ¶
type RPCNodesDedicatedBlockchainList struct {
Items []RPCNodesDedicatedBlockchain `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 (RPCNodesDedicatedBlockchainList) RawJSON ¶
func (r RPCNodesDedicatedBlockchainList) RawJSON() string
Returns the unmodified JSON received from the API
func (*RPCNodesDedicatedBlockchainList) UnmarshalJSON ¶
func (r *RPCNodesDedicatedBlockchainList) UnmarshalJSON(data []byte) error
type RPCNodesDedicatedList ¶
type RPCNodesDedicatedList struct {
Items []RPCNodesDedicated `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 (RPCNodesDedicatedList) RawJSON ¶
func (r RPCNodesDedicatedList) RawJSON() string
Returns the unmodified JSON received from the API
func (*RPCNodesDedicatedList) UnmarshalJSON ¶
func (r *RPCNodesDedicatedList) UnmarshalJSON(data []byte) error
type RPCNodesFlex ¶
type RPCNodesFlex struct {
ID string `json:"id,required"`
Blockchain string `json:"blockchain,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
Endpoint string `json:"endpoint,required"`
Name string `json:"name,required"`
Network string `json:"network,required"`
UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
UserID string `json:"user_id,required"`
// 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
UserID respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
func (RPCNodesFlex) RawJSON ¶
func (r RPCNodesFlex) RawJSON() string
Returns the unmodified JSON received from the API
func (*RPCNodesFlex) UnmarshalJSON ¶
func (r *RPCNodesFlex) UnmarshalJSON(data []byte) error
type RPCNodesFlexBlockchain ¶
type RPCNodesFlexBlockchain struct {
Blockchain string `json:"blockchain,required"`
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 API.
func (RPCNodesFlexBlockchain) RawJSON ¶
func (r RPCNodesFlexBlockchain) RawJSON() string
Returns the unmodified JSON received from the API
func (*RPCNodesFlexBlockchain) UnmarshalJSON ¶
func (r *RPCNodesFlexBlockchain) UnmarshalJSON(data []byte) error
type RPCNodesFlexBlockchainList ¶
type RPCNodesFlexBlockchainList struct {
Items []RPCNodesFlexBlockchain `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 (RPCNodesFlexBlockchainList) RawJSON ¶
func (r RPCNodesFlexBlockchainList) RawJSON() string
Returns the unmodified JSON received from the API
func (*RPCNodesFlexBlockchainList) UnmarshalJSON ¶
func (r *RPCNodesFlexBlockchainList) UnmarshalJSON(data []byte) error
type RPCNodesFlexList ¶
type RPCNodesFlexList struct {
Items []RPCNodesFlex `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 (RPCNodesFlexList) RawJSON ¶
func (r RPCNodesFlexList) RawJSON() string
Returns the unmodified JSON received from the API
func (*RPCNodesFlexList) UnmarshalJSON ¶
func (r *RPCNodesFlexList) UnmarshalJSON(data []byte) error
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.