swagger

package

v0.1.47 Latest Latest Go to latest Published: Apr 17, 2024 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/crusoecloud/client-go

Links

Open Source Insights

Documentation ¶

Overview ¶

* Crusoe Cloud API Gateway * * The API Gateway exposes all publicly available API endpoints for Crusoe Cloud products. * * API version: v1alpha5 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AsyncOperationResponse
type AttachedDiskV1Alpha5
type BasicAuth
type Billing
type BillingApiService
- func (a *BillingApiService) GetBillingIntent(ctx context.Context, orgId string, intentType string) (BillingIntentGetResponse, *http.Response, error)
type BillingIntentGetResponse
type BulkCreateLocationInfo
type BulkInstancePostRequestV1Alpha5
type CapacitiesApiListSliceCapacitiesOpts
type CapacitiesApiService
- func (a *CapacitiesApiService) ListSliceCapacities(ctx context.Context, localVarOptionals *CapacitiesApiListSliceCapacitiesOpts) (ListCapacitiesResponseV1Alpha5, *http.Response, error)
type CapacityV1Alpha5
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type CreateSshKeyRequest
type CreateSshKeyResponse
type CreateTokenRequest
type DiskAttachment
type DiskOperationsApiListStorageDisksOperationsOpts
type DiskOperationsApiService
- func (a *DiskOperationsApiService) GetStorageDisksOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)
- func (a *DiskOperationsApiService) ListStorageDisksOperations(ctx context.Context, projectId string, ...) (ListOperationsResponseV1Alpha5, *http.Response, error)
type DiskSnapshot
type DiskSnapshotPostRequest
type DiskTemplate
type DiskV1Alpha5
type DisksApiService
- func (a *DisksApiService) CreateDisk(ctx context.Context, body DisksPostRequestV1Alpha5, projectId string) (AsyncOperationResponse, *http.Response, error)
- func (a *DisksApiService) DeleteDisk(ctx context.Context, projectId string, diskId string) (AsyncOperationResponse, *http.Response, error)
- func (a *DisksApiService) GetDisk(ctx context.Context, projectId string, diskId string) (DiskV1Alpha5, *http.Response, error)
- func (a *DisksApiService) ListDisks(ctx context.Context, projectId string) (ListDisksResponseV1Alpha5, *http.Response, error)
- func (a *DisksApiService) ResizeDisk(ctx context.Context, body DisksPatchRequest, projectId string, diskId string) (AsyncOperationResponse, *http.Response, error)
type DisksPatchRequest
type DisksPostRequestV1Alpha5
type EntitiesApiService
- func (a *EntitiesApiService) CreateOrganization(ctx context.Context, body EntitiesPutPostRequest) (EntitiesPutPostResponse, *http.Response, error)
- func (a *EntitiesApiService) DeleteOrganization(ctx context.Context, orgId string) (*http.Response, error)
- func (a *EntitiesApiService) GetOrganizations(ctx context.Context) (ListEntitiesResponseV1Alpha5, *http.Response, error)
- func (a *EntitiesApiService) UpdateOrganization(ctx context.Context, body EntitiesPutPostRequest, orgId string) (EntitiesPutPostResponse, *http.Response, error)
type EntitiesPutPostRequest
type EntitiesPutPostResponse
type Entity
type ErrorBody
type FeatureFlagsApiService
- func (a *FeatureFlagsApiService) GetFeatureFlags(ctx context.Context) (FeatureFlagsGetResponse, *http.Response, error)
type FeatureFlagsGetResponse
type Fingerprints
type FirewallRuleObject
type GeneratedToken
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type HealthCheckOptions
type HostChannelAdapter
type IBNetworksApiService
- func (a *IBNetworksApiService) GetIBNetwork(ctx context.Context, projectId string, ibNetworkId string) (IbNetwork, *http.Response, error)
- func (a *IBNetworksApiService) ListIBNetworks(ctx context.Context, projectId string) (ListIbNetworksResponseV1Alpha5, *http.Response, error)
type IBPartitionsApiService
- func (a *IBPartitionsApiService) CreateIBPartition(ctx context.Context, body IbPartitionsPostRequestV1Alpha5, projectId string) (IbPartition, *http.Response, error)
- func (a *IBPartitionsApiService) DeleteIBPartition(ctx context.Context, projectId string, ibPartitionId string) (*http.Response, error)
- func (a *IBPartitionsApiService) GetIBPartition(ctx context.Context, projectId string, ibPartitionId string) (IbPartition, *http.Response, error)
- func (a *IBPartitionsApiService) ListIBPartitions(ctx context.Context, projectId string) (ListIbPartitionsResponseV1Alpha5, *http.Response, error)
type IbNetwork
type IbNetworkCapacity
type IbPartition
type IbPartitionsPostRequestV1Alpha5
type IdentitiesApiService
- func (a *IdentitiesApiService) DeleteUserIdentity(ctx context.Context) (*http.Response, error)
- func (a *IdentitiesApiService) GetUserIdentity(ctx context.Context) (UserResponse, *http.Response, error)
- func (a *IdentitiesApiService) UpdateUserIdentity(ctx context.Context, body IdentityPutRequest) (UserResponse, *http.Response, error)
type Identity
type IdentityPutRequest
type Image
type ImagesApiService
- func (a *ImagesApiService) GetImage(ctx context.Context, imageId string) (Image, *http.Response, error)
- func (a *ImagesApiService) ListImages(ctx context.Context) (ListImagesResponseV1Alpha5, *http.Response, error)
type InlineResponse400
type InlineResponse401
type InlineResponse403
type InlineResponse404
type InlineResponse500
type InstanceGroup
type InstanceGroupPatchRequest
type InstanceGroupPostRequest
type InstanceGroupsApiService
- func (a *InstanceGroupsApiService) CreateInstanceGroup(ctx context.Context, body InstanceGroupPostRequest, projectId string) (InstanceGroup, *http.Response, error)
- func (a *InstanceGroupsApiService) DeleteInstanceGroup(ctx context.Context, instanceGroupId string, projectId string) (*http.Response, error)
- func (a *InstanceGroupsApiService) GetInstanceGroup(ctx context.Context, instanceGroupId string, projectId string) (InstanceGroup, *http.Response, error)
- func (a *InstanceGroupsApiService) ListInstanceGroups(ctx context.Context, projectId string) (ListInstanceGroupsResponse, *http.Response, error)
- func (a *InstanceGroupsApiService) PatchInstanceGroup(ctx context.Context, body InstanceGroupPatchRequest, instanceGroupId string, ...) (InstanceGroup, *http.Response, error)
type InstanceTemplate
type InstanceTemplatePostRequestV1Alpha5
type InstanceTemplatesApiService
- func (a *InstanceTemplatesApiService) CreateInstanceTemplate(ctx context.Context, body InstanceTemplatePostRequestV1Alpha5, ...) (InstanceTemplate, *http.Response, error)
- func (a *InstanceTemplatesApiService) DeleteInstanceTemplate(ctx context.Context, instanceTemplateId string, projectId string) (*http.Response, error)
- func (a *InstanceTemplatesApiService) GetInstanceTemplate(ctx context.Context, instanceTemplateId string, projectId string) (InstanceTemplate, *http.Response, error)
- func (a *InstanceTemplatesApiService) ListInstanceTemplates(ctx context.Context, projectId string) (ListInstanceTemplatesResponseV1Alpha5, *http.Response, error)
type InstanceV1Alpha5
type InstancesAttachDiskPostRequestV1Alpha5
type InstancesDetachDiskPostRequest
type InstancesPatchRequestV1Alpha5
type InstancesPostRequestV1Alpha5
type IpAddresses
type ListCapacitiesResponseV1Alpha5
type ListDiskSnapshotsResponseV1Alpha5
type ListDisksResponseV1Alpha5
type ListEntitiesResponseV1Alpha5
type ListIbNetworksResponseV1Alpha5
type ListIbPartitionsResponseV1Alpha5
type ListImagesResponseV1Alpha5
type ListInstanceGroupsResponse
type ListInstanceTemplatesResponseV1Alpha5
type ListInstancesResponseV1Alpha5
type ListLoadBalancersResponseV1Alpha5
type ListLocationsResponseV1Alpha5
type ListOperationsResponseV1Alpha5
type ListProjectsResponseV1Alpha5
type ListSshKeysResponseV1Alpha5
type ListTokensResponseV1Alpha5
type ListTypesResponseV1Alpha5
type ListVpcFirewallRulesResponseV1Alpha5
type ListVpcNetworksResponseV1Alpha5
type ListVpcSubnetsResponseV1Alpha5
type LoadBalancer
type LoadBalancerNetworkInterface
type LoadBalancerOperationsApiListNetworkingLoadBalancersOperationsOpts
type LoadBalancerOperationsApiService
- func (a *LoadBalancerOperationsApiService) GetNetworkingLoadBalancersOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)
- func (a *LoadBalancerOperationsApiService) ListNetworkingLoadBalancersOperations(ctx context.Context, projectId string, ...) (ListOperationsResponseV1Alpha5, *http.Response, error)
type LoadBalancersApiService
- func (a *LoadBalancersApiService) CreateLoadBalancer(ctx context.Context, body LoadBalancersPostRequest, projectId string) (AsyncOperationResponse, *http.Response, error)
- func (a *LoadBalancersApiService) DeleteLoadBalancer(ctx context.Context, projectId string, loadBalancerId string) (AsyncOperationResponse, *http.Response, error)
- func (a *LoadBalancersApiService) GetLoadBalancer(ctx context.Context, projectId string, loadBalancerId string) (LoadBalancer, *http.Response, error)
- func (a *LoadBalancersApiService) ListLoadBalancers(ctx context.Context, projectId string) (ListLoadBalancersResponseV1Alpha5, *http.Response, error)
- func (a *LoadBalancersApiService) PatchLoadBalancer(ctx context.Context, body LoadBalancersPatchRequestV1Alpha5, projectId string, ...) (AsyncOperationResponse, *http.Response, error)
type LoadBalancersPatchRequestV1Alpha5
type LoadBalancersPostRequest
type LocationsApiService
- func (a *LocationsApiService) ListLocations(ctx context.Context) (ListLocationsResponseV1Alpha5, *http.Response, error)
type ModelType
type NetworkInterface
type NetworkTarget
type Operation
type PartialHostChannelAdapter
type PrivateIpv4Address
type Project
type ProjectUsageResponse
type ProjectsApiListProjectsOpts
type ProjectsApiService
- func (a *ProjectsApiService) CreateProject(ctx context.Context, body ProjectsPostRequest) (ProjectsPutPostResponseV1Alpha5, *http.Response, error)
- func (a *ProjectsApiService) DeleteProject(ctx context.Context, projectId string) (*http.Response, error)
- func (a *ProjectsApiService) GetProject(ctx context.Context, projectId string) (Project, *http.Response, error)
- func (a *ProjectsApiService) ListProjects(ctx context.Context, localVarOptionals *ProjectsApiListProjectsOpts) (ListProjectsResponseV1Alpha5, *http.Response, error)
- func (a *ProjectsApiService) UpdateProject(ctx context.Context, body ProjectsPutRequest, projectId string) (ProjectsPutPostResponseV1Alpha5, *http.Response, error)
type ProjectsPostRequest
type ProjectsPutPostResponseV1Alpha5
type ProjectsPutRequest
type ProspectPostRequest
type ProspectPostResponse
type ProspectsApiService
- func (a *ProspectsApiService) CreateProspect(ctx context.Context, body ProspectPostRequest) (ProspectPostResponse, *http.Response, error)
type PublicIpv4Address
type SSHKeysApiService
- func (a *SSHKeysApiService) CreateSSHKey(ctx context.Context, body CreateSshKeyRequest) (CreateSshKeyResponse, *http.Response, error)
- func (a *SSHKeysApiService) DeleteSSHKey(ctx context.Context, id string) (*http.Response, error)
- func (a *SSHKeysApiService) GetSSHKeys(ctx context.Context) (ListSshKeysResponseV1Alpha5, *http.Response, error)
type SnapshotOperationsApiListStorageSnapshotsOperationsOpts
type SnapshotOperationsApiService
- func (a *SnapshotOperationsApiService) GetStorageSnapshotsOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)
- func (a *SnapshotOperationsApiService) ListStorageSnapshotsOperations(ctx context.Context, projectId string, ...) (ListOperationsResponseV1Alpha5, *http.Response, error)
type SnapshotsApiService
- func (a *SnapshotsApiService) CreateDiskSnapshot(ctx context.Context, body DiskSnapshotPostRequest, projectId string) (AsyncOperationResponse, *http.Response, error)
- func (a *SnapshotsApiService) DeleteDiskSnapshot(ctx context.Context, projectId string, snapshotId string) (AsyncOperationResponse, *http.Response, error)
- func (a *SnapshotsApiService) GetDiskSnapshot(ctx context.Context, projectId string, snapshotId string) (DiskSnapshot, *http.Response, error)
- func (a *SnapshotsApiService) ListDiskSnapshots(ctx context.Context, projectId string) (ListDiskSnapshotsResponseV1Alpha5, *http.Response, error)
type SshKey
type TokenInfo
type TokensApiService
- func (a *TokensApiService) CreateToken(ctx context.Context, body CreateTokenRequest) (TokensPostResponse, *http.Response, error)
- func (a *TokensApiService) DeleteToken(ctx context.Context, accessKey string) (*http.Response, error)
- func (a *TokensApiService) GetTokens(ctx context.Context) (TokensGetResponseV1Alpha4, *http.Response, error)
type TokensGetResponseV1Alpha4
type TokensPostResponse
type UsageApiService
- func (a *UsageApiService) GetUsage(ctx context.Context, orgId string, projects []string, resourceTypes []string, ...) (UsageByProjectGetResponse, *http.Response, error)
- func (a *UsageApiService) GetUsageExport(ctx context.Context, orgId string, projects []string, resources []string, ...) (*http.Response, error)
- func (a *UsageApiService) GetUsageOptions(ctx context.Context, orgId string) (UsageOptions, *http.Response, error)
type UsageByProjectGetResponse
type UsageOptions
type UserResponse
type VMOperationsApiListComputeVMsInstancesOperationsOpts
type VMOperationsApiService
- func (a *VMOperationsApiService) GetComputeVMsInstancesOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)
- func (a *VMOperationsApiService) ListComputeVMsInstancesOperations(ctx context.Context, projectId string, ...) (ListOperationsResponseV1Alpha5, *http.Response, error)
type VMsApiListInstancesOpts
type VMsApiService
- func (a *VMsApiService) BulkCreateInstance(ctx context.Context, body BulkInstancePostRequestV1Alpha5, projectId string) (AsyncOperationResponse, *http.Response, error)
- func (a *VMsApiService) CreateInstance(ctx context.Context, body InstancesPostRequestV1Alpha5, projectId string) (AsyncOperationResponse, *http.Response, error)
- func (a *VMsApiService) DeleteInstance(ctx context.Context, projectId string, vmId string) (AsyncOperationResponse, *http.Response, error)
- func (a *VMsApiService) GetInstance(ctx context.Context, projectId string, vmId string) (InstanceV1Alpha5, *http.Response, error)
- func (a *VMsApiService) GetVMTypes(ctx context.Context, projectId string) (ListTypesResponseV1Alpha5, *http.Response, error)
- func (a *VMsApiService) ListInstances(ctx context.Context, projectId string, ...) (ListInstancesResponseV1Alpha5, *http.Response, error)
- func (a *VMsApiService) UpdateInstance(ctx context.Context, body InstancesPatchRequestV1Alpha5, projectId string, ...) (AsyncOperationResponse, *http.Response, error)
- func (a *VMsApiService) UpdateInstanceAttachDisks(ctx context.Context, body InstancesAttachDiskPostRequestV1Alpha5, ...) (AsyncOperationResponse, *http.Response, error)
- func (a *VMsApiService) UpdateInstanceDetachDisks(ctx context.Context, body InstancesDetachDiskPostRequest, projectId string, ...) (AsyncOperationResponse, *http.Response, error)
type VPCFirewallRuleOperationsApiListNetworkingVPCFirewallRulesOperationsOpts
type VPCFirewallRuleOperationsApiService
- func (a *VPCFirewallRuleOperationsApiService) GetNetworkingVPCFirewallRulesOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)
- func (a *VPCFirewallRuleOperationsApiService) ListNetworkingVPCFirewallRulesOperations(ctx context.Context, projectId string, ...) (ListOperationsResponseV1Alpha5, *http.Response, error)
type VPCFirewallRulesApiService
- func (a *VPCFirewallRulesApiService) CreateVPCFirewallRule(ctx context.Context, body VpcFirewallRulesPostRequestV1Alpha5, ...) (AsyncOperationResponse, *http.Response, error)
- func (a *VPCFirewallRulesApiService) DeleteVPCFirewallRule(ctx context.Context, projectId string, vpcFirewallRuleId string) (AsyncOperationResponse, *http.Response, error)
- func (a *VPCFirewallRulesApiService) GetVPCFirewallRule(ctx context.Context, projectId string, vpcFirewallRuleId string) (VpcFirewallRule, *http.Response, error)
- func (a *VPCFirewallRulesApiService) ListVPCFirewallRules(ctx context.Context, projectId string) (ListVpcFirewallRulesResponseV1Alpha5, *http.Response, error)
- func (a *VPCFirewallRulesApiService) PatchVPCFirewallRule(ctx context.Context, body VpcFirewallRulesPatchRequest, projectId string, ...) (AsyncOperationResponse, *http.Response, error)
type VPCNetworkOperationsApiListNetworkingVPCNetworksOperationsOpts
type VPCNetworkOperationsApiService
- func (a *VPCNetworkOperationsApiService) GetNetworkingVPCNetworksOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)
- func (a *VPCNetworkOperationsApiService) ListNetworkingVPCNetworksOperations(ctx context.Context, projectId string, ...) (ListOperationsResponseV1Alpha5, *http.Response, error)
type VPCNetworksApiService
- func (a *VPCNetworksApiService) CreateVPCNetwork(ctx context.Context, body VpcNetworkPostRequest, projectId string) (VpcNetworkPostResponse, *http.Response, error)
- func (a *VPCNetworksApiService) DeleteVPCNetwork(ctx context.Context, projectId string, vpcNetworkId string) (AsyncOperationResponse, *http.Response, error)
- func (a *VPCNetworksApiService) GetVPCNetwork(ctx context.Context, projectId string, vpcNetworkId string) (VpcNetwork, *http.Response, error)
- func (a *VPCNetworksApiService) ListVPCNetworks(ctx context.Context, projectId string) (ListVpcNetworksResponseV1Alpha5, *http.Response, error)
- func (a *VPCNetworksApiService) PatchVPCNetwork(ctx context.Context, body VpcNetworkPatchRequest, projectId string, ...) (AsyncOperationResponse, *http.Response, error)
type VPCSubnetOperationsApiListNetworkingVPCSubnetsOperationsOpts
type VPCSubnetOperationsApiService
- func (a *VPCSubnetOperationsApiService) GetNetworkingVPCSubnetsOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)
- func (a *VPCSubnetOperationsApiService) ListNetworkingVPCSubnetsOperations(ctx context.Context, projectId string, ...) (ListOperationsResponseV1Alpha5, *http.Response, error)
type VPCSubnetsApiService
- func (a *VPCSubnetsApiService) CreateVPCSubnet(ctx context.Context, body VpcSubnetPostRequest, projectId string) (VpcSubnetPostResponse, *http.Response, error)
- func (a *VPCSubnetsApiService) DeleteVPCSubnet(ctx context.Context, projectId string, vpcSubnetId string) (AsyncOperationResponse, *http.Response, error)
- func (a *VPCSubnetsApiService) GetVPCSubnet(ctx context.Context, projectId string, vpcSubnetId string) (VpcSubnet, *http.Response, error)
- func (a *VPCSubnetsApiService) ListVPCSubnets(ctx context.Context, projectId string) (ListVpcSubnetsResponseV1Alpha5, *http.Response, error)
- func (a *VPCSubnetsApiService) PatchVPCSubnet(ctx context.Context, body VpcSubnetPatchRequest, projectId string, ...) (AsyncOperationResponse, *http.Response, error)
type VirtualizationFeatures
type VmAttachmentV1Alpha5
type VpcFirewallRule
type VpcFirewallRulesPatchRequest
type VpcFirewallRulesPostRequestV1Alpha5
type VpcNetwork
type VpcNetworkPatchRequest
type VpcNetworkPostRequest
type VpcNetworkPostResponse
type VpcSubnet
type VpcSubnetPatchRequest
type VpcSubnetPostRequest
type VpcSubnetPostResponse

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	BillingApi *BillingApiService

	CapacitiesApi *CapacitiesApiService

	DiskOperationsApi *DiskOperationsApiService

	DisksApi *DisksApiService

	EntitiesApi *EntitiesApiService

	FeatureFlagsApi *FeatureFlagsApiService

	IBNetworksApi *IBNetworksApiService

	IBPartitionsApi *IBPartitionsApiService

	IdentitiesApi *IdentitiesApiService

	ImagesApi *ImagesApiService

	InstanceGroupsApi *InstanceGroupsApiService

	InstanceTemplatesApi *InstanceTemplatesApiService

	LoadBalancerOperationsApi *LoadBalancerOperationsApiService

	LoadBalancersApi *LoadBalancersApiService

	LocationsApi *LocationsApiService

	ProjectsApi *ProjectsApiService

	ProspectsApi *ProspectsApiService

	SSHKeysApi *SSHKeysApiService

	SnapshotOperationsApi *SnapshotOperationsApiService

	SnapshotsApi *SnapshotsApiService

	TokensApi *TokensApiService

	UsageApi *UsageApiService

	VMOperationsApi *VMOperationsApiService

	VMsApi *VMsApiService

	VPCFirewallRuleOperationsApi *VPCFirewallRuleOperationsApiService

	VPCFirewallRulesApi *VPCFirewallRulesApiService

	VPCNetworkOperationsApi *VPCNetworkOperationsApiService

	VPCNetworksApi *VPCNetworksApiService

	VPCSubnetOperationsApi *VPCSubnetOperationsApiService

	VPCSubnetsApi *VPCSubnetsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Crusoe Cloud API Gateway API vv1alpha5 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AsyncOperationResponse ¶ added in v0.1.35

type AsyncOperationResponse struct {
	Operation *Operation `json:"operation"`
}

type AttachedDiskV1Alpha5 ¶ added in v0.1.31

type AttachedDiskV1Alpha5 struct {
	AttachmentType string `json:"attachment_type"`
	BlockSize      int64  `json:"block_size"`
	CreatedAt      string `json:"created_at"`
	Id             string `json:"id"`
	Location       string `json:"location"`
	Mode           string `json:"mode"`
	Name           string `json:"name"`
	SerialNumber   string `json:"serial_number"`
	Size           string `json:"size"`
	Type_          string `json:"type"`
	UpdatedAt      string `json:"updated_at"`
}

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Billing ¶

type Billing struct {
	Balance               string `json:"balance"`
	Delinquent            bool   `json:"delinquent"`
	HasValidPaymentMethod bool   `json:"has_valid_payment_method"`
}

type BillingApiService ¶

type BillingApiService service

func (*BillingApiService) GetBillingIntent ¶

func (a *BillingApiService) GetBillingIntent(ctx context.Context, orgId string, intentType string) (BillingIntentGetResponse, *http.Response, error)

BillingApiService Retrieve an intent to facilitate a Stripe action.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId
@param intentType

@return BillingIntentGetResponse

type BillingIntentGetResponse ¶

type BillingIntentGetResponse struct {
	Intent string `json:"intent"`
}

type BulkCreateLocationInfo ¶ added in v0.1.40

type BulkCreateLocationInfo struct {
	// The ID of the Infiniband partition to create the VMs in, if an IB type was specified. Must be in the same location as the VMs.
	IbPartitionId string `json:"ib_partition_id,omitempty"`
	// The location to create the VMs in.
	Location string `json:"location"`
	// The ID of the subnet to create the VMs in. Must be in the same location as the VMs. If not provided, the default subnet for the location will be used, if there is one.
	SubnetId string `json:"subnet_id,omitempty"`
}

type BulkInstancePostRequestV1Alpha5 ¶ added in v0.1.39

type BulkInstancePostRequestV1Alpha5 struct {
	// The number of VMs to create. If multiple locations are specified, this will be the number of VMs created in each location.
	Count int64 `json:"count"`
	// The ID of the instance group the VMs will be created in.
	InstanceGroupId  string                               `json:"instance_group_id,omitempty"`
	InstanceTemplate *InstanceTemplatePostRequestV1Alpha5 `json:"instance_template,omitempty"`
	// The ID of the instance template to use for creating the VMs.
	InstanceTemplateId string `json:"instance_template_id,omitempty"`
	// The locations to create the VMs in. This will override any location specified in the instance template.
	Locations []BulkCreateLocationInfo `json:"locations,omitempty"`
	// The name prefix for the VMs to be created. E.g. \"my-vm\" will create VMs with names \"my-vm-1\",
	NamePrefix string `json:"name_prefix"`
}

type CapacitiesApiListSliceCapacitiesOpts ¶

type CapacitiesApiListSliceCapacitiesOpts struct {
	ProductName optional.Interface
	Location    optional.Interface
}

type CapacitiesApiService ¶

type CapacitiesApiService service

func (*CapacitiesApiService) ListSliceCapacities ¶

func (a *CapacitiesApiService) ListSliceCapacities(ctx context.Context, localVarOptionals *CapacitiesApiListSliceCapacitiesOpts) (ListCapacitiesResponseV1Alpha5, *http.Response, error)

type CapacityV1Alpha5 ¶ added in v0.1.32

type CapacityV1Alpha5 struct {
	Location string `json:"location"`
	Quantity int32  `json:"quantity"`
	Type_    string `json:"type,omitempty"`
}

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type CreateSshKeyRequest ¶

type CreateSshKeyRequest struct {
	Name      string `json:"name"`
	PublicKey string `json:"public_key"`
}

type CreateSshKeyResponse ¶

type CreateSshKeyResponse struct {
	SshKey *SshKey `json:"ssh_key"`
}

type CreateTokenRequest ¶

type CreateTokenRequest struct {
	Alias     string `json:"alias,omitempty"`
	ExpiresAt string `json:"expires_at"`
}

type DiskAttachment ¶

type DiskAttachment struct {
	AttachmentType string `json:"attachment_type"`
	DiskId         string `json:"disk_id"`
	Mode           string `json:"mode"`
}

type DiskOperationsApiListStorageDisksOperationsOpts ¶ added in v0.1.35

type DiskOperationsApiListStorageDisksOperationsOpts struct {
	ResourceId optional.String
	State      optional.Interface
}

type DiskOperationsApiService ¶

type DiskOperationsApiService service

func (*DiskOperationsApiService) GetStorageDisksOperation ¶

func (a *DiskOperationsApiService) GetStorageDisksOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)

DiskOperationsApiService Get status of a single asynchronous operation This resource retrieves information about the status of an asynchronous operation initiated by the disks resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param operationId

@return Operation

func (*DiskOperationsApiService) ListStorageDisksOperations ¶

func (a *DiskOperationsApiService) ListStorageDisksOperations(ctx context.Context, projectId string, localVarOptionals *DiskOperationsApiListStorageDisksOperationsOpts) (ListOperationsResponseV1Alpha5, *http.Response, error)

type DiskSnapshot ¶

type DiskSnapshot struct {
	BlockSize   int64  `json:"block_size"`
	CreatedAt   string `json:"created_at"`
	CreatedFrom string `json:"created_from"`
	Id          string `json:"id"`
	Size        string `json:"size"`
	UpdatedAt   string `json:"updated_at"`
}

type DiskSnapshotPostRequest ¶

type DiskSnapshotPostRequest struct {
	DiskId string `json:"disk_id"`
	RoleId string `json:"role_id"`
}

type DiskTemplate ¶ added in v0.1.39

type DiskTemplate struct {
	Size  string `json:"size"`
	Type_ string `json:"type"`
}

type DiskV1Alpha5 ¶ added in v0.1.31

type DiskV1Alpha5 struct {
	AttachedTo   []VmAttachmentV1Alpha5 `json:"attached_to"`
	BlockSize    int64                  `json:"block_size"`
	CreatedAt    string                 `json:"created_at"`
	Id           string                 `json:"id"`
	Location     string                 `json:"location"`
	Name         string                 `json:"name"`
	SerialNumber string                 `json:"serial_number"`
	Size         string                 `json:"size"`
	Type_        string                 `json:"type"`
	UpdatedAt    string                 `json:"updated_at"`
}

type DisksApiService ¶

type DisksApiService service

func (*DisksApiService) CreateDisk ¶

func (a *DisksApiService) CreateDisk(ctx context.Context, body DisksPostRequestV1Alpha5, projectId string) (AsyncOperationResponse, *http.Response, error)

DisksApiService Create a new disk owned by the logged in user. Requires either a disk snapshot ID, or size and location, where size of disk should be in gibibytes (GiB) or tebibytes (TiB) in the format [Size][Unit]. E.g. 10GiB. Disk type must be one of: DISK_TYPE_PERSISTENT_SSD. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return AsyncOperationResponse

func (*DisksApiService) DeleteDisk ¶

func (a *DisksApiService) DeleteDisk(ctx context.Context, projectId string, diskId string) (AsyncOperationResponse, *http.Response, error)

DisksApiService Delete a disk owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param diskId

@return AsyncOperationResponse

func (*DisksApiService) GetDisk ¶

func (a *DisksApiService) GetDisk(ctx context.Context, projectId string, diskId string) (DiskV1Alpha5, *http.Response, error)

DisksApiService Retrieve details for a disk that belongs to the logged in user. Size of disk will be in gibibytes (GiB)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param diskId

@return DiskV1Alpha5

func (*DisksApiService) ListDisks ¶

func (a *DisksApiService) ListDisks(ctx context.Context, projectId string) (ListDisksResponseV1Alpha5, *http.Response, error)

DisksApiService Retrieve details about all disks that belong to the logged in user. Size of disks will be in gibibytes (GiB)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListDisksResponseV1Alpha5

func (*DisksApiService) ResizeDisk ¶

func (a *DisksApiService) ResizeDisk(ctx context.Context, body DisksPatchRequest, projectId string, diskId string) (AsyncOperationResponse, *http.Response, error)

DisksApiService Resize a disk that the logged in user owns. Size should be in gibibytes (GiB) or tebibytes (TiB) in the format [Size][Unit]. E.g. 10GiB A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId
@param diskId

@return AsyncOperationResponse

type DisksPatchRequest ¶

type DisksPatchRequest struct {
	Size string `json:"size"`
}

type DisksPostRequestV1Alpha5 ¶ added in v0.1.29

type DisksPostRequestV1Alpha5 struct {
	BlockSize  int64  `json:"block_size,omitempty"`
	Location   string `json:"location,omitempty"`
	Name       string `json:"name"`
	Size       string `json:"size,omitempty"`
	SnapshotId string `json:"snapshot_id,omitempty"`
	Type_      string `json:"type"`
}

type EntitiesApiService ¶

type EntitiesApiService service

func (*EntitiesApiService) CreateOrganization ¶

func (a *EntitiesApiService) CreateOrganization(ctx context.Context, body EntitiesPutPostRequest) (EntitiesPutPostResponse, *http.Response, error)

EntitiesApiService Create a new organization owned by the logged in user. A successful response from this resource will contain the json encoded organization details.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return EntitiesPutPostResponse

func (*EntitiesApiService) DeleteOrganization ¶

func (a *EntitiesApiService) DeleteOrganization(ctx context.Context, orgId string) (*http.Response, error)

EntitiesApiService Delete an organization owned by the logged in user. Delete operations will cascade to projects and VMs, and all members will be removed from the organization.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId

func (*EntitiesApiService) GetOrganizations ¶

func (a *EntitiesApiService) GetOrganizations(ctx context.Context) (ListEntitiesResponseV1Alpha5, *http.Response, error)

EntitiesApiService Retrieve details about all active organizations the logged in user belongs to.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ListEntitiesResponseV1Alpha5

func (*EntitiesApiService) UpdateOrganization ¶

func (a *EntitiesApiService) UpdateOrganization(ctx context.Context, body EntitiesPutPostRequest, orgId string) (EntitiesPutPostResponse, *http.Response, error)

EntitiesApiService Update details for an organization that the logged in user owns. A successful response from this resource will contain the updated organization details.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param orgId

@return EntitiesPutPostResponse

type EntitiesPutPostRequest ¶

type EntitiesPutPostRequest struct {
	OrganizationName string `json:"organization_name"`
}

type EntitiesPutPostResponse ¶

type EntitiesPutPostResponse struct {
	Entity *Entity `json:"entity"`
}

type Entity ¶

type Entity struct {
	Billing  *Billing               `json:"billing"`
	Features map[string]interface{} `json:"features"`
	Id       string                 `json:"id"`
	Name     string                 `json:"name"`
	Relation string                 `json:"relation"`
}

type ErrorBody ¶

type ErrorBody struct {
	Code    string `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
}

type FeatureFlagsApiService ¶

type FeatureFlagsApiService service

func (*FeatureFlagsApiService) GetFeatureFlags ¶

func (a *FeatureFlagsApiService) GetFeatureFlags(ctx context.Context) (FeatureFlagsGetResponse, *http.Response, error)

FeatureFlagsApiService Get feature flags for the currently logged in user. A successful response from this resource will contain a map of all feature flags and the value assigned to each of them for the user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return FeatureFlagsGetResponse

type FeatureFlagsGetResponse ¶

type FeatureFlagsGetResponse struct {
	FeatureFlags map[string]interface{} `json:"feature_flags"`
}

type Fingerprints ¶

type Fingerprints struct {
	Md5    string `json:"md5"`
	Sha256 string `json:"sha256"`
}

type FirewallRuleObject ¶

type FirewallRuleObject struct {
	Cidr       string `json:"cidr,omitempty"`
	ResourceId string `json:"resource_id,omitempty"`
}

It has two fields: CIDR and ResourceID. The CIDR field may either be a CIDR or an IP address. If an IP, it will be converted to a CIDR. Resource ids of VPC networks, Subnets, and VMs are the only allowed. Only one of the two fields can be non empty.

type GeneratedToken ¶

type GeneratedToken struct {
	AccessKey string `json:"access_key"`
	Alias     string `json:"alias,omitempty"`
	CreatedAt string `json:"created_at"`
	ExpiresAt string `json:"expires_at"`
	SecretKey string `json:"secret_key"`
}

These are the fields returned from a PUT request.

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type HealthCheckOptions ¶ added in v0.1.35

type HealthCheckOptions struct {
	FailureCount string `json:"failure_count,omitempty"`
	Interval     string `json:"interval,omitempty"`
	Port         string `json:"port"`
	SuccessCount string `json:"success_count,omitempty"`
	Timeout      string `json:"timeout,omitempty"`
}

type HostChannelAdapter ¶

type HostChannelAdapter struct {
	Guid          string `json:"guid"`
	IbNetworkId   string `json:"ib_network_id"`
	IbPartitionId string `json:"ib_partition_id"`
	Type_         string `json:"type"`
}

type IBNetworksApiService ¶

type IBNetworksApiService service

func (*IBNetworksApiService) GetIBNetwork ¶

func (a *IBNetworksApiService) GetIBNetwork(ctx context.Context, projectId string, ibNetworkId string) (IbNetwork, *http.Response, error)

IBNetworksApiService Retrieve details for an Infiniband network.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param ibNetworkId

@return IbNetwork

func (*IBNetworksApiService) ListIBNetworks ¶

func (a *IBNetworksApiService) ListIBNetworks(ctx context.Context, projectId string) (ListIbNetworksResponseV1Alpha5, *http.Response, error)

IBNetworksApiService Retrieve details for all Infiniband networks.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListIbNetworksResponseV1Alpha5

type IBPartitionsApiService ¶

type IBPartitionsApiService service

func (*IBPartitionsApiService) CreateIBPartition ¶

func (a *IBPartitionsApiService) CreateIBPartition(ctx context.Context, body IbPartitionsPostRequestV1Alpha5, projectId string) (IbPartition, *http.Response, error)

IBPartitionsApiService Create a new Infiniband partition owned by the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return IbPartition

func (*IBPartitionsApiService) DeleteIBPartition ¶

func (a *IBPartitionsApiService) DeleteIBPartition(ctx context.Context, projectId string, ibPartitionId string) (*http.Response, error)

IBPartitionsApiService Delete an Infiniband partition owned by the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param ibPartitionId

func (*IBPartitionsApiService) GetIBPartition ¶

func (a *IBPartitionsApiService) GetIBPartition(ctx context.Context, projectId string, ibPartitionId string) (IbPartition, *http.Response, error)

IBPartitionsApiService Retrieve details for an Infiniband partition that belongs to the user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param ibPartitionId

@return IbPartition

func (*IBPartitionsApiService) ListIBPartitions ¶

func (a *IBPartitionsApiService) ListIBPartitions(ctx context.Context, projectId string) (ListIbPartitionsResponseV1Alpha5, *http.Response, error)

IBPartitionsApiService Retrieve details for all Infiniband partitions that belongs to the user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListIbPartitionsResponseV1Alpha5

type IbNetwork ¶

type IbNetwork struct {
	Capacities []IbNetworkCapacity `json:"capacities"`
	Id         string              `json:"id"`
	Location   string              `json:"location"`
	Name       string              `json:"name"`
}

type IbNetworkCapacity ¶

type IbNetworkCapacity struct {
	Quantity  int32  `json:"quantity"`
	SliceType string `json:"slice_type"`
}

type IbPartition ¶

type IbPartition struct {
	IbNetworkId string `json:"ib_network_id"`
	Id          string `json:"id"`
	Name        string `json:"name"`
}

type IbPartitionsPostRequestV1Alpha5 ¶ added in v0.1.29

type IbPartitionsPostRequestV1Alpha5 struct {
	IbNetworkId string `json:"ib_network_id"`
	Name        string `json:"name"`
}

type IdentitiesApiService ¶

type IdentitiesApiService service

func (*IdentitiesApiService) DeleteUserIdentity ¶

func (a *IdentitiesApiService) DeleteUserIdentity(ctx context.Context) (*http.Response, error)

IdentitiesApiService Delete the account for the logged in user. Delete operations will cascade to all entities the user owns (organizations, roles, vms).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*IdentitiesApiService) GetUserIdentity ¶

func (a *IdentitiesApiService) GetUserIdentity(ctx context.Context) (UserResponse, *http.Response, error)

IdentitiesApiService Retrieve user details for the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return UserResponse

func (*IdentitiesApiService) UpdateUserIdentity ¶

func (a *IdentitiesApiService) UpdateUserIdentity(ctx context.Context, body IdentityPutRequest) (UserResponse, *http.Response, error)

IdentitiesApiService Update user details for the logged in user. A successful response from this resource wil contain the updated user details.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return UserResponse

type Identity ¶

type Identity struct {
	Email string `json:"email"`
	Name  string `json:"name"`
	Role  string `json:"role"`
}

Identity contains the Traits Island stores for a User inside of Kratos. These are the fields returned from a GET or PUT request.

type IdentityPutRequest ¶

type IdentityPutRequest struct {
	Name string `json:"name"`
	Role string `json:"role,omitempty"`
}

type Image ¶

type Image struct {
	CreatedAt   string   `json:"created_at"`
	Description string   `json:"description"`
	Id          string   `json:"id"`
	Locations   []string `json:"locations"`
	Name        string   `json:"name"`
	Tags        []string `json:"tags"`
}

type ImagesApiService ¶

type ImagesApiService service

func (*ImagesApiService) GetImage ¶

func (a *ImagesApiService) GetImage(ctx context.Context, imageId string) (Image, *http.Response, error)

ImagesApiService Retrieve details about a VM image.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param imageId

@return Image

func (*ImagesApiService) ListImages ¶

func (a *ImagesApiService) ListImages(ctx context.Context) (ListImagesResponseV1Alpha5, *http.Response, error)

ImagesApiService Lists all VM images available for use.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ListImagesResponseV1Alpha5

type InlineResponse400 ¶ added in v0.1.39

type InlineResponse400 struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type InlineResponse401 ¶ added in v0.1.39

type InlineResponse401 struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type InlineResponse403 ¶ added in v0.1.39

type InlineResponse403 struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type InlineResponse404 ¶ added in v0.1.39

type InlineResponse404 struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type InlineResponse500 ¶ added in v0.1.39

type InlineResponse500 struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type InstanceGroup ¶ added in v0.1.42

type InstanceGroup struct {
	// Time the instance template was created.
	CreatedAt string `json:"created_at"`
	// ID of the instance group.
	Id string `json:"id"`
	// A list of IDs of instances currently in the instance group.
	Instances []string `json:"instances"`
	// Name of the instance group.
	Name string `json:"name"`
	// Project ID of the project this instance template belongs to.
	ProjectId string `json:"project_id"`
	// The number of running instances currently in the Instance Group.
	RunningInstanceCount int64 `json:"running_instance_count"`
	// Instance Template ID currently associated with the instance group.
	TemplateId string `json:"template_id"`
	// Most recent time the instance group was updated.
	UpdatedAt string `json:"updated_at"`
}

type InstanceGroupPatchRequest ¶ added in v0.1.42

type InstanceGroupPatchRequest struct {
	// Name of the instance group.
	Name string `json:"name,omitempty"`
	// Instance Template ID to be associated with the instance group.
	TemplateId string `json:"template_id,omitempty"`
}

This is a separate type from InstanceGroupPostRequest for clearer documentation, as these fields are not required in the PATCH endpoint.

type InstanceGroupPostRequest ¶ added in v0.1.42

type InstanceGroupPostRequest struct {
	// Name of the instance group.
	Name string `json:"name"`
	// Instance Template ID to be associated with the instance group.
	TemplateId string `json:"template_id"`
}

type InstanceGroupsApiService ¶ added in v0.1.42

type InstanceGroupsApiService service

func (*InstanceGroupsApiService) CreateInstanceGroup ¶ added in v0.1.42

func (a *InstanceGroupsApiService) CreateInstanceGroup(ctx context.Context, body InstanceGroupPostRequest, projectId string) (InstanceGroup, *http.Response, error)

InstanceGroupsApiService Create an instance group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return InstanceGroup

func (*InstanceGroupsApiService) DeleteInstanceGroup ¶ added in v0.1.42

func (a *InstanceGroupsApiService) DeleteInstanceGroup(ctx context.Context, instanceGroupId string, projectId string) (*http.Response, error)

InstanceGroupsApiService Delete an instance group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceGroupId
@param projectId

func (*InstanceGroupsApiService) GetInstanceGroup ¶ added in v0.1.42

func (a *InstanceGroupsApiService) GetInstanceGroup(ctx context.Context, instanceGroupId string, projectId string) (InstanceGroup, *http.Response, error)

InstanceGroupsApiService Retrieve details about an instance group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceGroupId
@param projectId

@return InstanceGroup

func (*InstanceGroupsApiService) ListInstanceGroups ¶ added in v0.1.42

func (a *InstanceGroupsApiService) ListInstanceGroups(ctx context.Context, projectId string) (ListInstanceGroupsResponse, *http.Response, error)

InstanceGroupsApiService Lists all instance groups.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListInstanceGroupsResponse

func (*InstanceGroupsApiService) PatchInstanceGroup ¶ added in v0.1.42

func (a *InstanceGroupsApiService) PatchInstanceGroup(ctx context.Context, body InstanceGroupPatchRequest, instanceGroupId string, projectId string) (InstanceGroup, *http.Response, error)

InstanceGroupsApiService Update an instance group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param instanceGroupId
@param projectId

@return InstanceGroup

type InstanceTemplate ¶ added in v0.1.39

type InstanceTemplate struct {
	// Time the instance template was created.
	CreatedAt string `json:"created_at"`
	// Disks to create for all VMs created from this instance template.
	Disks []DiskTemplate `json:"disks,omitempty"`
	// IB Partition to use for all VMs created from this instance template. Only used for IB-enabled VM types. Empty if template has no location.
	IbPartitionId string `json:"ib_partition_id"`
	// ID of the instance template.
	Id string `json:"id"`
	// OS Image to use for all VMs created from this instance template.
	ImageName string `json:"image_name"`
	// Location to use for all VMs created from this instance template. May be empty if we do not want to bind this template to a location.
	Location string `json:"location"`
	// Name of the instance template. (This is not the name of the VMs created from this instance template.)
	Name string `json:"name"`
	// Project ID of the project this instance template belongs to.
	ProjectId string `json:"project_id"`
	// Public IP address type to use for all VMs created from this instance template. Must either be \"static\" or \"dynamic\".
	PublicIpAddressType string `json:"public_ip_address_type"`
	// Shutdown script to use for all VMs created from this instance template.
	ShutdownScript string `json:"shutdown_script"`
	// SSH public key to use for all VMs created from this instance template.
	SshPublicKey string `json:"ssh_public_key"`
	// Startup script to use for all VMs created from this instance template.
	StartupScript string `json:"startup_script"`
	// SubnetID to use for all VMs created from this instance template. Only used if template has a location.
	SubnetId string `json:"subnet_id"`
	// Product name of the VM type we want to create from this instance template.
	Type_                  string                  `json:"type"`
	VirtualizationFeatures *VirtualizationFeatures `json:"virtualization_features,omitempty"`
}

type InstanceTemplatePostRequestV1Alpha5 ¶ added in v0.1.39

type InstanceTemplatePostRequestV1Alpha5 struct {
	// Disks to create for all VMs created from this instance template.
	Disks []DiskTemplate `json:"disks,omitempty"`
	// IB Partition to use for all VMs created from this instance template. Should only be provided for IB-enabled VM types. This is location-specific and must be provided if location is provided.
	IbPartitionId string `json:"ib_partition_id,omitempty"`
	// OS Image to use for all VMs created from this instance template.
	ImageName string `json:"image_name,omitempty"`
	// Location to use for all VMs created from this instance template. If provided, all location-specific resources must also be provided.
	Location string `json:"location,omitempty"`
	// Public IP address type to use for all VMs created from this instance template. Must either be \"static\" or \"dynamic\".
	PublicIpAddressType string `json:"public_ip_address_type,omitempty"`
	// Shutdown script to use for all VMs created from this instance template.
	ShutdownScript string `json:"shutdown_script,omitempty"`
	// SSH public key to use for all VMs created from this instance template.
	SshPublicKey string `json:"ssh_public_key"`
	// Startup script to use for all VMs created from this instance template.
	StartupScript string `json:"startup_script,omitempty"`
	// Subnet to use for all VMs created from this instance template. This is location-specific and must be provided if location is provided.
	SubnetId string `json:"subnet_id,omitempty"`
	// Name of the instance template. (This is not the name of the VMs created from this instance template.)
	TemplateName string `json:"template_name"`
	// Product name of the VM type we want to create from this instance template.
	Type_                  string                  `json:"type"`
	VirtualizationFeatures *VirtualizationFeatures `json:"virtualization_features,omitempty"`
}

type InstanceTemplatesApiService ¶ added in v0.1.39

type InstanceTemplatesApiService service

func (*InstanceTemplatesApiService) CreateInstanceTemplate ¶ added in v0.1.39

func (a *InstanceTemplatesApiService) CreateInstanceTemplate(ctx context.Context, body InstanceTemplatePostRequestV1Alpha5, projectId string) (InstanceTemplate, *http.Response, error)

InstanceTemplatesApiService Create a VM instance template, for use in bulk VM creation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return InstanceTemplate

func (*InstanceTemplatesApiService) DeleteInstanceTemplate ¶ added in v0.1.39

func (a *InstanceTemplatesApiService) DeleteInstanceTemplate(ctx context.Context, instanceTemplateId string, projectId string) (*http.Response, error)

InstanceTemplatesApiService Delete a VM instance template.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceTemplateId
@param projectId

func (*InstanceTemplatesApiService) GetInstanceTemplate ¶ added in v0.1.39

func (a *InstanceTemplatesApiService) GetInstanceTemplate(ctx context.Context, instanceTemplateId string, projectId string) (InstanceTemplate, *http.Response, error)

InstanceTemplatesApiService Retrieve details about a VM instance template.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param instanceTemplateId
@param projectId

@return InstanceTemplate

func (*InstanceTemplatesApiService) ListInstanceTemplates ¶ added in v0.1.39

func (a *InstanceTemplatesApiService) ListInstanceTemplates(ctx context.Context, projectId string) (ListInstanceTemplatesResponseV1Alpha5, *http.Response, error)

InstanceTemplatesApiService Lists all VM instance templates available for use.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListInstanceTemplatesResponseV1Alpha5

type InstanceV1Alpha5 ¶

type InstanceV1Alpha5 struct {
	CommitmentEnd          string                  `json:"commitment_end"`
	CommitmentPeriod       int64                   `json:"commitment_period"`
	CreatedAt              string                  `json:"created_at"`
	Disks                  []AttachedDiskV1Alpha5  `json:"disks"`
	HostChannelAdapters    []HostChannelAdapter    `json:"host_channel_adapters"`
	Id                     string                  `json:"id"`
	InstanceGroupId        string                  `json:"instance_group_id,omitempty"`
	InstanceTemplateId     string                  `json:"instance_template_id,omitempty"`
	Location               string                  `json:"location"`
	Name                   string                  `json:"name"`
	NetworkInterfaces      []NetworkInterface      `json:"network_interfaces"`
	ProjectId              string                  `json:"project_id"`
	SshDestination         string                  `json:"ssh_destination"`
	State                  string                  `json:"state"`
	Type_                  string                  `json:"type"`
	UpdatedAt              string                  `json:"updated_at"`
	VirtualizationFeatures *VirtualizationFeatures `json:"virtualization_features,omitempty"`
}

InstanceV1Alpha5 contains identifying information about a vm instance for vms.instances endpoints.

type InstancesAttachDiskPostRequestV1Alpha5 ¶

type InstancesAttachDiskPostRequestV1Alpha5 struct {
	// nolint:lll // DiskAttachment objects are large
	AttachDisks []DiskAttachment `json:"attach_disks"`
}

InstancesAttachDiskPostRequestV1Alpha5 is the request type for POST requests to the vms.instances.attach-disk endpoint.

type InstancesDetachDiskPostRequest ¶

type InstancesDetachDiskPostRequest struct {
	DetachDisks []string `json:"detach_disks"`
}

InstancesDetachDiskPostRequest is the request type for POST requests to the vms.instances.detach-disk endpoint.

type InstancesPatchRequestV1Alpha5 ¶ added in v0.1.31

type InstancesPatchRequestV1Alpha5 struct {
	Action              string                      `json:"action"`
	CommitmentPeriod    int64                       `json:"commitment_period,omitempty"`
	HostChannelAdapters []PartialHostChannelAdapter `json:"host_channel_adapters,omitempty"`
	NetworkInterfaces   []NetworkInterface          `json:"network_interfaces,omitempty"`
	Type_               string                      `json:"type,omitempty"`
}

type InstancesPostRequestV1Alpha5 ¶ added in v0.1.29

type InstancesPostRequestV1Alpha5 struct {
	CommitmentPeriod       int64                       `json:"commitment_period,omitempty"`
	Disks                  []DiskAttachment            `json:"disks,omitempty"`
	HostChannelAdapters    []PartialHostChannelAdapter `json:"host_channel_adapters,omitempty"`
	Image                  string                      `json:"image,omitempty"`
	Location               string                      `json:"location,omitempty"`
	Name                   string                      `json:"name"`
	NetworkInterfaces      []NetworkInterface          `json:"network_interfaces,omitempty"`
	ShutdownScript         string                      `json:"shutdown_script,omitempty"`
	SshPublicKey           string                      `json:"ssh_public_key"`
	StartupScript          string                      `json:"startup_script,omitempty"`
	Type_                  string                      `json:"type"`
	VirtualizationFeatures *VirtualizationFeatures     `json:"virtualization_features,omitempty"`
}

InstancesPostRequestV1Alpha5 is the request type for POST requests to the vms.instances endpoint.

type IpAddresses ¶

type IpAddresses struct {
	PrivateIpv4 *PrivateIpv4Address `json:"private_ipv4"`
	PublicIpv4  *PublicIpv4Address  `json:"public_ipv4"`
}

type ListCapacitiesResponseV1Alpha5 ¶

type ListCapacitiesResponseV1Alpha5 struct {
	Items []CapacityV1Alpha5 `json:"items"`
}

type ListDiskSnapshotsResponseV1Alpha5 ¶

type ListDiskSnapshotsResponseV1Alpha5 struct {
	Items []DiskSnapshot `json:"items"`
}

type ListDisksResponseV1Alpha5 ¶

type ListDisksResponseV1Alpha5 struct {
	Items []DiskV1Alpha5 `json:"items"`
}

type ListEntitiesResponseV1Alpha5 ¶ added in v0.1.29

type ListEntitiesResponseV1Alpha5 struct {
	Items []Entity `json:"items"`
}

type ListIbNetworksResponseV1Alpha5 ¶

type ListIbNetworksResponseV1Alpha5 struct {
	Items []IbNetwork `json:"items"`
}

type ListIbPartitionsResponseV1Alpha5 ¶

type ListIbPartitionsResponseV1Alpha5 struct {
	Items []IbPartition `json:"items"`
}

type ListImagesResponseV1Alpha5 ¶

type ListImagesResponseV1Alpha5 struct {
	Items []Image `json:"items"`
}

type ListInstanceGroupsResponse ¶ added in v0.1.42

type ListInstanceGroupsResponse struct {
	Items []InstanceGroup `json:"items"`
}

ListInstanceGroupsResponse is the resource response type for GET requests to the InstanceGroup endpoint.

type ListInstanceTemplatesResponseV1Alpha5 ¶ added in v0.1.39

type ListInstanceTemplatesResponseV1Alpha5 struct {
	Items []InstanceTemplate `json:"items"`
}

ListInstanceTemplatesResponseV1Alpha5 is the resource response type for GET requests to the InstanceTemplates endpoint.

type ListInstancesResponseV1Alpha5 ¶

type ListInstancesResponseV1Alpha5 struct {
	Items []InstanceV1Alpha5 `json:"items"`
	// Base64 encoded token representing the next page of instances. Empty if currently on the last page.
	NextPageToken string `json:"next_page_token,omitempty"`
	// Base64 encoded token representing the previous page of instances. Empty if currently on the first page.
	PrevPageToken string `json:"prev_page_token,omitempty"`
}

type ListLoadBalancersResponseV1Alpha5 ¶ added in v0.1.35

type ListLoadBalancersResponseV1Alpha5 struct {
	Items []LoadBalancer `json:"items"`
}

type ListLocationsResponseV1Alpha5 ¶ added in v0.1.29

type ListLocationsResponseV1Alpha5 struct {
	Items []string `json:"items"`
}

type ListOperationsResponseV1Alpha5 ¶

type ListOperationsResponseV1Alpha5 struct {
	Items []Operation `json:"items"`
}

type ListProjectsResponseV1Alpha5 ¶

type ListProjectsResponseV1Alpha5 struct {
	Items []Project `json:"items"`
}

type ListSshKeysResponseV1Alpha5 ¶

type ListSshKeysResponseV1Alpha5 struct {
	Items []SshKey `json:"items"`
}

type ListTokensResponseV1Alpha5 ¶

type ListTokensResponseV1Alpha5 struct {
	Items []TokenInfo `json:"items"`
}

type ListTypesResponseV1Alpha5 ¶

type ListTypesResponseV1Alpha5 struct {
	Items []ModelType `json:"items"`
}

type ListVpcFirewallRulesResponseV1Alpha5 ¶

type ListVpcFirewallRulesResponseV1Alpha5 struct {
	Items []VpcFirewallRule `json:"items"`
}

type ListVpcNetworksResponseV1Alpha5 ¶

type ListVpcNetworksResponseV1Alpha5 struct {
	Items []VpcNetwork `json:"items"`
}

type ListVpcSubnetsResponseV1Alpha5 ¶

type ListVpcSubnetsResponseV1Alpha5 struct {
	Items []VpcSubnet `json:"items"`
}

type LoadBalancer ¶ added in v0.1.35

type LoadBalancer struct {
	Algorithm         string                         `json:"algorithm"`
	Destinations      []NetworkTarget                `json:"destinations"`
	HealthCheck       *HealthCheckOptions            `json:"health_check,omitempty"`
	Id                string                         `json:"id"`
	Ips               []IpAddresses                  `json:"ips"`
	Location          string                         `json:"location"`
	Name              string                         `json:"name"`
	NetworkInterfaces []LoadBalancerNetworkInterface `json:"network_interfaces"`
	Protocols         []string                       `json:"protocols"`
	Type_             string                         `json:"type,omitempty"`
}

type LoadBalancerNetworkInterface ¶ added in v0.1.47

type LoadBalancerNetworkInterface struct {
	NetworkId string `json:"network_id,omitempty"`
	SubnetId  string `json:"subnet_id,omitempty"`
}

type LoadBalancerOperationsApiListNetworkingLoadBalancersOperationsOpts ¶ added in v0.1.35

type LoadBalancerOperationsApiListNetworkingLoadBalancersOperationsOpts struct {
	ResourceId optional.String
	State      optional.Interface
}

type LoadBalancerOperationsApiService ¶ added in v0.1.35

type LoadBalancerOperationsApiService service

func (*LoadBalancerOperationsApiService) GetNetworkingLoadBalancersOperation ¶ added in v0.1.35

func (a *LoadBalancerOperationsApiService) GetNetworkingLoadBalancersOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)

LoadBalancerOperationsApiService Get status of a single asynchronous operation This resource retrieves information about the status of an asynchronous operation initiated by the Load Balancer resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param operationId

@return Operation

func (*LoadBalancerOperationsApiService) ListNetworkingLoadBalancersOperations ¶ added in v0.1.35

func (a *LoadBalancerOperationsApiService) ListNetworkingLoadBalancersOperations(ctx context.Context, projectId string, localVarOptionals *LoadBalancerOperationsApiListNetworkingLoadBalancersOperationsOpts) (ListOperationsResponseV1Alpha5, *http.Response, error)

type LoadBalancersApiService ¶ added in v0.1.35

type LoadBalancersApiService service

func (*LoadBalancersApiService) CreateLoadBalancer ¶ added in v0.1.35

func (a *LoadBalancersApiService) CreateLoadBalancer(ctx context.Context, body LoadBalancersPostRequest, projectId string) (AsyncOperationResponse, *http.Response, error)

LoadBalancersApiService Create a new load balancer owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return AsyncOperationResponse

func (*LoadBalancersApiService) DeleteLoadBalancer ¶ added in v0.1.35

func (a *LoadBalancersApiService) DeleteLoadBalancer(ctx context.Context, projectId string, loadBalancerId string) (AsyncOperationResponse, *http.Response, error)

LoadBalancersApiService Delete a load balancer owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param loadBalancerId

@return AsyncOperationResponse

func (*LoadBalancersApiService) GetLoadBalancer ¶ added in v0.1.35

func (a *LoadBalancersApiService) GetLoadBalancer(ctx context.Context, projectId string, loadBalancerId string) (LoadBalancer, *http.Response, error)

LoadBalancersApiService Retrieve details for a load balancer that belongs to the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param loadBalancerId

@return LoadBalancer

func (*LoadBalancersApiService) ListLoadBalancers ¶ added in v0.1.35

func (a *LoadBalancersApiService) ListLoadBalancers(ctx context.Context, projectId string) (ListLoadBalancersResponseV1Alpha5, *http.Response, error)

LoadBalancersApiService Retrieve details about all load balancers that belong to the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListLoadBalancersResponseV1Alpha5

func (*LoadBalancersApiService) PatchLoadBalancer ¶ added in v0.1.35

func (a *LoadBalancersApiService) PatchLoadBalancer(ctx context.Context, body LoadBalancersPatchRequestV1Alpha5, projectId string, loadBalancerId string) (AsyncOperationResponse, *http.Response, error)

LoadBalancersApiService Patch (update) a load balancer owned by the logged in user. A successful response from this resource will contain the async operation. To disable health checking, pass \"health_check\": {\"port\": 0}

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId
@param loadBalancerId

@return AsyncOperationResponse

type LoadBalancersPatchRequestV1Alpha5 ¶ added in v0.1.35

type LoadBalancersPatchRequestV1Alpha5 struct {
	Destinations []NetworkTarget     `json:"destinations,omitempty"`
	HealthCheck  *HealthCheckOptions `json:"health_check,omitempty"`
	Name         string              `json:"name,omitempty"`
}

type LoadBalancersPostRequest ¶ added in v0.1.35

type LoadBalancersPostRequest struct {
	Algorithm         string                         `json:"algorithm"`
	Destinations      []NetworkTarget                `json:"destinations"`
	HealthCheck       *HealthCheckOptions            `json:"health_check,omitempty"`
	Location          string                         `json:"location"`
	Name              string                         `json:"name"`
	NetworkInterfaces []LoadBalancerNetworkInterface `json:"network_interfaces"`
	Protocols         []string                       `json:"protocols"`
	Type_             string                         `json:"type,omitempty"`
}

type LocationsApiService ¶

type LocationsApiService service

func (*LocationsApiService) ListLocations ¶

func (a *LocationsApiService) ListLocations(ctx context.Context) (ListLocationsResponseV1Alpha5, *http.Response, error)

LocationsApiService Lists all Crusoe Cloud locations usable for resource hosting.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ListLocationsResponseV1Alpha5

type ModelType ¶

type ModelType struct {
	CpuCores    int64  `json:"cpu_cores"`
	CpuType     string `json:"cpu_type"`
	Description string `json:"description"`
	DiskGb      int64  `json:"disk_gb"`
	DiskType    string `json:"disk_type"`
	GpuType     string `json:"gpu_type"`
	MemoryGb    int64  `json:"memory_gb"`
	MemoryType  string `json:"memory_type"`
	NumGpu      int64  `json:"num_gpu"`
	ProductName string `json:"product_name"`
}

type NetworkInterface ¶

type NetworkInterface struct {
	Id            string        `json:"id"`
	InterfaceType string        `json:"interface_type"`
	Ips           []IpAddresses `json:"ips"`
	MacAddress    string        `json:"mac_address"`
	Name          string        `json:"name"`
	Network       string        `json:"network"`
	Subnet        string        `json:"subnet"`
}

type NetworkTarget ¶ added in v0.1.35

type NetworkTarget struct {
	Cidr       string `json:"cidr,omitempty"`
	ResourceId string `json:"resource_id,omitempty"`
}

type Operation ¶

type Operation struct {
	CompletedAt string       `json:"completed_at"`
	Metadata    *interface{} `json:"metadata"`
	OperationId string       `json:"operation_id"`
	Result      *interface{} `json:"result,omitempty"`
	StartedAt   string       `json:"started_at"`
	State       string       `json:"state"`
}

Individual resources that use Operations should populate the `metadata` field with resource-specific information.

type PartialHostChannelAdapter ¶ added in v0.1.31

type PartialHostChannelAdapter struct {
	IbPartitionId string `json:"ib_partition_id,omitempty"`
}

type PrivateIpv4Address ¶

type PrivateIpv4Address struct {
	Address string `json:"address"`
}

type Project ¶

type Project struct {
	Id             string `json:"id"`
	Name           string `json:"name"`
	OrganizationId string `json:"organization_id"`
	Relation       string `json:"relation"`
}

type ProjectUsageResponse ¶ added in v0.1.29

type ProjectUsageResponse struct {
	BillableMetric string  `json:"billable_metric"`
	Date           string  `json:"date"`
	ProjectId      string  `json:"project_id"`
	Quantity       float64 `json:"quantity"`
	Region         string  `json:"region"`
	ResourceType   string  `json:"resource_type"`
}

type ProjectsApiListProjectsOpts ¶ added in v0.1.29

type ProjectsApiListProjectsOpts struct {
	OrgId       optional.String
	ProjectName optional.String
}

type ProjectsApiService ¶

type ProjectsApiService service

func (*ProjectsApiService) CreateProject ¶

func (a *ProjectsApiService) CreateProject(ctx context.Context, body ProjectsPostRequest) (ProjectsPutPostResponseV1Alpha5, *http.Response, error)

ProjectsApiService Create a new project that will be owned by the logged in user. The logged in user must have the permission to create projects within the organization. A successful response from this resource contains details of the created project.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return ProjectsPutPostResponseV1Alpha5

func (*ProjectsApiService) DeleteProject ¶

func (a *ProjectsApiService) DeleteProject(ctx context.Context, projectId string) (*http.Response, error)

ProjectsApiService Delete a project that the logged in user owns. Delete operations cascade to VMs created under that project.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

func (*ProjectsApiService) GetProject ¶ added in v0.1.29

func (a *ProjectsApiService) GetProject(ctx context.Context, projectId string) (Project, *http.Response, error)

ProjectsApiService Retrieve details about a project that the logged in user belongs to or owns.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return Project

func (*ProjectsApiService) ListProjects ¶ added in v0.1.29

func (a *ProjectsApiService) ListProjects(ctx context.Context, localVarOptionals *ProjectsApiListProjectsOpts) (ListProjectsResponseV1Alpha5, *http.Response, error)

func (*ProjectsApiService) UpdateProject ¶

func (a *ProjectsApiService) UpdateProject(ctx context.Context, body ProjectsPutRequest, projectId string) (ProjectsPutPostResponseV1Alpha5, *http.Response, error)

ProjectsApiService Update details for a project that the logged in user owns. Requests to this resource must contain the json-encoded representation of the changes they want to make to the project. Currently only the project's name can be changed.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return ProjectsPutPostResponseV1Alpha5

type ProjectsPostRequest ¶

type ProjectsPostRequest struct {
	Name           string `json:"name"`
	OrganizationId string `json:"organization_id"`
}

type ProjectsPutPostResponseV1Alpha5 ¶

type ProjectsPutPostResponseV1Alpha5 struct {
	Project *Project `json:"project"`
}

type ProjectsPutRequest ¶

type ProjectsPutRequest struct {
	Name string `json:"name"`
}

type ProspectPostRequest ¶

type ProspectPostRequest struct {
	Company            string   `json:"company"`
	Email              string   `json:"email"`
	ExpectedCapacity   string   `json:"expected_capacity"`
	ExpectedCommitment string   `json:"expected_commitment"`
	ExpectedService    []string `json:"expected_service"`
	Name               string   `json:"name"`
	Referral           string   `json:"referral"`
	Source             string   `json:"source"`
	UseCase            string   `json:"use_case"`
}

type ProspectPostResponse ¶

type ProspectPostResponse struct {
	Success bool `json:"success,omitempty"`
}

type ProspectsApiService ¶

type ProspectsApiService service

func (*ProspectsApiService) CreateProspect ¶

func (a *ProspectsApiService) CreateProspect(ctx context.Context, body ProspectPostRequest) (ProspectPostResponse, *http.Response, error)

ProspectsApiService Create a new prospective customer in Crusoe Cloud.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return ProspectPostResponse

type PublicIpv4Address ¶

type PublicIpv4Address struct {
	Address string `json:"address"`
	Id      string `json:"id"`
	Type_   string `json:"type"`
}

type SSHKeysApiService ¶

type SSHKeysApiService service

func (*SSHKeysApiService) CreateSSHKey ¶

func (a *SSHKeysApiService) CreateSSHKey(ctx context.Context, body CreateSshKeyRequest) (CreateSshKeyResponse, *http.Response, error)

SSHKeysApiService Register a new SSH public key to the logged in user. A successful response from this resource wil contain the created SSH key details.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return CreateSshKeyResponse

func (*SSHKeysApiService) DeleteSSHKey ¶

func (a *SSHKeysApiService) DeleteSSHKey(ctx context.Context, id string) (*http.Response, error)

SSHKeysApiService Delete an SSH public key registered to the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id

func (*SSHKeysApiService) GetSSHKeys ¶

func (a *SSHKeysApiService) GetSSHKeys(ctx context.Context) (ListSshKeysResponseV1Alpha5, *http.Response, error)

SSHKeysApiService Retrieve the list of SSH public keys registered to the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ListSshKeysResponseV1Alpha5

type SnapshotOperationsApiListStorageSnapshotsOperationsOpts ¶ added in v0.1.35

type SnapshotOperationsApiListStorageSnapshotsOperationsOpts struct {
	ResourceId optional.String
	State      optional.Interface
}

type SnapshotOperationsApiService ¶

type SnapshotOperationsApiService service

func (*SnapshotOperationsApiService) GetStorageSnapshotsOperation ¶

func (a *SnapshotOperationsApiService) GetStorageSnapshotsOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)

SnapshotOperationsApiService Get status of a single asynchronous operation This resource retrieves information about the status of an asynchronous operation initiated by the snapshots resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param operationId

@return Operation

func (*SnapshotOperationsApiService) ListStorageSnapshotsOperations ¶

func (a *SnapshotOperationsApiService) ListStorageSnapshotsOperations(ctx context.Context, projectId string, localVarOptionals *SnapshotOperationsApiListStorageSnapshotsOperationsOpts) (ListOperationsResponseV1Alpha5, *http.Response, error)

type SnapshotsApiService ¶

type SnapshotsApiService service

func (*SnapshotsApiService) CreateDiskSnapshot ¶

func (a *SnapshotsApiService) CreateDiskSnapshot(ctx context.Context, body DiskSnapshotPostRequest, projectId string) (AsyncOperationResponse, *http.Response, error)

SnapshotsApiService Create a new snapshot for a disk owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return AsyncOperationResponse

func (*SnapshotsApiService) DeleteDiskSnapshot ¶

func (a *SnapshotsApiService) DeleteDiskSnapshot(ctx context.Context, projectId string, snapshotId string) (AsyncOperationResponse, *http.Response, error)

SnapshotsApiService Delete a disk snapshot owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param snapshotId

@return AsyncOperationResponse

func (*SnapshotsApiService) GetDiskSnapshot ¶

func (a *SnapshotsApiService) GetDiskSnapshot(ctx context.Context, projectId string, snapshotId string) (DiskSnapshot, *http.Response, error)

SnapshotsApiService Retrieve details about a disk snapshot that belongs to the logged in user. Size of snapshot will be in bytes.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param snapshotId

@return DiskSnapshot

func (*SnapshotsApiService) ListDiskSnapshots ¶

func (a *SnapshotsApiService) ListDiskSnapshots(ctx context.Context, projectId string) (ListDiskSnapshotsResponseV1Alpha5, *http.Response, error)

SnapshotsApiService Retrieve details about all disk snapshots that belong to the logged in user. Size of snapshots will be in bytes.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListDiskSnapshotsResponseV1Alpha5

type SshKey ¶

type SshKey struct {
	CreatedAt    string        `json:"created_at"`
	Fingerprints *Fingerprints `json:"fingerprints"`
	Id           string        `json:"id"`
	Name         string        `json:"name"`
	PublicKey    string        `json:"public_key"`
}

type TokenInfo ¶

type TokenInfo struct {
	AccessKey string `json:"access_key"`
	Alias     string `json:"alias"`
	CreatedAt string `json:"created_at"`
	ExpiresAt string `json:"expires_at"`
	LastUsed  string `json:"last_used"`
}

These are the fields returned from a GET request.

type TokensApiService ¶

type TokensApiService service

func (*TokensApiService) CreateToken ¶

func (a *TokensApiService) CreateToken(ctx context.Context, body CreateTokenRequest) (TokensPostResponse, *http.Response, error)

TokensApiService Create a new token owned by the logged in user. A successful response from this resource will contain json-encoded details of API token. This is the only time the customer will be able to view the secret key associated with the token.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return TokensPostResponse

func (*TokensApiService) DeleteToken ¶

func (a *TokensApiService) DeleteToken(ctx context.Context, accessKey string) (*http.Response, error)

TokensApiService Delete an API token owned by the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param accessKey

func (*TokensApiService) GetTokens ¶

func (a *TokensApiService) GetTokens(ctx context.Context) (TokensGetResponseV1Alpha4, *http.Response, error)

TokensApiService Retrieve all active/expired API tokens for the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return TokensGetResponseV1Alpha4

type TokensGetResponseV1Alpha4 ¶

type TokensGetResponseV1Alpha4 struct {
	Tokens []TokenInfo `json:"tokens"`
}

type TokensPostResponse ¶

type TokensPostResponse struct {
	Token *GeneratedToken `json:"token"`
}

type UsageApiService ¶ added in v0.1.29

type UsageApiService service

func (*UsageApiService) GetUsage ¶ added in v0.1.29

func (a *UsageApiService) GetUsage(ctx context.Context, orgId string, projects []string, resourceTypes []string, regions []string, startDate string, endDate string) (UsageByProjectGetResponse, *http.Response, error)

UsageApiService Get project-level usage for products in Crusoe Cloud.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId
@param projects
@param resourceTypes
@param regions
@param startDate
@param endDate

@return UsageByProjectGetResponse

func (*UsageApiService) GetUsageExport ¶ added in v0.1.29

func (a *UsageApiService) GetUsageExport(ctx context.Context, orgId string, projects []string, resources []string, resourceTypes []string, regions []string, startDate string, endDate string) (*http.Response, error)

UsageApiService Get resource-level usage for products in Crusoe Cloud.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId
@param projects
@param resources
@param resourceTypes
@param regions
@param startDate
@param endDate

func (*UsageApiService) GetUsageOptions ¶ added in v0.1.29

func (a *UsageApiService) GetUsageOptions(ctx context.Context, orgId string) (UsageOptions, *http.Response, error)

UsageApiService Get options which exist for filters for /usage and /usage/export routes.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orgId

@return UsageOptions

type UsageByProjectGetResponse ¶ added in v0.1.29

type UsageByProjectGetResponse struct {
	Items []ProjectUsageResponse `json:"items"`
}

type UsageOptions ¶ added in v0.1.29

type UsageOptions struct {
	EndDate       string   `json:"end_date"`
	Projects      []string `json:"projects"`
	Regions       []string `json:"regions"`
	ResourceTypes []string `json:"resource_types"`
	StartDate     string   `json:"start_date"`
}

UsageOptions contains the values which exist for the fields which we allow filtering on for the usageByProjectGet endpoint.

type UserResponse ¶

type UserResponse struct {
	Identity *Identity `json:"identity"`
}

The Identity of a user is returned.

type VMOperationsApiListComputeVMsInstancesOperationsOpts ¶ added in v0.1.35

type VMOperationsApiListComputeVMsInstancesOperationsOpts struct {
	ResourceId     optional.String
	State          optional.Interface
	LowerTimeBound optional.String
}

type VMOperationsApiService ¶

type VMOperationsApiService service

func (*VMOperationsApiService) GetComputeVMsInstancesOperation ¶

func (a *VMOperationsApiService) GetComputeVMsInstancesOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)

VMOperationsApiService Get the status of a single asynchronous operation This resource retrieves information about the status of an asynchronous operation initiated by the instances resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param operationId

@return Operation

func (*VMOperationsApiService) ListComputeVMsInstancesOperations ¶

func (a *VMOperationsApiService) ListComputeVMsInstancesOperations(ctx context.Context, projectId string, localVarOptionals *VMOperationsApiListComputeVMsInstancesOperationsOpts) (ListOperationsResponseV1Alpha5, *http.Response, error)

type VMsApiListInstancesOpts ¶ added in v0.1.43

type VMsApiListInstancesOpts struct {
	Ids       optional.String
	Names     optional.String
	Types     optional.String
	Locations optional.String
	States    optional.String
	Limit     optional.String
	Sort      optional.String
	NextToken optional.String
	PrevToken optional.String
}

type VMsApiService ¶

type VMsApiService service

func (*VMsApiService) BulkCreateInstance ¶ added in v0.1.39

func (a *VMsApiService) BulkCreateInstance(ctx context.Context, body BulkInstancePostRequestV1Alpha5, projectId string) (AsyncOperationResponse, *http.Response, error)

VMsApiService Create new VM instances owned by the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return AsyncOperationResponse

func (*VMsApiService) CreateInstance ¶

func (a *VMsApiService) CreateInstance(ctx context.Context, body InstancesPostRequestV1Alpha5, projectId string) (AsyncOperationResponse, *http.Response, error)

VMsApiService Create a new VM instance owned by the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return AsyncOperationResponse

func (*VMsApiService) DeleteInstance ¶

func (a *VMsApiService) DeleteInstance(ctx context.Context, projectId string, vmId string) (AsyncOperationResponse, *http.Response, error)

VMsApiService Delete a VM that the logged in user owns.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param vmId

@return AsyncOperationResponse

func (*VMsApiService) GetInstance ¶

func (a *VMsApiService) GetInstance(ctx context.Context, projectId string, vmId string) (InstanceV1Alpha5, *http.Response, error)

VMsApiService Retrieve details about a particular VM.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param vmId

@return InstanceV1Alpha5

func (*VMsApiService) GetVMTypes ¶

func (a *VMsApiService) GetVMTypes(ctx context.Context, projectId string) (ListTypesResponseV1Alpha5, *http.Response, error)

VMsApiService Retrieve information about the types of VMs that are available to purchase along with their prices.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListTypesResponseV1Alpha5

func (*VMsApiService) ListInstances ¶

func (a *VMsApiService) ListInstances(ctx context.Context, projectId string, localVarOptionals *VMsApiListInstancesOpts) (ListInstancesResponseV1Alpha5, *http.Response, error)

func (*VMsApiService) UpdateInstance ¶

func (a *VMsApiService) UpdateInstance(ctx context.Context, body InstancesPatchRequestV1Alpha5, projectId string, vmId string) (AsyncOperationResponse, *http.Response, error)

VMsApiService Change the state of a VM the logged in user owns.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId
@param vmId

@return AsyncOperationResponse

func (*VMsApiService) UpdateInstanceAttachDisks ¶

func (a *VMsApiService) UpdateInstanceAttachDisks(ctx context.Context, body InstancesAttachDiskPostRequestV1Alpha5, projectId string, vmId string) (AsyncOperationResponse, *http.Response, error)

VMsApiService Attach disks to a VM the logged in user owns.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId
@param vmId

@return AsyncOperationResponse

func (*VMsApiService) UpdateInstanceDetachDisks ¶

func (a *VMsApiService) UpdateInstanceDetachDisks(ctx context.Context, body InstancesDetachDiskPostRequest, projectId string, vmId string) (AsyncOperationResponse, *http.Response, error)

VMsApiService Detach disks from a VM the logged in user owns.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId
@param vmId

@return AsyncOperationResponse

type VPCFirewallRuleOperationsApiListNetworkingVPCFirewallRulesOperationsOpts ¶ added in v0.1.35

type VPCFirewallRuleOperationsApiListNetworkingVPCFirewallRulesOperationsOpts struct {
	ResourceId optional.String
	State      optional.Interface
}

type VPCFirewallRuleOperationsApiService ¶

type VPCFirewallRuleOperationsApiService service

func (*VPCFirewallRuleOperationsApiService) GetNetworkingVPCFirewallRulesOperation ¶

func (a *VPCFirewallRuleOperationsApiService) GetNetworkingVPCFirewallRulesOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)

VPCFirewallRuleOperationsApiService Get status of a single asynchronous operation This resource retrieves information about the status of an asynchronous operation initiated by the snapshots resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param operationId

@return Operation

func (*VPCFirewallRuleOperationsApiService) ListNetworkingVPCFirewallRulesOperations ¶

func (a *VPCFirewallRuleOperationsApiService) ListNetworkingVPCFirewallRulesOperations(ctx context.Context, projectId string, localVarOptionals *VPCFirewallRuleOperationsApiListNetworkingVPCFirewallRulesOperationsOpts) (ListOperationsResponseV1Alpha5, *http.Response, error)

type VPCFirewallRulesApiService ¶

type VPCFirewallRulesApiService service

func (*VPCFirewallRulesApiService) CreateVPCFirewallRule ¶

func (a *VPCFirewallRulesApiService) CreateVPCFirewallRule(ctx context.Context, body VpcFirewallRulesPostRequestV1Alpha5, projectId string) (AsyncOperationResponse, *http.Response, error)

VPCFirewallRulesApiService Create a new VPC firewall rule owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return AsyncOperationResponse

func (*VPCFirewallRulesApiService) DeleteVPCFirewallRule ¶

func (a *VPCFirewallRulesApiService) DeleteVPCFirewallRule(ctx context.Context, projectId string, vpcFirewallRuleId string) (AsyncOperationResponse, *http.Response, error)

VPCFirewallRulesApiService Delete a VPC firewall rule owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param vpcFirewallRuleId

@return AsyncOperationResponse

func (*VPCFirewallRulesApiService) GetVPCFirewallRule ¶

func (a *VPCFirewallRulesApiService) GetVPCFirewallRule(ctx context.Context, projectId string, vpcFirewallRuleId string) (VpcFirewallRule, *http.Response, error)

VPCFirewallRulesApiService Retrieve details for a VPC firewall rule that belongs to the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param vpcFirewallRuleId

@return VpcFirewallRule

func (*VPCFirewallRulesApiService) ListVPCFirewallRules ¶

func (a *VPCFirewallRulesApiService) ListVPCFirewallRules(ctx context.Context, projectId string) (ListVpcFirewallRulesResponseV1Alpha5, *http.Response, error)

VPCFirewallRulesApiService Retrieve details about all VPC firewall rules that belong to the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListVpcFirewallRulesResponseV1Alpha5

func (*VPCFirewallRulesApiService) PatchVPCFirewallRule ¶

func (a *VPCFirewallRulesApiService) PatchVPCFirewallRule(ctx context.Context, body VpcFirewallRulesPatchRequest, projectId string, vpcFirewallRuleId string) (AsyncOperationResponse, *http.Response, error)

VPCFirewallRulesApiService Patch (update) a VPC firewall rule owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId
@param vpcFirewallRuleId

@return AsyncOperationResponse

type VPCNetworkOperationsApiListNetworkingVPCNetworksOperationsOpts ¶ added in v0.1.35

type VPCNetworkOperationsApiListNetworkingVPCNetworksOperationsOpts struct {
	ResourceId optional.String
	State      optional.Interface
}

type VPCNetworkOperationsApiService ¶ added in v0.1.31

type VPCNetworkOperationsApiService service

func (*VPCNetworkOperationsApiService) GetNetworkingVPCNetworksOperation ¶ added in v0.1.31

func (a *VPCNetworkOperationsApiService) GetNetworkingVPCNetworksOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)

VPCNetworkOperationsApiService Get status of a single asynchronous operation This resource retrieves information about the status of an asynchronous operation initiated by the VPC Network resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param operationId

@return Operation

func (*VPCNetworkOperationsApiService) ListNetworkingVPCNetworksOperations ¶ added in v0.1.31

func (a *VPCNetworkOperationsApiService) ListNetworkingVPCNetworksOperations(ctx context.Context, projectId string, localVarOptionals *VPCNetworkOperationsApiListNetworkingVPCNetworksOperationsOpts) (ListOperationsResponseV1Alpha5, *http.Response, error)

type VPCNetworksApiService ¶

type VPCNetworksApiService service

func (*VPCNetworksApiService) CreateVPCNetwork ¶ added in v0.1.31

func (a *VPCNetworksApiService) CreateVPCNetwork(ctx context.Context, body VpcNetworkPostRequest, projectId string) (VpcNetworkPostResponse, *http.Response, error)

VPCNetworksApiService Create a new VPC network owned by the logged in user. A successful response from this resource will contain information regarding the created VPC network.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return VpcNetworkPostResponse

func (*VPCNetworksApiService) DeleteVPCNetwork ¶ added in v0.1.31

func (a *VPCNetworksApiService) DeleteVPCNetwork(ctx context.Context, projectId string, vpcNetworkId string) (AsyncOperationResponse, *http.Response, error)

VPCNetworksApiService Delete a VPC network owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param vpcNetworkId

@return AsyncOperationResponse

func (*VPCNetworksApiService) GetVPCNetwork ¶

func (a *VPCNetworksApiService) GetVPCNetwork(ctx context.Context, projectId string, vpcNetworkId string) (VpcNetwork, *http.Response, error)

VPCNetworksApiService Retrieve details for a VPC network that belongs to the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param vpcNetworkId

@return VpcNetwork

func (*VPCNetworksApiService) ListVPCNetworks ¶

func (a *VPCNetworksApiService) ListVPCNetworks(ctx context.Context, projectId string) (ListVpcNetworksResponseV1Alpha5, *http.Response, error)

VPCNetworksApiService Retrieve details about all VPC networks that belong to the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListVpcNetworksResponseV1Alpha5

func (*VPCNetworksApiService) PatchVPCNetwork ¶ added in v0.1.31

func (a *VPCNetworksApiService) PatchVPCNetwork(ctx context.Context, body VpcNetworkPatchRequest, projectId string, vpcNetworkId string) (AsyncOperationResponse, *http.Response, error)

VPCNetworksApiService Patch (update) a VPC network owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId
@param vpcNetworkId

@return AsyncOperationResponse

type VPCSubnetOperationsApiListNetworkingVPCSubnetsOperationsOpts ¶ added in v0.1.35

type VPCSubnetOperationsApiListNetworkingVPCSubnetsOperationsOpts struct {
	ResourceId optional.String
	State      optional.Interface
}

type VPCSubnetOperationsApiService ¶ added in v0.1.32

type VPCSubnetOperationsApiService service

func (*VPCSubnetOperationsApiService) GetNetworkingVPCSubnetsOperation ¶ added in v0.1.32

func (a *VPCSubnetOperationsApiService) GetNetworkingVPCSubnetsOperation(ctx context.Context, projectId string, operationId string) (Operation, *http.Response, error)

VPCSubnetOperationsApiService Get status of a single asynchronous operation This resource retrieves information about the status of an asynchronous operation initiated by the VPC Subnet resource. Only information about the operation specified in the path will be returned, or an HTTP 403 will be returned if the operation does not exist, was not initiated by the logged in user, or has expired.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param operationId

@return Operation

func (*VPCSubnetOperationsApiService) ListNetworkingVPCSubnetsOperations ¶ added in v0.1.32

func (a *VPCSubnetOperationsApiService) ListNetworkingVPCSubnetsOperations(ctx context.Context, projectId string, localVarOptionals *VPCSubnetOperationsApiListNetworkingVPCSubnetsOperationsOpts) (ListOperationsResponseV1Alpha5, *http.Response, error)

type VPCSubnetsApiService ¶

type VPCSubnetsApiService service

func (*VPCSubnetsApiService) CreateVPCSubnet ¶ added in v0.1.32

func (a *VPCSubnetsApiService) CreateVPCSubnet(ctx context.Context, body VpcSubnetPostRequest, projectId string) (VpcSubnetPostResponse, *http.Response, error)

VPCSubnetsApiService Create a new VPC subnet owned by the logged in user. A successful response from this resource will contain information regarding the created subnet.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId

@return VpcSubnetPostResponse

func (*VPCSubnetsApiService) DeleteVPCSubnet ¶ added in v0.1.32

func (a *VPCSubnetsApiService) DeleteVPCSubnet(ctx context.Context, projectId string, vpcSubnetId string) (AsyncOperationResponse, *http.Response, error)

VPCSubnetsApiService Delete a VPC subnet owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param vpcSubnetId

@return AsyncOperationResponse

func (*VPCSubnetsApiService) GetVPCSubnet ¶

func (a *VPCSubnetsApiService) GetVPCSubnet(ctx context.Context, projectId string, vpcSubnetId string) (VpcSubnet, *http.Response, error)

VPCSubnetsApiService Retrieve details for a VPC subnet that belongs to the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId
@param vpcSubnetId

@return VpcSubnet

func (*VPCSubnetsApiService) ListVPCSubnets ¶

func (a *VPCSubnetsApiService) ListVPCSubnets(ctx context.Context, projectId string) (ListVpcSubnetsResponseV1Alpha5, *http.Response, error)

VPCSubnetsApiService Retrieve details about all VPC subnets that belong to the logged in user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId

@return ListVpcSubnetsResponseV1Alpha5

func (*VPCSubnetsApiService) PatchVPCSubnet ¶ added in v0.1.32

func (a *VPCSubnetsApiService) PatchVPCSubnet(ctx context.Context, body VpcSubnetPatchRequest, projectId string, vpcSubnetId string) (AsyncOperationResponse, *http.Response, error)

VPCSubnetsApiService Patch (update) a VPC subnet owned by the logged in user. A successful response from this resource will contain the async operation.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param projectId
@param vpcSubnetId

@return AsyncOperationResponse

type VirtualizationFeatures ¶ added in v0.1.45

type VirtualizationFeatures struct {
	NestedVirtualization bool `json:"nested_virtualization,omitempty"`
}

type VmAttachmentV1Alpha5 ¶ added in v0.1.31

type VmAttachmentV1Alpha5 struct {
	AttachmentType string `json:"attachment_type"`
	Mode           string `json:"mode,omitempty"`
	VmId           string `json:"vm_id"`
}

type VpcFirewallRule ¶

type VpcFirewallRule struct {
	Action           string               `json:"action"`
	DestinationPorts []string             `json:"destination_ports"`
	Destinations     []FirewallRuleObject `json:"destinations"`
	Direction        string               `json:"direction"`
	Id               string               `json:"id"`
	Name             string               `json:"name"`
	Protocols        []string             `json:"protocols"`
	SourcePorts      []string             `json:"source_ports"`
	Sources          []FirewallRuleObject `json:"sources"`
	State            string               `json:"state"`
	VpcNetworkId     string               `json:"vpc_network_id"`
}

type VpcFirewallRulesPatchRequest ¶

type VpcFirewallRulesPatchRequest struct {
	DestinationPorts []string             `json:"destination_ports,omitempty"`
	Destinations     []FirewallRuleObject `json:"destinations,omitempty"`
	Name             string               `json:"name,omitempty"`
	Protocols        []string             `json:"protocols,omitempty"`
	SourcePorts      []string             `json:"source_ports,omitempty"`
	Sources          []FirewallRuleObject `json:"sources,omitempty"`
}

type VpcFirewallRulesPostRequestV1Alpha5 ¶

type VpcFirewallRulesPostRequestV1Alpha5 struct {
	Action           string               `json:"action"`
	DestinationPorts []string             `json:"destination_ports,omitempty"`
	Destinations     []FirewallRuleObject `json:"destinations"`
	Direction        string               `json:"direction"`
	Name             string               `json:"name"`
	Protocols        []string             `json:"protocols"`
	SourcePorts      []string             `json:"source_ports,omitempty"`
	Sources          []FirewallRuleObject `json:"sources"`
	VpcNetworkId     string               `json:"vpc_network_id"`
}

type VpcNetwork ¶

type VpcNetwork struct {
	Cidr    string   `json:"cidr"`
	Gateway string   `json:"gateway"`
	Id      string   `json:"id"`
	Name    string   `json:"name"`
	Subnets []string `json:"subnets"`
}

type VpcNetworkPatchRequest ¶ added in v0.1.31

type VpcNetworkPatchRequest struct {
	Name string `json:"name"`
}

type VpcNetworkPostRequest ¶ added in v0.1.31

type VpcNetworkPostRequest struct {
	Cidr string `json:"cidr"`
	Name string `json:"name"`
}

type VpcNetworkPostResponse ¶ added in v0.1.31

type VpcNetworkPostResponse struct {
	Network *VpcNetwork `json:"network"`
}

type VpcSubnet ¶

type VpcSubnet struct {
	Cidr         string `json:"cidr"`
	Id           string `json:"id"`
	Location     string `json:"location"`
	Name         string `json:"name"`
	VpcNetworkId string `json:"vpc_network_id"`
}

type VpcSubnetPatchRequest ¶ added in v0.1.32

type VpcSubnetPatchRequest struct {
	Name string `json:"name"`
}

type VpcSubnetPostRequest ¶ added in v0.1.32

type VpcSubnetPostRequest struct {
	Cidr         string `json:"cidr"`
	Location     string `json:"location"`
	Name         string `json:"name"`
	VpcNetworkId string `json:"vpc_network_id"`
}

type VpcSubnetPostResponse ¶ added in v0.1.32

type VpcSubnetPostResponse struct {
	Subnet *VpcSubnet `json:"subnet"`
}

Source Files ¶

View all Source files

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