Documentation
¶
Index ¶
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 ConnectFlux ¶
type ConnectFlux struct {
// Unique identifier for the connect flux
ID string `json:"id,required"`
// Connect flux speed in Mbps
//
// Any of 50, 100, 200, 500, 1000, 2000, 5000.
BandwidthMbps int64 `json:"bandwidth_mbps,required"`
// CIDRs
Cidrs []string `json:"cidrs,required"`
// When the connect flux was created
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// Name of the connect flux
Name string `json:"name,required"`
// Provider CIDRs
ProviderCidrs []string `json:"provider_cidrs,required"`
// Provider name
ProviderName string `json:"provider_name,required"`
// Provider region
ProviderRegion string `json:"provider_region,required"`
// Region the resource is in.
//
// Any of "us-sea-1", "us-sva-1", "us-chi-1", "us-wdc-1", "eu-frk-1", "ap-sin-1",
// "ap-seo-1", "ap-tyo-1".
Region shared.RegionName `json:"region,required"`
// Status of the resource.
//
// Any of "pending", "creating", "updating", "ready", "deleting", "deleted",
// "error".
Status shared.ResourceStatus `json:"status,required"`
// When the connect flux 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
BandwidthMbps respjson.Field
Cidrs respjson.Field
CreatedAt respjson.Field
Name respjson.Field
ProviderCidrs respjson.Field
ProviderName respjson.Field
ProviderRegion respjson.Field
Region respjson.Field
Status respjson.Field
UpdatedAt respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
Connect flux details.
func (ConnectFlux) RawJSON ¶
func (r ConnectFlux) RawJSON() string
Returns the unmodified JSON received from the API
func (*ConnectFlux) UnmarshalJSON ¶
func (r *ConnectFlux) UnmarshalJSON(data []byte) error
type ConnectFluxList ¶
type ConnectFluxList struct {
Items []ConnectFlux `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 (ConnectFluxList) RawJSON ¶
func (r ConnectFluxList) RawJSON() string
Returns the unmodified JSON received from the API
func (*ConnectFluxList) UnmarshalJSON ¶
func (r *ConnectFluxList) UnmarshalJSON(data []byte) error
type ConnectService ¶
type ConnectService struct {
Options []option.RequestOption
Flux FluxService
}
ConnectService 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 NewConnectService method instead.
func NewConnectService ¶
func NewConnectService(opts ...option.RequestOption) (r ConnectService)
NewConnectService 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 FluxService ¶
type FluxService struct {
Options []option.RequestOption
}
FluxService 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 NewFluxService method instead.
func NewFluxService ¶
func NewFluxService(opts ...option.RequestOption) (r FluxService)
NewFluxService 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 (*FluxService) Get ¶
func (r *FluxService) Get(ctx context.Context, fluxID string, opts ...option.RequestOption) (res *ConnectFlux, err error)
Get Connect Flux details
func (*FluxService) List ¶
func (r *FluxService) List(ctx context.Context, opts ...option.RequestOption) (res *ConnectFluxList, err error)
List all Connect Flux
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.
Source Files