cycle

package module
v0.6.6 Latest Latest
Warning

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

Go to latest
Published: Jan 26, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

README

Cycle API Go Client

cycle

This is an auto-generated API client based on the OpenAPI Spec for Cycle. Please do not open any PRs for the generated code in generated.go. If you have any questions on what changes are made in the latest version, please refer to the spec above.

Usage

go get github.com/cycleplatform/api-client-go

Create a client

package main

import (
	"log" 
	"os"
	"context"
	"net/http"
	"fmt"
    "github.com/cycleplatform/api-client-go"
)

func main() {
    apiKey := os.Getenv("CYCLE_API_KEY")
	if apiKey == "" {
		log.Fatal("missing env var CYCLE_API_KEY")
	}

	hubId := os.Getenv("CYCLE_HUB_ID")
	if hubId == "" {
		log.Fatal("missing env var CYCLE_HUB_ID")
	}

	c, err := cycle.NewAuthenticatedClient(cycle.ClientConfig{
		APIKey: apiKey,
		HubID:  hubId,
	})

	if err != nil {
		log.Fatal(err)
	}

    // Get list of environments
    resp, err := c.GetEnvironmentsWithResponse(context.TODO(), &cycle.GetEnvironmentsParams{})
    if err != nil {
        log.Fatal(err)
    }

    if resp.StatusCode() != http.StatusOK {
        log.Fatalf("Expected HTTP 200 but received %d %s", resp.StatusCode(), *resp.JSONDefault.Error.Title)
    }

    for _, v := range resp.JSON200.Data {
        fmt.Printf("ID: %s - Name: %s\n", v.Id, v.Name)
    }
}

Development

Updating the API spec

Update the API spec to the latest version:

git submodule update --recursive --remote

Using npm, run (cd api-spec; npm run build:platform && npm run downconvert:platform)

Generating the client

go generate

See ogen for usage.

Documentation

Overview

Package cycle provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

View Source
const (
	BearerAuthScopes = "bearerAuth.Scopes"
	HubAuthScopes    = "hubAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewAggregateLogsRequest

func NewAggregateLogsRequest(server string, body AggregateLogsJSONRequestBody) (*http.Request, error)

NewAggregateLogsRequest calls the generic AggregateLogs builder with application/json body

func NewAggregateLogsRequestWithBody

func NewAggregateLogsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewAggregateLogsRequestWithBody generates requests for AggregateLogs with any type of body

func NewChangePasswordRequest

func NewChangePasswordRequest(server string, body ChangePasswordJSONRequestBody) (*http.Request, error)

NewChangePasswordRequest calls the generic ChangePassword builder with application/json body

func NewChangePasswordRequestWithBody

func NewChangePasswordRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewChangePasswordRequestWithBody generates requests for ChangePassword with any type of body

func NewClonePipelineRequest

func NewClonePipelineRequest(server string, body ClonePipelineJSONRequestBody) (*http.Request, error)

NewClonePipelineRequest calls the generic ClonePipeline builder with application/json body

func NewClonePipelineRequestWithBody

func NewClonePipelineRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewClonePipelineRequestWithBody generates requests for ClonePipeline with any type of body

func NewCreateApiKeyRequest

func NewCreateApiKeyRequest(server string, body CreateApiKeyJSONRequestBody) (*http.Request, error)

NewCreateApiKeyRequest calls the generic CreateApiKey builder with application/json body

func NewCreateApiKeyRequestWithBody

func NewCreateApiKeyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateApiKeyRequestWithBody generates requests for CreateApiKey with any type of body

func NewCreateAutoScaleGroupRequest

func NewCreateAutoScaleGroupRequest(server string, body CreateAutoScaleGroupJSONRequestBody) (*http.Request, error)

NewCreateAutoScaleGroupRequest calls the generic CreateAutoScaleGroup builder with application/json body

func NewCreateAutoScaleGroupRequestWithBody

func NewCreateAutoScaleGroupRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateAutoScaleGroupRequestWithBody generates requests for CreateAutoScaleGroup with any type of body

func NewCreateBillingMethodJobRequest

func NewCreateBillingMethodJobRequest(server string, methodId string, body CreateBillingMethodJobJSONRequestBody) (*http.Request, error)

NewCreateBillingMethodJobRequest calls the generic CreateBillingMethodJob builder with application/json body

func NewCreateBillingMethodJobRequestWithBody

func NewCreateBillingMethodJobRequestWithBody(server string, methodId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateBillingMethodJobRequestWithBody generates requests for CreateBillingMethodJob with any type of body

func NewCreateBillingMethodRequest

func NewCreateBillingMethodRequest(server string, body CreateBillingMethodJSONRequestBody) (*http.Request, error)

NewCreateBillingMethodRequest calls the generic CreateBillingMethod builder with application/json body

func NewCreateBillingMethodRequestWithBody

func NewCreateBillingMethodRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateBillingMethodRequestWithBody generates requests for CreateBillingMethod with any type of body

func NewCreateClusterJobRequest added in v0.6.3

func NewCreateClusterJobRequest(server string, clusterId string, body CreateClusterJobJSONRequestBody) (*http.Request, error)

NewCreateClusterJobRequest calls the generic CreateClusterJob builder with application/json body

func NewCreateClusterJobRequestWithBody added in v0.6.3

func NewCreateClusterJobRequestWithBody(server string, clusterId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateClusterJobRequestWithBody generates requests for CreateClusterJob with any type of body

func NewCreateClusterRequest

func NewCreateClusterRequest(server string, body CreateClusterJSONRequestBody) (*http.Request, error)

NewCreateClusterRequest calls the generic CreateCluster builder with application/json body

func NewCreateClusterRequestWithBody

func NewCreateClusterRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateClusterRequestWithBody generates requests for CreateCluster with any type of body

func NewCreateContainerBackupJobRequest

func NewCreateContainerBackupJobRequest(server string, containerId string, backupId string, body CreateContainerBackupJobJSONRequestBody) (*http.Request, error)

NewCreateContainerBackupJobRequest calls the generic CreateContainerBackupJob builder with application/json body

func NewCreateContainerBackupJobRequestWithBody

func NewCreateContainerBackupJobRequestWithBody(server string, containerId string, backupId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateContainerBackupJobRequestWithBody generates requests for CreateContainerBackupJob with any type of body

func NewCreateContainerJobRequest

func NewCreateContainerJobRequest(server string, containerId string, body CreateContainerJobJSONRequestBody) (*http.Request, error)

NewCreateContainerJobRequest calls the generic CreateContainerJob builder with application/json body

func NewCreateContainerJobRequestWithBody

func NewCreateContainerJobRequestWithBody(server string, containerId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateContainerJobRequestWithBody generates requests for CreateContainerJob with any type of body

func NewCreateContainerRequest

func NewCreateContainerRequest(server string, body CreateContainerJSONRequestBody) (*http.Request, error)

NewCreateContainerRequest calls the generic CreateContainer builder with application/json body

func NewCreateContainerRequestWithBody

func NewCreateContainerRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateContainerRequestWithBody generates requests for CreateContainer with any type of body

func NewCreateDNSZoneJobRequest

func NewCreateDNSZoneJobRequest(server string, zoneId string, body CreateDNSZoneJobJSONRequestBody) (*http.Request, error)

NewCreateDNSZoneJobRequest calls the generic CreateDNSZoneJob builder with application/json body

func NewCreateDNSZoneJobRequestWithBody

func NewCreateDNSZoneJobRequestWithBody(server string, zoneId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateDNSZoneJobRequestWithBody generates requests for CreateDNSZoneJob with any type of body

func NewCreateDNSZoneRecordJobRequest

func NewCreateDNSZoneRecordJobRequest(server string, zoneId string, recordId string, body CreateDNSZoneRecordJobJSONRequestBody) (*http.Request, error)

NewCreateDNSZoneRecordJobRequest calls the generic CreateDNSZoneRecordJob builder with application/json body

func NewCreateDNSZoneRecordJobRequestWithBody

func NewCreateDNSZoneRecordJobRequestWithBody(server string, zoneId string, recordId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateDNSZoneRecordJobRequestWithBody generates requests for CreateDNSZoneRecordJob with any type of body

func NewCreateDNSZoneRecordRequest

func NewCreateDNSZoneRecordRequest(server string, zoneId string, params *CreateDNSZoneRecordParams, body CreateDNSZoneRecordJSONRequestBody) (*http.Request, error)

NewCreateDNSZoneRecordRequest calls the generic CreateDNSZoneRecord builder with application/json body

func NewCreateDNSZoneRecordRequestWithBody

func NewCreateDNSZoneRecordRequestWithBody(server string, zoneId string, params *CreateDNSZoneRecordParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateDNSZoneRecordRequestWithBody generates requests for CreateDNSZoneRecord with any type of body

func NewCreateDNSZoneRequest

func NewCreateDNSZoneRequest(server string, body CreateDNSZoneJSONRequestBody) (*http.Request, error)

NewCreateDNSZoneRequest calls the generic CreateDNSZone builder with application/json body

func NewCreateDNSZoneRequestWithBody

func NewCreateDNSZoneRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateDNSZoneRequestWithBody generates requests for CreateDNSZone with any type of body

func NewCreateDiscoveryServiceJobRequest

func NewCreateDiscoveryServiceJobRequest(server string, environmentId string, body CreateDiscoveryServiceJobJSONRequestBody) (*http.Request, error)

NewCreateDiscoveryServiceJobRequest calls the generic CreateDiscoveryServiceJob builder with application/json body

func NewCreateDiscoveryServiceJobRequestWithBody

func NewCreateDiscoveryServiceJobRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateDiscoveryServiceJobRequestWithBody generates requests for CreateDiscoveryServiceJob with any type of body

func NewCreateEnvironmentJobRequest

func NewCreateEnvironmentJobRequest(server string, environmentId string, body CreateEnvironmentJobJSONRequestBody) (*http.Request, error)

NewCreateEnvironmentJobRequest calls the generic CreateEnvironmentJob builder with application/json body

func NewCreateEnvironmentJobRequestWithBody

func NewCreateEnvironmentJobRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateEnvironmentJobRequestWithBody generates requests for CreateEnvironmentJob with any type of body

func NewCreateEnvironmentRequest

func NewCreateEnvironmentRequest(server string, body CreateEnvironmentJSONRequestBody) (*http.Request, error)

NewCreateEnvironmentRequest calls the generic CreateEnvironment builder with application/json body

func NewCreateEnvironmentRequestWithBody

func NewCreateEnvironmentRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateEnvironmentRequestWithBody generates requests for CreateEnvironment with any type of body

func NewCreateExternalVolumeJobRequest added in v0.6.5

func NewCreateExternalVolumeJobRequest(server string, externalVolumeId string, body CreateExternalVolumeJobJSONRequestBody) (*http.Request, error)

NewCreateExternalVolumeJobRequest calls the generic CreateExternalVolumeJob builder with application/json body

func NewCreateExternalVolumeJobRequestWithBody added in v0.6.5

func NewCreateExternalVolumeJobRequestWithBody(server string, externalVolumeId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateExternalVolumeJobRequestWithBody generates requests for CreateExternalVolumeJob with any type of body

func NewCreateExternalVolumeRequest added in v0.6.5

func NewCreateExternalVolumeRequest(server string, params *CreateExternalVolumeParams, body CreateExternalVolumeJSONRequestBody) (*http.Request, error)

NewCreateExternalVolumeRequest calls the generic CreateExternalVolume builder with application/json body

func NewCreateExternalVolumeRequestWithBody added in v0.6.5

func NewCreateExternalVolumeRequestWithBody(server string, params *CreateExternalVolumeParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateExternalVolumeRequestWithBody generates requests for CreateExternalVolume with any type of body

func NewCreateExternalVolumesJobRequest added in v0.6.6

func NewCreateExternalVolumesJobRequest(server string, body CreateExternalVolumesJobJSONRequestBody) (*http.Request, error)

NewCreateExternalVolumesJobRequest calls the generic CreateExternalVolumesJob builder with application/json body

func NewCreateExternalVolumesJobRequestWithBody added in v0.6.6

func NewCreateExternalVolumesJobRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateExternalVolumesJobRequestWithBody generates requests for CreateExternalVolumesJob with any type of body

func NewCreateFunctionJobRequest

func NewCreateFunctionJobRequest(server string, containerId string, body CreateFunctionJobJSONRequestBody) (*http.Request, error)

NewCreateFunctionJobRequest calls the generic CreateFunctionJob builder with application/json body

func NewCreateFunctionJobRequestWithBody

func NewCreateFunctionJobRequestWithBody(server string, containerId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateFunctionJobRequestWithBody generates requests for CreateFunctionJob with any type of body

func NewCreateGatewayServiceJobRequest

func NewCreateGatewayServiceJobRequest(server string, environmentId string, body CreateGatewayServiceJobJSONRequestBody) (*http.Request, error)

NewCreateGatewayServiceJobRequest calls the generic CreateGatewayServiceJob builder with application/json body

func NewCreateGatewayServiceJobRequestWithBody

func NewCreateGatewayServiceJobRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateGatewayServiceJobRequestWithBody generates requests for CreateGatewayServiceJob with any type of body

func NewCreateHubInviteRequest

func NewCreateHubInviteRequest(server string, body CreateHubInviteJSONRequestBody) (*http.Request, error)

NewCreateHubInviteRequest calls the generic CreateHubInvite builder with application/json body

func NewCreateHubInviteRequestWithBody

func NewCreateHubInviteRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateHubInviteRequestWithBody generates requests for CreateHubInvite with any type of body

func NewCreateHubRequest

func NewCreateHubRequest(server string, body CreateHubJSONRequestBody) (*http.Request, error)

NewCreateHubRequest calls the generic CreateHub builder with application/json body

func NewCreateHubRequestWithBody

func NewCreateHubRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateHubRequestWithBody generates requests for CreateHub with any type of body

func NewCreateImageJobRequest

func NewCreateImageJobRequest(server string, imageId string, body CreateImageJobJSONRequestBody) (*http.Request, error)

NewCreateImageJobRequest calls the generic CreateImageJob builder with application/json body

func NewCreateImageJobRequestWithBody

func NewCreateImageJobRequestWithBody(server string, imageId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateImageJobRequestWithBody generates requests for CreateImageJob with any type of body

func NewCreateImageRequest

func NewCreateImageRequest(server string, body CreateImageJSONRequestBody) (*http.Request, error)

NewCreateImageRequest calls the generic CreateImage builder with application/json body

func NewCreateImageRequestWithBody

func NewCreateImageRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateImageRequestWithBody generates requests for CreateImage with any type of body

func NewCreateImageSourceRequest

func NewCreateImageSourceRequest(server string, body CreateImageSourceJSONRequestBody) (*http.Request, error)

NewCreateImageSourceRequest calls the generic CreateImageSource builder with application/json body

func NewCreateImageSourceRequestWithBody

func NewCreateImageSourceRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateImageSourceRequestWithBody generates requests for CreateImageSource with any type of body

func NewCreateImagesJobRequest

func NewCreateImagesJobRequest(server string, body CreateImagesJobJSONRequestBody) (*http.Request, error)

NewCreateImagesJobRequest calls the generic CreateImagesJob builder with application/json body

func NewCreateImagesJobRequestWithBody

func NewCreateImagesJobRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateImagesJobRequestWithBody generates requests for CreateImagesJob with any type of body

func NewCreateInstanceJobRequest

func NewCreateInstanceJobRequest(server string, containerId string, instanceId string, body CreateInstanceJobJSONRequestBody) (*http.Request, error)

NewCreateInstanceJobRequest calls the generic CreateInstanceJob builder with application/json body

func NewCreateInstanceJobRequestWithBody

func NewCreateInstanceJobRequestWithBody(server string, containerId string, instanceId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateInstanceJobRequestWithBody generates requests for CreateInstanceJob with any type of body

func NewCreateInstancesRequest

func NewCreateInstancesRequest(server string, containerId string, body CreateInstancesJSONRequestBody) (*http.Request, error)

NewCreateInstancesRequest calls the generic CreateInstances builder with application/json body

func NewCreateInstancesRequestWithBody

func NewCreateInstancesRequestWithBody(server string, containerId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateInstancesRequestWithBody generates requests for CreateInstances with any type of body

func NewCreateIntegrationJobRequest

func NewCreateIntegrationJobRequest(server string, integrationId string, body CreateIntegrationJobJSONRequestBody) (*http.Request, error)

NewCreateIntegrationJobRequest calls the generic CreateIntegrationJob builder with application/json body

func NewCreateIntegrationJobRequestWithBody

func NewCreateIntegrationJobRequestWithBody(server string, integrationId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateIntegrationJobRequestWithBody generates requests for CreateIntegrationJob with any type of body

func NewCreateIntegrationRequest

func NewCreateIntegrationRequest(server string, params *CreateIntegrationParams, body CreateIntegrationJSONRequestBody) (*http.Request, error)

NewCreateIntegrationRequest calls the generic CreateIntegration builder with application/json body

func NewCreateIntegrationRequestWithBody

func NewCreateIntegrationRequestWithBody(server string, params *CreateIntegrationParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateIntegrationRequestWithBody generates requests for CreateIntegration with any type of body

func NewCreateInvoiceJobRequest

func NewCreateInvoiceJobRequest(server string, invoiceId string, body CreateInvoiceJobJSONRequestBody) (*http.Request, error)

NewCreateInvoiceJobRequest calls the generic CreateInvoiceJob builder with application/json body

func NewCreateInvoiceJobRequestWithBody

func NewCreateInvoiceJobRequestWithBody(server string, invoiceId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateInvoiceJobRequestWithBody generates requests for CreateInvoiceJob with any type of body

func NewCreateIpPoolJobRequest added in v0.6.4

func NewCreateIpPoolJobRequest(server string, poolId string, body CreateIpPoolJobJSONRequestBody) (*http.Request, error)

NewCreateIpPoolJobRequest calls the generic CreateIpPoolJob builder with application/json body

func NewCreateIpPoolJobRequestWithBody added in v0.6.4

func NewCreateIpPoolJobRequestWithBody(server string, poolId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateIpPoolJobRequestWithBody generates requests for CreateIpPoolJob with any type of body

func NewCreateIpPoolRequest added in v0.6.3

func NewCreateIpPoolRequest(server string, body CreateIpPoolJSONRequestBody) (*http.Request, error)

NewCreateIpPoolRequest calls the generic CreateIpPool builder with application/json body

func NewCreateIpPoolRequestWithBody added in v0.6.3

func NewCreateIpPoolRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateIpPoolRequestWithBody generates requests for CreateIpPool with any type of body

func NewCreateLoadBalancerServiceJobRequest

func NewCreateLoadBalancerServiceJobRequest(server string, environmentId string, body CreateLoadBalancerServiceJobJSONRequestBody) (*http.Request, error)

NewCreateLoadBalancerServiceJobRequest calls the generic CreateLoadBalancerServiceJob builder with application/json body

func NewCreateLoadBalancerServiceJobRequestWithBody

func NewCreateLoadBalancerServiceJobRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateLoadBalancerServiceJobRequestWithBody generates requests for CreateLoadBalancerServiceJob with any type of body

func NewCreateNetworkJobRequest

func NewCreateNetworkJobRequest(server string, networkId string, body CreateNetworkJobJSONRequestBody) (*http.Request, error)

NewCreateNetworkJobRequest calls the generic CreateNetworkJob builder with application/json body

func NewCreateNetworkJobRequestWithBody

func NewCreateNetworkJobRequestWithBody(server string, networkId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateNetworkJobRequestWithBody generates requests for CreateNetworkJob with any type of body

func NewCreateNetworkRequest

func NewCreateNetworkRequest(server string, params *CreateNetworkParams, body CreateNetworkJSONRequestBody) (*http.Request, error)

NewCreateNetworkRequest calls the generic CreateNetwork builder with application/json body

func NewCreateNetworkRequestWithBody

func NewCreateNetworkRequestWithBody(server string, params *CreateNetworkParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateNetworkRequestWithBody generates requests for CreateNetwork with any type of body

func NewCreateOrderJobRequest

func NewCreateOrderJobRequest(server string, orderId string, body CreateOrderJobJSONRequestBody) (*http.Request, error)

NewCreateOrderJobRequest calls the generic CreateOrderJob builder with application/json body

func NewCreateOrderJobRequestWithBody

func NewCreateOrderJobRequestWithBody(server string, orderId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateOrderJobRequestWithBody generates requests for CreateOrderJob with any type of body

func NewCreateOrderRequest

func NewCreateOrderRequest(server string, params *CreateOrderParams, body CreateOrderJSONRequestBody) (*http.Request, error)

NewCreateOrderRequest calls the generic CreateOrder builder with application/json body

func NewCreateOrderRequestWithBody

func NewCreateOrderRequestWithBody(server string, params *CreateOrderParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateOrderRequestWithBody generates requests for CreateOrder with any type of body

func NewCreatePipelineJobRequest

func NewCreatePipelineJobRequest(server string, pipelineId string, body CreatePipelineJobJSONRequestBody) (*http.Request, error)

NewCreatePipelineJobRequest calls the generic CreatePipelineJob builder with application/json body

func NewCreatePipelineJobRequestWithBody

func NewCreatePipelineJobRequestWithBody(server string, pipelineId string, contentType string, body io.Reader) (*http.Request, error)

NewCreatePipelineJobRequestWithBody generates requests for CreatePipelineJob with any type of body

func NewCreatePipelineRequest

func NewCreatePipelineRequest(server string, body CreatePipelineJSONRequestBody) (*http.Request, error)

NewCreatePipelineRequest calls the generic CreatePipeline builder with application/json body

func NewCreatePipelineRequestWithBody

func NewCreatePipelineRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreatePipelineRequestWithBody generates requests for CreatePipeline with any type of body

func NewCreatePipelineTriggerKeyRequest

func NewCreatePipelineTriggerKeyRequest(server string, pipelineId string, body CreatePipelineTriggerKeyJSONRequestBody) (*http.Request, error)

NewCreatePipelineTriggerKeyRequest calls the generic CreatePipelineTriggerKey builder with application/json body

func NewCreatePipelineTriggerKeyRequestWithBody

func NewCreatePipelineTriggerKeyRequestWithBody(server string, pipelineId string, contentType string, body io.Reader) (*http.Request, error)

NewCreatePipelineTriggerKeyRequestWithBody generates requests for CreatePipelineTriggerKey with any type of body

func NewCreateRoleRequest

func NewCreateRoleRequest(server string, body CreateRoleJSONRequestBody) (*http.Request, error)

NewCreateRoleRequest calls the generic CreateRole builder with application/json body

func NewCreateRoleRequestWithBody

func NewCreateRoleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateRoleRequestWithBody generates requests for CreateRole with any type of body

func NewCreateSchedulerServiceJobRequest

func NewCreateSchedulerServiceJobRequest(server string, environmentId string, body CreateSchedulerServiceJobJSONRequestBody) (*http.Request, error)

NewCreateSchedulerServiceJobRequest calls the generic CreateSchedulerServiceJob builder with application/json body

func NewCreateSchedulerServiceJobRequestWithBody

func NewCreateSchedulerServiceJobRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateSchedulerServiceJobRequestWithBody generates requests for CreateSchedulerServiceJob with any type of body

func NewCreateScopedVariableRequest

func NewCreateScopedVariableRequest(server string, environmentId string, body CreateScopedVariableJSONRequestBody) (*http.Request, error)

NewCreateScopedVariableRequest calls the generic CreateScopedVariable builder with application/json body

func NewCreateScopedVariableRequestWithBody

func NewCreateScopedVariableRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateScopedVariableRequestWithBody generates requests for CreateScopedVariable with any type of body

func NewCreateServerJobRequest

func NewCreateServerJobRequest(server string, serverId string, body CreateServerJobJSONRequestBody) (*http.Request, error)

NewCreateServerJobRequest calls the generic CreateServerJob builder with application/json body

func NewCreateServerJobRequestWithBody

func NewCreateServerJobRequestWithBody(server string, serverId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateServerJobRequestWithBody generates requests for CreateServerJob with any type of body

func NewCreateServersRequest added in v0.6.6

func NewCreateServersRequest(server string, body CreateServersJSONRequestBody) (*http.Request, error)

NewCreateServersRequest calls the generic CreateServers builder with application/json body

func NewCreateServersRequestWithBody added in v0.6.6

func NewCreateServersRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateServersRequestWithBody generates requests for CreateServers with any type of body

func NewCreateStackBuildJobRequest

func NewCreateStackBuildJobRequest(server string, stackId string, buildId string, body CreateStackBuildJobJSONRequestBody) (*http.Request, error)

NewCreateStackBuildJobRequest calls the generic CreateStackBuildJob builder with application/json body

func NewCreateStackBuildJobRequestWithBody

func NewCreateStackBuildJobRequestWithBody(server string, stackId string, buildId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateStackBuildJobRequestWithBody generates requests for CreateStackBuildJob with any type of body

func NewCreateStackBuildRequest

func NewCreateStackBuildRequest(server string, stackId string, body CreateStackBuildJSONRequestBody) (*http.Request, error)

NewCreateStackBuildRequest calls the generic CreateStackBuild builder with application/json body

func NewCreateStackBuildRequestWithBody

func NewCreateStackBuildRequestWithBody(server string, stackId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateStackBuildRequestWithBody generates requests for CreateStackBuild with any type of body

func NewCreateStackJobRequest

func NewCreateStackJobRequest(server string, stackId string, body CreateStackJobJSONRequestBody) (*http.Request, error)

NewCreateStackJobRequest calls the generic CreateStackJob builder with application/json body

func NewCreateStackJobRequestWithBody

func NewCreateStackJobRequestWithBody(server string, stackId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateStackJobRequestWithBody generates requests for CreateStackJob with any type of body

func NewCreateStackRequest

func NewCreateStackRequest(server string, body CreateStackJSONRequestBody) (*http.Request, error)

NewCreateStackRequest calls the generic CreateStack builder with application/json body

func NewCreateStackRequestWithBody

func NewCreateStackRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateStackRequestWithBody generates requests for CreateStack with any type of body

func NewCreateUserSuppliedCertificateJobRequest

func NewCreateUserSuppliedCertificateJobRequest(server string, certificateId string, body CreateUserSuppliedCertificateJobJSONRequestBody) (*http.Request, error)

NewCreateUserSuppliedCertificateJobRequest calls the generic CreateUserSuppliedCertificateJob builder with application/json body

func NewCreateUserSuppliedCertificateJobRequestWithBody

func NewCreateUserSuppliedCertificateJobRequestWithBody(server string, certificateId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateUserSuppliedCertificateJobRequestWithBody generates requests for CreateUserSuppliedCertificateJob with any type of body

func NewCreateVPNServiceJobRequest

func NewCreateVPNServiceJobRequest(server string, environmentId string, body CreateVPNServiceJobJSONRequestBody) (*http.Request, error)

NewCreateVPNServiceJobRequest calls the generic CreateVPNServiceJob builder with application/json body

func NewCreateVPNServiceJobRequestWithBody

func NewCreateVPNServiceJobRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateVPNServiceJobRequestWithBody generates requests for CreateVPNServiceJob with any type of body

func NewCreateVPNUserRequest

func NewCreateVPNUserRequest(server string, environmentId string, body CreateVPNUserJSONRequestBody) (*http.Request, error)

NewCreateVPNUserRequest calls the generic CreateVPNUser builder with application/json body

func NewCreateVPNUserRequestWithBody

func NewCreateVPNUserRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateVPNUserRequestWithBody generates requests for CreateVPNUser with any type of body

func NewCreateVirtualMachineJobRequest

func NewCreateVirtualMachineJobRequest(server string, virtualMachineId string, body CreateVirtualMachineJobJSONRequestBody) (*http.Request, error)

NewCreateVirtualMachineJobRequest calls the generic CreateVirtualMachineJob builder with application/json body

func NewCreateVirtualMachineJobRequestWithBody

func NewCreateVirtualMachineJobRequestWithBody(server string, virtualMachineId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateVirtualMachineJobRequestWithBody generates requests for CreateVirtualMachineJob with any type of body

func NewCreateVirtualMachineRequest

func NewCreateVirtualMachineRequest(server string, params *CreateVirtualMachineParams, body CreateVirtualMachineJSONRequestBody) (*http.Request, error)

NewCreateVirtualMachineRequest calls the generic CreateVirtualMachine builder with application/json body

func NewCreateVirtualMachineRequestWithBody

func NewCreateVirtualMachineRequestWithBody(server string, params *CreateVirtualMachineParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateVirtualMachineRequestWithBody generates requests for CreateVirtualMachine with any type of body

func NewCreateVirtualMachineSshKeyRequest

func NewCreateVirtualMachineSshKeyRequest(server string, params *CreateVirtualMachineSshKeyParams, body CreateVirtualMachineSshKeyJSONRequestBody) (*http.Request, error)

NewCreateVirtualMachineSshKeyRequest calls the generic CreateVirtualMachineSshKey builder with application/json body

func NewCreateVirtualMachineSshKeyRequestWithBody

func NewCreateVirtualMachineSshKeyRequestWithBody(server string, params *CreateVirtualMachineSshKeyParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateVirtualMachineSshKeyRequestWithBody generates requests for CreateVirtualMachineSshKey with any type of body

func NewCreateVirtualProviderIsoJobRequest added in v0.6.3

func NewCreateVirtualProviderIsoJobRequest(server string, integrationId string, isoId string, body CreateVirtualProviderIsoJobJSONRequestBody) (*http.Request, error)

NewCreateVirtualProviderIsoJobRequest calls the generic CreateVirtualProviderIsoJob builder with application/json body

func NewCreateVirtualProviderIsoJobRequestWithBody added in v0.6.3

func NewCreateVirtualProviderIsoJobRequestWithBody(server string, integrationId string, isoId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateVirtualProviderIsoJobRequestWithBody generates requests for CreateVirtualProviderIsoJob with any type of body

func NewCreateVirtualProviderIsoRequest added in v0.6.3

func NewCreateVirtualProviderIsoRequest(server string, integrationId string, body CreateVirtualProviderIsoJSONRequestBody) (*http.Request, error)

NewCreateVirtualProviderIsoRequest calls the generic CreateVirtualProviderIso builder with application/json body

func NewCreateVirtualProviderIsoRequestWithBody added in v0.6.3

func NewCreateVirtualProviderIsoRequestWithBody(server string, integrationId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateVirtualProviderIsoRequestWithBody generates requests for CreateVirtualProviderIso with any type of body

func NewDeleteAPIKeyRequest

func NewDeleteAPIKeyRequest(server string, apikeyId string) (*http.Request, error)

NewDeleteAPIKeyRequest generates requests for DeleteAPIKey

func NewDeleteAccountRequest

func NewDeleteAccountRequest(server string) (*http.Request, error)

NewDeleteAccountRequest generates requests for DeleteAccount

func NewDeleteAutoScaleGroupRequest

func NewDeleteAutoScaleGroupRequest(server string, groupId string) (*http.Request, error)

NewDeleteAutoScaleGroupRequest generates requests for DeleteAutoScaleGroup

func NewDeleteBillingMethodRequest

func NewDeleteBillingMethodRequest(server string, methodId string) (*http.Request, error)

NewDeleteBillingMethodRequest generates requests for DeleteBillingMethod

func NewDeleteClusterRequest

func NewDeleteClusterRequest(server string, clusterId string) (*http.Request, error)

NewDeleteClusterRequest generates requests for DeleteCluster

func NewDeleteContainerBackupRequest

func NewDeleteContainerBackupRequest(server string, containerId string, backupId string) (*http.Request, error)

NewDeleteContainerBackupRequest generates requests for DeleteContainerBackup

func NewDeleteContainerInstancesRequest

func NewDeleteContainerInstancesRequest(server string, containerId string) (*http.Request, error)

NewDeleteContainerInstancesRequest generates requests for DeleteContainerInstances

func NewDeleteContainerRequest

func NewDeleteContainerRequest(server string, containerId string) (*http.Request, error)

NewDeleteContainerRequest generates requests for DeleteContainer

func NewDeleteDNSZoneRecordRequest

func NewDeleteDNSZoneRecordRequest(server string, zoneId string, recordId string) (*http.Request, error)

NewDeleteDNSZoneRecordRequest generates requests for DeleteDNSZoneRecord

func NewDeleteDNSZoneRequest

func NewDeleteDNSZoneRequest(server string, zoneId string) (*http.Request, error)

NewDeleteDNSZoneRequest generates requests for DeleteDNSZone

func NewDeleteEnvironmentRequest

func NewDeleteEnvironmentRequest(server string, environmentId string) (*http.Request, error)

NewDeleteEnvironmentRequest generates requests for DeleteEnvironment

func NewDeleteExternalVolumeRequest added in v0.6.5

func NewDeleteExternalVolumeRequest(server string, externalVolumeId string, body DeleteExternalVolumeJSONRequestBody) (*http.Request, error)

NewDeleteExternalVolumeRequest calls the generic DeleteExternalVolume builder with application/json body

func NewDeleteExternalVolumeRequestWithBody added in v0.6.5

func NewDeleteExternalVolumeRequestWithBody(server string, externalVolumeId string, contentType string, body io.Reader) (*http.Request, error)

NewDeleteExternalVolumeRequestWithBody generates requests for DeleteExternalVolume with any type of body

func NewDeleteHubInviteRequest

func NewDeleteHubInviteRequest(server string, inviteId string) (*http.Request, error)

NewDeleteHubInviteRequest generates requests for DeleteHubInvite

func NewDeleteHubMemberRequest

func NewDeleteHubMemberRequest(server string, memberId string) (*http.Request, error)

NewDeleteHubMemberRequest generates requests for DeleteHubMember

func NewDeleteHubRequest

func NewDeleteHubRequest(server string, body DeleteHubJSONRequestBody) (*http.Request, error)

NewDeleteHubRequest calls the generic DeleteHub builder with application/json body

func NewDeleteHubRequestWithBody

func NewDeleteHubRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewDeleteHubRequestWithBody generates requests for DeleteHub with any type of body

func NewDeleteIPPoolRequest

func NewDeleteIPPoolRequest(server string, poolId string) (*http.Request, error)

NewDeleteIPPoolRequest generates requests for DeleteIPPool

func NewDeleteImageRequest

func NewDeleteImageRequest(server string, imageId string) (*http.Request, error)

NewDeleteImageRequest generates requests for DeleteImage

func NewDeleteImageSourceRequest

func NewDeleteImageSourceRequest(server string, sourceId string) (*http.Request, error)

NewDeleteImageSourceRequest generates requests for DeleteImageSource

func NewDeleteInstanceRequest

func NewDeleteInstanceRequest(server string, containerId string, instanceId string) (*http.Request, error)

NewDeleteInstanceRequest generates requests for DeleteInstance

func NewDeleteIntegrationRequest

func NewDeleteIntegrationRequest(server string, integrationId string) (*http.Request, error)

NewDeleteIntegrationRequest generates requests for DeleteIntegration

func NewDeleteNetworkRequest

func NewDeleteNetworkRequest(server string, networkId string) (*http.Request, error)

NewDeleteNetworkRequest generates requests for DeleteNetwork

func NewDeletePipelineRequest

func NewDeletePipelineRequest(server string, pipelineId string) (*http.Request, error)

NewDeletePipelineRequest generates requests for DeletePipeline

func NewDeletePipelineTriggerKeyRequest

func NewDeletePipelineTriggerKeyRequest(server string, pipelineId string, triggerKeyId string) (*http.Request, error)

NewDeletePipelineTriggerKeyRequest generates requests for DeletePipelineTriggerKey

func NewDeleteRoleRequest

func NewDeleteRoleRequest(server string, roleId string) (*http.Request, error)

NewDeleteRoleRequest generates requests for DeleteRole

func NewDeleteScopedVariableRequest

func NewDeleteScopedVariableRequest(server string, environmentId string, scopedVariableId string) (*http.Request, error)

NewDeleteScopedVariableRequest generates requests for DeleteScopedVariable

func NewDeleteServerRequest

func NewDeleteServerRequest(server string, serverId string, body DeleteServerJSONRequestBody) (*http.Request, error)

NewDeleteServerRequest calls the generic DeleteServer builder with application/json body

func NewDeleteServerRequestWithBody

func NewDeleteServerRequestWithBody(server string, serverId string, contentType string, body io.Reader) (*http.Request, error)

NewDeleteServerRequestWithBody generates requests for DeleteServer with any type of body

func NewDeleteStackBuildRequest

func NewDeleteStackBuildRequest(server string, stackId string, buildId string) (*http.Request, error)

NewDeleteStackBuildRequest generates requests for DeleteStackBuild

func NewDeleteStackRequest

func NewDeleteStackRequest(server string, stackId string) (*http.Request, error)

NewDeleteStackRequest generates requests for DeleteStack

func NewDeleteVPNUserRequest

func NewDeleteVPNUserRequest(server string, environmentId string, userId string) (*http.Request, error)

NewDeleteVPNUserRequest generates requests for DeleteVPNUser

func NewDeleteVirtualMachineRequest

func NewDeleteVirtualMachineRequest(server string, virtualMachineId string) (*http.Request, error)

NewDeleteVirtualMachineRequest generates requests for DeleteVirtualMachine

func NewDeleteVirtualMachineSshKeyRequest

func NewDeleteVirtualMachineSshKeyRequest(server string, sshKeyId string) (*http.Request, error)

NewDeleteVirtualMachineSshKeyRequest generates requests for DeleteVirtualMachineSshKey

func NewDeleteVirtualProviderIsoRequest added in v0.6.3

func NewDeleteVirtualProviderIsoRequest(server string, integrationId string, isoId string) (*http.Request, error)

NewDeleteVirtualProviderIsoRequest generates requests for DeleteVirtualProviderIso

func NewDisableTwoFactorAuthRequest

func NewDisableTwoFactorAuthRequest(server string, body DisableTwoFactorAuthJSONRequestBody) (*http.Request, error)

NewDisableTwoFactorAuthRequest calls the generic DisableTwoFactorAuth builder with application/json body

func NewDisableTwoFactorAuthRequestWithBody

func NewDisableTwoFactorAuthRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewDisableTwoFactorAuthRequestWithBody generates requests for DisableTwoFactorAuth with any type of body

func NewEnableTwoFactorAuthRequest

func NewEnableTwoFactorAuthRequest(server string, body EnableTwoFactorAuthJSONRequestBody) (*http.Request, error)

NewEnableTwoFactorAuthRequest calls the generic EnableTwoFactorAuth builder with application/json body

func NewEnableTwoFactorAuthRequestWithBody

func NewEnableTwoFactorAuthRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewEnableTwoFactorAuthRequestWithBody generates requests for EnableTwoFactorAuth with any type of body

func NewExpireInstanceSSHCredentialsRequest

func NewExpireInstanceSSHCredentialsRequest(server string, containerId string, instanceId string) (*http.Request, error)

NewExpireInstanceSSHCredentialsRequest generates requests for ExpireInstanceSSHCredentials

func NewExpireVirtualMachineSosCredentialsRequest

func NewExpireVirtualMachineSosCredentialsRequest(server string, virtualMachineId string) (*http.Request, error)

NewExpireVirtualMachineSosCredentialsRequest generates requests for ExpireVirtualMachineSosCredentials

func NewExportStackRequest

func NewExportStackRequest(server string, environmentId string, body ExportStackJSONRequestBody) (*http.Request, error)

NewExportStackRequest calls the generic ExportStack builder with application/json body

func NewExportStackRequestWithBody

func NewExportStackRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewExportStackRequestWithBody generates requests for ExportStack with any type of body

func NewGenerateAggregatedEventsRequest

func NewGenerateAggregatedEventsRequest(server string, params *GenerateAggregatedEventsParams, body GenerateAggregatedEventsJSONRequestBody) (*http.Request, error)

NewGenerateAggregatedEventsRequest calls the generic GenerateAggregatedEvents builder with application/json body

func NewGenerateAggregatedEventsRequestWithBody

func NewGenerateAggregatedEventsRequestWithBody(server string, params *GenerateAggregatedEventsParams, contentType string, body io.Reader) (*http.Request, error)

NewGenerateAggregatedEventsRequestWithBody generates requests for GenerateAggregatedEvents with any type of body

func NewGenerateAggregatedMetricsRequest

func NewGenerateAggregatedMetricsRequest(server string, params *GenerateAggregatedMetricsParams, body GenerateAggregatedMetricsJSONRequestBody) (*http.Request, error)

NewGenerateAggregatedMetricsRequest calls the generic GenerateAggregatedMetrics builder with application/json body

func NewGenerateAggregatedMetricsRequestWithBody

func NewGenerateAggregatedMetricsRequestWithBody(server string, params *GenerateAggregatedMetricsParams, contentType string, body io.Reader) (*http.Request, error)

NewGenerateAggregatedMetricsRequestWithBody generates requests for GenerateAggregatedMetrics with any type of body

func NewGenerateInstanceSSHCredentialsRequest

func NewGenerateInstanceSSHCredentialsRequest(server string, containerId string, instanceId string) (*http.Request, error)

NewGenerateInstanceSSHCredentialsRequest generates requests for GenerateInstanceSSHCredentials

func NewGenerateVirtualMachineSosCredentialsRequest

func NewGenerateVirtualMachineSosCredentialsRequest(server string, virtualMachineId string) (*http.Request, error)

NewGenerateVirtualMachineSosCredentialsRequest generates requests for GenerateVirtualMachineSosCredentials

func NewGetAPIKeyRequest

func NewGetAPIKeyRequest(server string, apikeyId string, params *GetAPIKeyParams) (*http.Request, error)

NewGetAPIKeyRequest generates requests for GetAPIKey

func NewGetAccountInvitesRequest

func NewGetAccountInvitesRequest(server string, params *GetAccountInvitesParams) (*http.Request, error)

NewGetAccountInvitesRequest generates requests for GetAccountInvites

func NewGetAccountLoginsRequest

func NewGetAccountLoginsRequest(server string, params *GetAccountLoginsParams) (*http.Request, error)

NewGetAccountLoginsRequest generates requests for GetAccountLogins

func NewGetAccountMembershipsRequest

func NewGetAccountMembershipsRequest(server string, params *GetAccountMembershipsParams) (*http.Request, error)

NewGetAccountMembershipsRequest generates requests for GetAccountMemberships

func NewGetAccountRequest

func NewGetAccountRequest(server string) (*http.Request, error)

NewGetAccountRequest generates requests for GetAccount

func NewGetAllPipelineRunsRequest added in v0.6.6

func NewGetAllPipelineRunsRequest(server string, params *GetAllPipelineRunsParams) (*http.Request, error)

NewGetAllPipelineRunsRequest generates requests for GetAllPipelineRuns

func NewGetAllStackBuildsRequest added in v0.6.6

func NewGetAllStackBuildsRequest(server string, params *GetAllStackBuildsParams) (*http.Request, error)

NewGetAllStackBuildsRequest generates requests for GetAllStackBuilds

func NewGetAllTlsCertificatesRequest added in v0.6.6

func NewGetAllTlsCertificatesRequest(server string, params *GetAllTlsCertificatesParams) (*http.Request, error)

NewGetAllTlsCertificatesRequest generates requests for GetAllTlsCertificates

func NewGetAnnouncementsRequest

func NewGetAnnouncementsRequest(server string, params *GetAnnouncementsParams) (*http.Request, error)

NewGetAnnouncementsRequest generates requests for GetAnnouncements

func NewGetApiKeysRequest

func NewGetApiKeysRequest(server string, params *GetApiKeysParams) (*http.Request, error)

NewGetApiKeysRequest generates requests for GetApiKeys

func NewGetAutoScaleGroupRequest

func NewGetAutoScaleGroupRequest(server string, groupId string, params *GetAutoScaleGroupParams) (*http.Request, error)

NewGetAutoScaleGroupRequest generates requests for GetAutoScaleGroup

func NewGetAutoScaleGroupsRequest

func NewGetAutoScaleGroupsRequest(server string, params *GetAutoScaleGroupsParams) (*http.Request, error)

NewGetAutoScaleGroupsRequest generates requests for GetAutoScaleGroups

func NewGetAvailableIntegrationsRequest

func NewGetAvailableIntegrationsRequest(server string) (*http.Request, error)

NewGetAvailableIntegrationsRequest generates requests for GetAvailableIntegrations

func NewGetAvailableIpsRequest

func NewGetAvailableIpsRequest(server string, virtualMachineId string) (*http.Request, error)

NewGetAvailableIpsRequest generates requests for GetAvailableIps

func NewGetBillingMethodRequest

func NewGetBillingMethodRequest(server string, methodId string) (*http.Request, error)

NewGetBillingMethodRequest generates requests for GetBillingMethod

func NewGetBillingMethodsRequest

func NewGetBillingMethodsRequest(server string, params *GetBillingMethodsParams) (*http.Request, error)

NewGetBillingMethodsRequest generates requests for GetBillingMethods

func NewGetBillingOrderRequest

func NewGetBillingOrderRequest(server string, orderId string, params *GetBillingOrderParams) (*http.Request, error)

NewGetBillingOrderRequest generates requests for GetBillingOrder

func NewGetBillingOveragesRequest

func NewGetBillingOveragesRequest(server string, params *GetBillingOveragesParams) (*http.Request, error)

NewGetBillingOveragesRequest generates requests for GetBillingOverages

func NewGetBillingServiceRequest

func NewGetBillingServiceRequest(server string, servicesId string) (*http.Request, error)

NewGetBillingServiceRequest generates requests for GetBillingService

func NewGetBillingServicesRequest

func NewGetBillingServicesRequest(server string, params *GetBillingServicesParams) (*http.Request, error)

NewGetBillingServicesRequest generates requests for GetBillingServices

func NewGetBillingStatusRequest added in v0.6.2

func NewGetBillingStatusRequest(server string) (*http.Request, error)

NewGetBillingStatusRequest generates requests for GetBillingStatus

func NewGetBillingSupportPlansRequest

func NewGetBillingSupportPlansRequest(server string, params *GetBillingSupportPlansParams) (*http.Request, error)

NewGetBillingSupportPlansRequest generates requests for GetBillingSupportPlans

func NewGetBillingTiersRequest

func NewGetBillingTiersRequest(server string) (*http.Request, error)

NewGetBillingTiersRequest generates requests for GetBillingTiers

func NewGetChangelogRequest added in v0.6.4

func NewGetChangelogRequest(server string, params *GetChangelogParams) (*http.Request, error)

NewGetChangelogRequest generates requests for GetChangelog

func NewGetClusterMonitoringTiersRequest added in v0.6.3

func NewGetClusterMonitoringTiersRequest(server string) (*http.Request, error)

NewGetClusterMonitoringTiersRequest generates requests for GetClusterMonitoringTiers

func NewGetClusterRequest

func NewGetClusterRequest(server string, clusterId string) (*http.Request, error)

NewGetClusterRequest generates requests for GetCluster

func NewGetClustersRequest

func NewGetClustersRequest(server string, params *GetClustersParams) (*http.Request, error)

NewGetClustersRequest generates requests for GetClusters

func NewGetCompatibleImagesRequest

func NewGetCompatibleImagesRequest(server string, containerId string, params *GetCompatibleImagesParams) (*http.Request, error)

NewGetCompatibleImagesRequest generates requests for GetCompatibleImages

func NewGetCompatibleServersRequest

func NewGetCompatibleServersRequest(server string, containerId string, params *GetCompatibleServersParams) (*http.Request, error)

NewGetCompatibleServersRequest generates requests for GetCompatibleServers

func NewGetContainerBackupLogsRequest

func NewGetContainerBackupLogsRequest(server string, containerId string, backupId string) (*http.Request, error)

NewGetContainerBackupLogsRequest generates requests for GetContainerBackupLogs

func NewGetContainerBackupRequest

func NewGetContainerBackupRequest(server string, containerId string, backupId string, params *GetContainerBackupParams) (*http.Request, error)

NewGetContainerBackupRequest generates requests for GetContainerBackup

func NewGetContainerBackupsRequest

func NewGetContainerBackupsRequest(server string, containerId string, params *GetContainerBackupsParams) (*http.Request, error)

NewGetContainerBackupsRequest generates requests for GetContainerBackups

func NewGetContainerRequest

func NewGetContainerRequest(server string, containerId string, params *GetContainerParams) (*http.Request, error)

NewGetContainerRequest generates requests for GetContainer

func NewGetContainerServersRequest

func NewGetContainerServersRequest(server string, containerId string, params *GetContainerServersParams) (*http.Request, error)

NewGetContainerServersRequest generates requests for GetContainerServers

func NewGetContainerSummaryRequest

func NewGetContainerSummaryRequest(server string, containerId string) (*http.Request, error)

NewGetContainerSummaryRequest generates requests for GetContainerSummary

func NewGetContainersRequest

func NewGetContainersRequest(server string, params *GetContainersParams) (*http.Request, error)

NewGetContainersRequest generates requests for GetContainers

func NewGetCreditRequest

func NewGetCreditRequest(server string, creditsId string) (*http.Request, error)

NewGetCreditRequest generates requests for GetCredit

func NewGetCreditsRequest

func NewGetCreditsRequest(server string, params *GetCreditsParams) (*http.Request, error)

NewGetCreditsRequest generates requests for GetCredits

func NewGetDNSZoneRecordsRequest

func NewGetDNSZoneRecordsRequest(server string, zoneId string, params *GetDNSZoneRecordsParams) (*http.Request, error)

NewGetDNSZoneRecordsRequest generates requests for GetDNSZoneRecords

func NewGetDNSZoneRequest

func NewGetDNSZoneRequest(server string, zoneId string) (*http.Request, error)

NewGetDNSZoneRequest generates requests for GetDNSZone

func NewGetDNSZonesRequest

func NewGetDNSZonesRequest(server string, params *GetDNSZonesParams) (*http.Request, error)

NewGetDNSZonesRequest generates requests for GetDNSZones

func NewGetDefaultHubRolesRequest

func NewGetDefaultHubRolesRequest(server string) (*http.Request, error)

NewGetDefaultHubRolesRequest generates requests for GetDefaultHubRoles

func NewGetDeploymentStrategiesRequest

func NewGetDeploymentStrategiesRequest(server string) (*http.Request, error)

NewGetDeploymentStrategiesRequest generates requests for GetDeploymentStrategies

func NewGetEnvironmentDeploymentsRequest

func NewGetEnvironmentDeploymentsRequest(server string, environmentId string) (*http.Request, error)

NewGetEnvironmentDeploymentsRequest generates requests for GetEnvironmentDeployments

func NewGetEnvironmentRequest

func NewGetEnvironmentRequest(server string, environmentId string, params *GetEnvironmentParams) (*http.Request, error)

NewGetEnvironmentRequest generates requests for GetEnvironment

func NewGetEnvironmentSummaryRequest

func NewGetEnvironmentSummaryRequest(server string, environmentId string) (*http.Request, error)

NewGetEnvironmentSummaryRequest generates requests for GetEnvironmentSummary

func NewGetEnvironmentsRequest

func NewGetEnvironmentsRequest(server string, params *GetEnvironmentsParams) (*http.Request, error)

NewGetEnvironmentsRequest generates requests for GetEnvironments

func NewGetEventsRequest

func NewGetEventsRequest(server string, params *GetEventsParams) (*http.Request, error)

NewGetEventsRequest generates requests for GetEvents

func NewGetExternalVolumeRequest added in v0.6.5

func NewGetExternalVolumeRequest(server string, externalVolumeId string, params *GetExternalVolumeParams) (*http.Request, error)

NewGetExternalVolumeRequest generates requests for GetExternalVolume

func NewGetExternalVolumeSourcesRequest added in v0.6.5

func NewGetExternalVolumeSourcesRequest(server string) (*http.Request, error)

NewGetExternalVolumeSourcesRequest generates requests for GetExternalVolumeSources

func NewGetExternalVolumesRequest added in v0.6.5

func NewGetExternalVolumesRequest(server string, params *GetExternalVolumesParams) (*http.Request, error)

NewGetExternalVolumesRequest generates requests for GetExternalVolumes

func NewGetHubActivityRequest

func NewGetHubActivityRequest(server string, params *GetHubActivityParams) (*http.Request, error)

NewGetHubActivityRequest generates requests for GetHubActivity

func NewGetHubCapabilitiesRequest

func NewGetHubCapabilitiesRequest(server string) (*http.Request, error)

NewGetHubCapabilitiesRequest generates requests for GetHubCapabilities

func NewGetHubInvitesRequest

func NewGetHubInvitesRequest(server string, params *GetHubInvitesParams) (*http.Request, error)

NewGetHubInvitesRequest generates requests for GetHubInvites

func NewGetHubMemberAccountRequest

func NewGetHubMemberAccountRequest(server string, accountId string, params *GetHubMemberAccountParams) (*http.Request, error)

NewGetHubMemberAccountRequest generates requests for GetHubMemberAccount

func NewGetHubMemberRequest

func NewGetHubMemberRequest(server string, memberId string, params *GetHubMemberParams) (*http.Request, error)

NewGetHubMemberRequest generates requests for GetHubMember

func NewGetHubMembersRequest

func NewGetHubMembersRequest(server string, params *GetHubMembersParams) (*http.Request, error)

NewGetHubMembersRequest generates requests for GetHubMembers

func NewGetHubMembershipRequest

func NewGetHubMembershipRequest(server string, params *GetHubMembershipParams) (*http.Request, error)

NewGetHubMembershipRequest generates requests for GetHubMembership

func NewGetHubNotificationSocketAuthRequest

func NewGetHubNotificationSocketAuthRequest(server string) (*http.Request, error)

NewGetHubNotificationSocketAuthRequest generates requests for GetHubNotificationSocketAuth

func NewGetHubRequest

func NewGetHubRequest(server string, params *GetHubParams) (*http.Request, error)

NewGetHubRequest generates requests for GetHub

func NewGetHubUsageRequest

func NewGetHubUsageRequest(server string, params *GetHubUsageParams) (*http.Request, error)

NewGetHubUsageRequest generates requests for GetHubUsage

func NewGetHubsRequest

func NewGetHubsRequest(server string, params *GetHubsParams) (*http.Request, error)

NewGetHubsRequest generates requests for GetHubs

func NewGetIPPoolRequest

func NewGetIPPoolRequest(server string, poolId string, params *GetIPPoolParams) (*http.Request, error)

NewGetIPPoolRequest generates requests for GetIPPool

func NewGetImageBuildLogRequest

func NewGetImageBuildLogRequest(server string, imageId string) (*http.Request, error)

NewGetImageBuildLogRequest generates requests for GetImageBuildLog

func NewGetImageRequest

func NewGetImageRequest(server string, imageId string, params *GetImageParams) (*http.Request, error)

NewGetImageRequest generates requests for GetImage

func NewGetImageSourceRequest

func NewGetImageSourceRequest(server string, sourceId string, params *GetImageSourceParams) (*http.Request, error)

NewGetImageSourceRequest generates requests for GetImageSource

func NewGetImageSourcesRequest

func NewGetImageSourcesRequest(server string, params *GetImageSourcesParams) (*http.Request, error)

NewGetImageSourcesRequest generates requests for GetImageSources

func NewGetImagesRequest

func NewGetImagesRequest(server string, params *GetImagesParams) (*http.Request, error)

NewGetImagesRequest generates requests for GetImages

func NewGetInfrastructureSummaryRequest

func NewGetInfrastructureSummaryRequest(server string, params *GetInfrastructureSummaryParams) (*http.Request, error)

NewGetInfrastructureSummaryRequest generates requests for GetInfrastructureSummary

func NewGetInstanceConsoleStreamAuthRequest

func NewGetInstanceConsoleStreamAuthRequest(server string, containerId string, instanceId string) (*http.Request, error)

NewGetInstanceConsoleStreamAuthRequest generates requests for GetInstanceConsoleStreamAuth

func NewGetInstanceRequest

func NewGetInstanceRequest(server string, containerId string, instanceId string, params *GetInstanceParams) (*http.Request, error)

NewGetInstanceRequest generates requests for GetInstance

func NewGetInstanceTelemetryReportRequest

func NewGetInstanceTelemetryReportRequest(server string, containerId string, instanceId string, params *GetInstanceTelemetryReportParams) (*http.Request, error)

NewGetInstanceTelemetryReportRequest generates requests for GetInstanceTelemetryReport

func NewGetInstanceTelemetryStreamAuthRequest

func NewGetInstanceTelemetryStreamAuthRequest(server string, containerId string, instanceId string) (*http.Request, error)

NewGetInstanceTelemetryStreamAuthRequest generates requests for GetInstanceTelemetryStreamAuth

func NewGetInstanceVolumesRequest

func NewGetInstanceVolumesRequest(server string, containerId string, instanceId string, params *GetInstanceVolumesParams) (*http.Request, error)

NewGetInstanceVolumesRequest generates requests for GetInstanceVolumes

func NewGetInstancesRequest

func NewGetInstancesRequest(server string, containerId string, params *GetInstancesParams) (*http.Request, error)

NewGetInstancesRequest generates requests for GetInstances

func NewGetIntegrationRequest

func NewGetIntegrationRequest(server string, integrationId string, params *GetIntegrationParams) (*http.Request, error)

NewGetIntegrationRequest generates requests for GetIntegration

func NewGetIntegrationsRequest

func NewGetIntegrationsRequest(server string, params *GetIntegrationsParams) (*http.Request, error)

NewGetIntegrationsRequest generates requests for GetIntegrations

func NewGetInvoiceRequest

func NewGetInvoiceRequest(server string, invoiceId string, params *GetInvoiceParams) (*http.Request, error)

NewGetInvoiceRequest generates requests for GetInvoice

func NewGetInvoicesRequest

func NewGetInvoicesRequest(server string, params *GetInvoicesParams) (*http.Request, error)

NewGetInvoicesRequest generates requests for GetInvoices

func NewGetIpPoolsRequest added in v0.6.3

func NewGetIpPoolsRequest(server string, params *GetIpPoolsParams) (*http.Request, error)

NewGetIpPoolsRequest generates requests for GetIpPools

func NewGetJobRequest

func NewGetJobRequest(server string, jobId string) (*http.Request, error)

NewGetJobRequest generates requests for GetJob

func NewGetJobsRequest

func NewGetJobsRequest(server string, params *GetJobsParams) (*http.Request, error)

NewGetJobsRequest generates requests for GetJobs

func NewGetLatestJobsRequest

func NewGetLatestJobsRequest(server string) (*http.Request, error)

NewGetLatestJobsRequest generates requests for GetLatestJobs

func NewGetLoadBalancerLatestTelemetryReportRequest

func NewGetLoadBalancerLatestTelemetryReportRequest(server string, environmentId string, params *GetLoadBalancerLatestTelemetryReportParams) (*http.Request, error)

NewGetLoadBalancerLatestTelemetryReportRequest generates requests for GetLoadBalancerLatestTelemetryReport

func NewGetLoadBalancerServiceRequest

func NewGetLoadBalancerServiceRequest(server string, environmentId string) (*http.Request, error)

NewGetLoadBalancerServiceRequest generates requests for GetLoadBalancerService

func NewGetLoadBalancerTelemetryLatestControllersRequest

func NewGetLoadBalancerTelemetryLatestControllersRequest(server string, environmentId string, params *GetLoadBalancerTelemetryLatestControllersParams) (*http.Request, error)

NewGetLoadBalancerTelemetryLatestControllersRequest generates requests for GetLoadBalancerTelemetryLatestControllers

func NewGetLoadBalancerTelemetryReportRequest

func NewGetLoadBalancerTelemetryReportRequest(server string, environmentId string, params *GetLoadBalancerTelemetryReportParams) (*http.Request, error)

NewGetLoadBalancerTelemetryReportRequest generates requests for GetLoadBalancerTelemetryReport

func NewGetMetricsRequest

func NewGetMetricsRequest(server string, params *GetMetricsParams) (*http.Request, error)

NewGetMetricsRequest generates requests for GetMetrics

func NewGetMonitoringMonitorsRequest

func NewGetMonitoringMonitorsRequest(server string) (*http.Request, error)

NewGetMonitoringMonitorsRequest generates requests for GetMonitoringMonitors

func NewGetNetworkRequest

func NewGetNetworkRequest(server string, networkId string, params *GetNetworkParams) (*http.Request, error)

NewGetNetworkRequest generates requests for GetNetwork

func NewGetNetworksRequest

func NewGetNetworksRequest(server string, params *GetNetworksParams) (*http.Request, error)

NewGetNetworksRequest generates requests for GetNetworks

func NewGetOrdersRequest

func NewGetOrdersRequest(server string, params *GetOrdersParams) (*http.Request, error)

NewGetOrdersRequest generates requests for GetOrders

func NewGetPipelineRequest

func NewGetPipelineRequest(server string, pipelineId string, params *GetPipelineParams) (*http.Request, error)

NewGetPipelineRequest generates requests for GetPipeline

func NewGetPipelineRunRequest

func NewGetPipelineRunRequest(server string, pipelineId string, runId string, params *GetPipelineRunParams) (*http.Request, error)

NewGetPipelineRunRequest generates requests for GetPipelineRun

func NewGetPipelineRunsRequest

func NewGetPipelineRunsRequest(server string, pipelineId string, params *GetPipelineRunsParams) (*http.Request, error)

NewGetPipelineRunsRequest generates requests for GetPipelineRuns

func NewGetPipelineTriggerKeyRequest

func NewGetPipelineTriggerKeyRequest(server string, pipelineId string, triggerKeyId string) (*http.Request, error)

NewGetPipelineTriggerKeyRequest generates requests for GetPipelineTriggerKey

func NewGetPipelineTriggerKeysRequest

func NewGetPipelineTriggerKeysRequest(server string, pipelineId string, params *GetPipelineTriggerKeysParams) (*http.Request, error)

NewGetPipelineTriggerKeysRequest generates requests for GetPipelineTriggerKeys

func NewGetPipelinesRequest

func NewGetPipelinesRequest(server string, params *GetPipelinesParams) (*http.Request, error)

NewGetPipelinesRequest generates requests for GetPipelines

func NewGetPoolIPsRequest

func NewGetPoolIPsRequest(server string, poolId string) (*http.Request, error)

NewGetPoolIPsRequest generates requests for GetPoolIPs

func NewGetProviderLocationsRequest

func NewGetProviderLocationsRequest(server string, integrationId string, params *GetProviderLocationsParams) (*http.Request, error)

NewGetProviderLocationsRequest generates requests for GetProviderLocations

func NewGetProviderServerModelsRequest added in v0.6.6

func NewGetProviderServerModelsRequest(server string, integrationId string, params *GetProviderServerModelsParams) (*http.Request, error)

NewGetProviderServerModelsRequest generates requests for GetProviderServerModels

func NewGetRoleRequest

func NewGetRoleRequest(server string, roleId string, params *GetRoleParams) (*http.Request, error)

NewGetRoleRequest generates requests for GetRole

func NewGetRolesRequest

func NewGetRolesRequest(server string, params *GetRolesParams) (*http.Request, error)

NewGetRolesRequest generates requests for GetRoles

func NewGetScopedVariableRequest

func NewGetScopedVariableRequest(server string, environmentId string, scopedVariableId string) (*http.Request, error)

NewGetScopedVariableRequest generates requests for GetScopedVariable

func NewGetScopedVariablesRequest

func NewGetScopedVariablesRequest(server string, environmentId string, params *GetScopedVariablesParams) (*http.Request, error)

NewGetScopedVariablesRequest generates requests for GetScopedVariables

func NewGetSearchIndexRequest

func NewGetSearchIndexRequest(server string) (*http.Request, error)

NewGetSearchIndexRequest generates requests for GetSearchIndex

func NewGetServerConsoleRequest

func NewGetServerConsoleRequest(server string, serverId string) (*http.Request, error)

NewGetServerConsoleRequest generates requests for GetServerConsole

func NewGetServerInstancesRequest

func NewGetServerInstancesRequest(server string, serverId string, params *GetServerInstancesParams) (*http.Request, error)

NewGetServerInstancesRequest generates requests for GetServerInstances

func NewGetServerRequest

func NewGetServerRequest(server string, serverId string, params *GetServerParams) (*http.Request, error)

NewGetServerRequest generates requests for GetServer

func NewGetServerTagsRequest

func NewGetServerTagsRequest(server string, params *GetServerTagsParams) (*http.Request, error)

NewGetServerTagsRequest generates requests for GetServerTags

func NewGetServerTelemetryRequest

func NewGetServerTelemetryRequest(server string, serverId string, params *GetServerTelemetryParams) (*http.Request, error)

NewGetServerTelemetryRequest generates requests for GetServerTelemetry

func NewGetServerUsageRequest

func NewGetServerUsageRequest(server string, serverId string) (*http.Request, error)

NewGetServerUsageRequest generates requests for GetServerUsage

func NewGetServersRequest

func NewGetServersRequest(server string, params *GetServersParams) (*http.Request, error)

NewGetServersRequest generates requests for GetServers

func NewGetStackBuildLogRequest

func NewGetStackBuildLogRequest(server string, stackId string, buildId string) (*http.Request, error)

NewGetStackBuildLogRequest generates requests for GetStackBuildLog

func NewGetStackBuildRequest

func NewGetStackBuildRequest(server string, stackId string, buildId string) (*http.Request, error)

NewGetStackBuildRequest generates requests for GetStackBuild

func NewGetStackBuildsRequest

func NewGetStackBuildsRequest(server string, stackId string, params *GetStackBuildsParams) (*http.Request, error)

NewGetStackBuildsRequest generates requests for GetStackBuilds

func NewGetStackRequest

func NewGetStackRequest(server string, stackId string) (*http.Request, error)

NewGetStackRequest generates requests for GetStack

func NewGetStacksRequest

func NewGetStacksRequest(server string, params *GetStacksParams) (*http.Request, error)

NewGetStacksRequest generates requests for GetStacks

func NewGetTLSGenerationAttemptsRequest

func NewGetTLSGenerationAttemptsRequest(server string, params *GetTLSGenerationAttemptsParams) (*http.Request, error)

NewGetTLSGenerationAttemptsRequest generates requests for GetTLSGenerationAttempts

func NewGetTwoFactorAuthSetupRequest

func NewGetTwoFactorAuthSetupRequest(server string) (*http.Request, error)

NewGetTwoFactorAuthSetupRequest generates requests for GetTwoFactorAuthSetup

func NewGetUserSuppliedCertificateRequest

func NewGetUserSuppliedCertificateRequest(server string, certificateId string) (*http.Request, error)

NewGetUserSuppliedCertificateRequest generates requests for GetUserSuppliedCertificate

func NewGetUserSuppliedCertificatesRequest

func NewGetUserSuppliedCertificatesRequest(server string, params *GetUserSuppliedCertificatesParams) (*http.Request, error)

NewGetUserSuppliedCertificatesRequest generates requests for GetUserSuppliedCertificates

func NewGetVPNLoginsRequest

func NewGetVPNLoginsRequest(server string, environmentId string, params *GetVPNLoginsParams) (*http.Request, error)

NewGetVPNLoginsRequest generates requests for GetVPNLogins

func NewGetVPNServiceRequest

func NewGetVPNServiceRequest(server string, environmentId string) (*http.Request, error)

NewGetVPNServiceRequest generates requests for GetVPNService

func NewGetVPNUsersRequest

func NewGetVPNUsersRequest(server string, environmentId string) (*http.Request, error)

NewGetVPNUsersRequest generates requests for GetVPNUsers

func NewGetVirtualMachineBaseImagesRequest

func NewGetVirtualMachineBaseImagesRequest(server string) (*http.Request, error)

NewGetVirtualMachineBaseImagesRequest generates requests for GetVirtualMachineBaseImages

func NewGetVirtualMachineRequest

func NewGetVirtualMachineRequest(server string, virtualMachineId string, params *GetVirtualMachineParams) (*http.Request, error)

NewGetVirtualMachineRequest generates requests for GetVirtualMachine

func NewGetVirtualMachineSshKeyRequest

func NewGetVirtualMachineSshKeyRequest(server string, sshKeyId string, params *GetVirtualMachineSshKeyParams) (*http.Request, error)

NewGetVirtualMachineSshKeyRequest generates requests for GetVirtualMachineSshKey

func NewGetVirtualMachineSshKeysRequest

func NewGetVirtualMachineSshKeysRequest(server string, params *GetVirtualMachineSshKeysParams) (*http.Request, error)

NewGetVirtualMachineSshKeysRequest generates requests for GetVirtualMachineSshKeys

func NewGetVirtualMachinesRequest

func NewGetVirtualMachinesRequest(server string, params *GetVirtualMachinesParams) (*http.Request, error)

NewGetVirtualMachinesRequest generates requests for GetVirtualMachines

func NewGetVirtualProviderIsoDownloadUrlRequest added in v0.6.3

func NewGetVirtualProviderIsoDownloadUrlRequest(server string, integrationId string, isoId string) (*http.Request, error)

NewGetVirtualProviderIsoDownloadUrlRequest generates requests for GetVirtualProviderIsoDownloadUrl

func NewGetVirtualProviderIsoRequest added in v0.6.3

func NewGetVirtualProviderIsoRequest(server string, integrationId string, isoId string, params *GetVirtualProviderIsoParams) (*http.Request, error)

NewGetVirtualProviderIsoRequest generates requests for GetVirtualProviderIso

func NewGetVirtualProviderIsosRequest added in v0.6.3

func NewGetVirtualProviderIsosRequest(server string, integrationId string, params *GetVirtualProviderIsosParams) (*http.Request, error)

NewGetVirtualProviderIsosRequest generates requests for GetVirtualProviderIsos

func NewLookupComponentsRequest

func NewLookupComponentsRequest(server string, body LookupComponentsJSONRequestBody) (*http.Request, error)

NewLookupComponentsRequest calls the generic LookupComponents builder with application/json body

func NewLookupComponentsRequestWithBody

func NewLookupComponentsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewLookupComponentsRequestWithBody generates requests for LookupComponents with any type of body

func NewLookupIdentifierRequest

func NewLookupIdentifierRequest(server string, params *LookupIdentifierParams) (*http.Request, error)

NewLookupIdentifierRequest generates requests for LookupIdentifier

func NewLookupStackBuildRequest

func NewLookupStackBuildRequest(server string, buildId string) (*http.Request, error)

NewLookupStackBuildRequest generates requests for LookupStackBuild

func NewLookupTLSCertificateRequest

func NewLookupTLSCertificateRequest(server string, params *LookupTLSCertificateParams) (*http.Request, error)

NewLookupTLSCertificateRequest generates requests for LookupTLSCertificate

func NewRecoverTwoFactorAuthRequest

func NewRecoverTwoFactorAuthRequest(server string, body RecoverTwoFactorAuthJSONRequestBody) (*http.Request, error)

NewRecoverTwoFactorAuthRequest calls the generic RecoverTwoFactorAuth builder with application/json body

func NewRecoverTwoFactorAuthRequestWithBody

func NewRecoverTwoFactorAuthRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewRecoverTwoFactorAuthRequestWithBody generates requests for RecoverTwoFactorAuth with any type of body

func NewResetPasswordRequest

func NewResetPasswordRequest(server string, body ResetPasswordJSONRequestBody) (*http.Request, error)

NewResetPasswordRequest calls the generic ResetPassword builder with application/json body

func NewResetPasswordRequestWithBody

func NewResetPasswordRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewResetPasswordRequestWithBody generates requests for ResetPassword with any type of body

func NewTriggerPipelineRequest

func NewTriggerPipelineRequest(server string, pipelineId string, body TriggerPipelineJSONRequestBody) (*http.Request, error)

NewTriggerPipelineRequest calls the generic TriggerPipeline builder with application/json body

func NewTriggerPipelineRequestWithBody

func NewTriggerPipelineRequestWithBody(server string, pipelineId string, contentType string, body io.Reader) (*http.Request, error)

NewTriggerPipelineRequestWithBody generates requests for TriggerPipeline with any type of body

func NewUpdateAPIKeyRequest

func NewUpdateAPIKeyRequest(server string, apikeyId string, body UpdateAPIKeyJSONRequestBody) (*http.Request, error)

NewUpdateAPIKeyRequest calls the generic UpdateAPIKey builder with application/json body

func NewUpdateAPIKeyRequestWithBody

func NewUpdateAPIKeyRequestWithBody(server string, apikeyId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAPIKeyRequestWithBody generates requests for UpdateAPIKey with any type of body

func NewUpdateAccountInviteRequest

func NewUpdateAccountInviteRequest(server string, inviteId string, params *UpdateAccountInviteParams, body UpdateAccountInviteJSONRequestBody) (*http.Request, error)

NewUpdateAccountInviteRequest calls the generic UpdateAccountInvite builder with application/json body

func NewUpdateAccountInviteRequestWithBody

func NewUpdateAccountInviteRequestWithBody(server string, inviteId string, params *UpdateAccountInviteParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAccountInviteRequestWithBody generates requests for UpdateAccountInvite with any type of body

func NewUpdateAccountRequest

func NewUpdateAccountRequest(server string, body UpdateAccountJSONRequestBody) (*http.Request, error)

NewUpdateAccountRequest calls the generic UpdateAccount builder with application/json body

func NewUpdateAccountRequestWithBody

func NewUpdateAccountRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAccountRequestWithBody generates requests for UpdateAccount with any type of body

func NewUpdateAutoScaleGroupAccessRequest

func NewUpdateAutoScaleGroupAccessRequest(server string, groupId string, body UpdateAutoScaleGroupAccessJSONRequestBody) (*http.Request, error)

NewUpdateAutoScaleGroupAccessRequest calls the generic UpdateAutoScaleGroupAccess builder with application/json body

func NewUpdateAutoScaleGroupAccessRequestWithBody

func NewUpdateAutoScaleGroupAccessRequestWithBody(server string, groupId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAutoScaleGroupAccessRequestWithBody generates requests for UpdateAutoScaleGroupAccess with any type of body

func NewUpdateAutoScaleGroupRequest

func NewUpdateAutoScaleGroupRequest(server string, groupId string, body UpdateAutoScaleGroupJSONRequestBody) (*http.Request, error)

NewUpdateAutoScaleGroupRequest calls the generic UpdateAutoScaleGroup builder with application/json body

func NewUpdateAutoScaleGroupRequestWithBody

func NewUpdateAutoScaleGroupRequestWithBody(server string, groupId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAutoScaleGroupRequestWithBody generates requests for UpdateAutoScaleGroup with any type of body

func NewUpdateBillingMethodRequest

func NewUpdateBillingMethodRequest(server string, methodId string, body UpdateBillingMethodJSONRequestBody) (*http.Request, error)

NewUpdateBillingMethodRequest calls the generic UpdateBillingMethod builder with application/json body

func NewUpdateBillingMethodRequestWithBody

func NewUpdateBillingMethodRequestWithBody(server string, methodId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateBillingMethodRequestWithBody generates requests for UpdateBillingMethod with any type of body

func NewUpdateBillingOrderRequest

func NewUpdateBillingOrderRequest(server string, orderId string, params *UpdateBillingOrderParams, body UpdateBillingOrderJSONRequestBody) (*http.Request, error)

NewUpdateBillingOrderRequest calls the generic UpdateBillingOrder builder with application/json body

func NewUpdateBillingOrderRequestWithBody

func NewUpdateBillingOrderRequestWithBody(server string, orderId string, params *UpdateBillingOrderParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateBillingOrderRequestWithBody generates requests for UpdateBillingOrder with any type of body

func NewUpdateClusterAccessRequest

func NewUpdateClusterAccessRequest(server string, clusterId string, body UpdateClusterAccessJSONRequestBody) (*http.Request, error)

NewUpdateClusterAccessRequest calls the generic UpdateClusterAccess builder with application/json body

func NewUpdateClusterAccessRequestWithBody

func NewUpdateClusterAccessRequestWithBody(server string, clusterId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateClusterAccessRequestWithBody generates requests for UpdateClusterAccess with any type of body

func NewUpdateClusterRequest

func NewUpdateClusterRequest(server string, clusterId string, body UpdateClusterJSONRequestBody) (*http.Request, error)

NewUpdateClusterRequest calls the generic UpdateCluster builder with application/json body

func NewUpdateClusterRequestWithBody

func NewUpdateClusterRequestWithBody(server string, clusterId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateClusterRequestWithBody generates requests for UpdateCluster with any type of body

func NewUpdateContainerRequest

func NewUpdateContainerRequest(server string, containerId string, body UpdateContainerJSONRequestBody) (*http.Request, error)

NewUpdateContainerRequest calls the generic UpdateContainer builder with application/json body

func NewUpdateContainerRequestWithBody

func NewUpdateContainerRequestWithBody(server string, containerId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateContainerRequestWithBody generates requests for UpdateContainer with any type of body

func NewUpdateDNSZoneAccessRequest

func NewUpdateDNSZoneAccessRequest(server string, zoneId string, params *UpdateDNSZoneAccessParams, body UpdateDNSZoneAccessJSONRequestBody) (*http.Request, error)

NewUpdateDNSZoneAccessRequest calls the generic UpdateDNSZoneAccess builder with application/json body

func NewUpdateDNSZoneAccessRequestWithBody

func NewUpdateDNSZoneAccessRequestWithBody(server string, zoneId string, params *UpdateDNSZoneAccessParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDNSZoneAccessRequestWithBody generates requests for UpdateDNSZoneAccess with any type of body

func NewUpdateDNSZoneRecordRequest

func NewUpdateDNSZoneRecordRequest(server string, zoneId string, recordId string, params *UpdateDNSZoneRecordParams, body UpdateDNSZoneRecordJSONRequestBody) (*http.Request, error)

NewUpdateDNSZoneRecordRequest calls the generic UpdateDNSZoneRecord builder with application/json body

func NewUpdateDNSZoneRecordRequestWithBody

func NewUpdateDNSZoneRecordRequestWithBody(server string, zoneId string, recordId string, params *UpdateDNSZoneRecordParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDNSZoneRecordRequestWithBody generates requests for UpdateDNSZoneRecord with any type of body

func NewUpdateDNSZoneRequest

func NewUpdateDNSZoneRequest(server string, zoneId string, params *UpdateDNSZoneParams, body UpdateDNSZoneJSONRequestBody) (*http.Request, error)

NewUpdateDNSZoneRequest calls the generic UpdateDNSZone builder with application/json body

func NewUpdateDNSZoneRequestWithBody

func NewUpdateDNSZoneRequestWithBody(server string, zoneId string, params *UpdateDNSZoneParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDNSZoneRequestWithBody generates requests for UpdateDNSZone with any type of body

func NewUpdateEnvironmentAccessRequest

func NewUpdateEnvironmentAccessRequest(server string, environmentId string, body UpdateEnvironmentAccessJSONRequestBody) (*http.Request, error)

NewUpdateEnvironmentAccessRequest calls the generic UpdateEnvironmentAccess builder with application/json body

func NewUpdateEnvironmentAccessRequestWithBody

func NewUpdateEnvironmentAccessRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateEnvironmentAccessRequestWithBody generates requests for UpdateEnvironmentAccess with any type of body

func NewUpdateEnvironmentRequest

func NewUpdateEnvironmentRequest(server string, environmentId string, body UpdateEnvironmentJSONRequestBody) (*http.Request, error)

NewUpdateEnvironmentRequest calls the generic UpdateEnvironment builder with application/json body

func NewUpdateEnvironmentRequestWithBody

func NewUpdateEnvironmentRequestWithBody(server string, environmentId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateEnvironmentRequestWithBody generates requests for UpdateEnvironment with any type of body

func NewUpdateExternalVolumeAccessRequest added in v0.6.5

func NewUpdateExternalVolumeAccessRequest(server string, externalVolumeId string, body UpdateExternalVolumeAccessJSONRequestBody) (*http.Request, error)

NewUpdateExternalVolumeAccessRequest calls the generic UpdateExternalVolumeAccess builder with application/json body

func NewUpdateExternalVolumeAccessRequestWithBody added in v0.6.5

func NewUpdateExternalVolumeAccessRequestWithBody(server string, externalVolumeId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateExternalVolumeAccessRequestWithBody generates requests for UpdateExternalVolumeAccess with any type of body

func NewUpdateExternalVolumeRequest added in v0.6.5

func NewUpdateExternalVolumeRequest(server string, externalVolumeId string, params *UpdateExternalVolumeParams, body UpdateExternalVolumeJSONRequestBody) (*http.Request, error)

NewUpdateExternalVolumeRequest calls the generic UpdateExternalVolume builder with application/json body

func NewUpdateExternalVolumeRequestWithBody added in v0.6.5

func NewUpdateExternalVolumeRequestWithBody(server string, externalVolumeId string, params *UpdateExternalVolumeParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateExternalVolumeRequestWithBody generates requests for UpdateExternalVolume with any type of body

func NewUpdateHubMemberRequest

func NewUpdateHubMemberRequest(server string, memberId string, body UpdateHubMemberJSONRequestBody) (*http.Request, error)

NewUpdateHubMemberRequest calls the generic UpdateHubMember builder with application/json body

func NewUpdateHubMemberRequestWithBody

func NewUpdateHubMemberRequestWithBody(server string, memberId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateHubMemberRequestWithBody generates requests for UpdateHubMember with any type of body

func NewUpdateHubRequest

func NewUpdateHubRequest(server string, body UpdateHubJSONRequestBody) (*http.Request, error)

NewUpdateHubRequest calls the generic UpdateHub builder with application/json body

func NewUpdateHubRequestWithBody

func NewUpdateHubRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateHubRequestWithBody generates requests for UpdateHub with any type of body

func NewUpdateImageRequest

func NewUpdateImageRequest(server string, imageId string, body UpdateImageJSONRequestBody) (*http.Request, error)

NewUpdateImageRequest calls the generic UpdateImage builder with application/json body

func NewUpdateImageRequestWithBody

func NewUpdateImageRequestWithBody(server string, imageId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateImageRequestWithBody generates requests for UpdateImage with any type of body

func NewUpdateImageSourceAccessRequest

func NewUpdateImageSourceAccessRequest(server string, sourceId string, body UpdateImageSourceAccessJSONRequestBody) (*http.Request, error)

NewUpdateImageSourceAccessRequest calls the generic UpdateImageSourceAccess builder with application/json body

func NewUpdateImageSourceAccessRequestWithBody

func NewUpdateImageSourceAccessRequestWithBody(server string, sourceId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateImageSourceAccessRequestWithBody generates requests for UpdateImageSourceAccess with any type of body

func NewUpdateImageSourceRequest

func NewUpdateImageSourceRequest(server string, sourceId string, body UpdateImageSourceJSONRequestBody) (*http.Request, error)

NewUpdateImageSourceRequest calls the generic UpdateImageSource builder with application/json body

func NewUpdateImageSourceRequestWithBody

func NewUpdateImageSourceRequestWithBody(server string, sourceId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateImageSourceRequestWithBody generates requests for UpdateImageSource with any type of body

func NewUpdateIntegrationRequest

func NewUpdateIntegrationRequest(server string, integrationId string, params *UpdateIntegrationParams, body UpdateIntegrationJSONRequestBody) (*http.Request, error)

NewUpdateIntegrationRequest calls the generic UpdateIntegration builder with application/json body

func NewUpdateIntegrationRequestWithBody

func NewUpdateIntegrationRequestWithBody(server string, integrationId string, params *UpdateIntegrationParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateIntegrationRequestWithBody generates requests for UpdateIntegration with any type of body

func NewUpdateNetworkAccessRequest

func NewUpdateNetworkAccessRequest(server string, networkId string, params *UpdateNetworkAccessParams, body UpdateNetworkAccessJSONRequestBody) (*http.Request, error)

NewUpdateNetworkAccessRequest calls the generic UpdateNetworkAccess builder with application/json body

func NewUpdateNetworkAccessRequestWithBody

func NewUpdateNetworkAccessRequestWithBody(server string, networkId string, params *UpdateNetworkAccessParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateNetworkAccessRequestWithBody generates requests for UpdateNetworkAccess with any type of body

func NewUpdateNetworkRequest

func NewUpdateNetworkRequest(server string, networkId string, params *UpdateNetworkParams, body UpdateNetworkJSONRequestBody) (*http.Request, error)

NewUpdateNetworkRequest calls the generic UpdateNetwork builder with application/json body

func NewUpdateNetworkRequestWithBody

func NewUpdateNetworkRequestWithBody(server string, networkId string, params *UpdateNetworkParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateNetworkRequestWithBody generates requests for UpdateNetwork with any type of body

func NewUpdatePipelineAccessRequest

func NewUpdatePipelineAccessRequest(server string, pipelineId string, body UpdatePipelineAccessJSONRequestBody) (*http.Request, error)

NewUpdatePipelineAccessRequest calls the generic UpdatePipelineAccess builder with application/json body

func NewUpdatePipelineAccessRequestWithBody

func NewUpdatePipelineAccessRequestWithBody(server string, pipelineId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdatePipelineAccessRequestWithBody generates requests for UpdatePipelineAccess with any type of body

func NewUpdatePipelineRequest

func NewUpdatePipelineRequest(server string, pipelineId string, body UpdatePipelineJSONRequestBody) (*http.Request, error)

NewUpdatePipelineRequest calls the generic UpdatePipeline builder with application/json body

func NewUpdatePipelineRequestWithBody

func NewUpdatePipelineRequestWithBody(server string, pipelineId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdatePipelineRequestWithBody generates requests for UpdatePipeline with any type of body

func NewUpdatePipelineTriggerKeyRequest

func NewUpdatePipelineTriggerKeyRequest(server string, pipelineId string, triggerKeyId string, body UpdatePipelineTriggerKeyJSONRequestBody) (*http.Request, error)

NewUpdatePipelineTriggerKeyRequest calls the generic UpdatePipelineTriggerKey builder with application/json body

func NewUpdatePipelineTriggerKeyRequestWithBody

func NewUpdatePipelineTriggerKeyRequestWithBody(server string, pipelineId string, triggerKeyId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdatePipelineTriggerKeyRequestWithBody generates requests for UpdatePipelineTriggerKey with any type of body

func NewUpdateRoleRequest

func NewUpdateRoleRequest(server string, roleId string, body UpdateRoleJSONRequestBody) (*http.Request, error)

NewUpdateRoleRequest calls the generic UpdateRole builder with application/json body

func NewUpdateRoleRequestWithBody

func NewUpdateRoleRequestWithBody(server string, roleId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateRoleRequestWithBody generates requests for UpdateRole with any type of body

func NewUpdateScopedVariableRequest

func NewUpdateScopedVariableRequest(server string, environmentId string, scopedVariableId string, body UpdateScopedVariableJSONRequestBody) (*http.Request, error)

NewUpdateScopedVariableRequest calls the generic UpdateScopedVariable builder with application/json body

func NewUpdateScopedVariableRequestWithBody

func NewUpdateScopedVariableRequestWithBody(server string, environmentId string, scopedVariableId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateScopedVariableRequestWithBody generates requests for UpdateScopedVariable with any type of body

func NewUpdateServerRequest

func NewUpdateServerRequest(server string, serverId string, body UpdateServerJSONRequestBody) (*http.Request, error)

NewUpdateServerRequest calls the generic UpdateServer builder with application/json body

func NewUpdateServerRequestWithBody

func NewUpdateServerRequestWithBody(server string, serverId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateServerRequestWithBody generates requests for UpdateServer with any type of body

func NewUpdateStackAccessRequest

func NewUpdateStackAccessRequest(server string, stackId string, body UpdateStackAccessJSONRequestBody) (*http.Request, error)

NewUpdateStackAccessRequest calls the generic UpdateStackAccess builder with application/json body

func NewUpdateStackAccessRequestWithBody

func NewUpdateStackAccessRequestWithBody(server string, stackId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateStackAccessRequestWithBody generates requests for UpdateStackAccess with any type of body

func NewUpdateStackRequest

func NewUpdateStackRequest(server string, stackId string, body UpdateStackJSONRequestBody) (*http.Request, error)

NewUpdateStackRequest calls the generic UpdateStack builder with application/json body

func NewUpdateStackRequestWithBody

func NewUpdateStackRequestWithBody(server string, stackId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateStackRequestWithBody generates requests for UpdateStack with any type of body

func NewUpdateVirtualMachineRequest

func NewUpdateVirtualMachineRequest(server string, virtualMachineId string, body UpdateVirtualMachineJSONRequestBody) (*http.Request, error)

NewUpdateVirtualMachineRequest calls the generic UpdateVirtualMachine builder with application/json body

func NewUpdateVirtualMachineRequestWithBody

func NewUpdateVirtualMachineRequestWithBody(server string, virtualMachineId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateVirtualMachineRequestWithBody generates requests for UpdateVirtualMachine with any type of body

func NewUpdateVirtualMachineSshKeyRequest

func NewUpdateVirtualMachineSshKeyRequest(server string, sshKeyId string, params *UpdateVirtualMachineSshKeyParams, body UpdateVirtualMachineSshKeyJSONRequestBody) (*http.Request, error)

NewUpdateVirtualMachineSshKeyRequest calls the generic UpdateVirtualMachineSshKey builder with application/json body

func NewUpdateVirtualMachineSshKeyRequestWithBody

func NewUpdateVirtualMachineSshKeyRequestWithBody(server string, sshKeyId string, params *UpdateVirtualMachineSshKeyParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateVirtualMachineSshKeyRequestWithBody generates requests for UpdateVirtualMachineSshKey with any type of body

func NewUpdateVirtualProviderIsoRequest added in v0.6.3

func NewUpdateVirtualProviderIsoRequest(server string, integrationId string, isoId string, body UpdateVirtualProviderIsoJSONRequestBody) (*http.Request, error)

NewUpdateVirtualProviderIsoRequest calls the generic UpdateVirtualProviderIso builder with application/json body

func NewUpdateVirtualProviderIsoRequestWithBody added in v0.6.3

func NewUpdateVirtualProviderIsoRequestWithBody(server string, integrationId string, isoId string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateVirtualProviderIsoRequestWithBody generates requests for UpdateVirtualProviderIso with any type of body

func NewUploadUserSuppliedCertificateRequest

func NewUploadUserSuppliedCertificateRequest(server string, body UploadUserSuppliedCertificateJSONRequestBody) (*http.Request, error)

NewUploadUserSuppliedCertificateRequest calls the generic UploadUserSuppliedCertificate builder with application/json body

func NewUploadUserSuppliedCertificateRequestWithBody

func NewUploadUserSuppliedCertificateRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUploadUserSuppliedCertificateRequestWithBody generates requests for UploadUserSuppliedCertificate with any type of body

Types

type ACL

type ACL struct {
	Roles *map[string]struct {
		// Manage Can the user delete / update ACLs for this resource?
		Manage bool `json:"manage"`

		// Modify Can the user edit the state / name / identifier of this resource?
		Modify bool `json:"modify"`

		// View Can the user see / use this resource?
		View bool `json:"view"`
	} `json:"roles,omitempty"`
}

ACL An access control list. Defines which roles have which permissions on specific resources.

type Account

type Account struct {
	// AllowSupportLogin Indicates whether or not Cycle employees have authorization to log in to this Account in a support capacity.
	AllowSupportLogin *bool `json:"allow_support_login,omitempty"`

	// Email Information about the email address associated with the Account.
	Email struct {
		Added DateTime `json:"added"`

		// Address The email address.
		Address string `json:"address"`

		// Verified If true, the email has been verified and the Account is active.
		Verified bool `json:"verified"`
	} `json:"email"`

	// Events A collection of timestamps for each event in the Account's lifetime.
	Events struct {
		Created   DateTime `json:"created"`
		Deleted   DateTime `json:"deleted"`
		LastLogin DateTime `json:"last_login"`
		Updated   DateTime `json:"updated"`
	} `json:"events"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Name The first and last name associated with the Account.
	Name struct {
		// First The first name of the Account owner.
		First string `json:"first"`

		// Last The last name of the Account owner.
		Last string `json:"last"`
	} `json:"name"`
	State AccountState `json:"state"`

	// TwoFactorAuth Two factor auth verification information.
	TwoFactorAuth *struct {
		// Verified A boolean representing if the account has verified with two-factor authentication.
		Verified bool `json:"verified"`
	} `json:"two_factor_auth"`
}

Account An object representing information about the currently logged-in user.

type AccountMembershipIncludes

type AccountMembershipIncludes struct {
	// Hubs A record with an ID mapped to a hub resource.
	Hubs *map[string]Hub `json:"hubs,omitempty"`

	// Roles A map of Roles relevant to this Hub Membership, keyed by the Role ID.
	Roles *map[string]Role `json:"roles,omitempty"`

	// RolesIdentifiers A map of Roles relevant to this Hub Membership, keyed by the Role ID.
	RolesIdentifiers *map[string]ID `json:"roles:identifiers,omitempty"`

	// Senders A record with an ID mapped to a public account for the account that sent this memberships initial invite.
	Senders *struct {
		// Accounts A record with an ID mapped to a public account.
		Accounts *map[string]PublicAccount `json:"accounts,omitempty"`
	} `json:"senders,omitempty"`
}

AccountMembershipIncludes A resource that is associated with an account's membership.

type AccountState

type AccountState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the account.
	Current AccountStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

AccountState defines model for AccountState.

type AccountStateCurrent

type AccountStateCurrent string

AccountStateCurrent The current state of the account.

const (
	AccountStateCurrentDeleted    AccountStateCurrent = "deleted"
	AccountStateCurrentDeleting   AccountStateCurrent = "deleting"
	AccountStateCurrentLive       AccountStateCurrent = "live"
	AccountStateCurrentNew        AccountStateCurrent = "new"
	AccountStateCurrentPurging    AccountStateCurrent = "purging"
	AccountStateCurrentSuspending AccountStateCurrent = "suspending"
)

Defines values for AccountStateCurrent.

type Activity

type Activity struct {
	// Annotations A record of additional annotations for the activity.
	Annotations map[string]interface{} `json:"annotations"`

	// Changes An array of changes.
	Changes []Change `json:"changes"`

	// Component An object holding information about a component.
	Component *struct {
		// Id A 24 character hex string used to identify a unique resource.
		Id ID `json:"id"`

		// Type The type of component.
		Type string `json:"type"`
	} `json:"component"`

	// Context ID context for resources associated with an activity.
	Context Context `json:"context"`

	// Error An object describing a given activity error.
	Error *struct {
		// Message The error message.
		Message string `json:"message"`
	} `json:"error"`

	// Event The activity event.
	Event ActivityEvent `json:"event"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Monitor Details related to the monitor that raised this activity event.
	Monitor *ActivityMonitor `json:"monitor,omitempty"`

	// Security Security information pertaining to this activity.
	Security *ActivitySecurity `json:"security,omitempty"`
	Session  *Session          `json:"session"`

	// Status A status for the given activity.
	Status ActivityStatus `json:"status"`

	// Tags An array of tags that denote things such as a type of security event, or can be user-provided.
	Tags *[]string `json:"tags,omitempty"`
	Time DateTime  `json:"time"`

	// User Userscope
	User struct {
		// Id The given user's ID.
		Id string `json:"id"`

		// Type The type of user.
		Type ActivityUserType `json:"type"`
	} `json:"user"`

	// Verbosity A number representing the detail level (verbosity) of this activity.
	//
	// - 0: activity that other users would find useful
	// - 1: activity that can be useful in tracking down how a user did something
	// - 2: full activity, can be useful in debugging problems
	Verbosity int `json:"verbosity"`
}

Activity A resource representing information about activity taking place on a given hub.

type ActivityEvent

type ActivityEvent string

ActivityEvent The activity event.

const (
	ActivityEventBillingInvoicePay                                      ActivityEvent = "billing.invoice.pay"
	ActivityEventBillingInvoiceTaskCredit                               ActivityEvent = "billing.invoice.task.credit"
	ActivityEventBillingInvoiceTaskPay                                  ActivityEvent = "billing.invoice.task.pay"
	ActivityEventBillingInvoiceTaskRefund                               ActivityEvent = "billing.invoice.task.refund"
	ActivityEventBillingInvoiceTaskVoid                                 ActivityEvent = "billing.invoice.task.void"
	ActivityEventBillingMethodCreate                                    ActivityEvent = "billing.method.create"
	ActivityEventBillingMethodDelete                                    ActivityEvent = "billing.method.delete"
	ActivityEventBillingMethodTaskDelete                                ActivityEvent = "billing.method.task.delete"
	ActivityEventBillingMethodUpdate                                    ActivityEvent = "billing.method.update"
	ActivityEventBillingOrderConfirm                                    ActivityEvent = "billing.order.confirm"
	ActivityEventBillingOrderTaskConfirm                                ActivityEvent = "billing.order.task.confirm"
	ActivityEventContainerBackupCreate                                  ActivityEvent = "container.backup.create"
	ActivityEventContainerBackupDelete                                  ActivityEvent = "container.backup.delete"
	ActivityEventContainerBackupRestore                                 ActivityEvent = "container.backup.restore"
	ActivityEventContainerBackupTaskDelete                              ActivityEvent = "container.backup.task.delete"
	ActivityEventContainerBackupTaskRestore                             ActivityEvent = "container.backup.task.restore"
	ActivityEventContainerCreate                                        ActivityEvent = "container.create"
	ActivityEventContainerDelete                                        ActivityEvent = "container.delete"
	ActivityEventContainerDeprecate                                     ActivityEvent = "container.deprecate"
	ActivityEventContainerFunctionTaskTrigger                           ActivityEvent = "container.function.task.trigger"
	ActivityEventContainerFunctionTrigger                               ActivityEvent = "container.function.trigger"
	ActivityEventContainerInitialize                                    ActivityEvent = "container.initialize"
	ActivityEventContainerInstanceDelete                                ActivityEvent = "container.instance.delete"
	ActivityEventContainerInstanceError                                 ActivityEvent = "container.instance.error"
	ActivityEventContainerInstanceHealthcheckFailed                     ActivityEvent = "container.instance.healthcheck.failed"
	ActivityEventContainerInstanceHealthcheckRestarted                  ActivityEvent = "container.instance.healthcheck.restarted"
	ActivityEventContainerInstanceMigrationRevert                       ActivityEvent = "container.instance.migration.revert"
	ActivityEventContainerInstanceMigrationStart                        ActivityEvent = "container.instance.migration.start"
	ActivityEventContainerInstanceSshLogin                              ActivityEvent = "container.instance.ssh.login"
	ActivityEventContainerInstanceTaskMigrationRevert                   ActivityEvent = "container.instance.task.migration.revert"
	ActivityEventContainerInstanceTaskMigrationStart                    ActivityEvent = "container.instance.task.migration.start"
	ActivityEventContainerInstanceTaskVolumeExtend                      ActivityEvent = "container.instance.task.volume.extend"
	ActivityEventContainerInstanceTrafficDrainReconfigure               ActivityEvent = "container.instance.traffic-drain.reconfigure"
	ActivityEventContainerInstanceVolumeExtend                          ActivityEvent = "container.instance.volume.extend"
	ActivityEventContainerInstancesAutoscaleDown                        ActivityEvent = "container.instances.autoscale.down"
	ActivityEventContainerInstancesAutoscaleUp                          ActivityEvent = "container.instances.autoscale.up"
	ActivityEventContainerInstancesCreate                               ActivityEvent = "container.instances.create"
	ActivityEventContainerInstancesDelete                               ActivityEvent = "container.instances.delete"
	ActivityEventContainerReconfigure                                   ActivityEvent = "container.reconfigure"
	ActivityEventContainerReimage                                       ActivityEvent = "container.reimage"
	ActivityEventContainerRestart                                       ActivityEvent = "container.restart"
	ActivityEventContainerScale                                         ActivityEvent = "container.scale"
	ActivityEventContainerStart                                         ActivityEvent = "container.start"
	ActivityEventContainerStop                                          ActivityEvent = "container.stop"
	ActivityEventContainerTaskDelete                                    ActivityEvent = "container.task.delete"
	ActivityEventContainerTaskReconfigure                               ActivityEvent = "container.task.reconfigure"
	ActivityEventContainerTaskReimage                                   ActivityEvent = "container.task.reimage"
	ActivityEventContainerTaskRestart                                   ActivityEvent = "container.task.restart"
	ActivityEventContainerTaskScale                                     ActivityEvent = "container.task.scale"
	ActivityEventContainerTaskStart                                     ActivityEvent = "container.task.start"
	ActivityEventContainerTaskStop                                      ActivityEvent = "container.task.stop"
	ActivityEventContainerTaskVolumesReconfigure                        ActivityEvent = "container.task.volumes.reconfigure"
	ActivityEventContainerUpdate                                        ActivityEvent = "container.update"
	ActivityEventContainerVolumesReconfigure                            ActivityEvent = "container.volumes.reconfigure"
	ActivityEventDnsCertificateAssociate                                ActivityEvent = "dns.certificate.associate"
	ActivityEventDnsCertificateCreate                                   ActivityEvent = "dns.certificate.create"
	ActivityEventDnsCertificateDeprecate                                ActivityEvent = "dns.certificate.deprecate"
	ActivityEventDnsCertificateTaskDeprecate                            ActivityEvent = "dns.certificate.task.deprecate"
	ActivityEventDnsZoneCreate                                          ActivityEvent = "dns.zone.create"
	ActivityEventDnsZoneDelete                                          ActivityEvent = "dns.zone.delete"
	ActivityEventDnsZoneRecordCertGenerate                              ActivityEvent = "dns.zone.record.cert.generate"
	ActivityEventDnsZoneRecordCertGenerateAuto                          ActivityEvent = "dns.zone.record.cert.generate.auto"
	ActivityEventDnsZoneRecordCreate                                    ActivityEvent = "dns.zone.record.create"
	ActivityEventDnsZoneRecordDelete                                    ActivityEvent = "dns.zone.record.delete"
	ActivityEventDnsZoneRecordTaskCertGenerate                          ActivityEvent = "dns.zone.record.task.cert.generate"
	ActivityEventDnsZoneRecordTaskDelete                                ActivityEvent = "dns.zone.record.task.delete"
	ActivityEventDnsZoneRecordUpdate                                    ActivityEvent = "dns.zone.record.update"
	ActivityEventDnsZoneTaskDelete                                      ActivityEvent = "dns.zone.task.delete"
	ActivityEventDnsZoneTaskVerify                                      ActivityEvent = "dns.zone.task.verify"
	ActivityEventDnsZoneUpdate                                          ActivityEvent = "dns.zone.update"
	ActivityEventDnsZoneVerify                                          ActivityEvent = "dns.zone.verify"
	ActivityEventEnvironmentCreate                                      ActivityEvent = "environment.create"
	ActivityEventEnvironmentDelete                                      ActivityEvent = "environment.delete"
	ActivityEventEnvironmentDeploymentStart                             ActivityEvent = "environment.deployment.start"
	ActivityEventEnvironmentDeploymentStop                              ActivityEvent = "environment.deployment.stop"
	ActivityEventEnvironmentDeploymentsPrune                            ActivityEvent = "environment.deployments.prune"
	ActivityEventEnvironmentDeploymentsReconfigure                      ActivityEvent = "environment.deployments.reconfigure"
	ActivityEventEnvironmentInitialize                                  ActivityEvent = "environment.initialize"
	ActivityEventEnvironmentMonitoringReconfigure                       ActivityEvent = "environment.monitoring.reconfigure"
	ActivityEventEnvironmentScopedVariableCreate                        ActivityEvent = "environment.scoped-variable.create"
	ActivityEventEnvironmentScopedVariableDelete                        ActivityEvent = "environment.scoped-variable.delete"
	ActivityEventEnvironmentScopedVariableTaskDelete                    ActivityEvent = "environment.scoped-variable.task.delete"
	ActivityEventEnvironmentScopedVariableUpdate                        ActivityEvent = "environment.scoped-variable.update"
	ActivityEventEnvironmentServicesDiscoveryReconfigure                ActivityEvent = "environment.services.discovery.reconfigure"
	ActivityEventEnvironmentServicesDiscoveryTaskReconfigure            ActivityEvent = "environment.services.discovery.task.reconfigure"
	ActivityEventEnvironmentServicesLbReconfigure                       ActivityEvent = "environment.services.lb.reconfigure"
	ActivityEventEnvironmentServicesLbTaskReconfigure                   ActivityEvent = "environment.services.lb.task.reconfigure"
	ActivityEventEnvironmentServicesSchedulerReconfigure                ActivityEvent = "environment.services.scheduler.reconfigure"
	ActivityEventEnvironmentServicesSchedulerTaskReconfigure            ActivityEvent = "environment.services.scheduler.task.reconfigure"
	ActivityEventEnvironmentServicesVpnLogin                            ActivityEvent = "environment.services.vpn.login"
	ActivityEventEnvironmentServicesVpnReconfigure                      ActivityEvent = "environment.services.vpn.reconfigure"
	ActivityEventEnvironmentServicesVpnReset                            ActivityEvent = "environment.services.vpn.reset"
	ActivityEventEnvironmentServicesVpnTaskReconfigure                  ActivityEvent = "environment.services.vpn.task.reconfigure"
	ActivityEventEnvironmentServicesVpnTaskReset                        ActivityEvent = "environment.services.vpn.task.reset"
	ActivityEventEnvironmentServicesVpnUserCreate                       ActivityEvent = "environment.services.vpn.user.create"
	ActivityEventEnvironmentStart                                       ActivityEvent = "environment.start"
	ActivityEventEnvironmentStop                                        ActivityEvent = "environment.stop"
	ActivityEventEnvironmentTaskDelete                                  ActivityEvent = "environment.task.delete"
	ActivityEventEnvironmentTaskDeploymentsReconfigure                  ActivityEvent = "environment.task.deployments.reconfigure"
	ActivityEventEnvironmentTaskInitialize                              ActivityEvent = "environment.task.initialize"
	ActivityEventEnvironmentTaskMonitoringReconfigure                   ActivityEvent = "environment.task.monitoring.reconfigure"
	ActivityEventEnvironmentTaskStart                                   ActivityEvent = "environment.task.start"
	ActivityEventEnvironmentTaskStop                                    ActivityEvent = "environment.task.stop"
	ActivityEventEnvironmentUpdate                                      ActivityEvent = "environment.update"
	ActivityEventHubApikeyCreate                                        ActivityEvent = "hub.apikey.create"
	ActivityEventHubApikeyDelete                                        ActivityEvent = "hub.apikey.delete"
	ActivityEventHubApikeyUpdate                                        ActivityEvent = "hub.apikey.update"
	ActivityEventHubCreate                                              ActivityEvent = "hub.create"
	ActivityEventHubImagesPrune                                         ActivityEvent = "hub.images.prune"
	ActivityEventHubInactive                                            ActivityEvent = "hub.inactive"
	ActivityEventHubIntegrationCreate                                   ActivityEvent = "hub.integration.create"
	ActivityEventHubIntegrationDelete                                   ActivityEvent = "hub.integration.delete"
	ActivityEventHubIntegrationTaskDelete                               ActivityEvent = "hub.integration.task.delete"
	ActivityEventHubIntegrationTaskVerify                               ActivityEvent = "hub.integration.task.verify"
	ActivityEventHubIntegrationUpdate                                   ActivityEvent = "hub.integration.update"
	ActivityEventHubMembershipCreate                                    ActivityEvent = "hub.membership.create"
	ActivityEventHubMembershipDelete                                    ActivityEvent = "hub.membership.delete"
	ActivityEventHubMembershipUpdate                                    ActivityEvent = "hub.membership.update"
	ActivityEventHubRoleCreate                                          ActivityEvent = "hub.role.create"
	ActivityEventHubRoleDelete                                          ActivityEvent = "hub.role.delete"
	ActivityEventHubRoleTaskDelete                                      ActivityEvent = "hub.role.task.delete"
	ActivityEventHubRoleUpdate                                          ActivityEvent = "hub.role.update"
	ActivityEventHubTaskDelete                                          ActivityEvent = "hub.task.delete"
	ActivityEventHubTaskImagesPrune                                     ActivityEvent = "hub.task.images.prune"
	ActivityEventHubUpdate                                              ActivityEvent = "hub.update"
	ActivityEventImageCreate                                            ActivityEvent = "image.create"
	ActivityEventImageDelete                                            ActivityEvent = "image.delete"
	ActivityEventImageImport                                            ActivityEvent = "image.import"
	ActivityEventImageSourceCreate                                      ActivityEvent = "image.source.create"
	ActivityEventImageSourceDelete                                      ActivityEvent = "image.source.delete"
	ActivityEventImageSourceTaskDelete                                  ActivityEvent = "image.source.task.delete"
	ActivityEventImageSourceUpdate                                      ActivityEvent = "image.source.update"
	ActivityEventImageTaskDelete                                        ActivityEvent = "image.task.delete"
	ActivityEventImageTaskImport                                        ActivityEvent = "image.task.import"
	ActivityEventImageUpdate                                            ActivityEvent = "image.update"
	ActivityEventInfrastructureAutoscaleGroupCreate                     ActivityEvent = "infrastructure.autoscale.group.create"
	ActivityEventInfrastructureAutoscaleGroupDelete                     ActivityEvent = "infrastructure.autoscale.group.delete"
	ActivityEventInfrastructureAutoscaleGroupTaskDelete                 ActivityEvent = "infrastructure.autoscale.group.task.delete"
	ActivityEventInfrastructureAutoscaleGroupUpdate                     ActivityEvent = "infrastructure.autoscale.group.update"
	ActivityEventInfrastructureClusterCreate                            ActivityEvent = "infrastructure.cluster.create"
	ActivityEventInfrastructureClusterDelete                            ActivityEvent = "infrastructure.cluster.delete"
	ActivityEventInfrastructureClusterFeaturesMonitoringTierReconfigure ActivityEvent = "infrastructure.cluster.features.monitoring.tier.reconfigure"
	ActivityEventInfrastructureClusterTaskDelete                        ActivityEvent = "infrastructure.cluster.task.delete"
	ActivityEventInfrastructureClusterUpdate                            ActivityEvent = "infrastructure.cluster.update"
	ActivityEventInfrastructureExternalVolumeAttachmentReconfigure      ActivityEvent = "infrastructure.external-volume.attachment.reconfigure"
	ActivityEventInfrastructureExternalVolumeCreate                     ActivityEvent = "infrastructure.external-volume.create"
	ActivityEventInfrastructureExternalVolumeDelete                     ActivityEvent = "infrastructure.external-volume.delete"
	ActivityEventInfrastructureExternalVolumeServersReconfigure         ActivityEvent = "infrastructure.external-volume.servers.reconfigure"
	ActivityEventInfrastructureExternalVolumeTaskAttachmentReconfigure  ActivityEvent = "infrastructure.external-volume.task.attachment.reconfigure"
	ActivityEventInfrastructureExternalVolumeTaskDelete                 ActivityEvent = "infrastructure.external-volume.task.delete"
	ActivityEventInfrastructureExternalVolumeTaskServersReconfigure     ActivityEvent = "infrastructure.external-volume.task.servers.reconfigure"
	ActivityEventInfrastructureExternalVolumeUpdate                     ActivityEvent = "infrastructure.external-volume.update"
	ActivityEventInfrastructureExternalVolumesTaskScan                  ActivityEvent = "infrastructure.external-volumes.task.scan"
	ActivityEventInfrastructureIpsPoolCreate                            ActivityEvent = "infrastructure.ips.pool.create"
	ActivityEventInfrastructureIpsPoolTaskDelete                        ActivityEvent = "infrastructure.ips.pool.task.delete"
	ActivityEventInfrastructureProviderCreate                           ActivityEvent = "infrastructure.provider.create"
	ActivityEventInfrastructureProviderTaskDelete                       ActivityEvent = "infrastructure.provider.task.delete"
	ActivityEventInfrastructureProviderTaskVerify                       ActivityEvent = "infrastructure.provider.task.verify"
	ActivityEventInfrastructureProviderUpdate                           ActivityEvent = "infrastructure.provider.update"
	ActivityEventInfrastructureServerAuthReset                          ActivityEvent = "infrastructure.server.auth.reset"
	ActivityEventInfrastructureServerComputeRestart                     ActivityEvent = "infrastructure.server.compute.restart"
	ActivityEventInfrastructureServerComputeSpawnerRestart              ActivityEvent = "infrastructure.server.compute.spawner.restart"
	ActivityEventInfrastructureServerConsole                            ActivityEvent = "infrastructure.server.console"
	ActivityEventInfrastructureServerDelete                             ActivityEvent = "infrastructure.server.delete"
	ActivityEventInfrastructureServerEvacuationReset                    ActivityEvent = "infrastructure.server.evacuation.reset"
	ActivityEventInfrastructureServerEvacuationStart                    ActivityEvent = "infrastructure.server.evacuation.start"
	ActivityEventInfrastructureServerFeaturesReconfigure                ActivityEvent = "infrastructure.server.features.reconfigure"
	ActivityEventInfrastructureServerLive                               ActivityEvent = "infrastructure.server.live"
	ActivityEventInfrastructureServerPowerOff                           ActivityEvent = "infrastructure.server.power-off"
	ActivityEventInfrastructureServerProvision                          ActivityEvent = "infrastructure.server.provision"
	ActivityEventInfrastructureServerRestart                            ActivityEvent = "infrastructure.server.restart"
	ActivityEventInfrastructureServerServicesInternalApiThrottle        ActivityEvent = "infrastructure.server.services.internal-api.throttle"
	ActivityEventInfrastructureServerServicesSftpAuth                   ActivityEvent = "infrastructure.server.services.sftp.auth"
	ActivityEventInfrastructureServerServicesSftpLockdown               ActivityEvent = "infrastructure.server.services.sftp.lockdown"
	ActivityEventInfrastructureServerSharedfsReconfigure                ActivityEvent = "infrastructure.server.sharedfs.reconfigure"
	ActivityEventInfrastructureServerSshToken                           ActivityEvent = "infrastructure.server.ssh.token"
	ActivityEventInfrastructureServerTaskDelete                         ActivityEvent = "infrastructure.server.task.delete"
	ActivityEventInfrastructureServerTaskEvacuationReset                ActivityEvent = "infrastructure.server.task.evacuation.reset"
	ActivityEventInfrastructureServerTaskEvacuationStart                ActivityEvent = "infrastructure.server.task.evacuation.start"
	ActivityEventInfrastructureServerTaskFeaturesReconfigure            ActivityEvent = "infrastructure.server.task.features.reconfigure"
	ActivityEventInfrastructureServerTaskProvision                      ActivityEvent = "infrastructure.server.task.provision"
	ActivityEventInfrastructureServerTaskRestart                        ActivityEvent = "infrastructure.server.task.restart"
	ActivityEventInfrastructureServerTaskSharedfsReconfigure            ActivityEvent = "infrastructure.server.task.sharedfs.reconfigure"
	ActivityEventInfrastructureServerUnquarantine                       ActivityEvent = "infrastructure.server.unquarantine"
	ActivityEventInfrastructureServerUpdate                             ActivityEvent = "infrastructure.server.update"
	ActivityEventInfrastructureVirtualProvidersIsoCreate                ActivityEvent = "infrastructure.virtual-providers.iso.create"
	ActivityEventInfrastructureVirtualProvidersIsoDelete                ActivityEvent = "infrastructure.virtual-providers.iso.delete"
	ActivityEventInfrastructureVirtualProvidersIsoGenerate              ActivityEvent = "infrastructure.virtual-providers.iso.generate"
	ActivityEventInfrastructureVirtualProvidersIsoTaskDelete            ActivityEvent = "infrastructure.virtual-providers.iso.task.delete"
	ActivityEventInfrastructureVirtualProvidersIsoUpdate                ActivityEvent = "infrastructure.virtual-providers.iso.update"
	ActivityEventPipelineCreate                                         ActivityEvent = "pipeline.create"
	ActivityEventPipelineDelete                                         ActivityEvent = "pipeline.delete"
	ActivityEventPipelineKeyCreate                                      ActivityEvent = "pipeline.key.create"
	ActivityEventPipelineKeyDelete                                      ActivityEvent = "pipeline.key.delete"
	ActivityEventPipelineKeyUpdate                                      ActivityEvent = "pipeline.key.update"
	ActivityEventPipelineRunCompleted                                   ActivityEvent = "pipeline.run.completed"
	ActivityEventPipelineTaskDelete                                     ActivityEvent = "pipeline.task.delete"
	ActivityEventPipelineTaskTrigger                                    ActivityEvent = "pipeline.task.trigger"
	ActivityEventPipelineTrigger                                        ActivityEvent = "pipeline.trigger"
	ActivityEventPipelineUpdate                                         ActivityEvent = "pipeline.update"
	ActivityEventSdnNetworkCreate                                       ActivityEvent = "sdn.network.create"
	ActivityEventSdnNetworkTaskDelete                                   ActivityEvent = "sdn.network.task.delete"
	ActivityEventSdnNetworkTaskReconfigure                              ActivityEvent = "sdn.network.task.reconfigure"
	ActivityEventSdnNetworkUpdate                                       ActivityEvent = "sdn.network.update"
	ActivityEventStackBuildCreate                                       ActivityEvent = "stack.build.create"
	ActivityEventStackBuildDelete                                       ActivityEvent = "stack.build.delete"
	ActivityEventStackBuildDeploy                                       ActivityEvent = "stack.build.deploy"
	ActivityEventStackBuildGenerate                                     ActivityEvent = "stack.build.generate"
	ActivityEventStackBuildTaskDelete                                   ActivityEvent = "stack.build.task.delete"
	ActivityEventStackBuildTaskDeploy                                   ActivityEvent = "stack.build.task.deploy"
	ActivityEventStackBuildTaskGenerate                                 ActivityEvent = "stack.build.task.generate"
	ActivityEventStackCreate                                            ActivityEvent = "stack.create"
	ActivityEventStackDelete                                            ActivityEvent = "stack.delete"
	ActivityEventStackPrune                                             ActivityEvent = "stack.prune"
	ActivityEventStackTaskDelete                                        ActivityEvent = "stack.task.delete"
	ActivityEventStackTaskPrune                                         ActivityEvent = "stack.task.prune"
	ActivityEventStackUpdate                                            ActivityEvent = "stack.update"
	ActivityEventVirtualMachineCreate                                   ActivityEvent = "virtual-machine.create"
	ActivityEventVirtualMachineDelete                                   ActivityEvent = "virtual-machine.delete"
	ActivityEventVirtualMachineInitialize                               ActivityEvent = "virtual-machine.initialize"
	ActivityEventVirtualMachineIpAllocate                               ActivityEvent = "virtual-machine.ip.allocate"
	ActivityEventVirtualMachineIpUnallocate                             ActivityEvent = "virtual-machine.ip.unallocate"
	ActivityEventVirtualMachineReconfigure                              ActivityEvent = "virtual-machine.reconfigure"
	ActivityEventVirtualMachineRootpwChange                             ActivityEvent = "virtual-machine.rootpw.change"
	ActivityEventVirtualMachineSosLogin                                 ActivityEvent = "virtual-machine.sos.login"
	ActivityEventVirtualMachineSshKeyCreate                             ActivityEvent = "virtual-machine.ssh-key.create"
	ActivityEventVirtualMachineSshKeyDelete                             ActivityEvent = "virtual-machine.ssh-key.delete"
	ActivityEventVirtualMachineSshKeyTaskDelete                         ActivityEvent = "virtual-machine.ssh-key.task.delete"
	ActivityEventVirtualMachineSshKeyUpdate                             ActivityEvent = "virtual-machine.ssh-key.update"
	ActivityEventVirtualMachineStart                                    ActivityEvent = "virtual-machine.start"
	ActivityEventVirtualMachineStop                                     ActivityEvent = "virtual-machine.stop"
	ActivityEventVirtualMachineTaskDelete                               ActivityEvent = "virtual-machine.task.delete"
	ActivityEventVirtualMachineTaskIpAllocate                           ActivityEvent = "virtual-machine.task.ip.allocate"
	ActivityEventVirtualMachineTaskIpUnallocate                         ActivityEvent = "virtual-machine.task.ip.unallocate"
	ActivityEventVirtualMachineTaskReconfigure                          ActivityEvent = "virtual-machine.task.reconfigure"
	ActivityEventVirtualMachineTaskStart                                ActivityEvent = "virtual-machine.task.start"
	ActivityEventVirtualMachineTaskStop                                 ActivityEvent = "virtual-machine.task.stop"
	ActivityEventVirtualMachineTaskVolumesReconfigure                   ActivityEvent = "virtual-machine.task.volumes.reconfigure"
	ActivityEventVirtualMachineUpdate                                   ActivityEvent = "virtual-machine.update"
	ActivityEventVirtualMachineVolumesReconfigure                       ActivityEvent = "virtual-machine.volumes.reconfigure"
)

Defines values for ActivityEvent.

type ActivityIncludes

type ActivityIncludes struct {
	// Components A resource that is associated with activity.
	Components *ComponentsIncludes `json:"components,omitempty"`

	// Users An identity that created a resource.
	Users *CreatorInclude `json:"users,omitempty"`
}

ActivityIncludes All includable resources linkable to the given records.

type ActivityMonitor

type ActivityMonitor struct {
	// Event How the platform has handled this monitor event.
	Event ActivityMonitorEvent `json:"event"`

	// Level The severity of the event.
	Level ActivityMonitorLevel `json:"level"`

	// State The current state of the monitored resource
	State ActivityMonitorState `json:"state"`
}

ActivityMonitor Details related to the monitor that raised this activity event.

type ActivityMonitorEvent

type ActivityMonitorEvent string

ActivityMonitorEvent How the platform has handled this monitor event.

const (
	ActivityMonitorEventDetection  ActivityMonitorEvent = "detection"
	ActivityMonitorEventNotice     ActivityMonitorEvent = "notice"
	ActivityMonitorEventPrevention ActivityMonitorEvent = "prevention"
	ActivityMonitorEventReaction   ActivityMonitorEvent = "reaction"
	ActivityMonitorEventSuggestion ActivityMonitorEvent = "suggestion"
)

Defines values for ActivityMonitorEvent.

type ActivityMonitorLevel

type ActivityMonitorLevel string

ActivityMonitorLevel The severity of the event.

const (
	ActivityMonitorLevelCritical ActivityMonitorLevel = "critical"
	ActivityMonitorLevelHigh     ActivityMonitorLevel = "high"
	ActivityMonitorLevelInfo     ActivityMonitorLevel = "info"
	ActivityMonitorLevelLow      ActivityMonitorLevel = "low"
	ActivityMonitorLevelMedium   ActivityMonitorLevel = "medium"
)

Defines values for ActivityMonitorLevel.

type ActivityMonitorState

type ActivityMonitorState string

ActivityMonitorState The current state of the monitored resource

const (
	ActivityMonitorStateFlux        ActivityMonitorState = "flux"
	ActivityMonitorStateNone        ActivityMonitorState = "none"
	ActivityMonitorStateRecovered   ActivityMonitorState = "recovered"
	ActivityMonitorStateUnknown     ActivityMonitorState = "unknown"
	ActivityMonitorStateUnreachable ActivityMonitorState = "unreachable"
)

Defines values for ActivityMonitorState.

type ActivitySecurity

type ActivitySecurity struct {
	// Attack The type of attack the platform has determined has occurred.
	Attack ActivitySecurityAttack `json:"attack"`

	// Event How the platform has handled this security event.
	Event ActivitySecurityEvent `json:"event"`

	// Risk A risk level assessed by the platform. Depending on the nature of the incident, this may change even if the event type is the same.
	Risk ActivitySecurityRisk `json:"risk"`

	// Surface From where the platform has determined this security event originated from.
	Surface ActivitySecuritySurface `json:"surface"`
}

ActivitySecurity Security information pertaining to this activity.

type ActivitySecurityAttack

type ActivitySecurityAttack string

ActivitySecurityAttack The type of attack the platform has determined has occurred.

const (
	ActivitySecurityAttackAccessElevation      ActivitySecurityAttack = "access-elevation"
	ActivitySecurityAttackAuthFailure          ActivitySecurityAttack = "auth-failure"
	ActivitySecurityAttackBruteForce           ActivitySecurityAttack = "brute-force"
	ActivitySecurityAttackExploitVulnerability ActivitySecurityAttack = "exploit-vulnerability"
	ActivitySecurityAttackNone                 ActivitySecurityAttack = "none"
	ActivitySecurityAttackServiceInterruption  ActivitySecurityAttack = "service-interruption"
	ActivitySecurityAttackSocialEngineer       ActivitySecurityAttack = "social-engineer"
)

Defines values for ActivitySecurityAttack.

type ActivitySecurityEvent

type ActivitySecurityEvent string

ActivitySecurityEvent How the platform has handled this security event.

const (
	ActivitySecurityEventDetection  ActivitySecurityEvent = "detection"
	ActivitySecurityEventNotice     ActivitySecurityEvent = "notice"
	ActivitySecurityEventPrevention ActivitySecurityEvent = "prevention"
	ActivitySecurityEventReaction   ActivitySecurityEvent = "reaction"
	ActivitySecurityEventSuggestion ActivitySecurityEvent = "suggestion"
)

Defines values for ActivitySecurityEvent.

type ActivitySecurityRisk

type ActivitySecurityRisk string

ActivitySecurityRisk A risk level assessed by the platform. Depending on the nature of the incident, this may change even if the event type is the same.

const (
	ActivitySecurityRiskCritical ActivitySecurityRisk = "critical"
	ActivitySecurityRiskHigh     ActivitySecurityRisk = "high"
	ActivitySecurityRiskInfo     ActivitySecurityRisk = "info"
	ActivitySecurityRiskLow      ActivitySecurityRisk = "low"
	ActivitySecurityRiskMedium   ActivitySecurityRisk = "medium"
)

Defines values for ActivitySecurityRisk.

type ActivitySecuritySurface

type ActivitySecuritySurface string

ActivitySecuritySurface From where the platform has determined this security event originated from.

const (
	ActivitySecuritySurfaceApi     ActivitySecuritySurface = "api"
	ActivitySecuritySurfaceFs      ActivitySecuritySurface = "fs"
	ActivitySecuritySurfaceNetwork ActivitySecuritySurface = "network"
	ActivitySecuritySurfaceService ActivitySecuritySurface = "service"
)

Defines values for ActivitySecuritySurface.

type ActivityStatus

type ActivityStatus string

ActivityStatus A status for the given activity.

const (
	ActivityStatusAlert   ActivityStatus = "alert"
	ActivityStatusError   ActivityStatus = "error"
	ActivityStatusInfo    ActivityStatus = "info"
	ActivityStatusRequest ActivityStatus = "request"
	ActivityStatusSuccess ActivityStatus = "success"
	ActivityStatusWarn    ActivityStatus = "warn"
)

Defines values for ActivityStatus.

type ActivityUserType

type ActivityUserType string

ActivityUserType The type of user.

const (
	ActivityUserTypeAccount          ActivityUserType = "account"
	ActivityUserTypeApiKey           ActivityUserType = "api-key"
	ActivityUserTypeEmployee         ActivityUserType = "employee"
	ActivityUserTypeEnvironment      ActivityUserType = "environment"
	ActivityUserTypePlatform         ActivityUserType = "platform"
	ActivityUserTypePlatformPipeline ActivityUserType = "platform-pipeline"
	ActivityUserTypeVisitor          ActivityUserType = "visitor"
)

Defines values for ActivityUserType.

type Address

type Address struct {
	// Country The country this billing method is associated with.
	Country string `json:"country"`

	// Zip The zip code this billing method is associated with.
	Zip string `json:"zip"`
}

Address Address information for a given billing method.

type AggregateLogsJSONBody

type AggregateLogsJSONBody struct {
	// ContextWindowSize Context window size indicates how many log lines after a match to return in the response.
	// This allows greater context around the matched lines.
	ContextWindowSize *int `json:"context_window_size"`

	// Limit Describes the maximum number of log lines the query will return.
	Limit *int `json:"limit"`

	// Local Indicates that only locally cached log lines should be queried.  If true, logs in object storage will not be returned.
	Local *bool `json:"local"`
	Scope struct {
		// DateRange The date range used to narrow log aggregation.
		DateRange *struct {
			End   *DateTime `json:"end,omitempty"`
			Start *DateTime `json:"start,omitempty"`
		} `json:"date_range,omitempty"`

		// Ids The ID or IDs used to narrow log aggregation.
		Ids *[]ID `json:"ids"`

		// Type The type of resource used to narrow log aggregation.
		Type AggregateLogsJSONBodyScopeType `json:"type"`
	} `json:"scope"`
	Search *[]struct {
		// Match The search input is a string input that is used to in the aggregate to narrow the log line results.
		Match string `json:"match"`

		// Type The input type used to query logs. When set to regexp, a regex expression will be used to find a log line with a message matching the expression.  When set to 'raw', the aggregate will look for an exact string match.
		Type AggregateLogsJSONBodySearchType `json:"type"`
	} `json:"search,omitempty"`
}

AggregateLogsJSONBody defines parameters for AggregateLogs.

type AggregateLogsJSONBodyScopeType

type AggregateLogsJSONBodyScopeType string

AggregateLogsJSONBodyScopeType defines parameters for AggregateLogs.

const (
	AggregateLogsJSONBodyScopeTypeContainer   AggregateLogsJSONBodyScopeType = "container"
	AggregateLogsJSONBodyScopeTypeEnvironment AggregateLogsJSONBodyScopeType = "environment"
	AggregateLogsJSONBodyScopeTypeInstance    AggregateLogsJSONBodyScopeType = "instance"
)

Defines values for AggregateLogsJSONBodyScopeType.

type AggregateLogsJSONBodySearchType

type AggregateLogsJSONBodySearchType string

AggregateLogsJSONBodySearchType defines parameters for AggregateLogs.

const (
	Raw    AggregateLogsJSONBodySearchType = "raw"
	Regexp AggregateLogsJSONBodySearchType = "regexp"
)

Defines values for AggregateLogsJSONBodySearchType.

type AggregateLogsJSONRequestBody

type AggregateLogsJSONRequestBody AggregateLogsJSONBody

AggregateLogsJSONRequestBody defines body for AggregateLogs for application/json ContentType.

type AggregateLogsResponse

type AggregateLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []LogLine `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseAggregateLogsResponse

func ParseAggregateLogsResponse(rsp *http.Response) (*AggregateLogsResponse, error)

ParseAggregateLogsResponse parses an HTTP response from a AggregateLogsWithResponse call

func (AggregateLogsResponse) Status

func (r AggregateLogsResponse) Status() string

Status returns HTTPResponse.Status

func (AggregateLogsResponse) StatusCode

func (r AggregateLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Announcement

type Announcement struct {
	AffectedIntegrations *[]string `json:"affected_integrations,omitempty"`
	AffectedServices     *[]string `json:"affected_services,omitempty"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Description A description of the announcement
	Description string `json:"description"`

	// Events A collection of timestamps for each event in the announcement's lifetime.
	Events struct {
		Created  DateTime `json:"created"`
		Deleted  DateTime `json:"deleted"`
		Resolved DateTime `json:"resolved"`
		Updated  DateTime `json:"updated"`
	} `json:"events"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Priority The priority or severity of the announcement.
	Priority AnnouncementPriority `json:"priority"`
	State    struct {
		Changed DateTime `json:"changed"`

		// Current The current state of the method.
		Current AnnouncementStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`

	// Title A description of the event being announced.
	Title   string               `json:"title"`
	Updates []AnnouncementUpdate `json:"updates"`
}

Announcement An announcement from the Cycle team.

type AnnouncementPriority

type AnnouncementPriority string

AnnouncementPriority The priority or severity of the announcement.

const (
	AnnouncementPriorityHigh   AnnouncementPriority = "high"
	AnnouncementPriorityLow    AnnouncementPriority = "low"
	AnnouncementPriorityMedium AnnouncementPriority = "medium"
	AnnouncementPriorityNotice AnnouncementPriority = "notice"
	AnnouncementPrioritySevere AnnouncementPriority = "severe"
)

Defines values for AnnouncementPriority.

type AnnouncementStateCurrent

type AnnouncementStateCurrent string

AnnouncementStateCurrent The current state of the method.

const (
	AnnouncementStateCurrentDeleted  AnnouncementStateCurrent = "deleted"
	AnnouncementStateCurrentDeleting AnnouncementStateCurrent = "deleting"
	AnnouncementStateCurrentLive     AnnouncementStateCurrent = "live"
)

Defines values for AnnouncementStateCurrent.

type AnnouncementUpdate

type AnnouncementUpdate struct {
	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Message The text describing the update to the announcement.
	Message string   `json:"message"`
	Time    DateTime `json:"time"`
}

AnnouncementUpdate An update to an Announcement.

type ApiKey

type ApiKey struct {
	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the API key's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Ips An array of IP's this API key can make calls from.
	Ips *[]string `json:"ips"`

	// Name A name for the API key.
	Name string `json:"name"`

	// RoleId A 24 character hex string used to identify a unique resource.
	RoleId ID `json:"role_id"`

	// Secret The API key secret.
	Secret string      `json:"secret"`
	State  ApiKeyState `json:"state"`
}

ApiKey An API key resource

type ApiKeyCreator

type ApiKeyCreator struct {
	// Capabilities The API key capabilities list
	Capabilities struct {
		All      bool     `json:"all"`
		Specific []string `json:"specific"`
	} `json:"capabilities"`

	// Events Describes the date and time at which certain events occurred in the lifetime of this resource.
	Events Events `json:"events"`

	// HubId A 24 character hex string used to identify a unique resource.
	HubId ID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id  ID        `json:"id"`
	Ips *[]string `json:"ips"`

	// Name The name of the API key
	Name string `json:"name"`

	// Permissions Permissions information for an API Key
	Permissions Permissions `json:"permissions"`

	// Secret The API key secret
	Secret *string `json:"secret,omitempty"`
	State  struct {
		Changed DateTime                  `json:"changed"`
		Current ApiKeyCreatorStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`
}

ApiKeyCreator An extended resource that has information on a Cycle hub API key

type ApiKeyCreatorStateCurrent

type ApiKeyCreatorStateCurrent string

ApiKeyCreatorStateCurrent defines model for ApiKeyCreator.State.Current.

const (
	ApiKeyCreatorStateCurrentDeleted  ApiKeyCreatorStateCurrent = "deleted"
	ApiKeyCreatorStateCurrentDeleting ApiKeyCreatorStateCurrent = "deleting"
	ApiKeyCreatorStateCurrentLive     ApiKeyCreatorStateCurrent = "live"
)

Defines values for ApiKeyCreatorStateCurrent.

type ApiKeyIncludes

type ApiKeyIncludes struct {
	// Roles A map of roles relevant to this API key, keyed by the role ID.
	Roles *map[string]Role `json:"roles,omitempty"`

	// RolesIdentifiers A map of roles relevant to this API key, keyed by the role ID.
	RolesIdentifiers *map[string]ID `json:"roles:identifiers,omitempty"`
}

ApiKeyIncludes A resource that is associated with an API key.

type ApiKeyState

type ApiKeyState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the API key.
	Current ApiKeyStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

ApiKeyState defines model for ApiKeyState.

type ApiKeyStateCurrent

type ApiKeyStateCurrent string

ApiKeyStateCurrent The current state of the API key.

const (
	ApiKeyStateCurrentConfiguring ApiKeyStateCurrent = "configuring"
	ApiKeyStateCurrentDeleted     ApiKeyStateCurrent = "deleted"
	ApiKeyStateCurrentDeleting    ApiKeyStateCurrent = "deleting"
	ApiKeyStateCurrentInactive    ApiKeyStateCurrent = "inactive"
	ApiKeyStateCurrentLive        ApiKeyStateCurrent = "live"
	ApiKeyStateCurrentNew         ApiKeyStateCurrent = "new"
)

Defines values for ApiKeyStateCurrent.

type AssociatedDiscount

type AssociatedDiscount struct {
	// Amount An object holding information about term and amount that relates to a specific billing component.
	Amount  BillingAmount `json:"amount"`
	Expires DateTime      `json:"expires"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`
}

AssociatedDiscount Information about a billing discount.

type Attempt

type Attempt struct {
	// Domains A list of domains associated with the attempt.
	Domains []string `json:"domains"`

	// Error If success is false this property will be populated with an error.
	Error *string `json:"error,omitempty"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Success A boolean where true means the attept was successful at creating the TLS certificate.
	Success bool     `json:"success"`
	Time    DateTime `json:"time"`
}

Attempt A DNS TLS certificate generation attempt resource.

type AutoScaleGroup

type AutoScaleGroup struct {
	Acl     *ACL   `json:"acl"`
	Cluster string `json:"cluster"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the auto-scale group's lifetime.
	Events struct {
		Created  DateTime `json:"created"`
		Deleted  DateTime `json:"deleted"`
		LastSync DateTime `json:"last_sync"`
		Updated  DateTime `json:"updated"`
	} `json:"events"`
	HubId          string                       `json:"hub_id"`
	Id             string                       `json:"id"`
	Identifier     string                       `json:"identifier"`
	Infrastructure AutoScaleGroupInfrastructure `json:"infrastructure"`
	Name           string                       `json:"name"`
	Scale          *AutoScaleGroupScale         `json:"scale,omitempty"`
	State          struct {
		Changed DateTime `json:"changed"`

		// Current The current state of the auto-scale group.
		Current AutoScaleGroupStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`
}

AutoScaleGroup defines model for AutoScaleGroup.

type AutoScaleGroupIncludes

type AutoScaleGroupIncludes struct {
	// Integrations A resource that is associated with an integration.
	Integrations *IntegrationsIncludes `json:"integrations,omitempty"`

	// Locations A resource that is associated with a provider location.
	Locations *LocationsIncludes `json:"locations,omitempty"`

	// Models A resource associated with a server models.
	Models *ProviderServerModelsIncludes `json:"models,omitempty"`
}

AutoScaleGroupIncludes All includable resource linkable to the given auto-scale group.

type AutoScaleGroupInfrastructure

type AutoScaleGroupInfrastructure struct {
	Models []struct {
		// IntegrationId A 24 character hex string used to identify a unique resource.
		IntegrationId *ID `json:"integration_id,omitempty"`
		Locations     []struct {
			AvailabilityZones []string `json:"availability_zones"`
			Id                string   `json:"id"`
		} `json:"locations"`
		ModelId  string `json:"model_id"`
		Priority int    `json:"priority"`

		// Provider The integration identifier for infrastructure provider used.
		Provider string `json:"provider"`
	} `json:"models"`
}

AutoScaleGroupInfrastructure defines model for AutoScaleGroupInfrastructure.

type AutoScaleGroupScale

type AutoScaleGroupScale struct {
	Down *struct {
		// InactivityPeriod A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		InactivityPeriod *Duration                      `json:"inactivity_period,omitempty"`
		Method           *AutoScaleGroupScaleDownMethod `json:"method,omitempty"`

		// MinTtl A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		MinTtl *Duration `json:"min_ttl,omitempty"`
	} `json:"down,omitempty"`
	Up *struct {
		Maximum *int `json:"maximum,omitempty"`
	} `json:"up,omitempty"`
}

AutoScaleGroupScale defines model for AutoScaleGroupScale.

type AutoScaleGroupScaleDownMethod

type AutoScaleGroupScaleDownMethod string

AutoScaleGroupScaleDownMethod defines model for AutoScaleGroupScale.Down.Method.

const (
	Fifo AutoScaleGroupScaleDownMethod = "fifo"
	Lifo AutoScaleGroupScaleDownMethod = "lifo"
)

Defines values for AutoScaleGroupScaleDownMethod.

type AutoScaleGroupStateCurrent

type AutoScaleGroupStateCurrent string

AutoScaleGroupStateCurrent The current state of the auto-scale group.

const (
	AutoScaleGroupStateCurrentDeleted  AutoScaleGroupStateCurrent = "deleted"
	AutoScaleGroupStateCurrentDeleting AutoScaleGroupStateCurrent = "deleting"
	AutoScaleGroupStateCurrentLive     AutoScaleGroupStateCurrent = "live"
	AutoScaleGroupStateCurrentNew      AutoScaleGroupStateCurrent = "new"
)

Defines values for AutoScaleGroupStateCurrent.

type BillingAmount

type BillingAmount struct {
	// Mills 1/10th of a cent.
	Mills int `json:"mills"`

	// Term The length of the term.
	Term BillingAmountTerm `json:"term"`
}

BillingAmount An object holding information about term and amount that relates to a specific billing component.

type BillingAmountTerm

type BillingAmountTerm string

BillingAmountTerm The length of the term.

const (
	BillingAmountTermMonthly BillingAmountTerm = "monthly"
	BillingAmountTermOnce    BillingAmountTerm = "once"
	BillingAmountTermYearly  BillingAmountTerm = "yearly"
)

Defines values for BillingAmountTerm.

type BillingBuilds

type BillingBuilds struct {
	// CpuCores The number of CPU Cores availiable for builds
	CpuCores float32 `json:"cpu_cores"`

	// MaxDailyBuilds The maximum number of builds processed per day
	MaxDailyBuilds *int    `json:"max_daily_builds"`
	Parallel       float32 `json:"parallel"`

	// RamGb The amount of RAM availiable for builds
	RamGb float32 `json:"ram_gb"`
}

BillingBuilds An object holding information about servers included in Billing tier

type BillingImageStorage

type BillingImageStorage struct {
	// AdditionalGb Additional cost for image storage exceeding included_gb
	AdditionalGb struct {
		Mills float32                             `json:"mills"`
		Term  BillingImageStorageAdditionalGbTerm `json:"term"`
	} `json:"additional_gb"`

	// HardCap A boolean indicating if there is a hard limit on the image storage
	HardCap bool `json:"hard_cap"`

	// IncludedGb The GB of image storage included in tier
	IncludedGb float32 `json:"included_gb"`
}

BillingImageStorage An object holding information about servers included in Billing tier

type BillingImageStorageAdditionalGbTerm

type BillingImageStorageAdditionalGbTerm string

BillingImageStorageAdditionalGbTerm defines model for BillingImageStorage.AdditionalGb.Term.

const (
	BillingImageStorageAdditionalGbTermMonthly BillingImageStorageAdditionalGbTerm = "monthly"
	BillingImageStorageAdditionalGbTermOnce    BillingImageStorageAdditionalGbTerm = "once"
	BillingImageStorageAdditionalGbTermYearly  BillingImageStorageAdditionalGbTerm = "yearly"
)

Defines values for BillingImageStorageAdditionalGbTerm.

type BillingOrder

type BillingOrder struct {
	// Approved A boolean where true represents the order is approved to be paid by the user.
	Approved bool `json:"approved"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the billing order's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Expires DateTime `json:"expires"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id    ID          `json:"id"`
	Items []OrderItem `json:"items"`

	// PromoCodeId An ID associated with a promo code used with the order.
	PromoCodeId *string `json:"promo_code_id"`
	State       struct {
		Changed DateTime `json:"changed"`

		// Current The current state of the order.
		Current BillingOrderStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`

	// Term Information about a billing term.
	Term Term `json:"term"`

	// TotalPrice 1/10th of a cent.
	TotalPrice int `json:"total_price"`
}

BillingOrder Information about an order.

type BillingOrderIncludes

type BillingOrderIncludes struct {
	// PromoCodes A resource that is associated with a promo code.
	PromoCodes *PromoCodeInclude `json:"promo_codes,omitempty"`
}

BillingOrderIncludes defines model for BillingOrderIncludes.

type BillingOrderStateCurrent

type BillingOrderStateCurrent string

BillingOrderStateCurrent The current state of the order.

const (
	BillingOrderStateCurrentDeleted   BillingOrderStateCurrent = "deleted"
	BillingOrderStateCurrentDeleting  BillingOrderStateCurrent = "deleting"
	BillingOrderStateCurrentNew       BillingOrderStateCurrent = "new"
	BillingOrderStateCurrentProcessed BillingOrderStateCurrent = "processed"
)

Defines values for BillingOrderStateCurrent.

type BillingRam

type BillingRam struct {
	// AdditionalGb Additional cost for image storage exceeding included_gb
	AdditionalGb struct {
		Mills float32                    `json:"mills"`
		Term  BillingRamAdditionalGbTerm `json:"term"`
	} `json:"additional_gb"`

	// HardCap A boolean indicating if there is a hard limit on the image storage
	HardCap bool `json:"hard_cap"`

	// IncludedGb The GB of image storage included in tier
	IncludedGb float32 `json:"included_gb"`
}

BillingRam An object holding information about servers included in Billing tier

type BillingRamAdditionalGbTerm

type BillingRamAdditionalGbTerm string

BillingRamAdditionalGbTerm defines model for BillingRam.AdditionalGb.Term.

const (
	BillingRamAdditionalGbTermMonthly BillingRamAdditionalGbTerm = "monthly"
	BillingRamAdditionalGbTermOnce    BillingRamAdditionalGbTerm = "once"
	BillingRamAdditionalGbTermYearly  BillingRamAdditionalGbTerm = "yearly"
)

Defines values for BillingRamAdditionalGbTerm.

type BillingService added in v0.6.4

type BillingService struct {
	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Discount Information about a billing discount.
	Discount AssociatedDiscount `json:"discount"`

	// Events A collection of timestamps for each event in the billing service's lifetime.
	Events struct {
		Created    DateTime `json:"created"`
		Deleted    DateTime `json:"deleted"`
		LastBilled DateTime `json:"last_billed"`
		Updated    DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Item Information for an item's plan.
	Item ServiceItem `json:"item"`

	// Order An order is a resource that describes a billing order
	Order Order `json:"order"`

	// Price An object holding information about term and amount that relates to a specific billing component.
	Price BillingAmount       `json:"price"`
	State BillingServiceState `json:"state"`

	// Term Information about a billing term.
	Term Term `json:"term"`

	// Title Billing service title.
	Title string `json:"title"`
}

BillingService Information about billing service.

type BillingServiceState

type BillingServiceState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the billing service.
	Current BillingServiceStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

BillingServiceState defines model for BillingServiceState.

type BillingServiceStateCurrent

type BillingServiceStateCurrent string

BillingServiceStateCurrent The current state of the billing service.

const (
	BillingServiceStateCurrentActive BillingServiceStateCurrent = "active"
)

Defines values for BillingServiceStateCurrent.

type BillingSummary

type BillingSummary struct {
	// Discount 1/10th of a cent (mills).
	Discount float32 `json:"discount"`

	// Price 1/10th of a cent (mills).
	Price float32 `json:"price"`

	// ServiceId The ID of the billing service, the summary pertains to.
	ServiceId string `json:"service_id"`

	// Term Information about a billing term.
	Term Term `json:"term"`

	// Title The billing summary title.
	Title string `json:"title"`

	// Type The plan type.
	Type BillingSummaryType `json:"type"`
}

BillingSummary A billing summary.

type BillingSummaryType

type BillingSummaryType string

BillingSummaryType The plan type.

const (
	Support BillingSummaryType = "support"
	Tier    BillingSummaryType = "tier"
)

Defines values for BillingSummaryType.

type BucketImageSourceType

type BucketImageSourceType struct {
	Details struct {
		Id string `json:"id"`

		// Origin The origin of the image.
		Origin ImageOrigin `json:"origin"`
	} `json:"details"`
	Override *struct {
		Target   *string `json:"target,omitempty"`
		TargzUrl *string `json:"targz_url,omitempty"`
	} `json:"override,omitempty"`
	Type BucketImageSourceTypeType `json:"type"`
}

BucketImageSourceType defines model for BucketImageSourceType.

type BucketImageSourceTypeType

type BucketImageSourceTypeType string

BucketImageSourceTypeType defines model for BucketImageSourceType.Type.

const (
	BucketImageSourceTypeTypeBucket BucketImageSourceTypeType = "bucket"
)

Defines values for BucketImageSourceTypeType.

type BuildLog

type BuildLog struct {
	// Events A collection of timestamps for each event in the build log's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// ImageId The ID of the image the build log pertains to.
	ImageId string `json:"image_id"`

	// Log The log itself.
	Log string `json:"log"`
}

BuildLog A build log for a given image.

type CPUSnapshot

type CPUSnapshot struct {
	// NumCores The total number of cores on the originating node the instance is running on.
	NumCores int `json:"num_cores"`

	// Throttling Throttling statistics.
	Throttling struct {
		// Periods The amount of periods that have passed since the last restart.
		Periods *int `json:"periods,omitempty"`

		// ThrottledPeriods How many times the instance has been throttled for using all its alloted CPU during a period.
		ThrottledPeriods *int `json:"throttled_periods,omitempty"`

		// ThrottledTime The amount of time in nanoseconds this instnace has spent with throttled CPU resources.
		ThrottledTime *int `json:"throttled_time,omitempty"`
	} `json:"throttling"`

	// Usage Usage statistics.
	Usage struct {
		// Kernel The amount of time in nanoseconds used by the kernel since last restart.
		Kernel int `json:"kernel"`

		// Total Total amount of VPU time since last restart.
		Total int `json:"total"`

		// User The amount of time in nanoseconds taken up for user processes.
		User float32 `json:"user"`
	} `json:"usage"`
}

CPUSnapshot A telemetry snapshot pertaining to CPU usage.

type CPUSpec

type CPUSpec struct {
	// Cores The number of cores.
	Cores *int `json:"cores,omitempty"`

	// Count The number of CPUs.
	Count int `json:"count"`

	// Extra Extra information about the CPU if there is any.
	Extra *map[string]string `json:"extra,omitempty"`

	// Shared A boolean where true represents the CPU is shared.
	Shared *bool `json:"shared,omitempty"`

	// Threads The number of threads.
	Threads *int `json:"threads,omitempty"`

	// Type The type of the CPU.
	Type string `json:"type"`
}

CPUSpec Information about the CPU for a given server.

type Capability

type Capability string

Capability A capability that a user or API key that represents what an API key or a user can do.

const (
	ApiKeysManage                     Capability = "api-keys-manage"
	ApionlyJobsView                   Capability = "apionly-jobs-view"
	ApionlyNotificationsListen        Capability = "apionly-notifications-listen"
	AutoscaleGroupsManage             Capability = "autoscale-groups-manage"
	AutoscaleGroupsView               Capability = "autoscale-groups-view"
	BillingCreditsView                Capability = "billing-credits-view"
	BillingInvoicesPay                Capability = "billing-invoices-pay"
	BillingInvoicesView               Capability = "billing-invoices-view"
	BillingMethodsManage              Capability = "billing-methods-manage"
	BillingServicesManage             Capability = "billing-services-manage"
	BillingServicesView               Capability = "billing-services-view"
	ClustersManage                    Capability = "clusters-manage"
	ClustersView                      Capability = "clusters-view"
	ContainersBackupsManage           Capability = "containers-backups-manage"
	ContainersBackupsView             Capability = "containers-backups-view"
	ContainersConsole                 Capability = "containers-console"
	ContainersDeploy                  Capability = "containers-deploy"
	ContainersFunctionsTrigger        Capability = "containers-functions-trigger"
	ContainersInstancesMigrate        Capability = "containers-instances-migrate"
	ContainersLock                    Capability = "containers-lock"
	ContainersManage                  Capability = "containers-manage"
	ContainersSsh                     Capability = "containers-ssh"
	ContainersView                    Capability = "containers-view"
	ContainersVolumesManage           Capability = "containers-volumes-manage"
	ContainersVolumesView             Capability = "containers-volumes-view"
	DnsCertsView                      Capability = "dns-certs-view"
	DnsManage                         Capability = "dns-manage"
	DnsView                           Capability = "dns-view"
	EnvironmentsDeploymentsManage     Capability = "environments-deployments-manage"
	EnvironmentsManage                Capability = "environments-manage"
	EnvironmentsScopedvariablesManage Capability = "environments-scopedvariables-manage"
	EnvironmentsScopedvariablesView   Capability = "environments-scopedvariables-view"
	EnvironmentsServicesManage        Capability = "environments-services-manage"
	EnvironmentsView                  Capability = "environments-view"
	EnvironmentsVpn                   Capability = "environments-vpn"
	EnvironmentsVpnManage             Capability = "environments-vpn-manage"
	ExternalVolumesManage             Capability = "external-volumes-manage"
	ExternalVolumesView               Capability = "external-volumes-view"
	HubsAuditlogView                  Capability = "hubs-auditlog-view"
	HubsDelete                        Capability = "hubs-delete"
	HubsIntegrationsManage            Capability = "hubs-integrations-manage"
	HubsIntegrationsView              Capability = "hubs-integrations-view"
	HubsInvitesManage                 Capability = "hubs-invites-manage"
	HubsInvitesSend                   Capability = "hubs-invites-send"
	HubsMembersManage                 Capability = "hubs-members-manage"
	HubsMembersView                   Capability = "hubs-members-view"
	HubsRolesManage                   Capability = "hubs-roles-manage"
	HubsRolesView                     Capability = "hubs-roles-view"
	HubsUpdate                        Capability = "hubs-update"
	HubsUsageView                     Capability = "hubs-usage-view"
	ImagesManage                      Capability = "images-manage"
	ImagesSourcesManage               Capability = "images-sources-manage"
	ImagesSourcesView                 Capability = "images-sources-view"
	ImagesView                        Capability = "images-view"
	IpsManage                         Capability = "ips-manage"
	MonitorManage                     Capability = "monitor-manage"
	MonitorView                       Capability = "monitor-view"
	PipelinesManage                   Capability = "pipelines-manage"
	PipelinesTrigger                  Capability = "pipelines-trigger"
	PipelinesView                     Capability = "pipelines-view"
	SanManage                         Capability = "san-manage"
	SanView                           Capability = "san-view"
	SdnNetworksManage                 Capability = "sdn-networks-manage"
	SdnNetworksView                   Capability = "sdn-networks-view"
	SecurityManage                    Capability = "security-manage"
	SecurityView                      Capability = "security-view"
	ServersConsole                    Capability = "servers-console"
	ServersDecommission               Capability = "servers-decommission"
	ServersLogin                      Capability = "servers-login"
	ServersManage                     Capability = "servers-manage"
	ServersProvision                  Capability = "servers-provision"
	ServersView                       Capability = "servers-view"
	StacksBuildsDeploy                Capability = "stacks-builds-deploy"
	StacksBuildsManage                Capability = "stacks-builds-manage"
	StacksManage                      Capability = "stacks-manage"
	StacksView                        Capability = "stacks-view"
	VirtualMachinesConsole            Capability = "virtual-machines-console"
	VirtualMachinesDeploy             Capability = "virtual-machines-deploy"
	VirtualMachinesLock               Capability = "virtual-machines-lock"
	VirtualMachinesManage             Capability = "virtual-machines-manage"
	VirtualMachinesRootPwView         Capability = "virtual-machines-root-pw-view"
	VirtualMachinesRootPwViewTemp     Capability = "virtual-machines-root-pw-view-temp"
	VirtualMachinesSshKeysManage      Capability = "virtual-machines-ssh-keys-manage"
	VirtualMachinesView               Capability = "virtual-machines-view"
)

Defines values for Capability.

type Change

type Change struct {
	// After Details about a given event that is part of an activity.
	After *Detail `json:"after,omitempty"`

	// Before Details about a given event that is part of an activity.
	Before *Detail `json:"before,omitempty"`

	// Component A description of the resource that was changed.
	Component string `json:"component"`
}

Change An object with information of details for before and after a resource changed.

type ChangePasswordJSONBody

type ChangePasswordJSONBody struct {
	// Current Current Password
	Current string `json:"current"`

	// New New Password
	New string `json:"new"`
}

ChangePasswordJSONBody defines parameters for ChangePassword.

type ChangePasswordJSONRequestBody

type ChangePasswordJSONRequestBody ChangePasswordJSONBody

ChangePasswordJSONRequestBody defines body for ChangePassword for application/json ContentType.

type ChangePasswordResponse

type ChangePasswordResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An object representing information about the currently logged-in user.
		Data Account `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseChangePasswordResponse

func ParseChangePasswordResponse(rsp *http.Response) (*ChangePasswordResponse, error)

ParseChangePasswordResponse parses an HTTP response from a ChangePasswordWithResponse call

func (ChangePasswordResponse) Status

func (r ChangePasswordResponse) Status() string

Status returns HTTPResponse.Status

func (ChangePasswordResponse) StatusCode

func (r ChangePasswordResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ChangelogEntry added in v0.6.4

type ChangelogEntry struct {
	Approved *struct {
		Date DateTime `json:"date"`

		// SignedBy A type of creator and a matching identifier.
		SignedBy UserScope `json:"signed_by"`
	} `json:"approved"`
	Changes []struct {
		Codebase    *string                   `json:"codebase"`
		Description string                    `json:"description"`
		ExternalUrl *string                   `json:"external_url"`
		Notes       *[]string                 `json:"notes"`
		Showcase    bool                      `json:"showcase"`
		Title       string                    `json:"title"`
		Type        ChangelogEntryChangesType `json:"type"`
	} `json:"changes"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator     CreatorScope `json:"creator"`
	EmailEvents *[]struct {
		Address string `json:"address"`

		// Sender A type of creator and a matching identifier.
		Sender UserScope                     `json:"sender"`
		Sent   DateTime                      `json:"sent"`
		Type   ChangelogEntryEmailEventsType `json:"type"`
	} `json:"email_events,omitempty"`

	// Events A collection of timestamps for each event in the changelog entry's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// Hero An object describing the hero image for the changelog entry.
	Hero *struct {
		ImageAlt *string `json:"image_alt"`
		ImageUrl *string `json:"image_url"`
		Intro    string  `json:"intro"`
	} `json:"hero"`

	// Id A 24 character hex string used to identify a unique resource.
	Id        ID `json:"id"`
	Published *struct {
		Date DateTime `json:"date"`

		// SignedBy A type of creator and a matching identifier.
		SignedBy UserScope `json:"signed_by"`
	} `json:"published"`
	State ChangelogEntryState `json:"state"`

	// Title The title of the changelog entry.
	Title string `json:"title"`

	// Version The version of the release described in the changelog entry.
	Version string `json:"version"`
}

ChangelogEntry A changelog entry released by the Cycle team.

type ChangelogEntryChangesType added in v0.6.4

type ChangelogEntryChangesType string

ChangelogEntryChangesType defines model for ChangelogEntry.Changes.Type.

const (
	ChangelogEntryChangesTypeAdded       ChangelogEntryChangesType = "added"
	ChangelogEntryChangesTypeChanged     ChangelogEntryChangesType = "changed"
	ChangelogEntryChangesTypeDeprecated  ChangelogEntryChangesType = "deprecated"
	ChangelogEntryChangesTypeFixed       ChangelogEntryChangesType = "fixed"
	ChangelogEntryChangesTypeImprovement ChangelogEntryChangesType = "improvement"
	ChangelogEntryChangesTypeRemoved     ChangelogEntryChangesType = "removed"
	ChangelogEntryChangesTypeSecurity    ChangelogEntryChangesType = "security"
)

Defines values for ChangelogEntryChangesType.

type ChangelogEntryEmailEventsType added in v0.6.4

type ChangelogEntryEmailEventsType string

ChangelogEntryEmailEventsType defines model for ChangelogEntry.EmailEvents.Type.

const (
	External ChangelogEntryEmailEventsType = "external"
	Internal ChangelogEntryEmailEventsType = "internal"
	Single   ChangelogEntryEmailEventsType = "single"
)

Defines values for ChangelogEntryEmailEventsType.

type ChangelogEntryState added in v0.6.4

type ChangelogEntryState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the changelog entry.
	Current ChangelogEntryStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

ChangelogEntryState defines model for ChangelogEntryState.

type ChangelogEntryStateCurrent added in v0.6.4

type ChangelogEntryStateCurrent string

ChangelogEntryStateCurrent The current state of the changelog entry.

const (
	ChangelogEntryStateCurrentApproved  ChangelogEntryStateCurrent = "approved"
	ChangelogEntryStateCurrentDeleted   ChangelogEntryStateCurrent = "deleted"
	ChangelogEntryStateCurrentNew       ChangelogEntryStateCurrent = "new"
	ChangelogEntryStateCurrentPublished ChangelogEntryStateCurrent = "published"
)

Defines values for ChangelogEntryStateCurrent.

type Cidr added in v0.6.3

type Cidr = string

Cidr A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix. It combines an IP address with a suffix that indicates how many bits are fixed for routing.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) AggregateLogs

func (c *Client) AggregateLogs(ctx context.Context, body AggregateLogsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AggregateLogsWithBody

func (c *Client) AggregateLogsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ChangePassword

func (c *Client) ChangePassword(ctx context.Context, body ChangePasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ChangePasswordWithBody

func (c *Client) ChangePasswordWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ClonePipeline

func (c *Client) ClonePipeline(ctx context.Context, body ClonePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ClonePipelineWithBody

func (c *Client) ClonePipelineWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateApiKey

func (c *Client) CreateApiKey(ctx context.Context, body CreateApiKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateApiKeyWithBody

func (c *Client) CreateApiKeyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateAutoScaleGroup

func (c *Client) CreateAutoScaleGroup(ctx context.Context, body CreateAutoScaleGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateAutoScaleGroupWithBody

func (c *Client) CreateAutoScaleGroupWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateBillingMethod

func (c *Client) CreateBillingMethod(ctx context.Context, body CreateBillingMethodJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateBillingMethodJob

func (c *Client) CreateBillingMethodJob(ctx context.Context, methodId string, body CreateBillingMethodJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateBillingMethodJobWithBody

func (c *Client) CreateBillingMethodJobWithBody(ctx context.Context, methodId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateBillingMethodWithBody

func (c *Client) CreateBillingMethodWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateCluster

func (c *Client) CreateCluster(ctx context.Context, body CreateClusterJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateClusterJob added in v0.6.3

func (c *Client) CreateClusterJob(ctx context.Context, clusterId string, body CreateClusterJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateClusterJobWithBody added in v0.6.3

func (c *Client) CreateClusterJobWithBody(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateClusterWithBody

func (c *Client) CreateClusterWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateContainer

func (c *Client) CreateContainer(ctx context.Context, body CreateContainerJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateContainerBackupJob

func (c *Client) CreateContainerBackupJob(ctx context.Context, containerId string, backupId string, body CreateContainerBackupJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateContainerBackupJobWithBody

func (c *Client) CreateContainerBackupJobWithBody(ctx context.Context, containerId string, backupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateContainerJob

func (c *Client) CreateContainerJob(ctx context.Context, containerId string, body CreateContainerJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateContainerJobWithBody

func (c *Client) CreateContainerJobWithBody(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateContainerWithBody

func (c *Client) CreateContainerWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDNSZone

func (c *Client) CreateDNSZone(ctx context.Context, body CreateDNSZoneJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDNSZoneJob

func (c *Client) CreateDNSZoneJob(ctx context.Context, zoneId string, body CreateDNSZoneJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDNSZoneJobWithBody

func (c *Client) CreateDNSZoneJobWithBody(ctx context.Context, zoneId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDNSZoneRecord

func (c *Client) CreateDNSZoneRecord(ctx context.Context, zoneId string, params *CreateDNSZoneRecordParams, body CreateDNSZoneRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDNSZoneRecordJob

func (c *Client) CreateDNSZoneRecordJob(ctx context.Context, zoneId string, recordId string, body CreateDNSZoneRecordJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDNSZoneRecordJobWithBody

func (c *Client) CreateDNSZoneRecordJobWithBody(ctx context.Context, zoneId string, recordId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDNSZoneRecordWithBody

func (c *Client) CreateDNSZoneRecordWithBody(ctx context.Context, zoneId string, params *CreateDNSZoneRecordParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDNSZoneWithBody

func (c *Client) CreateDNSZoneWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDiscoveryServiceJob

func (c *Client) CreateDiscoveryServiceJob(ctx context.Context, environmentId string, body CreateDiscoveryServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDiscoveryServiceJobWithBody

func (c *Client) CreateDiscoveryServiceJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEnvironment

func (c *Client) CreateEnvironment(ctx context.Context, body CreateEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEnvironmentJob

func (c *Client) CreateEnvironmentJob(ctx context.Context, environmentId string, body CreateEnvironmentJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEnvironmentJobWithBody

func (c *Client) CreateEnvironmentJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEnvironmentWithBody

func (c *Client) CreateEnvironmentWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateExternalVolume added in v0.6.5

func (c *Client) CreateExternalVolume(ctx context.Context, params *CreateExternalVolumeParams, body CreateExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateExternalVolumeJob added in v0.6.5

func (c *Client) CreateExternalVolumeJob(ctx context.Context, externalVolumeId string, body CreateExternalVolumeJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateExternalVolumeJobWithBody added in v0.6.5

func (c *Client) CreateExternalVolumeJobWithBody(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateExternalVolumeWithBody added in v0.6.5

func (c *Client) CreateExternalVolumeWithBody(ctx context.Context, params *CreateExternalVolumeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateExternalVolumesJob added in v0.6.6

func (c *Client) CreateExternalVolumesJob(ctx context.Context, body CreateExternalVolumesJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateExternalVolumesJobWithBody added in v0.6.6

func (c *Client) CreateExternalVolumesJobWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateFunctionJob

func (c *Client) CreateFunctionJob(ctx context.Context, containerId string, body CreateFunctionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateFunctionJobWithBody

func (c *Client) CreateFunctionJobWithBody(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateGatewayServiceJob

func (c *Client) CreateGatewayServiceJob(ctx context.Context, environmentId string, body CreateGatewayServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateGatewayServiceJobWithBody

func (c *Client) CreateGatewayServiceJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateHub

func (c *Client) CreateHub(ctx context.Context, body CreateHubJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateHubInvite

func (c *Client) CreateHubInvite(ctx context.Context, body CreateHubInviteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateHubInviteWithBody

func (c *Client) CreateHubInviteWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateHubWithBody

func (c *Client) CreateHubWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateImage

func (c *Client) CreateImage(ctx context.Context, body CreateImageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateImageJob

func (c *Client) CreateImageJob(ctx context.Context, imageId string, body CreateImageJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateImageJobWithBody

func (c *Client) CreateImageJobWithBody(ctx context.Context, imageId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateImageSource

func (c *Client) CreateImageSource(ctx context.Context, body CreateImageSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateImageSourceWithBody

func (c *Client) CreateImageSourceWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateImageWithBody

func (c *Client) CreateImageWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateImagesJob

func (c *Client) CreateImagesJob(ctx context.Context, body CreateImagesJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateImagesJobWithBody

func (c *Client) CreateImagesJobWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateInstanceJob

func (c *Client) CreateInstanceJob(ctx context.Context, containerId string, instanceId string, body CreateInstanceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateInstanceJobWithBody

func (c *Client) CreateInstanceJobWithBody(ctx context.Context, containerId string, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateInstances

func (c *Client) CreateInstances(ctx context.Context, containerId string, body CreateInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateInstancesWithBody

func (c *Client) CreateInstancesWithBody(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateIntegration

func (c *Client) CreateIntegration(ctx context.Context, params *CreateIntegrationParams, body CreateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateIntegrationJob

func (c *Client) CreateIntegrationJob(ctx context.Context, integrationId string, body CreateIntegrationJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateIntegrationJobWithBody

func (c *Client) CreateIntegrationJobWithBody(ctx context.Context, integrationId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateIntegrationWithBody

func (c *Client) CreateIntegrationWithBody(ctx context.Context, params *CreateIntegrationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateInvoiceJob

func (c *Client) CreateInvoiceJob(ctx context.Context, invoiceId string, body CreateInvoiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateInvoiceJobWithBody

func (c *Client) CreateInvoiceJobWithBody(ctx context.Context, invoiceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateIpPool added in v0.6.3

func (c *Client) CreateIpPool(ctx context.Context, body CreateIpPoolJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateIpPoolJob added in v0.6.4

func (c *Client) CreateIpPoolJob(ctx context.Context, poolId string, body CreateIpPoolJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateIpPoolJobWithBody added in v0.6.4

func (c *Client) CreateIpPoolJobWithBody(ctx context.Context, poolId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateIpPoolWithBody added in v0.6.3

func (c *Client) CreateIpPoolWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateLoadBalancerServiceJob

func (c *Client) CreateLoadBalancerServiceJob(ctx context.Context, environmentId string, body CreateLoadBalancerServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateLoadBalancerServiceJobWithBody

func (c *Client) CreateLoadBalancerServiceJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateNetwork

func (c *Client) CreateNetwork(ctx context.Context, params *CreateNetworkParams, body CreateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateNetworkJob

func (c *Client) CreateNetworkJob(ctx context.Context, networkId string, body CreateNetworkJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateNetworkJobWithBody

func (c *Client) CreateNetworkJobWithBody(ctx context.Context, networkId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateNetworkWithBody

func (c *Client) CreateNetworkWithBody(ctx context.Context, params *CreateNetworkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateOrder

func (c *Client) CreateOrder(ctx context.Context, params *CreateOrderParams, body CreateOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateOrderJob

func (c *Client) CreateOrderJob(ctx context.Context, orderId string, body CreateOrderJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateOrderJobWithBody

func (c *Client) CreateOrderJobWithBody(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateOrderWithBody

func (c *Client) CreateOrderWithBody(ctx context.Context, params *CreateOrderParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreatePipeline

func (c *Client) CreatePipeline(ctx context.Context, body CreatePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreatePipelineJob

func (c *Client) CreatePipelineJob(ctx context.Context, pipelineId string, body CreatePipelineJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreatePipelineJobWithBody

func (c *Client) CreatePipelineJobWithBody(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreatePipelineTriggerKey

func (c *Client) CreatePipelineTriggerKey(ctx context.Context, pipelineId string, body CreatePipelineTriggerKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreatePipelineTriggerKeyWithBody

func (c *Client) CreatePipelineTriggerKeyWithBody(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreatePipelineWithBody

func (c *Client) CreatePipelineWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateRole

func (c *Client) CreateRole(ctx context.Context, body CreateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateRoleWithBody

func (c *Client) CreateRoleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateSchedulerServiceJob

func (c *Client) CreateSchedulerServiceJob(ctx context.Context, environmentId string, body CreateSchedulerServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateSchedulerServiceJobWithBody

func (c *Client) CreateSchedulerServiceJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateScopedVariable

func (c *Client) CreateScopedVariable(ctx context.Context, environmentId string, body CreateScopedVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateScopedVariableWithBody

func (c *Client) CreateScopedVariableWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateServerJob

func (c *Client) CreateServerJob(ctx context.Context, serverId string, body CreateServerJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateServerJobWithBody

func (c *Client) CreateServerJobWithBody(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateServers added in v0.6.6

func (c *Client) CreateServers(ctx context.Context, body CreateServersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateServersWithBody added in v0.6.6

func (c *Client) CreateServersWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateStack

func (c *Client) CreateStack(ctx context.Context, body CreateStackJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateStackBuild

func (c *Client) CreateStackBuild(ctx context.Context, stackId string, body CreateStackBuildJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateStackBuildJob

func (c *Client) CreateStackBuildJob(ctx context.Context, stackId string, buildId string, body CreateStackBuildJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateStackBuildJobWithBody

func (c *Client) CreateStackBuildJobWithBody(ctx context.Context, stackId string, buildId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateStackBuildWithBody

func (c *Client) CreateStackBuildWithBody(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateStackJob

func (c *Client) CreateStackJob(ctx context.Context, stackId string, body CreateStackJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateStackJobWithBody

func (c *Client) CreateStackJobWithBody(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateStackWithBody

func (c *Client) CreateStackWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateUserSuppliedCertificateJob

func (c *Client) CreateUserSuppliedCertificateJob(ctx context.Context, certificateId string, body CreateUserSuppliedCertificateJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateUserSuppliedCertificateJobWithBody

func (c *Client) CreateUserSuppliedCertificateJobWithBody(ctx context.Context, certificateId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVPNServiceJob

func (c *Client) CreateVPNServiceJob(ctx context.Context, environmentId string, body CreateVPNServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVPNServiceJobWithBody

func (c *Client) CreateVPNServiceJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVPNUser

func (c *Client) CreateVPNUser(ctx context.Context, environmentId string, body CreateVPNUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVPNUserWithBody

func (c *Client) CreateVPNUserWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVirtualMachine

func (c *Client) CreateVirtualMachine(ctx context.Context, params *CreateVirtualMachineParams, body CreateVirtualMachineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVirtualMachineJob

func (c *Client) CreateVirtualMachineJob(ctx context.Context, virtualMachineId string, body CreateVirtualMachineJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVirtualMachineJobWithBody

func (c *Client) CreateVirtualMachineJobWithBody(ctx context.Context, virtualMachineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVirtualMachineSshKey

func (c *Client) CreateVirtualMachineSshKey(ctx context.Context, params *CreateVirtualMachineSshKeyParams, body CreateVirtualMachineSshKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVirtualMachineSshKeyWithBody

func (c *Client) CreateVirtualMachineSshKeyWithBody(ctx context.Context, params *CreateVirtualMachineSshKeyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVirtualMachineWithBody

func (c *Client) CreateVirtualMachineWithBody(ctx context.Context, params *CreateVirtualMachineParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVirtualProviderIso added in v0.6.3

func (c *Client) CreateVirtualProviderIso(ctx context.Context, integrationId string, body CreateVirtualProviderIsoJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVirtualProviderIsoJob added in v0.6.3

func (c *Client) CreateVirtualProviderIsoJob(ctx context.Context, integrationId string, isoId string, body CreateVirtualProviderIsoJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVirtualProviderIsoJobWithBody added in v0.6.3

func (c *Client) CreateVirtualProviderIsoJobWithBody(ctx context.Context, integrationId string, isoId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateVirtualProviderIsoWithBody added in v0.6.3

func (c *Client) CreateVirtualProviderIsoWithBody(ctx context.Context, integrationId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteAPIKey

func (c *Client) DeleteAPIKey(ctx context.Context, apikeyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteAccount

func (c *Client) DeleteAccount(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteAutoScaleGroup

func (c *Client) DeleteAutoScaleGroup(ctx context.Context, groupId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteBillingMethod

func (c *Client) DeleteBillingMethod(ctx context.Context, methodId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteCluster

func (c *Client) DeleteCluster(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteContainer

func (c *Client) DeleteContainer(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteContainerBackup

func (c *Client) DeleteContainerBackup(ctx context.Context, containerId string, backupId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteContainerInstances

func (c *Client) DeleteContainerInstances(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteDNSZone

func (c *Client) DeleteDNSZone(ctx context.Context, zoneId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteDNSZoneRecord

func (c *Client) DeleteDNSZoneRecord(ctx context.Context, zoneId string, recordId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteEnvironment

func (c *Client) DeleteEnvironment(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteExternalVolume added in v0.6.5

func (c *Client) DeleteExternalVolume(ctx context.Context, externalVolumeId string, body DeleteExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteExternalVolumeWithBody added in v0.6.5

func (c *Client) DeleteExternalVolumeWithBody(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteHub

func (c *Client) DeleteHub(ctx context.Context, body DeleteHubJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteHubInvite

func (c *Client) DeleteHubInvite(ctx context.Context, inviteId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteHubMember

func (c *Client) DeleteHubMember(ctx context.Context, memberId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteHubWithBody

func (c *Client) DeleteHubWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteIPPool

func (c *Client) DeleteIPPool(ctx context.Context, poolId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteImage

func (c *Client) DeleteImage(ctx context.Context, imageId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteImageSource

func (c *Client) DeleteImageSource(ctx context.Context, sourceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteInstance

func (c *Client) DeleteInstance(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteIntegration

func (c *Client) DeleteIntegration(ctx context.Context, integrationId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteNetwork

func (c *Client) DeleteNetwork(ctx context.Context, networkId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeletePipeline

func (c *Client) DeletePipeline(ctx context.Context, pipelineId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeletePipelineTriggerKey

func (c *Client) DeletePipelineTriggerKey(ctx context.Context, pipelineId string, triggerKeyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteRole

func (c *Client) DeleteRole(ctx context.Context, roleId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteScopedVariable

func (c *Client) DeleteScopedVariable(ctx context.Context, environmentId string, scopedVariableId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteServer

func (c *Client) DeleteServer(ctx context.Context, serverId string, body DeleteServerJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteServerWithBody

func (c *Client) DeleteServerWithBody(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteStack

func (c *Client) DeleteStack(ctx context.Context, stackId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteStackBuild

func (c *Client) DeleteStackBuild(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteVPNUser

func (c *Client) DeleteVPNUser(ctx context.Context, environmentId string, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteVirtualMachine

func (c *Client) DeleteVirtualMachine(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteVirtualMachineSshKey

func (c *Client) DeleteVirtualMachineSshKey(ctx context.Context, sshKeyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteVirtualProviderIso added in v0.6.3

func (c *Client) DeleteVirtualProviderIso(ctx context.Context, integrationId string, isoId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DisableTwoFactorAuth

func (c *Client) DisableTwoFactorAuth(ctx context.Context, body DisableTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DisableTwoFactorAuthWithBody

func (c *Client) DisableTwoFactorAuthWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnableTwoFactorAuth

func (c *Client) EnableTwoFactorAuth(ctx context.Context, body EnableTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) EnableTwoFactorAuthWithBody

func (c *Client) EnableTwoFactorAuthWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExpireInstanceSSHCredentials

func (c *Client) ExpireInstanceSSHCredentials(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExpireVirtualMachineSosCredentials

func (c *Client) ExpireVirtualMachineSosCredentials(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExportStack

func (c *Client) ExportStack(ctx context.Context, environmentId string, body ExportStackJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExportStackWithBody

func (c *Client) ExportStackWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GenerateAggregatedEvents

func (c *Client) GenerateAggregatedEvents(ctx context.Context, params *GenerateAggregatedEventsParams, body GenerateAggregatedEventsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GenerateAggregatedEventsWithBody

func (c *Client) GenerateAggregatedEventsWithBody(ctx context.Context, params *GenerateAggregatedEventsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GenerateAggregatedMetrics

func (c *Client) GenerateAggregatedMetrics(ctx context.Context, params *GenerateAggregatedMetricsParams, body GenerateAggregatedMetricsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GenerateAggregatedMetricsWithBody

func (c *Client) GenerateAggregatedMetricsWithBody(ctx context.Context, params *GenerateAggregatedMetricsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GenerateInstanceSSHCredentials

func (c *Client) GenerateInstanceSSHCredentials(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GenerateVirtualMachineSosCredentials

func (c *Client) GenerateVirtualMachineSosCredentials(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAPIKey

func (c *Client) GetAPIKey(ctx context.Context, apikeyId string, params *GetAPIKeyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAccount

func (c *Client) GetAccount(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAccountInvites

func (c *Client) GetAccountInvites(ctx context.Context, params *GetAccountInvitesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAccountLogins

func (c *Client) GetAccountLogins(ctx context.Context, params *GetAccountLoginsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAccountMemberships

func (c *Client) GetAccountMemberships(ctx context.Context, params *GetAccountMembershipsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAllPipelineRuns added in v0.6.6

func (c *Client) GetAllPipelineRuns(ctx context.Context, params *GetAllPipelineRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAllStackBuilds added in v0.6.6

func (c *Client) GetAllStackBuilds(ctx context.Context, params *GetAllStackBuildsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAllTlsCertificates added in v0.6.6

func (c *Client) GetAllTlsCertificates(ctx context.Context, params *GetAllTlsCertificatesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAnnouncements

func (c *Client) GetAnnouncements(ctx context.Context, params *GetAnnouncementsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiKeys

func (c *Client) GetApiKeys(ctx context.Context, params *GetApiKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAutoScaleGroup

func (c *Client) GetAutoScaleGroup(ctx context.Context, groupId string, params *GetAutoScaleGroupParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAutoScaleGroups

func (c *Client) GetAutoScaleGroups(ctx context.Context, params *GetAutoScaleGroupsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAvailableIntegrations

func (c *Client) GetAvailableIntegrations(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAvailableIps

func (c *Client) GetAvailableIps(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBillingMethod

func (c *Client) GetBillingMethod(ctx context.Context, methodId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBillingMethods

func (c *Client) GetBillingMethods(ctx context.Context, params *GetBillingMethodsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBillingOrder

func (c *Client) GetBillingOrder(ctx context.Context, orderId string, params *GetBillingOrderParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBillingOverages

func (c *Client) GetBillingOverages(ctx context.Context, params *GetBillingOveragesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBillingService

func (c *Client) GetBillingService(ctx context.Context, servicesId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBillingServices

func (c *Client) GetBillingServices(ctx context.Context, params *GetBillingServicesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBillingStatus added in v0.6.2

func (c *Client) GetBillingStatus(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBillingSupportPlans

func (c *Client) GetBillingSupportPlans(ctx context.Context, params *GetBillingSupportPlansParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBillingTiers

func (c *Client) GetBillingTiers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetChangelog added in v0.6.4

func (c *Client) GetChangelog(ctx context.Context, params *GetChangelogParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCluster

func (c *Client) GetCluster(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetClusterMonitoringTiers added in v0.6.3

func (c *Client) GetClusterMonitoringTiers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetClusters

func (c *Client) GetClusters(ctx context.Context, params *GetClustersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCompatibleImages

func (c *Client) GetCompatibleImages(ctx context.Context, containerId string, params *GetCompatibleImagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCompatibleServers

func (c *Client) GetCompatibleServers(ctx context.Context, containerId string, params *GetCompatibleServersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetContainer

func (c *Client) GetContainer(ctx context.Context, containerId string, params *GetContainerParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetContainerBackup

func (c *Client) GetContainerBackup(ctx context.Context, containerId string, backupId string, params *GetContainerBackupParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetContainerBackupLogs

func (c *Client) GetContainerBackupLogs(ctx context.Context, containerId string, backupId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetContainerBackups

func (c *Client) GetContainerBackups(ctx context.Context, containerId string, params *GetContainerBackupsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetContainerServers

func (c *Client) GetContainerServers(ctx context.Context, containerId string, params *GetContainerServersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetContainerSummary

func (c *Client) GetContainerSummary(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetContainers

func (c *Client) GetContainers(ctx context.Context, params *GetContainersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCredit

func (c *Client) GetCredit(ctx context.Context, creditsId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCredits

func (c *Client) GetCredits(ctx context.Context, params *GetCreditsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDNSZone

func (c *Client) GetDNSZone(ctx context.Context, zoneId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDNSZoneRecords

func (c *Client) GetDNSZoneRecords(ctx context.Context, zoneId string, params *GetDNSZoneRecordsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDNSZones

func (c *Client) GetDNSZones(ctx context.Context, params *GetDNSZonesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDefaultHubRoles

func (c *Client) GetDefaultHubRoles(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDeploymentStrategies

func (c *Client) GetDeploymentStrategies(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetEnvironment

func (c *Client) GetEnvironment(ctx context.Context, environmentId string, params *GetEnvironmentParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetEnvironmentDeployments

func (c *Client) GetEnvironmentDeployments(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetEnvironmentSummary

func (c *Client) GetEnvironmentSummary(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetEnvironments

func (c *Client) GetEnvironments(ctx context.Context, params *GetEnvironmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetEvents

func (c *Client) GetEvents(ctx context.Context, params *GetEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetExternalVolume added in v0.6.5

func (c *Client) GetExternalVolume(ctx context.Context, externalVolumeId string, params *GetExternalVolumeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetExternalVolumeSources added in v0.6.5

func (c *Client) GetExternalVolumeSources(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetExternalVolumes added in v0.6.5

func (c *Client) GetExternalVolumes(ctx context.Context, params *GetExternalVolumesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHub

func (c *Client) GetHub(ctx context.Context, params *GetHubParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHubActivity

func (c *Client) GetHubActivity(ctx context.Context, params *GetHubActivityParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHubCapabilities

func (c *Client) GetHubCapabilities(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHubInvites

func (c *Client) GetHubInvites(ctx context.Context, params *GetHubInvitesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHubMember

func (c *Client) GetHubMember(ctx context.Context, memberId string, params *GetHubMemberParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHubMemberAccount

func (c *Client) GetHubMemberAccount(ctx context.Context, accountId string, params *GetHubMemberAccountParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHubMembers

func (c *Client) GetHubMembers(ctx context.Context, params *GetHubMembersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHubMembership

func (c *Client) GetHubMembership(ctx context.Context, params *GetHubMembershipParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHubNotificationSocketAuth

func (c *Client) GetHubNotificationSocketAuth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHubUsage

func (c *Client) GetHubUsage(ctx context.Context, params *GetHubUsageParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHubs

func (c *Client) GetHubs(ctx context.Context, params *GetHubsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetIPPool

func (c *Client) GetIPPool(ctx context.Context, poolId string, params *GetIPPoolParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetImage

func (c *Client) GetImage(ctx context.Context, imageId string, params *GetImageParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetImageBuildLog

func (c *Client) GetImageBuildLog(ctx context.Context, imageId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetImageSource

func (c *Client) GetImageSource(ctx context.Context, sourceId string, params *GetImageSourceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetImageSources

func (c *Client) GetImageSources(ctx context.Context, params *GetImageSourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetImages

func (c *Client) GetImages(ctx context.Context, params *GetImagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInfrastructureSummary

func (c *Client) GetInfrastructureSummary(ctx context.Context, params *GetInfrastructureSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInstance

func (c *Client) GetInstance(ctx context.Context, containerId string, instanceId string, params *GetInstanceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInstanceConsoleStreamAuth

func (c *Client) GetInstanceConsoleStreamAuth(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInstanceTelemetryReport

func (c *Client) GetInstanceTelemetryReport(ctx context.Context, containerId string, instanceId string, params *GetInstanceTelemetryReportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInstanceTelemetryStreamAuth

func (c *Client) GetInstanceTelemetryStreamAuth(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInstanceVolumes

func (c *Client) GetInstanceVolumes(ctx context.Context, containerId string, instanceId string, params *GetInstanceVolumesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInstances

func (c *Client) GetInstances(ctx context.Context, containerId string, params *GetInstancesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetIntegration

func (c *Client) GetIntegration(ctx context.Context, integrationId string, params *GetIntegrationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetIntegrations

func (c *Client) GetIntegrations(ctx context.Context, params *GetIntegrationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInvoice

func (c *Client) GetInvoice(ctx context.Context, invoiceId string, params *GetInvoiceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInvoices

func (c *Client) GetInvoices(ctx context.Context, params *GetInvoicesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetIpPools added in v0.6.3

func (c *Client) GetIpPools(ctx context.Context, params *GetIpPoolsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetJob

func (c *Client) GetJob(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetJobs

func (c *Client) GetJobs(ctx context.Context, params *GetJobsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetLatestJobs

func (c *Client) GetLatestJobs(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetLoadBalancerLatestTelemetryReport

func (c *Client) GetLoadBalancerLatestTelemetryReport(ctx context.Context, environmentId string, params *GetLoadBalancerLatestTelemetryReportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetLoadBalancerService

func (c *Client) GetLoadBalancerService(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetLoadBalancerTelemetryLatestControllers

func (c *Client) GetLoadBalancerTelemetryLatestControllers(ctx context.Context, environmentId string, params *GetLoadBalancerTelemetryLatestControllersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetLoadBalancerTelemetryReport

func (c *Client) GetLoadBalancerTelemetryReport(ctx context.Context, environmentId string, params *GetLoadBalancerTelemetryReportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetMetrics

func (c *Client) GetMetrics(ctx context.Context, params *GetMetricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetMonitoringMonitors

func (c *Client) GetMonitoringMonitors(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetNetwork

func (c *Client) GetNetwork(ctx context.Context, networkId string, params *GetNetworkParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetNetworks

func (c *Client) GetNetworks(ctx context.Context, params *GetNetworksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetOrders

func (c *Client) GetOrders(ctx context.Context, params *GetOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetPipeline

func (c *Client) GetPipeline(ctx context.Context, pipelineId string, params *GetPipelineParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetPipelineRun

func (c *Client) GetPipelineRun(ctx context.Context, pipelineId string, runId string, params *GetPipelineRunParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetPipelineRuns

func (c *Client) GetPipelineRuns(ctx context.Context, pipelineId string, params *GetPipelineRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetPipelineTriggerKey

func (c *Client) GetPipelineTriggerKey(ctx context.Context, pipelineId string, triggerKeyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetPipelineTriggerKeys

func (c *Client) GetPipelineTriggerKeys(ctx context.Context, pipelineId string, params *GetPipelineTriggerKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetPipelines

func (c *Client) GetPipelines(ctx context.Context, params *GetPipelinesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetPoolIPs

func (c *Client) GetPoolIPs(ctx context.Context, poolId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetProviderLocations

func (c *Client) GetProviderLocations(ctx context.Context, integrationId string, params *GetProviderLocationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetProviderServerModels added in v0.6.6

func (c *Client) GetProviderServerModels(ctx context.Context, integrationId string, params *GetProviderServerModelsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRole

func (c *Client) GetRole(ctx context.Context, roleId string, params *GetRoleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRoles

func (c *Client) GetRoles(ctx context.Context, params *GetRolesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetScopedVariable

func (c *Client) GetScopedVariable(ctx context.Context, environmentId string, scopedVariableId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetScopedVariables

func (c *Client) GetScopedVariables(ctx context.Context, environmentId string, params *GetScopedVariablesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSearchIndex

func (c *Client) GetSearchIndex(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetServer

func (c *Client) GetServer(ctx context.Context, serverId string, params *GetServerParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetServerConsole

func (c *Client) GetServerConsole(ctx context.Context, serverId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetServerInstances

func (c *Client) GetServerInstances(ctx context.Context, serverId string, params *GetServerInstancesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetServerTags

func (c *Client) GetServerTags(ctx context.Context, params *GetServerTagsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetServerTelemetry

func (c *Client) GetServerTelemetry(ctx context.Context, serverId string, params *GetServerTelemetryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetServerUsage

func (c *Client) GetServerUsage(ctx context.Context, serverId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetServers

func (c *Client) GetServers(ctx context.Context, params *GetServersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetStack

func (c *Client) GetStack(ctx context.Context, stackId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetStackBuild

func (c *Client) GetStackBuild(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetStackBuildLog

func (c *Client) GetStackBuildLog(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetStackBuilds

func (c *Client) GetStackBuilds(ctx context.Context, stackId string, params *GetStackBuildsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetStacks

func (c *Client) GetStacks(ctx context.Context, params *GetStacksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTLSGenerationAttempts

func (c *Client) GetTLSGenerationAttempts(ctx context.Context, params *GetTLSGenerationAttemptsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTwoFactorAuthSetup

func (c *Client) GetTwoFactorAuthSetup(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetUserSuppliedCertificate

func (c *Client) GetUserSuppliedCertificate(ctx context.Context, certificateId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetUserSuppliedCertificates

func (c *Client) GetUserSuppliedCertificates(ctx context.Context, params *GetUserSuppliedCertificatesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVPNLogins

func (c *Client) GetVPNLogins(ctx context.Context, environmentId string, params *GetVPNLoginsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVPNService

func (c *Client) GetVPNService(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVPNUsers

func (c *Client) GetVPNUsers(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVirtualMachine

func (c *Client) GetVirtualMachine(ctx context.Context, virtualMachineId string, params *GetVirtualMachineParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVirtualMachineBaseImages

func (c *Client) GetVirtualMachineBaseImages(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVirtualMachineSshKey

func (c *Client) GetVirtualMachineSshKey(ctx context.Context, sshKeyId string, params *GetVirtualMachineSshKeyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVirtualMachineSshKeys

func (c *Client) GetVirtualMachineSshKeys(ctx context.Context, params *GetVirtualMachineSshKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVirtualMachines

func (c *Client) GetVirtualMachines(ctx context.Context, params *GetVirtualMachinesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVirtualProviderIso added in v0.6.3

func (c *Client) GetVirtualProviderIso(ctx context.Context, integrationId string, isoId string, params *GetVirtualProviderIsoParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVirtualProviderIsoDownloadUrl added in v0.6.3

func (c *Client) GetVirtualProviderIsoDownloadUrl(ctx context.Context, integrationId string, isoId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetVirtualProviderIsos added in v0.6.3

func (c *Client) GetVirtualProviderIsos(ctx context.Context, integrationId string, params *GetVirtualProviderIsosParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LookupComponents

func (c *Client) LookupComponents(ctx context.Context, body LookupComponentsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LookupComponentsWithBody

func (c *Client) LookupComponentsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LookupIdentifier

func (c *Client) LookupIdentifier(ctx context.Context, params *LookupIdentifierParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LookupStackBuild

func (c *Client) LookupStackBuild(ctx context.Context, buildId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LookupTLSCertificate

func (c *Client) LookupTLSCertificate(ctx context.Context, params *LookupTLSCertificateParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RecoverTwoFactorAuth

func (c *Client) RecoverTwoFactorAuth(ctx context.Context, body RecoverTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RecoverTwoFactorAuthWithBody

func (c *Client) RecoverTwoFactorAuthWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ResetPassword

func (c *Client) ResetPassword(ctx context.Context, body ResetPasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ResetPasswordWithBody

func (c *Client) ResetPasswordWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) TriggerPipeline

func (c *Client) TriggerPipeline(ctx context.Context, pipelineId string, body TriggerPipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) TriggerPipelineWithBody

func (c *Client) TriggerPipelineWithBody(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAPIKey

func (c *Client) UpdateAPIKey(ctx context.Context, apikeyId string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAPIKeyWithBody

func (c *Client) UpdateAPIKeyWithBody(ctx context.Context, apikeyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAccount

func (c *Client) UpdateAccount(ctx context.Context, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAccountInvite

func (c *Client) UpdateAccountInvite(ctx context.Context, inviteId string, params *UpdateAccountInviteParams, body UpdateAccountInviteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAccountInviteWithBody

func (c *Client) UpdateAccountInviteWithBody(ctx context.Context, inviteId string, params *UpdateAccountInviteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAccountWithBody

func (c *Client) UpdateAccountWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAutoScaleGroup

func (c *Client) UpdateAutoScaleGroup(ctx context.Context, groupId string, body UpdateAutoScaleGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAutoScaleGroupAccess

func (c *Client) UpdateAutoScaleGroupAccess(ctx context.Context, groupId string, body UpdateAutoScaleGroupAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAutoScaleGroupAccessWithBody

func (c *Client) UpdateAutoScaleGroupAccessWithBody(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAutoScaleGroupWithBody

func (c *Client) UpdateAutoScaleGroupWithBody(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateBillingMethod

func (c *Client) UpdateBillingMethod(ctx context.Context, methodId string, body UpdateBillingMethodJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateBillingMethodWithBody

func (c *Client) UpdateBillingMethodWithBody(ctx context.Context, methodId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateBillingOrder

func (c *Client) UpdateBillingOrder(ctx context.Context, orderId string, params *UpdateBillingOrderParams, body UpdateBillingOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateBillingOrderWithBody

func (c *Client) UpdateBillingOrderWithBody(ctx context.Context, orderId string, params *UpdateBillingOrderParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateCluster

func (c *Client) UpdateCluster(ctx context.Context, clusterId string, body UpdateClusterJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateClusterAccess

func (c *Client) UpdateClusterAccess(ctx context.Context, clusterId string, body UpdateClusterAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateClusterAccessWithBody

func (c *Client) UpdateClusterAccessWithBody(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateClusterWithBody

func (c *Client) UpdateClusterWithBody(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateContainer

func (c *Client) UpdateContainer(ctx context.Context, containerId string, body UpdateContainerJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateContainerWithBody

func (c *Client) UpdateContainerWithBody(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDNSZone

func (c *Client) UpdateDNSZone(ctx context.Context, zoneId string, params *UpdateDNSZoneParams, body UpdateDNSZoneJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDNSZoneAccess

func (c *Client) UpdateDNSZoneAccess(ctx context.Context, zoneId string, params *UpdateDNSZoneAccessParams, body UpdateDNSZoneAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDNSZoneAccessWithBody

func (c *Client) UpdateDNSZoneAccessWithBody(ctx context.Context, zoneId string, params *UpdateDNSZoneAccessParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDNSZoneRecord

func (c *Client) UpdateDNSZoneRecord(ctx context.Context, zoneId string, recordId string, params *UpdateDNSZoneRecordParams, body UpdateDNSZoneRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDNSZoneRecordWithBody

func (c *Client) UpdateDNSZoneRecordWithBody(ctx context.Context, zoneId string, recordId string, params *UpdateDNSZoneRecordParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDNSZoneWithBody

func (c *Client) UpdateDNSZoneWithBody(ctx context.Context, zoneId string, params *UpdateDNSZoneParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateEnvironment

func (c *Client) UpdateEnvironment(ctx context.Context, environmentId string, body UpdateEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateEnvironmentAccess

func (c *Client) UpdateEnvironmentAccess(ctx context.Context, environmentId string, body UpdateEnvironmentAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateEnvironmentAccessWithBody

func (c *Client) UpdateEnvironmentAccessWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateEnvironmentWithBody

func (c *Client) UpdateEnvironmentWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateExternalVolume added in v0.6.5

func (c *Client) UpdateExternalVolume(ctx context.Context, externalVolumeId string, params *UpdateExternalVolumeParams, body UpdateExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateExternalVolumeAccess added in v0.6.5

func (c *Client) UpdateExternalVolumeAccess(ctx context.Context, externalVolumeId string, body UpdateExternalVolumeAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateExternalVolumeAccessWithBody added in v0.6.5

func (c *Client) UpdateExternalVolumeAccessWithBody(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateExternalVolumeWithBody added in v0.6.5

func (c *Client) UpdateExternalVolumeWithBody(ctx context.Context, externalVolumeId string, params *UpdateExternalVolumeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateHub

func (c *Client) UpdateHub(ctx context.Context, body UpdateHubJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateHubMember

func (c *Client) UpdateHubMember(ctx context.Context, memberId string, body UpdateHubMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateHubMemberWithBody

func (c *Client) UpdateHubMemberWithBody(ctx context.Context, memberId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateHubWithBody

func (c *Client) UpdateHubWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateImage

func (c *Client) UpdateImage(ctx context.Context, imageId string, body UpdateImageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateImageSource

func (c *Client) UpdateImageSource(ctx context.Context, sourceId string, body UpdateImageSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateImageSourceAccess

func (c *Client) UpdateImageSourceAccess(ctx context.Context, sourceId string, body UpdateImageSourceAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateImageSourceAccessWithBody

func (c *Client) UpdateImageSourceAccessWithBody(ctx context.Context, sourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateImageSourceWithBody

func (c *Client) UpdateImageSourceWithBody(ctx context.Context, sourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateImageWithBody

func (c *Client) UpdateImageWithBody(ctx context.Context, imageId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateIntegration

func (c *Client) UpdateIntegration(ctx context.Context, integrationId string, params *UpdateIntegrationParams, body UpdateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateIntegrationWithBody

func (c *Client) UpdateIntegrationWithBody(ctx context.Context, integrationId string, params *UpdateIntegrationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateNetwork

func (c *Client) UpdateNetwork(ctx context.Context, networkId string, params *UpdateNetworkParams, body UpdateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateNetworkAccess

func (c *Client) UpdateNetworkAccess(ctx context.Context, networkId string, params *UpdateNetworkAccessParams, body UpdateNetworkAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateNetworkAccessWithBody

func (c *Client) UpdateNetworkAccessWithBody(ctx context.Context, networkId string, params *UpdateNetworkAccessParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateNetworkWithBody

func (c *Client) UpdateNetworkWithBody(ctx context.Context, networkId string, params *UpdateNetworkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdatePipeline

func (c *Client) UpdatePipeline(ctx context.Context, pipelineId string, body UpdatePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdatePipelineAccess

func (c *Client) UpdatePipelineAccess(ctx context.Context, pipelineId string, body UpdatePipelineAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdatePipelineAccessWithBody

func (c *Client) UpdatePipelineAccessWithBody(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdatePipelineTriggerKey

func (c *Client) UpdatePipelineTriggerKey(ctx context.Context, pipelineId string, triggerKeyId string, body UpdatePipelineTriggerKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdatePipelineTriggerKeyWithBody

func (c *Client) UpdatePipelineTriggerKeyWithBody(ctx context.Context, pipelineId string, triggerKeyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdatePipelineWithBody

func (c *Client) UpdatePipelineWithBody(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateRole

func (c *Client) UpdateRole(ctx context.Context, roleId string, body UpdateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateRoleWithBody

func (c *Client) UpdateRoleWithBody(ctx context.Context, roleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateScopedVariable

func (c *Client) UpdateScopedVariable(ctx context.Context, environmentId string, scopedVariableId string, body UpdateScopedVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateScopedVariableWithBody

func (c *Client) UpdateScopedVariableWithBody(ctx context.Context, environmentId string, scopedVariableId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateServer

func (c *Client) UpdateServer(ctx context.Context, serverId string, body UpdateServerJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateServerWithBody

func (c *Client) UpdateServerWithBody(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateStack

func (c *Client) UpdateStack(ctx context.Context, stackId string, body UpdateStackJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateStackAccess

func (c *Client) UpdateStackAccess(ctx context.Context, stackId string, body UpdateStackAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateStackAccessWithBody

func (c *Client) UpdateStackAccessWithBody(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateStackWithBody

func (c *Client) UpdateStackWithBody(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateVirtualMachine

func (c *Client) UpdateVirtualMachine(ctx context.Context, virtualMachineId string, body UpdateVirtualMachineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateVirtualMachineSshKey

func (c *Client) UpdateVirtualMachineSshKey(ctx context.Context, sshKeyId string, params *UpdateVirtualMachineSshKeyParams, body UpdateVirtualMachineSshKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateVirtualMachineSshKeyWithBody

func (c *Client) UpdateVirtualMachineSshKeyWithBody(ctx context.Context, sshKeyId string, params *UpdateVirtualMachineSshKeyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateVirtualMachineWithBody

func (c *Client) UpdateVirtualMachineWithBody(ctx context.Context, virtualMachineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateVirtualProviderIso added in v0.6.3

func (c *Client) UpdateVirtualProviderIso(ctx context.Context, integrationId string, isoId string, body UpdateVirtualProviderIsoJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateVirtualProviderIsoWithBody added in v0.6.3

func (c *Client) UpdateVirtualProviderIsoWithBody(ctx context.Context, integrationId string, isoId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UploadUserSuppliedCertificate

func (c *Client) UploadUserSuppliedCertificate(ctx context.Context, body UploadUserSuppliedCertificateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UploadUserSuppliedCertificateWithBody

func (c *Client) UploadUserSuppliedCertificateWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientConfig

type ClientConfig struct {
	APIKey  string
	HubID   string
	BaseURL *string
}

type ClientInterface

type ClientInterface interface {
	// DeleteAccount request
	DeleteAccount(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAccount request
	GetAccount(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateAccountWithBody request with any body
	UpdateAccountWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateAccount(ctx context.Context, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DisableTwoFactorAuthWithBody request with any body
	DisableTwoFactorAuthWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	DisableTwoFactorAuth(ctx context.Context, body DisableTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RecoverTwoFactorAuthWithBody request with any body
	RecoverTwoFactorAuthWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RecoverTwoFactorAuth(ctx context.Context, body RecoverTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTwoFactorAuthSetup request
	GetTwoFactorAuthSetup(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EnableTwoFactorAuthWithBody request with any body
	EnableTwoFactorAuthWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	EnableTwoFactorAuth(ctx context.Context, body EnableTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAccountInvites request
	GetAccountInvites(ctx context.Context, params *GetAccountInvitesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateAccountInviteWithBody request with any body
	UpdateAccountInviteWithBody(ctx context.Context, inviteId string, params *UpdateAccountInviteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateAccountInvite(ctx context.Context, inviteId string, params *UpdateAccountInviteParams, body UpdateAccountInviteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAccountLogins request
	GetAccountLogins(ctx context.Context, params *GetAccountLoginsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAccountMemberships request
	GetAccountMemberships(ctx context.Context, params *GetAccountMembershipsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ChangePasswordWithBody request with any body
	ChangePasswordWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ChangePassword(ctx context.Context, body ChangePasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ResetPasswordWithBody request with any body
	ResetPasswordWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ResetPassword(ctx context.Context, body ResetPasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAnnouncements request
	GetAnnouncements(ctx context.Context, params *GetAnnouncementsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCredits request
	GetCredits(ctx context.Context, params *GetCreditsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCredit request
	GetCredit(ctx context.Context, creditsId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInvoices request
	GetInvoices(ctx context.Context, params *GetInvoicesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInvoice request
	GetInvoice(ctx context.Context, invoiceId string, params *GetInvoiceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateInvoiceJobWithBody request with any body
	CreateInvoiceJobWithBody(ctx context.Context, invoiceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateInvoiceJob(ctx context.Context, invoiceId string, body CreateInvoiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBillingMethods request
	GetBillingMethods(ctx context.Context, params *GetBillingMethodsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateBillingMethodWithBody request with any body
	CreateBillingMethodWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateBillingMethod(ctx context.Context, body CreateBillingMethodJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteBillingMethod request
	DeleteBillingMethod(ctx context.Context, methodId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBillingMethod request
	GetBillingMethod(ctx context.Context, methodId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateBillingMethodWithBody request with any body
	UpdateBillingMethodWithBody(ctx context.Context, methodId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateBillingMethod(ctx context.Context, methodId string, body UpdateBillingMethodJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateBillingMethodJobWithBody request with any body
	CreateBillingMethodJobWithBody(ctx context.Context, methodId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateBillingMethodJob(ctx context.Context, methodId string, body CreateBillingMethodJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrders request
	GetOrders(ctx context.Context, params *GetOrdersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateOrderWithBody request with any body
	CreateOrderWithBody(ctx context.Context, params *CreateOrderParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateOrder(ctx context.Context, params *CreateOrderParams, body CreateOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBillingOrder request
	GetBillingOrder(ctx context.Context, orderId string, params *GetBillingOrderParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateBillingOrderWithBody request with any body
	UpdateBillingOrderWithBody(ctx context.Context, orderId string, params *UpdateBillingOrderParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateBillingOrder(ctx context.Context, orderId string, params *UpdateBillingOrderParams, body UpdateBillingOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateOrderJobWithBody request with any body
	CreateOrderJobWithBody(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateOrderJob(ctx context.Context, orderId string, body CreateOrderJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBillingSupportPlans request
	GetBillingSupportPlans(ctx context.Context, params *GetBillingSupportPlansParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBillingTiers request
	GetBillingTiers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBillingServices request
	GetBillingServices(ctx context.Context, params *GetBillingServicesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBillingOverages request
	GetBillingOverages(ctx context.Context, params *GetBillingOveragesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBillingService request
	GetBillingService(ctx context.Context, servicesId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBillingStatus request
	GetBillingStatus(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetChangelog request
	GetChangelog(ctx context.Context, params *GetChangelogParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetContainers request
	GetContainers(ctx context.Context, params *GetContainersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateContainerWithBody request with any body
	CreateContainerWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateContainer(ctx context.Context, body CreateContainerJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteContainer request
	DeleteContainer(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetContainer request
	GetContainer(ctx context.Context, containerId string, params *GetContainerParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateContainerWithBody request with any body
	UpdateContainerWithBody(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateContainer(ctx context.Context, containerId string, body UpdateContainerJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetContainerBackups request
	GetContainerBackups(ctx context.Context, containerId string, params *GetContainerBackupsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteContainerBackup request
	DeleteContainerBackup(ctx context.Context, containerId string, backupId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetContainerBackup request
	GetContainerBackup(ctx context.Context, containerId string, backupId string, params *GetContainerBackupParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetContainerBackupLogs request
	GetContainerBackupLogs(ctx context.Context, containerId string, backupId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateContainerBackupJobWithBody request with any body
	CreateContainerBackupJobWithBody(ctx context.Context, containerId string, backupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateContainerBackupJob(ctx context.Context, containerId string, backupId string, body CreateContainerBackupJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCompatibleImages request
	GetCompatibleImages(ctx context.Context, containerId string, params *GetCompatibleImagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateFunctionJobWithBody request with any body
	CreateFunctionJobWithBody(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateFunctionJob(ctx context.Context, containerId string, body CreateFunctionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteContainerInstances request
	DeleteContainerInstances(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInstances request
	GetInstances(ctx context.Context, containerId string, params *GetInstancesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateInstancesWithBody request with any body
	CreateInstancesWithBody(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateInstances(ctx context.Context, containerId string, body CreateInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteInstance request
	DeleteInstance(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInstance request
	GetInstance(ctx context.Context, containerId string, instanceId string, params *GetInstanceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInstanceConsoleStreamAuth request
	GetInstanceConsoleStreamAuth(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExpireInstanceSSHCredentials request
	ExpireInstanceSSHCredentials(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GenerateInstanceSSHCredentials request
	GenerateInstanceSSHCredentials(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateInstanceJobWithBody request with any body
	CreateInstanceJobWithBody(ctx context.Context, containerId string, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateInstanceJob(ctx context.Context, containerId string, instanceId string, body CreateInstanceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInstanceTelemetryReport request
	GetInstanceTelemetryReport(ctx context.Context, containerId string, instanceId string, params *GetInstanceTelemetryReportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInstanceTelemetryStreamAuth request
	GetInstanceTelemetryStreamAuth(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInstanceVolumes request
	GetInstanceVolumes(ctx context.Context, containerId string, instanceId string, params *GetInstanceVolumesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetContainerServers request
	GetContainerServers(ctx context.Context, containerId string, params *GetContainerServersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCompatibleServers request
	GetCompatibleServers(ctx context.Context, containerId string, params *GetCompatibleServersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetContainerSummary request
	GetContainerSummary(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateContainerJobWithBody request with any body
	CreateContainerJobWithBody(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateContainerJob(ctx context.Context, containerId string, body CreateContainerJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTLSGenerationAttempts request
	GetTLSGenerationAttempts(ctx context.Context, params *GetTLSGenerationAttemptsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllTlsCertificates request
	GetAllTlsCertificates(ctx context.Context, params *GetAllTlsCertificatesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LookupTLSCertificate request
	LookupTLSCertificate(ctx context.Context, params *LookupTLSCertificateParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUserSuppliedCertificates request
	GetUserSuppliedCertificates(ctx context.Context, params *GetUserSuppliedCertificatesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UploadUserSuppliedCertificateWithBody request with any body
	UploadUserSuppliedCertificateWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UploadUserSuppliedCertificate(ctx context.Context, body UploadUserSuppliedCertificateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUserSuppliedCertificate request
	GetUserSuppliedCertificate(ctx context.Context, certificateId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateUserSuppliedCertificateJobWithBody request with any body
	CreateUserSuppliedCertificateJobWithBody(ctx context.Context, certificateId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateUserSuppliedCertificateJob(ctx context.Context, certificateId string, body CreateUserSuppliedCertificateJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDNSZones request
	GetDNSZones(ctx context.Context, params *GetDNSZonesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDNSZoneWithBody request with any body
	CreateDNSZoneWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDNSZone(ctx context.Context, body CreateDNSZoneJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteDNSZone request
	DeleteDNSZone(ctx context.Context, zoneId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDNSZone request
	GetDNSZone(ctx context.Context, zoneId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDNSZoneWithBody request with any body
	UpdateDNSZoneWithBody(ctx context.Context, zoneId string, params *UpdateDNSZoneParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateDNSZone(ctx context.Context, zoneId string, params *UpdateDNSZoneParams, body UpdateDNSZoneJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDNSZoneAccessWithBody request with any body
	UpdateDNSZoneAccessWithBody(ctx context.Context, zoneId string, params *UpdateDNSZoneAccessParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateDNSZoneAccess(ctx context.Context, zoneId string, params *UpdateDNSZoneAccessParams, body UpdateDNSZoneAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDNSZoneRecords request
	GetDNSZoneRecords(ctx context.Context, zoneId string, params *GetDNSZoneRecordsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDNSZoneRecordWithBody request with any body
	CreateDNSZoneRecordWithBody(ctx context.Context, zoneId string, params *CreateDNSZoneRecordParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDNSZoneRecord(ctx context.Context, zoneId string, params *CreateDNSZoneRecordParams, body CreateDNSZoneRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteDNSZoneRecord request
	DeleteDNSZoneRecord(ctx context.Context, zoneId string, recordId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDNSZoneRecordWithBody request with any body
	UpdateDNSZoneRecordWithBody(ctx context.Context, zoneId string, recordId string, params *UpdateDNSZoneRecordParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateDNSZoneRecord(ctx context.Context, zoneId string, recordId string, params *UpdateDNSZoneRecordParams, body UpdateDNSZoneRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDNSZoneRecordJobWithBody request with any body
	CreateDNSZoneRecordJobWithBody(ctx context.Context, zoneId string, recordId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDNSZoneRecordJob(ctx context.Context, zoneId string, recordId string, body CreateDNSZoneRecordJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDNSZoneJobWithBody request with any body
	CreateDNSZoneJobWithBody(ctx context.Context, zoneId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDNSZoneJob(ctx context.Context, zoneId string, body CreateDNSZoneJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEnvironments request
	GetEnvironments(ctx context.Context, params *GetEnvironmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateEnvironmentWithBody request with any body
	CreateEnvironmentWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateEnvironment(ctx context.Context, body CreateEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteEnvironment request
	DeleteEnvironment(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEnvironment request
	GetEnvironment(ctx context.Context, environmentId string, params *GetEnvironmentParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateEnvironmentWithBody request with any body
	UpdateEnvironmentWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateEnvironment(ctx context.Context, environmentId string, body UpdateEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateEnvironmentAccessWithBody request with any body
	UpdateEnvironmentAccessWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateEnvironmentAccess(ctx context.Context, environmentId string, body UpdateEnvironmentAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEnvironmentDeployments request
	GetEnvironmentDeployments(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExportStackWithBody request with any body
	ExportStackWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ExportStack(ctx context.Context, environmentId string, body ExportStackJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetScopedVariables request
	GetScopedVariables(ctx context.Context, environmentId string, params *GetScopedVariablesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateScopedVariableWithBody request with any body
	CreateScopedVariableWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateScopedVariable(ctx context.Context, environmentId string, body CreateScopedVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteScopedVariable request
	DeleteScopedVariable(ctx context.Context, environmentId string, scopedVariableId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetScopedVariable request
	GetScopedVariable(ctx context.Context, environmentId string, scopedVariableId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateScopedVariableWithBody request with any body
	UpdateScopedVariableWithBody(ctx context.Context, environmentId string, scopedVariableId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateScopedVariable(ctx context.Context, environmentId string, scopedVariableId string, body UpdateScopedVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDiscoveryServiceJobWithBody request with any body
	CreateDiscoveryServiceJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDiscoveryServiceJob(ctx context.Context, environmentId string, body CreateDiscoveryServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateGatewayServiceJobWithBody request with any body
	CreateGatewayServiceJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateGatewayServiceJob(ctx context.Context, environmentId string, body CreateGatewayServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLoadBalancerService request
	GetLoadBalancerService(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateLoadBalancerServiceJobWithBody request with any body
	CreateLoadBalancerServiceJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateLoadBalancerServiceJob(ctx context.Context, environmentId string, body CreateLoadBalancerServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLoadBalancerLatestTelemetryReport request
	GetLoadBalancerLatestTelemetryReport(ctx context.Context, environmentId string, params *GetLoadBalancerLatestTelemetryReportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLoadBalancerTelemetryLatestControllers request
	GetLoadBalancerTelemetryLatestControllers(ctx context.Context, environmentId string, params *GetLoadBalancerTelemetryLatestControllersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLoadBalancerTelemetryReport request
	GetLoadBalancerTelemetryReport(ctx context.Context, environmentId string, params *GetLoadBalancerTelemetryReportParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateSchedulerServiceJobWithBody request with any body
	CreateSchedulerServiceJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateSchedulerServiceJob(ctx context.Context, environmentId string, body CreateSchedulerServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVPNService request
	GetVPNService(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVPNLogins request
	GetVPNLogins(ctx context.Context, environmentId string, params *GetVPNLoginsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVPNServiceJobWithBody request with any body
	CreateVPNServiceJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateVPNServiceJob(ctx context.Context, environmentId string, body CreateVPNServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVPNUsers request
	GetVPNUsers(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVPNUserWithBody request with any body
	CreateVPNUserWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateVPNUser(ctx context.Context, environmentId string, body CreateVPNUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteVPNUser request
	DeleteVPNUser(ctx context.Context, environmentId string, userId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEnvironmentSummary request
	GetEnvironmentSummary(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateEnvironmentJobWithBody request with any body
	CreateEnvironmentJobWithBody(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateEnvironmentJob(ctx context.Context, environmentId string, body CreateEnvironmentJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHubs request
	GetHubs(ctx context.Context, params *GetHubsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateHubWithBody request with any body
	CreateHubWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateHub(ctx context.Context, body CreateHubJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHubCapabilities request
	GetHubCapabilities(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteHubWithBody request with any body
	DeleteHubWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	DeleteHub(ctx context.Context, body DeleteHubJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHub request
	GetHub(ctx context.Context, params *GetHubParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateHubWithBody request with any body
	UpdateHubWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateHub(ctx context.Context, body UpdateHubJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHubActivity request
	GetHubActivity(ctx context.Context, params *GetHubActivityParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiKeys request
	GetApiKeys(ctx context.Context, params *GetApiKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateApiKeyWithBody request with any body
	CreateApiKeyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateApiKey(ctx context.Context, body CreateApiKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteAPIKey request
	DeleteAPIKey(ctx context.Context, apikeyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAPIKey request
	GetAPIKey(ctx context.Context, apikeyId string, params *GetAPIKeyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateAPIKeyWithBody request with any body
	UpdateAPIKeyWithBody(ctx context.Context, apikeyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateAPIKey(ctx context.Context, apikeyId string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIntegrations request
	GetIntegrations(ctx context.Context, params *GetIntegrationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateIntegrationWithBody request with any body
	CreateIntegrationWithBody(ctx context.Context, params *CreateIntegrationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateIntegration(ctx context.Context, params *CreateIntegrationParams, body CreateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAvailableIntegrations request
	GetAvailableIntegrations(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteIntegration request
	DeleteIntegration(ctx context.Context, integrationId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIntegration request
	GetIntegration(ctx context.Context, integrationId string, params *GetIntegrationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateIntegrationWithBody request with any body
	UpdateIntegrationWithBody(ctx context.Context, integrationId string, params *UpdateIntegrationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateIntegration(ctx context.Context, integrationId string, params *UpdateIntegrationParams, body UpdateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateIntegrationJobWithBody request with any body
	CreateIntegrationJobWithBody(ctx context.Context, integrationId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateIntegrationJob(ctx context.Context, integrationId string, body CreateIntegrationJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHubInvites request
	GetHubInvites(ctx context.Context, params *GetHubInvitesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateHubInviteWithBody request with any body
	CreateHubInviteWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateHubInvite(ctx context.Context, body CreateHubInviteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteHubInvite request
	DeleteHubInvite(ctx context.Context, inviteId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHubMembers request
	GetHubMembers(ctx context.Context, params *GetHubMembersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHubMemberAccount request
	GetHubMemberAccount(ctx context.Context, accountId string, params *GetHubMemberAccountParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteHubMember request
	DeleteHubMember(ctx context.Context, memberId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHubMember request
	GetHubMember(ctx context.Context, memberId string, params *GetHubMemberParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateHubMemberWithBody request with any body
	UpdateHubMemberWithBody(ctx context.Context, memberId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateHubMember(ctx context.Context, memberId string, body UpdateHubMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHubMembership request
	GetHubMembership(ctx context.Context, params *GetHubMembershipParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHubNotificationSocketAuth request
	GetHubNotificationSocketAuth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRoles request
	GetRoles(ctx context.Context, params *GetRolesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRoleWithBody request with any body
	CreateRoleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateRole(ctx context.Context, body CreateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDefaultHubRoles request
	GetDefaultHubRoles(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteRole request
	DeleteRole(ctx context.Context, roleId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRole request
	GetRole(ctx context.Context, roleId string, params *GetRoleParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateRoleWithBody request with any body
	UpdateRoleWithBody(ctx context.Context, roleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateRole(ctx context.Context, roleId string, body UpdateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHubUsage request
	GetHubUsage(ctx context.Context, params *GetHubUsageParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetImages request
	GetImages(ctx context.Context, params *GetImagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateImageWithBody request with any body
	CreateImageWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateImage(ctx context.Context, body CreateImageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetImageSources request
	GetImageSources(ctx context.Context, params *GetImageSourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateImageSourceWithBody request with any body
	CreateImageSourceWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateImageSource(ctx context.Context, body CreateImageSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteImageSource request
	DeleteImageSource(ctx context.Context, sourceId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetImageSource request
	GetImageSource(ctx context.Context, sourceId string, params *GetImageSourceParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateImageSourceWithBody request with any body
	UpdateImageSourceWithBody(ctx context.Context, sourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateImageSource(ctx context.Context, sourceId string, body UpdateImageSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateImageSourceAccessWithBody request with any body
	UpdateImageSourceAccessWithBody(ctx context.Context, sourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateImageSourceAccess(ctx context.Context, sourceId string, body UpdateImageSourceAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateImagesJobWithBody request with any body
	CreateImagesJobWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateImagesJob(ctx context.Context, body CreateImagesJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteImage request
	DeleteImage(ctx context.Context, imageId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetImage request
	GetImage(ctx context.Context, imageId string, params *GetImageParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateImageWithBody request with any body
	UpdateImageWithBody(ctx context.Context, imageId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateImage(ctx context.Context, imageId string, body UpdateImageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetImageBuildLog request
	GetImageBuildLog(ctx context.Context, imageId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateImageJobWithBody request with any body
	CreateImageJobWithBody(ctx context.Context, imageId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateImageJob(ctx context.Context, imageId string, body CreateImageJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAutoScaleGroups request
	GetAutoScaleGroups(ctx context.Context, params *GetAutoScaleGroupsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateAutoScaleGroupWithBody request with any body
	CreateAutoScaleGroupWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateAutoScaleGroup(ctx context.Context, body CreateAutoScaleGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteAutoScaleGroup request
	DeleteAutoScaleGroup(ctx context.Context, groupId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAutoScaleGroup request
	GetAutoScaleGroup(ctx context.Context, groupId string, params *GetAutoScaleGroupParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateAutoScaleGroupWithBody request with any body
	UpdateAutoScaleGroupWithBody(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateAutoScaleGroup(ctx context.Context, groupId string, body UpdateAutoScaleGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateAutoScaleGroupAccessWithBody request with any body
	UpdateAutoScaleGroupAccessWithBody(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateAutoScaleGroupAccess(ctx context.Context, groupId string, body UpdateAutoScaleGroupAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetClusters request
	GetClusters(ctx context.Context, params *GetClustersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateClusterWithBody request with any body
	CreateClusterWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateCluster(ctx context.Context, body CreateClusterJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteCluster request
	DeleteCluster(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCluster request
	GetCluster(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateClusterWithBody request with any body
	UpdateClusterWithBody(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateCluster(ctx context.Context, clusterId string, body UpdateClusterJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateClusterAccessWithBody request with any body
	UpdateClusterAccessWithBody(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateClusterAccess(ctx context.Context, clusterId string, body UpdateClusterAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateClusterJobWithBody request with any body
	CreateClusterJobWithBody(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateClusterJob(ctx context.Context, clusterId string, body CreateClusterJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDeploymentStrategies request
	GetDeploymentStrategies(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetExternalVolumes request
	GetExternalVolumes(ctx context.Context, params *GetExternalVolumesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateExternalVolumeWithBody request with any body
	CreateExternalVolumeWithBody(ctx context.Context, params *CreateExternalVolumeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateExternalVolume(ctx context.Context, params *CreateExternalVolumeParams, body CreateExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetExternalVolumeSources request
	GetExternalVolumeSources(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateExternalVolumesJobWithBody request with any body
	CreateExternalVolumesJobWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateExternalVolumesJob(ctx context.Context, body CreateExternalVolumesJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteExternalVolumeWithBody request with any body
	DeleteExternalVolumeWithBody(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	DeleteExternalVolume(ctx context.Context, externalVolumeId string, body DeleteExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetExternalVolume request
	GetExternalVolume(ctx context.Context, externalVolumeId string, params *GetExternalVolumeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateExternalVolumeWithBody request with any body
	UpdateExternalVolumeWithBody(ctx context.Context, externalVolumeId string, params *UpdateExternalVolumeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateExternalVolume(ctx context.Context, externalVolumeId string, params *UpdateExternalVolumeParams, body UpdateExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateExternalVolumeAccessWithBody request with any body
	UpdateExternalVolumeAccessWithBody(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateExternalVolumeAccess(ctx context.Context, externalVolumeId string, body UpdateExternalVolumeAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateExternalVolumeJobWithBody request with any body
	CreateExternalVolumeJobWithBody(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateExternalVolumeJob(ctx context.Context, externalVolumeId string, body CreateExternalVolumeJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIpPools request
	GetIpPools(ctx context.Context, params *GetIpPoolsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateIpPoolWithBody request with any body
	CreateIpPoolWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateIpPool(ctx context.Context, body CreateIpPoolJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteIPPool request
	DeleteIPPool(ctx context.Context, poolId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIPPool request
	GetIPPool(ctx context.Context, poolId string, params *GetIPPoolParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPoolIPs request
	GetPoolIPs(ctx context.Context, poolId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateIpPoolJobWithBody request with any body
	CreateIpPoolJobWithBody(ctx context.Context, poolId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateIpPoolJob(ctx context.Context, poolId string, body CreateIpPoolJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetClusterMonitoringTiers request
	GetClusterMonitoringTiers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetProviderLocations request
	GetProviderLocations(ctx context.Context, integrationId string, params *GetProviderLocationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetProviderServerModels request
	GetProviderServerModels(ctx context.Context, integrationId string, params *GetProviderServerModelsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServers request
	GetServers(ctx context.Context, params *GetServersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateServersWithBody request with any body
	CreateServersWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateServers(ctx context.Context, body CreateServersJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServerTags request
	GetServerTags(ctx context.Context, params *GetServerTagsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteServerWithBody request with any body
	DeleteServerWithBody(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	DeleteServer(ctx context.Context, serverId string, body DeleteServerJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServer request
	GetServer(ctx context.Context, serverId string, params *GetServerParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateServerWithBody request with any body
	UpdateServerWithBody(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateServer(ctx context.Context, serverId string, body UpdateServerJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServerConsole request
	GetServerConsole(ctx context.Context, serverId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServerInstances request
	GetServerInstances(ctx context.Context, serverId string, params *GetServerInstancesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateServerJobWithBody request with any body
	CreateServerJobWithBody(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateServerJob(ctx context.Context, serverId string, body CreateServerJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServerTelemetry request
	GetServerTelemetry(ctx context.Context, serverId string, params *GetServerTelemetryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServerUsage request
	GetServerUsage(ctx context.Context, serverId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInfrastructureSummary request
	GetInfrastructureSummary(ctx context.Context, params *GetInfrastructureSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVirtualProviderIsos request
	GetVirtualProviderIsos(ctx context.Context, integrationId string, params *GetVirtualProviderIsosParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVirtualProviderIsoWithBody request with any body
	CreateVirtualProviderIsoWithBody(ctx context.Context, integrationId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateVirtualProviderIso(ctx context.Context, integrationId string, body CreateVirtualProviderIsoJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteVirtualProviderIso request
	DeleteVirtualProviderIso(ctx context.Context, integrationId string, isoId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVirtualProviderIso request
	GetVirtualProviderIso(ctx context.Context, integrationId string, isoId string, params *GetVirtualProviderIsoParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateVirtualProviderIsoWithBody request with any body
	UpdateVirtualProviderIsoWithBody(ctx context.Context, integrationId string, isoId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateVirtualProviderIso(ctx context.Context, integrationId string, isoId string, body UpdateVirtualProviderIsoJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVirtualProviderIsoDownloadUrl request
	GetVirtualProviderIsoDownloadUrl(ctx context.Context, integrationId string, isoId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVirtualProviderIsoJobWithBody request with any body
	CreateVirtualProviderIsoJobWithBody(ctx context.Context, integrationId string, isoId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateVirtualProviderIsoJob(ctx context.Context, integrationId string, isoId string, body CreateVirtualProviderIsoJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetJobs request
	GetJobs(ctx context.Context, params *GetJobsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLatestJobs request
	GetLatestJobs(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetJob request
	GetJob(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEvents request
	GetEvents(ctx context.Context, params *GetEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GenerateAggregatedEventsWithBody request with any body
	GenerateAggregatedEventsWithBody(ctx context.Context, params *GenerateAggregatedEventsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	GenerateAggregatedEvents(ctx context.Context, params *GenerateAggregatedEventsParams, body GenerateAggregatedEventsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AggregateLogsWithBody request with any body
	AggregateLogsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AggregateLogs(ctx context.Context, body AggregateLogsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMetrics request
	GetMetrics(ctx context.Context, params *GetMetricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GenerateAggregatedMetricsWithBody request with any body
	GenerateAggregatedMetricsWithBody(ctx context.Context, params *GenerateAggregatedMetricsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	GenerateAggregatedMetrics(ctx context.Context, params *GenerateAggregatedMetricsParams, body GenerateAggregatedMetricsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMonitoringMonitors request
	GetMonitoringMonitors(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPipelines request
	GetPipelines(ctx context.Context, params *GetPipelinesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreatePipelineWithBody request with any body
	CreatePipelineWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreatePipeline(ctx context.Context, body CreatePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ClonePipelineWithBody request with any body
	ClonePipelineWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ClonePipeline(ctx context.Context, body ClonePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllPipelineRuns request
	GetAllPipelineRuns(ctx context.Context, params *GetAllPipelineRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeletePipeline request
	DeletePipeline(ctx context.Context, pipelineId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPipeline request
	GetPipeline(ctx context.Context, pipelineId string, params *GetPipelineParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdatePipelineWithBody request with any body
	UpdatePipelineWithBody(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdatePipeline(ctx context.Context, pipelineId string, body UpdatePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdatePipelineAccessWithBody request with any body
	UpdatePipelineAccessWithBody(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdatePipelineAccess(ctx context.Context, pipelineId string, body UpdatePipelineAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPipelineTriggerKeys request
	GetPipelineTriggerKeys(ctx context.Context, pipelineId string, params *GetPipelineTriggerKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreatePipelineTriggerKeyWithBody request with any body
	CreatePipelineTriggerKeyWithBody(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreatePipelineTriggerKey(ctx context.Context, pipelineId string, body CreatePipelineTriggerKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeletePipelineTriggerKey request
	DeletePipelineTriggerKey(ctx context.Context, pipelineId string, triggerKeyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPipelineTriggerKey request
	GetPipelineTriggerKey(ctx context.Context, pipelineId string, triggerKeyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdatePipelineTriggerKeyWithBody request with any body
	UpdatePipelineTriggerKeyWithBody(ctx context.Context, pipelineId string, triggerKeyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdatePipelineTriggerKey(ctx context.Context, pipelineId string, triggerKeyId string, body UpdatePipelineTriggerKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPipelineRuns request
	GetPipelineRuns(ctx context.Context, pipelineId string, params *GetPipelineRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPipelineRun request
	GetPipelineRun(ctx context.Context, pipelineId string, runId string, params *GetPipelineRunParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreatePipelineJobWithBody request with any body
	CreatePipelineJobWithBody(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreatePipelineJob(ctx context.Context, pipelineId string, body CreatePipelineJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TriggerPipelineWithBody request with any body
	TriggerPipelineWithBody(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	TriggerPipeline(ctx context.Context, pipelineId string, body TriggerPipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetNetworks request
	GetNetworks(ctx context.Context, params *GetNetworksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateNetworkWithBody request with any body
	CreateNetworkWithBody(ctx context.Context, params *CreateNetworkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateNetwork(ctx context.Context, params *CreateNetworkParams, body CreateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteNetwork request
	DeleteNetwork(ctx context.Context, networkId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetNetwork request
	GetNetwork(ctx context.Context, networkId string, params *GetNetworkParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateNetworkWithBody request with any body
	UpdateNetworkWithBody(ctx context.Context, networkId string, params *UpdateNetworkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateNetwork(ctx context.Context, networkId string, params *UpdateNetworkParams, body UpdateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateNetworkAccessWithBody request with any body
	UpdateNetworkAccessWithBody(ctx context.Context, networkId string, params *UpdateNetworkAccessParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateNetworkAccess(ctx context.Context, networkId string, params *UpdateNetworkAccessParams, body UpdateNetworkAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateNetworkJobWithBody request with any body
	CreateNetworkJobWithBody(ctx context.Context, networkId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateNetworkJob(ctx context.Context, networkId string, body CreateNetworkJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSearchIndex request
	GetSearchIndex(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStacks request
	GetStacks(ctx context.Context, params *GetStacksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateStackWithBody request with any body
	CreateStackWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateStack(ctx context.Context, body CreateStackJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllStackBuilds request
	GetAllStackBuilds(ctx context.Context, params *GetAllStackBuildsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LookupStackBuild request
	LookupStackBuild(ctx context.Context, buildId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteStack request
	DeleteStack(ctx context.Context, stackId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStack request
	GetStack(ctx context.Context, stackId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateStackWithBody request with any body
	UpdateStackWithBody(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateStack(ctx context.Context, stackId string, body UpdateStackJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateStackAccessWithBody request with any body
	UpdateStackAccessWithBody(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateStackAccess(ctx context.Context, stackId string, body UpdateStackAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStackBuilds request
	GetStackBuilds(ctx context.Context, stackId string, params *GetStackBuildsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateStackBuildWithBody request with any body
	CreateStackBuildWithBody(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateStackBuild(ctx context.Context, stackId string, body CreateStackBuildJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteStackBuild request
	DeleteStackBuild(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStackBuild request
	GetStackBuild(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStackBuildLog request
	GetStackBuildLog(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateStackBuildJobWithBody request with any body
	CreateStackBuildJobWithBody(ctx context.Context, stackId string, buildId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateStackBuildJob(ctx context.Context, stackId string, buildId string, body CreateStackBuildJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateStackJobWithBody request with any body
	CreateStackJobWithBody(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateStackJob(ctx context.Context, stackId string, body CreateStackJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LookupComponentsWithBody request with any body
	LookupComponentsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	LookupComponents(ctx context.Context, body LookupComponentsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LookupIdentifier request
	LookupIdentifier(ctx context.Context, params *LookupIdentifierParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVirtualMachines request
	GetVirtualMachines(ctx context.Context, params *GetVirtualMachinesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVirtualMachineWithBody request with any body
	CreateVirtualMachineWithBody(ctx context.Context, params *CreateVirtualMachineParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateVirtualMachine(ctx context.Context, params *CreateVirtualMachineParams, body CreateVirtualMachineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVirtualMachineBaseImages request
	GetVirtualMachineBaseImages(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVirtualMachineSshKeys request
	GetVirtualMachineSshKeys(ctx context.Context, params *GetVirtualMachineSshKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVirtualMachineSshKeyWithBody request with any body
	CreateVirtualMachineSshKeyWithBody(ctx context.Context, params *CreateVirtualMachineSshKeyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateVirtualMachineSshKey(ctx context.Context, params *CreateVirtualMachineSshKeyParams, body CreateVirtualMachineSshKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteVirtualMachineSshKey request
	DeleteVirtualMachineSshKey(ctx context.Context, sshKeyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVirtualMachineSshKey request
	GetVirtualMachineSshKey(ctx context.Context, sshKeyId string, params *GetVirtualMachineSshKeyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateVirtualMachineSshKeyWithBody request with any body
	UpdateVirtualMachineSshKeyWithBody(ctx context.Context, sshKeyId string, params *UpdateVirtualMachineSshKeyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateVirtualMachineSshKey(ctx context.Context, sshKeyId string, params *UpdateVirtualMachineSshKeyParams, body UpdateVirtualMachineSshKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteVirtualMachine request
	DeleteVirtualMachine(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVirtualMachine request
	GetVirtualMachine(ctx context.Context, virtualMachineId string, params *GetVirtualMachineParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateVirtualMachineWithBody request with any body
	UpdateVirtualMachineWithBody(ctx context.Context, virtualMachineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateVirtualMachine(ctx context.Context, virtualMachineId string, body UpdateVirtualMachineJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAvailableIps request
	GetAvailableIps(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExpireVirtualMachineSosCredentials request
	ExpireVirtualMachineSosCredentials(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GenerateVirtualMachineSosCredentials request
	GenerateVirtualMachineSosCredentials(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVirtualMachineJobWithBody request with any body
	CreateVirtualMachineJobWithBody(ctx context.Context, virtualMachineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateVirtualMachineJob(ctx context.Context, virtualMachineId string, body CreateVirtualMachineJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewAuthenticatedClient

func NewAuthenticatedClient(config ClientConfig) (*ClientWithResponses, error)

generate a Cycle API client (with responses) that handles auth based on the provided token and hub

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) AggregateLogsWithBodyWithResponse

func (c *ClientWithResponses) AggregateLogsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AggregateLogsResponse, error)

AggregateLogsWithBodyWithResponse request with arbitrary body returning *AggregateLogsResponse

func (*ClientWithResponses) AggregateLogsWithResponse

func (c *ClientWithResponses) AggregateLogsWithResponse(ctx context.Context, body AggregateLogsJSONRequestBody, reqEditors ...RequestEditorFn) (*AggregateLogsResponse, error)

func (*ClientWithResponses) ChangePasswordWithBodyWithResponse

func (c *ClientWithResponses) ChangePasswordWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ChangePasswordResponse, error)

ChangePasswordWithBodyWithResponse request with arbitrary body returning *ChangePasswordResponse

func (*ClientWithResponses) ChangePasswordWithResponse

func (c *ClientWithResponses) ChangePasswordWithResponse(ctx context.Context, body ChangePasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*ChangePasswordResponse, error)

func (*ClientWithResponses) ClonePipelineWithBodyWithResponse

func (c *ClientWithResponses) ClonePipelineWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClonePipelineResponse, error)

ClonePipelineWithBodyWithResponse request with arbitrary body returning *ClonePipelineResponse

func (*ClientWithResponses) ClonePipelineWithResponse

func (c *ClientWithResponses) ClonePipelineWithResponse(ctx context.Context, body ClonePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*ClonePipelineResponse, error)

func (*ClientWithResponses) CreateApiKeyWithBodyWithResponse

func (c *ClientWithResponses) CreateApiKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateApiKeyResponse, error)

CreateApiKeyWithBodyWithResponse request with arbitrary body returning *CreateApiKeyResponse

func (*ClientWithResponses) CreateApiKeyWithResponse

func (c *ClientWithResponses) CreateApiKeyWithResponse(ctx context.Context, body CreateApiKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateApiKeyResponse, error)

func (*ClientWithResponses) CreateAutoScaleGroupWithBodyWithResponse

func (c *ClientWithResponses) CreateAutoScaleGroupWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAutoScaleGroupResponse, error)

CreateAutoScaleGroupWithBodyWithResponse request with arbitrary body returning *CreateAutoScaleGroupResponse

func (*ClientWithResponses) CreateAutoScaleGroupWithResponse

func (c *ClientWithResponses) CreateAutoScaleGroupWithResponse(ctx context.Context, body CreateAutoScaleGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAutoScaleGroupResponse, error)

func (*ClientWithResponses) CreateBillingMethodJobWithBodyWithResponse

func (c *ClientWithResponses) CreateBillingMethodJobWithBodyWithResponse(ctx context.Context, methodId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateBillingMethodJobResponse, error)

CreateBillingMethodJobWithBodyWithResponse request with arbitrary body returning *CreateBillingMethodJobResponse

func (*ClientWithResponses) CreateBillingMethodJobWithResponse

func (c *ClientWithResponses) CreateBillingMethodJobWithResponse(ctx context.Context, methodId string, body CreateBillingMethodJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBillingMethodJobResponse, error)

func (*ClientWithResponses) CreateBillingMethodWithBodyWithResponse

func (c *ClientWithResponses) CreateBillingMethodWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateBillingMethodResponse, error)

CreateBillingMethodWithBodyWithResponse request with arbitrary body returning *CreateBillingMethodResponse

func (*ClientWithResponses) CreateBillingMethodWithResponse

func (c *ClientWithResponses) CreateBillingMethodWithResponse(ctx context.Context, body CreateBillingMethodJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBillingMethodResponse, error)

func (*ClientWithResponses) CreateClusterJobWithBodyWithResponse added in v0.6.3

func (c *ClientWithResponses) CreateClusterJobWithBodyWithResponse(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateClusterJobResponse, error)

CreateClusterJobWithBodyWithResponse request with arbitrary body returning *CreateClusterJobResponse

func (*ClientWithResponses) CreateClusterJobWithResponse added in v0.6.3

func (c *ClientWithResponses) CreateClusterJobWithResponse(ctx context.Context, clusterId string, body CreateClusterJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateClusterJobResponse, error)

func (*ClientWithResponses) CreateClusterWithBodyWithResponse

func (c *ClientWithResponses) CreateClusterWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateClusterResponse, error)

CreateClusterWithBodyWithResponse request with arbitrary body returning *CreateClusterResponse

func (*ClientWithResponses) CreateClusterWithResponse

func (c *ClientWithResponses) CreateClusterWithResponse(ctx context.Context, body CreateClusterJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateClusterResponse, error)

func (*ClientWithResponses) CreateContainerBackupJobWithBodyWithResponse

func (c *ClientWithResponses) CreateContainerBackupJobWithBodyWithResponse(ctx context.Context, containerId string, backupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateContainerBackupJobResponse, error)

CreateContainerBackupJobWithBodyWithResponse request with arbitrary body returning *CreateContainerBackupJobResponse

func (*ClientWithResponses) CreateContainerBackupJobWithResponse

func (c *ClientWithResponses) CreateContainerBackupJobWithResponse(ctx context.Context, containerId string, backupId string, body CreateContainerBackupJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateContainerBackupJobResponse, error)

func (*ClientWithResponses) CreateContainerJobWithBodyWithResponse

func (c *ClientWithResponses) CreateContainerJobWithBodyWithResponse(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateContainerJobResponse, error)

CreateContainerJobWithBodyWithResponse request with arbitrary body returning *CreateContainerJobResponse

func (*ClientWithResponses) CreateContainerJobWithResponse

func (c *ClientWithResponses) CreateContainerJobWithResponse(ctx context.Context, containerId string, body CreateContainerJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateContainerJobResponse, error)

func (*ClientWithResponses) CreateContainerWithBodyWithResponse

func (c *ClientWithResponses) CreateContainerWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateContainerResponse, error)

CreateContainerWithBodyWithResponse request with arbitrary body returning *CreateContainerResponse

func (*ClientWithResponses) CreateContainerWithResponse

func (c *ClientWithResponses) CreateContainerWithResponse(ctx context.Context, body CreateContainerJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateContainerResponse, error)

func (*ClientWithResponses) CreateDNSZoneJobWithBodyWithResponse

func (c *ClientWithResponses) CreateDNSZoneJobWithBodyWithResponse(ctx context.Context, zoneId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSZoneJobResponse, error)

CreateDNSZoneJobWithBodyWithResponse request with arbitrary body returning *CreateDNSZoneJobResponse

func (*ClientWithResponses) CreateDNSZoneJobWithResponse

func (c *ClientWithResponses) CreateDNSZoneJobWithResponse(ctx context.Context, zoneId string, body CreateDNSZoneJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSZoneJobResponse, error)

func (*ClientWithResponses) CreateDNSZoneRecordJobWithBodyWithResponse

func (c *ClientWithResponses) CreateDNSZoneRecordJobWithBodyWithResponse(ctx context.Context, zoneId string, recordId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSZoneRecordJobResponse, error)

CreateDNSZoneRecordJobWithBodyWithResponse request with arbitrary body returning *CreateDNSZoneRecordJobResponse

func (*ClientWithResponses) CreateDNSZoneRecordJobWithResponse

func (c *ClientWithResponses) CreateDNSZoneRecordJobWithResponse(ctx context.Context, zoneId string, recordId string, body CreateDNSZoneRecordJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSZoneRecordJobResponse, error)

func (*ClientWithResponses) CreateDNSZoneRecordWithBodyWithResponse

func (c *ClientWithResponses) CreateDNSZoneRecordWithBodyWithResponse(ctx context.Context, zoneId string, params *CreateDNSZoneRecordParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSZoneRecordResponse, error)

CreateDNSZoneRecordWithBodyWithResponse request with arbitrary body returning *CreateDNSZoneRecordResponse

func (*ClientWithResponses) CreateDNSZoneRecordWithResponse

func (c *ClientWithResponses) CreateDNSZoneRecordWithResponse(ctx context.Context, zoneId string, params *CreateDNSZoneRecordParams, body CreateDNSZoneRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSZoneRecordResponse, error)

func (*ClientWithResponses) CreateDNSZoneWithBodyWithResponse

func (c *ClientWithResponses) CreateDNSZoneWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSZoneResponse, error)

CreateDNSZoneWithBodyWithResponse request with arbitrary body returning *CreateDNSZoneResponse

func (*ClientWithResponses) CreateDNSZoneWithResponse

func (c *ClientWithResponses) CreateDNSZoneWithResponse(ctx context.Context, body CreateDNSZoneJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSZoneResponse, error)

func (*ClientWithResponses) CreateDiscoveryServiceJobWithBodyWithResponse

func (c *ClientWithResponses) CreateDiscoveryServiceJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDiscoveryServiceJobResponse, error)

CreateDiscoveryServiceJobWithBodyWithResponse request with arbitrary body returning *CreateDiscoveryServiceJobResponse

func (*ClientWithResponses) CreateDiscoveryServiceJobWithResponse

func (c *ClientWithResponses) CreateDiscoveryServiceJobWithResponse(ctx context.Context, environmentId string, body CreateDiscoveryServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDiscoveryServiceJobResponse, error)

func (*ClientWithResponses) CreateEnvironmentJobWithBodyWithResponse

func (c *ClientWithResponses) CreateEnvironmentJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnvironmentJobResponse, error)

CreateEnvironmentJobWithBodyWithResponse request with arbitrary body returning *CreateEnvironmentJobResponse

func (*ClientWithResponses) CreateEnvironmentJobWithResponse

func (c *ClientWithResponses) CreateEnvironmentJobWithResponse(ctx context.Context, environmentId string, body CreateEnvironmentJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnvironmentJobResponse, error)

func (*ClientWithResponses) CreateEnvironmentWithBodyWithResponse

func (c *ClientWithResponses) CreateEnvironmentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnvironmentResponse, error)

CreateEnvironmentWithBodyWithResponse request with arbitrary body returning *CreateEnvironmentResponse

func (*ClientWithResponses) CreateEnvironmentWithResponse

func (c *ClientWithResponses) CreateEnvironmentWithResponse(ctx context.Context, body CreateEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnvironmentResponse, error)

func (*ClientWithResponses) CreateExternalVolumeJobWithBodyWithResponse added in v0.6.5

func (c *ClientWithResponses) CreateExternalVolumeJobWithBodyWithResponse(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateExternalVolumeJobResponse, error)

CreateExternalVolumeJobWithBodyWithResponse request with arbitrary body returning *CreateExternalVolumeJobResponse

func (*ClientWithResponses) CreateExternalVolumeJobWithResponse added in v0.6.5

func (c *ClientWithResponses) CreateExternalVolumeJobWithResponse(ctx context.Context, externalVolumeId string, body CreateExternalVolumeJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateExternalVolumeJobResponse, error)

func (*ClientWithResponses) CreateExternalVolumeWithBodyWithResponse added in v0.6.5

func (c *ClientWithResponses) CreateExternalVolumeWithBodyWithResponse(ctx context.Context, params *CreateExternalVolumeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateExternalVolumeResponse, error)

CreateExternalVolumeWithBodyWithResponse request with arbitrary body returning *CreateExternalVolumeResponse

func (*ClientWithResponses) CreateExternalVolumeWithResponse added in v0.6.5

func (*ClientWithResponses) CreateExternalVolumesJobWithBodyWithResponse added in v0.6.6

func (c *ClientWithResponses) CreateExternalVolumesJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateExternalVolumesJobResponse, error)

CreateExternalVolumesJobWithBodyWithResponse request with arbitrary body returning *CreateExternalVolumesJobResponse

func (*ClientWithResponses) CreateExternalVolumesJobWithResponse added in v0.6.6

func (c *ClientWithResponses) CreateExternalVolumesJobWithResponse(ctx context.Context, body CreateExternalVolumesJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateExternalVolumesJobResponse, error)

func (*ClientWithResponses) CreateFunctionJobWithBodyWithResponse

func (c *ClientWithResponses) CreateFunctionJobWithBodyWithResponse(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFunctionJobResponse, error)

CreateFunctionJobWithBodyWithResponse request with arbitrary body returning *CreateFunctionJobResponse

func (*ClientWithResponses) CreateFunctionJobWithResponse

func (c *ClientWithResponses) CreateFunctionJobWithResponse(ctx context.Context, containerId string, body CreateFunctionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFunctionJobResponse, error)

func (*ClientWithResponses) CreateGatewayServiceJobWithBodyWithResponse

func (c *ClientWithResponses) CreateGatewayServiceJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateGatewayServiceJobResponse, error)

CreateGatewayServiceJobWithBodyWithResponse request with arbitrary body returning *CreateGatewayServiceJobResponse

func (*ClientWithResponses) CreateGatewayServiceJobWithResponse

func (c *ClientWithResponses) CreateGatewayServiceJobWithResponse(ctx context.Context, environmentId string, body CreateGatewayServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateGatewayServiceJobResponse, error)

func (*ClientWithResponses) CreateHubInviteWithBodyWithResponse

func (c *ClientWithResponses) CreateHubInviteWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateHubInviteResponse, error)

CreateHubInviteWithBodyWithResponse request with arbitrary body returning *CreateHubInviteResponse

func (*ClientWithResponses) CreateHubInviteWithResponse

func (c *ClientWithResponses) CreateHubInviteWithResponse(ctx context.Context, body CreateHubInviteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateHubInviteResponse, error)

func (*ClientWithResponses) CreateHubWithBodyWithResponse

func (c *ClientWithResponses) CreateHubWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateHubResponse, error)

CreateHubWithBodyWithResponse request with arbitrary body returning *CreateHubResponse

func (*ClientWithResponses) CreateHubWithResponse

func (c *ClientWithResponses) CreateHubWithResponse(ctx context.Context, body CreateHubJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateHubResponse, error)

func (*ClientWithResponses) CreateImageJobWithBodyWithResponse

func (c *ClientWithResponses) CreateImageJobWithBodyWithResponse(ctx context.Context, imageId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateImageJobResponse, error)

CreateImageJobWithBodyWithResponse request with arbitrary body returning *CreateImageJobResponse

func (*ClientWithResponses) CreateImageJobWithResponse

func (c *ClientWithResponses) CreateImageJobWithResponse(ctx context.Context, imageId string, body CreateImageJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateImageJobResponse, error)

func (*ClientWithResponses) CreateImageSourceWithBodyWithResponse

func (c *ClientWithResponses) CreateImageSourceWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateImageSourceResponse, error)

CreateImageSourceWithBodyWithResponse request with arbitrary body returning *CreateImageSourceResponse

func (*ClientWithResponses) CreateImageSourceWithResponse

func (c *ClientWithResponses) CreateImageSourceWithResponse(ctx context.Context, body CreateImageSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateImageSourceResponse, error)

func (*ClientWithResponses) CreateImageWithBodyWithResponse

func (c *ClientWithResponses) CreateImageWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateImageResponse, error)

CreateImageWithBodyWithResponse request with arbitrary body returning *CreateImageResponse

func (*ClientWithResponses) CreateImageWithResponse

func (c *ClientWithResponses) CreateImageWithResponse(ctx context.Context, body CreateImageJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateImageResponse, error)

func (*ClientWithResponses) CreateImagesJobWithBodyWithResponse

func (c *ClientWithResponses) CreateImagesJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateImagesJobResponse, error)

CreateImagesJobWithBodyWithResponse request with arbitrary body returning *CreateImagesJobResponse

func (*ClientWithResponses) CreateImagesJobWithResponse

func (c *ClientWithResponses) CreateImagesJobWithResponse(ctx context.Context, body CreateImagesJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateImagesJobResponse, error)

func (*ClientWithResponses) CreateInstanceJobWithBodyWithResponse

func (c *ClientWithResponses) CreateInstanceJobWithBodyWithResponse(ctx context.Context, containerId string, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateInstanceJobResponse, error)

CreateInstanceJobWithBodyWithResponse request with arbitrary body returning *CreateInstanceJobResponse

func (*ClientWithResponses) CreateInstanceJobWithResponse

func (c *ClientWithResponses) CreateInstanceJobWithResponse(ctx context.Context, containerId string, instanceId string, body CreateInstanceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateInstanceJobResponse, error)

func (*ClientWithResponses) CreateInstancesWithBodyWithResponse

func (c *ClientWithResponses) CreateInstancesWithBodyWithResponse(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateInstancesResponse, error)

CreateInstancesWithBodyWithResponse request with arbitrary body returning *CreateInstancesResponse

func (*ClientWithResponses) CreateInstancesWithResponse

func (c *ClientWithResponses) CreateInstancesWithResponse(ctx context.Context, containerId string, body CreateInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateInstancesResponse, error)

func (*ClientWithResponses) CreateIntegrationJobWithBodyWithResponse

func (c *ClientWithResponses) CreateIntegrationJobWithBodyWithResponse(ctx context.Context, integrationId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateIntegrationJobResponse, error)

CreateIntegrationJobWithBodyWithResponse request with arbitrary body returning *CreateIntegrationJobResponse

func (*ClientWithResponses) CreateIntegrationJobWithResponse

func (c *ClientWithResponses) CreateIntegrationJobWithResponse(ctx context.Context, integrationId string, body CreateIntegrationJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateIntegrationJobResponse, error)

func (*ClientWithResponses) CreateIntegrationWithBodyWithResponse

func (c *ClientWithResponses) CreateIntegrationWithBodyWithResponse(ctx context.Context, params *CreateIntegrationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateIntegrationResponse, error)

CreateIntegrationWithBodyWithResponse request with arbitrary body returning *CreateIntegrationResponse

func (*ClientWithResponses) CreateIntegrationWithResponse

func (*ClientWithResponses) CreateInvoiceJobWithBodyWithResponse

func (c *ClientWithResponses) CreateInvoiceJobWithBodyWithResponse(ctx context.Context, invoiceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateInvoiceJobResponse, error)

CreateInvoiceJobWithBodyWithResponse request with arbitrary body returning *CreateInvoiceJobResponse

func (*ClientWithResponses) CreateInvoiceJobWithResponse

func (c *ClientWithResponses) CreateInvoiceJobWithResponse(ctx context.Context, invoiceId string, body CreateInvoiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateInvoiceJobResponse, error)

func (*ClientWithResponses) CreateIpPoolJobWithBodyWithResponse added in v0.6.4

func (c *ClientWithResponses) CreateIpPoolJobWithBodyWithResponse(ctx context.Context, poolId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateIpPoolJobResponse, error)

CreateIpPoolJobWithBodyWithResponse request with arbitrary body returning *CreateIpPoolJobResponse

func (*ClientWithResponses) CreateIpPoolJobWithResponse added in v0.6.4

func (c *ClientWithResponses) CreateIpPoolJobWithResponse(ctx context.Context, poolId string, body CreateIpPoolJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateIpPoolJobResponse, error)

func (*ClientWithResponses) CreateIpPoolWithBodyWithResponse added in v0.6.3

func (c *ClientWithResponses) CreateIpPoolWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateIpPoolResponse, error)

CreateIpPoolWithBodyWithResponse request with arbitrary body returning *CreateIpPoolResponse

func (*ClientWithResponses) CreateIpPoolWithResponse added in v0.6.3

func (c *ClientWithResponses) CreateIpPoolWithResponse(ctx context.Context, body CreateIpPoolJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateIpPoolResponse, error)

func (*ClientWithResponses) CreateLoadBalancerServiceJobWithBodyWithResponse

func (c *ClientWithResponses) CreateLoadBalancerServiceJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateLoadBalancerServiceJobResponse, error)

CreateLoadBalancerServiceJobWithBodyWithResponse request with arbitrary body returning *CreateLoadBalancerServiceJobResponse

func (*ClientWithResponses) CreateLoadBalancerServiceJobWithResponse

func (c *ClientWithResponses) CreateLoadBalancerServiceJobWithResponse(ctx context.Context, environmentId string, body CreateLoadBalancerServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateLoadBalancerServiceJobResponse, error)

func (*ClientWithResponses) CreateNetworkJobWithBodyWithResponse

func (c *ClientWithResponses) CreateNetworkJobWithBodyWithResponse(ctx context.Context, networkId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateNetworkJobResponse, error)

CreateNetworkJobWithBodyWithResponse request with arbitrary body returning *CreateNetworkJobResponse

func (*ClientWithResponses) CreateNetworkJobWithResponse

func (c *ClientWithResponses) CreateNetworkJobWithResponse(ctx context.Context, networkId string, body CreateNetworkJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateNetworkJobResponse, error)

func (*ClientWithResponses) CreateNetworkWithBodyWithResponse

func (c *ClientWithResponses) CreateNetworkWithBodyWithResponse(ctx context.Context, params *CreateNetworkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateNetworkResponse, error)

CreateNetworkWithBodyWithResponse request with arbitrary body returning *CreateNetworkResponse

func (*ClientWithResponses) CreateNetworkWithResponse

func (c *ClientWithResponses) CreateNetworkWithResponse(ctx context.Context, params *CreateNetworkParams, body CreateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateNetworkResponse, error)

func (*ClientWithResponses) CreateOrderJobWithBodyWithResponse

func (c *ClientWithResponses) CreateOrderJobWithBodyWithResponse(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrderJobResponse, error)

CreateOrderJobWithBodyWithResponse request with arbitrary body returning *CreateOrderJobResponse

func (*ClientWithResponses) CreateOrderJobWithResponse

func (c *ClientWithResponses) CreateOrderJobWithResponse(ctx context.Context, orderId string, body CreateOrderJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrderJobResponse, error)

func (*ClientWithResponses) CreateOrderWithBodyWithResponse

func (c *ClientWithResponses) CreateOrderWithBodyWithResponse(ctx context.Context, params *CreateOrderParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrderResponse, error)

CreateOrderWithBodyWithResponse request with arbitrary body returning *CreateOrderResponse

func (*ClientWithResponses) CreateOrderWithResponse

func (c *ClientWithResponses) CreateOrderWithResponse(ctx context.Context, params *CreateOrderParams, body CreateOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrderResponse, error)

func (*ClientWithResponses) CreatePipelineJobWithBodyWithResponse

func (c *ClientWithResponses) CreatePipelineJobWithBodyWithResponse(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePipelineJobResponse, error)

CreatePipelineJobWithBodyWithResponse request with arbitrary body returning *CreatePipelineJobResponse

func (*ClientWithResponses) CreatePipelineJobWithResponse

func (c *ClientWithResponses) CreatePipelineJobWithResponse(ctx context.Context, pipelineId string, body CreatePipelineJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePipelineJobResponse, error)

func (*ClientWithResponses) CreatePipelineTriggerKeyWithBodyWithResponse

func (c *ClientWithResponses) CreatePipelineTriggerKeyWithBodyWithResponse(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePipelineTriggerKeyResponse, error)

CreatePipelineTriggerKeyWithBodyWithResponse request with arbitrary body returning *CreatePipelineTriggerKeyResponse

func (*ClientWithResponses) CreatePipelineTriggerKeyWithResponse

func (c *ClientWithResponses) CreatePipelineTriggerKeyWithResponse(ctx context.Context, pipelineId string, body CreatePipelineTriggerKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePipelineTriggerKeyResponse, error)

func (*ClientWithResponses) CreatePipelineWithBodyWithResponse

func (c *ClientWithResponses) CreatePipelineWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePipelineResponse, error)

CreatePipelineWithBodyWithResponse request with arbitrary body returning *CreatePipelineResponse

func (*ClientWithResponses) CreatePipelineWithResponse

func (c *ClientWithResponses) CreatePipelineWithResponse(ctx context.Context, body CreatePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePipelineResponse, error)

func (*ClientWithResponses) CreateRoleWithBodyWithResponse

func (c *ClientWithResponses) CreateRoleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRoleResponse, error)

CreateRoleWithBodyWithResponse request with arbitrary body returning *CreateRoleResponse

func (*ClientWithResponses) CreateRoleWithResponse

func (c *ClientWithResponses) CreateRoleWithResponse(ctx context.Context, body CreateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRoleResponse, error)

func (*ClientWithResponses) CreateSchedulerServiceJobWithBodyWithResponse

func (c *ClientWithResponses) CreateSchedulerServiceJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSchedulerServiceJobResponse, error)

CreateSchedulerServiceJobWithBodyWithResponse request with arbitrary body returning *CreateSchedulerServiceJobResponse

func (*ClientWithResponses) CreateSchedulerServiceJobWithResponse

func (c *ClientWithResponses) CreateSchedulerServiceJobWithResponse(ctx context.Context, environmentId string, body CreateSchedulerServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSchedulerServiceJobResponse, error)

func (*ClientWithResponses) CreateScopedVariableWithBodyWithResponse

func (c *ClientWithResponses) CreateScopedVariableWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateScopedVariableResponse, error)

CreateScopedVariableWithBodyWithResponse request with arbitrary body returning *CreateScopedVariableResponse

func (*ClientWithResponses) CreateScopedVariableWithResponse

func (c *ClientWithResponses) CreateScopedVariableWithResponse(ctx context.Context, environmentId string, body CreateScopedVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateScopedVariableResponse, error)

func (*ClientWithResponses) CreateServerJobWithBodyWithResponse

func (c *ClientWithResponses) CreateServerJobWithBodyWithResponse(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateServerJobResponse, error)

CreateServerJobWithBodyWithResponse request with arbitrary body returning *CreateServerJobResponse

func (*ClientWithResponses) CreateServerJobWithResponse

func (c *ClientWithResponses) CreateServerJobWithResponse(ctx context.Context, serverId string, body CreateServerJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateServerJobResponse, error)

func (*ClientWithResponses) CreateServersWithBodyWithResponse added in v0.6.6

func (c *ClientWithResponses) CreateServersWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateServersResponse, error)

CreateServersWithBodyWithResponse request with arbitrary body returning *CreateServersResponse

func (*ClientWithResponses) CreateServersWithResponse added in v0.6.6

func (c *ClientWithResponses) CreateServersWithResponse(ctx context.Context, body CreateServersJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateServersResponse, error)

func (*ClientWithResponses) CreateStackBuildJobWithBodyWithResponse

func (c *ClientWithResponses) CreateStackBuildJobWithBodyWithResponse(ctx context.Context, stackId string, buildId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStackBuildJobResponse, error)

CreateStackBuildJobWithBodyWithResponse request with arbitrary body returning *CreateStackBuildJobResponse

func (*ClientWithResponses) CreateStackBuildJobWithResponse

func (c *ClientWithResponses) CreateStackBuildJobWithResponse(ctx context.Context, stackId string, buildId string, body CreateStackBuildJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStackBuildJobResponse, error)

func (*ClientWithResponses) CreateStackBuildWithBodyWithResponse

func (c *ClientWithResponses) CreateStackBuildWithBodyWithResponse(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStackBuildResponse, error)

CreateStackBuildWithBodyWithResponse request with arbitrary body returning *CreateStackBuildResponse

func (*ClientWithResponses) CreateStackBuildWithResponse

func (c *ClientWithResponses) CreateStackBuildWithResponse(ctx context.Context, stackId string, body CreateStackBuildJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStackBuildResponse, error)

func (*ClientWithResponses) CreateStackJobWithBodyWithResponse

func (c *ClientWithResponses) CreateStackJobWithBodyWithResponse(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStackJobResponse, error)

CreateStackJobWithBodyWithResponse request with arbitrary body returning *CreateStackJobResponse

func (*ClientWithResponses) CreateStackJobWithResponse

func (c *ClientWithResponses) CreateStackJobWithResponse(ctx context.Context, stackId string, body CreateStackJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStackJobResponse, error)

func (*ClientWithResponses) CreateStackWithBodyWithResponse

func (c *ClientWithResponses) CreateStackWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStackResponse, error)

CreateStackWithBodyWithResponse request with arbitrary body returning *CreateStackResponse

func (*ClientWithResponses) CreateStackWithResponse

func (c *ClientWithResponses) CreateStackWithResponse(ctx context.Context, body CreateStackJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStackResponse, error)

func (*ClientWithResponses) CreateUserSuppliedCertificateJobWithBodyWithResponse

func (c *ClientWithResponses) CreateUserSuppliedCertificateJobWithBodyWithResponse(ctx context.Context, certificateId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateUserSuppliedCertificateJobResponse, error)

CreateUserSuppliedCertificateJobWithBodyWithResponse request with arbitrary body returning *CreateUserSuppliedCertificateJobResponse

func (*ClientWithResponses) CreateUserSuppliedCertificateJobWithResponse

func (c *ClientWithResponses) CreateUserSuppliedCertificateJobWithResponse(ctx context.Context, certificateId string, body CreateUserSuppliedCertificateJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUserSuppliedCertificateJobResponse, error)

func (*ClientWithResponses) CreateVPNServiceJobWithBodyWithResponse

func (c *ClientWithResponses) CreateVPNServiceJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVPNServiceJobResponse, error)

CreateVPNServiceJobWithBodyWithResponse request with arbitrary body returning *CreateVPNServiceJobResponse

func (*ClientWithResponses) CreateVPNServiceJobWithResponse

func (c *ClientWithResponses) CreateVPNServiceJobWithResponse(ctx context.Context, environmentId string, body CreateVPNServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVPNServiceJobResponse, error)

func (*ClientWithResponses) CreateVPNUserWithBodyWithResponse

func (c *ClientWithResponses) CreateVPNUserWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVPNUserResponse, error)

CreateVPNUserWithBodyWithResponse request with arbitrary body returning *CreateVPNUserResponse

func (*ClientWithResponses) CreateVPNUserWithResponse

func (c *ClientWithResponses) CreateVPNUserWithResponse(ctx context.Context, environmentId string, body CreateVPNUserJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVPNUserResponse, error)

func (*ClientWithResponses) CreateVirtualMachineJobWithBodyWithResponse

func (c *ClientWithResponses) CreateVirtualMachineJobWithBodyWithResponse(ctx context.Context, virtualMachineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVirtualMachineJobResponse, error)

CreateVirtualMachineJobWithBodyWithResponse request with arbitrary body returning *CreateVirtualMachineJobResponse

func (*ClientWithResponses) CreateVirtualMachineJobWithResponse

func (c *ClientWithResponses) CreateVirtualMachineJobWithResponse(ctx context.Context, virtualMachineId string, body CreateVirtualMachineJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVirtualMachineJobResponse, error)

func (*ClientWithResponses) CreateVirtualMachineSshKeyWithBodyWithResponse

func (c *ClientWithResponses) CreateVirtualMachineSshKeyWithBodyWithResponse(ctx context.Context, params *CreateVirtualMachineSshKeyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVirtualMachineSshKeyResponse, error)

CreateVirtualMachineSshKeyWithBodyWithResponse request with arbitrary body returning *CreateVirtualMachineSshKeyResponse

func (*ClientWithResponses) CreateVirtualMachineWithBodyWithResponse

func (c *ClientWithResponses) CreateVirtualMachineWithBodyWithResponse(ctx context.Context, params *CreateVirtualMachineParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVirtualMachineResponse, error)

CreateVirtualMachineWithBodyWithResponse request with arbitrary body returning *CreateVirtualMachineResponse

func (*ClientWithResponses) CreateVirtualMachineWithResponse

func (*ClientWithResponses) CreateVirtualProviderIsoJobWithBodyWithResponse added in v0.6.3

func (c *ClientWithResponses) CreateVirtualProviderIsoJobWithBodyWithResponse(ctx context.Context, integrationId string, isoId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVirtualProviderIsoJobResponse, error)

CreateVirtualProviderIsoJobWithBodyWithResponse request with arbitrary body returning *CreateVirtualProviderIsoJobResponse

func (*ClientWithResponses) CreateVirtualProviderIsoJobWithResponse added in v0.6.3

func (c *ClientWithResponses) CreateVirtualProviderIsoJobWithResponse(ctx context.Context, integrationId string, isoId string, body CreateVirtualProviderIsoJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVirtualProviderIsoJobResponse, error)

func (*ClientWithResponses) CreateVirtualProviderIsoWithBodyWithResponse added in v0.6.3

func (c *ClientWithResponses) CreateVirtualProviderIsoWithBodyWithResponse(ctx context.Context, integrationId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVirtualProviderIsoResponse, error)

CreateVirtualProviderIsoWithBodyWithResponse request with arbitrary body returning *CreateVirtualProviderIsoResponse

func (*ClientWithResponses) CreateVirtualProviderIsoWithResponse added in v0.6.3

func (c *ClientWithResponses) CreateVirtualProviderIsoWithResponse(ctx context.Context, integrationId string, body CreateVirtualProviderIsoJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVirtualProviderIsoResponse, error)

func (*ClientWithResponses) DeleteAPIKeyWithResponse

func (c *ClientWithResponses) DeleteAPIKeyWithResponse(ctx context.Context, apikeyId string, reqEditors ...RequestEditorFn) (*DeleteAPIKeyResponse, error)

DeleteAPIKeyWithResponse request returning *DeleteAPIKeyResponse

func (*ClientWithResponses) DeleteAccountWithResponse

func (c *ClientWithResponses) DeleteAccountWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*DeleteAccountResponse, error)

DeleteAccountWithResponse request returning *DeleteAccountResponse

func (*ClientWithResponses) DeleteAutoScaleGroupWithResponse

func (c *ClientWithResponses) DeleteAutoScaleGroupWithResponse(ctx context.Context, groupId string, reqEditors ...RequestEditorFn) (*DeleteAutoScaleGroupResponse, error)

DeleteAutoScaleGroupWithResponse request returning *DeleteAutoScaleGroupResponse

func (*ClientWithResponses) DeleteBillingMethodWithResponse

func (c *ClientWithResponses) DeleteBillingMethodWithResponse(ctx context.Context, methodId string, reqEditors ...RequestEditorFn) (*DeleteBillingMethodResponse, error)

DeleteBillingMethodWithResponse request returning *DeleteBillingMethodResponse

func (*ClientWithResponses) DeleteClusterWithResponse

func (c *ClientWithResponses) DeleteClusterWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*DeleteClusterResponse, error)

DeleteClusterWithResponse request returning *DeleteClusterResponse

func (*ClientWithResponses) DeleteContainerBackupWithResponse

func (c *ClientWithResponses) DeleteContainerBackupWithResponse(ctx context.Context, containerId string, backupId string, reqEditors ...RequestEditorFn) (*DeleteContainerBackupResponse, error)

DeleteContainerBackupWithResponse request returning *DeleteContainerBackupResponse

func (*ClientWithResponses) DeleteContainerInstancesWithResponse

func (c *ClientWithResponses) DeleteContainerInstancesWithResponse(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*DeleteContainerInstancesResponse, error)

DeleteContainerInstancesWithResponse request returning *DeleteContainerInstancesResponse

func (*ClientWithResponses) DeleteContainerWithResponse

func (c *ClientWithResponses) DeleteContainerWithResponse(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*DeleteContainerResponse, error)

DeleteContainerWithResponse request returning *DeleteContainerResponse

func (*ClientWithResponses) DeleteDNSZoneRecordWithResponse

func (c *ClientWithResponses) DeleteDNSZoneRecordWithResponse(ctx context.Context, zoneId string, recordId string, reqEditors ...RequestEditorFn) (*DeleteDNSZoneRecordResponse, error)

DeleteDNSZoneRecordWithResponse request returning *DeleteDNSZoneRecordResponse

func (*ClientWithResponses) DeleteDNSZoneWithResponse

func (c *ClientWithResponses) DeleteDNSZoneWithResponse(ctx context.Context, zoneId string, reqEditors ...RequestEditorFn) (*DeleteDNSZoneResponse, error)

DeleteDNSZoneWithResponse request returning *DeleteDNSZoneResponse

func (*ClientWithResponses) DeleteEnvironmentWithResponse

func (c *ClientWithResponses) DeleteEnvironmentWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*DeleteEnvironmentResponse, error)

DeleteEnvironmentWithResponse request returning *DeleteEnvironmentResponse

func (*ClientWithResponses) DeleteExternalVolumeWithBodyWithResponse added in v0.6.5

func (c *ClientWithResponses) DeleteExternalVolumeWithBodyWithResponse(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteExternalVolumeResponse, error)

DeleteExternalVolumeWithBodyWithResponse request with arbitrary body returning *DeleteExternalVolumeResponse

func (*ClientWithResponses) DeleteExternalVolumeWithResponse added in v0.6.5

func (c *ClientWithResponses) DeleteExternalVolumeWithResponse(ctx context.Context, externalVolumeId string, body DeleteExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteExternalVolumeResponse, error)

func (*ClientWithResponses) DeleteHubInviteWithResponse

func (c *ClientWithResponses) DeleteHubInviteWithResponse(ctx context.Context, inviteId string, reqEditors ...RequestEditorFn) (*DeleteHubInviteResponse, error)

DeleteHubInviteWithResponse request returning *DeleteHubInviteResponse

func (*ClientWithResponses) DeleteHubMemberWithResponse

func (c *ClientWithResponses) DeleteHubMemberWithResponse(ctx context.Context, memberId string, reqEditors ...RequestEditorFn) (*DeleteHubMemberResponse, error)

DeleteHubMemberWithResponse request returning *DeleteHubMemberResponse

func (*ClientWithResponses) DeleteHubWithBodyWithResponse

func (c *ClientWithResponses) DeleteHubWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteHubResponse, error)

DeleteHubWithBodyWithResponse request with arbitrary body returning *DeleteHubResponse

func (*ClientWithResponses) DeleteHubWithResponse

func (c *ClientWithResponses) DeleteHubWithResponse(ctx context.Context, body DeleteHubJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteHubResponse, error)

func (*ClientWithResponses) DeleteIPPoolWithResponse

func (c *ClientWithResponses) DeleteIPPoolWithResponse(ctx context.Context, poolId string, reqEditors ...RequestEditorFn) (*DeleteIPPoolResponse, error)

DeleteIPPoolWithResponse request returning *DeleteIPPoolResponse

func (*ClientWithResponses) DeleteImageSourceWithResponse

func (c *ClientWithResponses) DeleteImageSourceWithResponse(ctx context.Context, sourceId string, reqEditors ...RequestEditorFn) (*DeleteImageSourceResponse, error)

DeleteImageSourceWithResponse request returning *DeleteImageSourceResponse

func (*ClientWithResponses) DeleteImageWithResponse

func (c *ClientWithResponses) DeleteImageWithResponse(ctx context.Context, imageId string, reqEditors ...RequestEditorFn) (*DeleteImageResponse, error)

DeleteImageWithResponse request returning *DeleteImageResponse

func (*ClientWithResponses) DeleteInstanceWithResponse

func (c *ClientWithResponses) DeleteInstanceWithResponse(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*DeleteInstanceResponse, error)

DeleteInstanceWithResponse request returning *DeleteInstanceResponse

func (*ClientWithResponses) DeleteIntegrationWithResponse

func (c *ClientWithResponses) DeleteIntegrationWithResponse(ctx context.Context, integrationId string, reqEditors ...RequestEditorFn) (*DeleteIntegrationResponse, error)

DeleteIntegrationWithResponse request returning *DeleteIntegrationResponse

func (*ClientWithResponses) DeleteNetworkWithResponse

func (c *ClientWithResponses) DeleteNetworkWithResponse(ctx context.Context, networkId string, reqEditors ...RequestEditorFn) (*DeleteNetworkResponse, error)

DeleteNetworkWithResponse request returning *DeleteNetworkResponse

func (*ClientWithResponses) DeletePipelineTriggerKeyWithResponse

func (c *ClientWithResponses) DeletePipelineTriggerKeyWithResponse(ctx context.Context, pipelineId string, triggerKeyId string, reqEditors ...RequestEditorFn) (*DeletePipelineTriggerKeyResponse, error)

DeletePipelineTriggerKeyWithResponse request returning *DeletePipelineTriggerKeyResponse

func (*ClientWithResponses) DeletePipelineWithResponse

func (c *ClientWithResponses) DeletePipelineWithResponse(ctx context.Context, pipelineId string, reqEditors ...RequestEditorFn) (*DeletePipelineResponse, error)

DeletePipelineWithResponse request returning *DeletePipelineResponse

func (*ClientWithResponses) DeleteRoleWithResponse

func (c *ClientWithResponses) DeleteRoleWithResponse(ctx context.Context, roleId string, reqEditors ...RequestEditorFn) (*DeleteRoleResponse, error)

DeleteRoleWithResponse request returning *DeleteRoleResponse

func (*ClientWithResponses) DeleteScopedVariableWithResponse

func (c *ClientWithResponses) DeleteScopedVariableWithResponse(ctx context.Context, environmentId string, scopedVariableId string, reqEditors ...RequestEditorFn) (*DeleteScopedVariableResponse, error)

DeleteScopedVariableWithResponse request returning *DeleteScopedVariableResponse

func (*ClientWithResponses) DeleteServerWithBodyWithResponse

func (c *ClientWithResponses) DeleteServerWithBodyWithResponse(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteServerResponse, error)

DeleteServerWithBodyWithResponse request with arbitrary body returning *DeleteServerResponse

func (*ClientWithResponses) DeleteServerWithResponse

func (c *ClientWithResponses) DeleteServerWithResponse(ctx context.Context, serverId string, body DeleteServerJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteServerResponse, error)

func (*ClientWithResponses) DeleteStackBuildWithResponse

func (c *ClientWithResponses) DeleteStackBuildWithResponse(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*DeleteStackBuildResponse, error)

DeleteStackBuildWithResponse request returning *DeleteStackBuildResponse

func (*ClientWithResponses) DeleteStackWithResponse

func (c *ClientWithResponses) DeleteStackWithResponse(ctx context.Context, stackId string, reqEditors ...RequestEditorFn) (*DeleteStackResponse, error)

DeleteStackWithResponse request returning *DeleteStackResponse

func (*ClientWithResponses) DeleteVPNUserWithResponse

func (c *ClientWithResponses) DeleteVPNUserWithResponse(ctx context.Context, environmentId string, userId string, reqEditors ...RequestEditorFn) (*DeleteVPNUserResponse, error)

DeleteVPNUserWithResponse request returning *DeleteVPNUserResponse

func (*ClientWithResponses) DeleteVirtualMachineSshKeyWithResponse

func (c *ClientWithResponses) DeleteVirtualMachineSshKeyWithResponse(ctx context.Context, sshKeyId string, reqEditors ...RequestEditorFn) (*DeleteVirtualMachineSshKeyResponse, error)

DeleteVirtualMachineSshKeyWithResponse request returning *DeleteVirtualMachineSshKeyResponse

func (*ClientWithResponses) DeleteVirtualMachineWithResponse

func (c *ClientWithResponses) DeleteVirtualMachineWithResponse(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*DeleteVirtualMachineResponse, error)

DeleteVirtualMachineWithResponse request returning *DeleteVirtualMachineResponse

func (*ClientWithResponses) DeleteVirtualProviderIsoWithResponse added in v0.6.3

func (c *ClientWithResponses) DeleteVirtualProviderIsoWithResponse(ctx context.Context, integrationId string, isoId string, reqEditors ...RequestEditorFn) (*DeleteVirtualProviderIsoResponse, error)

DeleteVirtualProviderIsoWithResponse request returning *DeleteVirtualProviderIsoResponse

func (*ClientWithResponses) DisableTwoFactorAuthWithBodyWithResponse

func (c *ClientWithResponses) DisableTwoFactorAuthWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DisableTwoFactorAuthResponse, error)

DisableTwoFactorAuthWithBodyWithResponse request with arbitrary body returning *DisableTwoFactorAuthResponse

func (*ClientWithResponses) DisableTwoFactorAuthWithResponse

func (c *ClientWithResponses) DisableTwoFactorAuthWithResponse(ctx context.Context, body DisableTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*DisableTwoFactorAuthResponse, error)

func (*ClientWithResponses) EnableTwoFactorAuthWithBodyWithResponse

func (c *ClientWithResponses) EnableTwoFactorAuthWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EnableTwoFactorAuthResponse, error)

EnableTwoFactorAuthWithBodyWithResponse request with arbitrary body returning *EnableTwoFactorAuthResponse

func (*ClientWithResponses) EnableTwoFactorAuthWithResponse

func (c *ClientWithResponses) EnableTwoFactorAuthWithResponse(ctx context.Context, body EnableTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*EnableTwoFactorAuthResponse, error)

func (*ClientWithResponses) ExpireInstanceSSHCredentialsWithResponse

func (c *ClientWithResponses) ExpireInstanceSSHCredentialsWithResponse(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*ExpireInstanceSSHCredentialsResponse, error)

ExpireInstanceSSHCredentialsWithResponse request returning *ExpireInstanceSSHCredentialsResponse

func (*ClientWithResponses) ExpireVirtualMachineSosCredentialsWithResponse

func (c *ClientWithResponses) ExpireVirtualMachineSosCredentialsWithResponse(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*ExpireVirtualMachineSosCredentialsResponse, error)

ExpireVirtualMachineSosCredentialsWithResponse request returning *ExpireVirtualMachineSosCredentialsResponse

func (*ClientWithResponses) ExportStackWithBodyWithResponse

func (c *ClientWithResponses) ExportStackWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExportStackResponse, error)

ExportStackWithBodyWithResponse request with arbitrary body returning *ExportStackResponse

func (*ClientWithResponses) ExportStackWithResponse

func (c *ClientWithResponses) ExportStackWithResponse(ctx context.Context, environmentId string, body ExportStackJSONRequestBody, reqEditors ...RequestEditorFn) (*ExportStackResponse, error)

func (*ClientWithResponses) GenerateAggregatedEventsWithBodyWithResponse

func (c *ClientWithResponses) GenerateAggregatedEventsWithBodyWithResponse(ctx context.Context, params *GenerateAggregatedEventsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GenerateAggregatedEventsResponse, error)

GenerateAggregatedEventsWithBodyWithResponse request with arbitrary body returning *GenerateAggregatedEventsResponse

func (*ClientWithResponses) GenerateAggregatedMetricsWithBodyWithResponse

func (c *ClientWithResponses) GenerateAggregatedMetricsWithBodyWithResponse(ctx context.Context, params *GenerateAggregatedMetricsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GenerateAggregatedMetricsResponse, error)

GenerateAggregatedMetricsWithBodyWithResponse request with arbitrary body returning *GenerateAggregatedMetricsResponse

func (*ClientWithResponses) GenerateInstanceSSHCredentialsWithResponse

func (c *ClientWithResponses) GenerateInstanceSSHCredentialsWithResponse(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*GenerateInstanceSSHCredentialsResponse, error)

GenerateInstanceSSHCredentialsWithResponse request returning *GenerateInstanceSSHCredentialsResponse

func (*ClientWithResponses) GenerateVirtualMachineSosCredentialsWithResponse

func (c *ClientWithResponses) GenerateVirtualMachineSosCredentialsWithResponse(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*GenerateVirtualMachineSosCredentialsResponse, error)

GenerateVirtualMachineSosCredentialsWithResponse request returning *GenerateVirtualMachineSosCredentialsResponse

func (*ClientWithResponses) GetAPIKeyWithResponse

func (c *ClientWithResponses) GetAPIKeyWithResponse(ctx context.Context, apikeyId string, params *GetAPIKeyParams, reqEditors ...RequestEditorFn) (*GetAPIKeyResponse, error)

GetAPIKeyWithResponse request returning *GetAPIKeyResponse

func (*ClientWithResponses) GetAccountInvitesWithResponse

func (c *ClientWithResponses) GetAccountInvitesWithResponse(ctx context.Context, params *GetAccountInvitesParams, reqEditors ...RequestEditorFn) (*GetAccountInvitesResponse, error)

GetAccountInvitesWithResponse request returning *GetAccountInvitesResponse

func (*ClientWithResponses) GetAccountLoginsWithResponse

func (c *ClientWithResponses) GetAccountLoginsWithResponse(ctx context.Context, params *GetAccountLoginsParams, reqEditors ...RequestEditorFn) (*GetAccountLoginsResponse, error)

GetAccountLoginsWithResponse request returning *GetAccountLoginsResponse

func (*ClientWithResponses) GetAccountMembershipsWithResponse

func (c *ClientWithResponses) GetAccountMembershipsWithResponse(ctx context.Context, params *GetAccountMembershipsParams, reqEditors ...RequestEditorFn) (*GetAccountMembershipsResponse, error)

GetAccountMembershipsWithResponse request returning *GetAccountMembershipsResponse

func (*ClientWithResponses) GetAccountWithResponse

func (c *ClientWithResponses) GetAccountWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountResponse, error)

GetAccountWithResponse request returning *GetAccountResponse

func (*ClientWithResponses) GetAllPipelineRunsWithResponse added in v0.6.6

func (c *ClientWithResponses) GetAllPipelineRunsWithResponse(ctx context.Context, params *GetAllPipelineRunsParams, reqEditors ...RequestEditorFn) (*GetAllPipelineRunsResponse, error)

GetAllPipelineRunsWithResponse request returning *GetAllPipelineRunsResponse

func (*ClientWithResponses) GetAllStackBuildsWithResponse added in v0.6.6

func (c *ClientWithResponses) GetAllStackBuildsWithResponse(ctx context.Context, params *GetAllStackBuildsParams, reqEditors ...RequestEditorFn) (*GetAllStackBuildsResponse, error)

GetAllStackBuildsWithResponse request returning *GetAllStackBuildsResponse

func (*ClientWithResponses) GetAllTlsCertificatesWithResponse added in v0.6.6

func (c *ClientWithResponses) GetAllTlsCertificatesWithResponse(ctx context.Context, params *GetAllTlsCertificatesParams, reqEditors ...RequestEditorFn) (*GetAllTlsCertificatesResponse, error)

GetAllTlsCertificatesWithResponse request returning *GetAllTlsCertificatesResponse

func (*ClientWithResponses) GetAnnouncementsWithResponse

func (c *ClientWithResponses) GetAnnouncementsWithResponse(ctx context.Context, params *GetAnnouncementsParams, reqEditors ...RequestEditorFn) (*GetAnnouncementsResponse, error)

GetAnnouncementsWithResponse request returning *GetAnnouncementsResponse

func (*ClientWithResponses) GetApiKeysWithResponse

func (c *ClientWithResponses) GetApiKeysWithResponse(ctx context.Context, params *GetApiKeysParams, reqEditors ...RequestEditorFn) (*GetApiKeysResponse, error)

GetApiKeysWithResponse request returning *GetApiKeysResponse

func (*ClientWithResponses) GetAutoScaleGroupWithResponse

func (c *ClientWithResponses) GetAutoScaleGroupWithResponse(ctx context.Context, groupId string, params *GetAutoScaleGroupParams, reqEditors ...RequestEditorFn) (*GetAutoScaleGroupResponse, error)

GetAutoScaleGroupWithResponse request returning *GetAutoScaleGroupResponse

func (*ClientWithResponses) GetAutoScaleGroupsWithResponse

func (c *ClientWithResponses) GetAutoScaleGroupsWithResponse(ctx context.Context, params *GetAutoScaleGroupsParams, reqEditors ...RequestEditorFn) (*GetAutoScaleGroupsResponse, error)

GetAutoScaleGroupsWithResponse request returning *GetAutoScaleGroupsResponse

func (*ClientWithResponses) GetAvailableIntegrationsWithResponse

func (c *ClientWithResponses) GetAvailableIntegrationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAvailableIntegrationsResponse, error)

GetAvailableIntegrationsWithResponse request returning *GetAvailableIntegrationsResponse

func (*ClientWithResponses) GetAvailableIpsWithResponse

func (c *ClientWithResponses) GetAvailableIpsWithResponse(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*GetAvailableIpsResponse, error)

GetAvailableIpsWithResponse request returning *GetAvailableIpsResponse

func (*ClientWithResponses) GetBillingMethodWithResponse

func (c *ClientWithResponses) GetBillingMethodWithResponse(ctx context.Context, methodId string, reqEditors ...RequestEditorFn) (*GetBillingMethodResponse, error)

GetBillingMethodWithResponse request returning *GetBillingMethodResponse

func (*ClientWithResponses) GetBillingMethodsWithResponse

func (c *ClientWithResponses) GetBillingMethodsWithResponse(ctx context.Context, params *GetBillingMethodsParams, reqEditors ...RequestEditorFn) (*GetBillingMethodsResponse, error)

GetBillingMethodsWithResponse request returning *GetBillingMethodsResponse

func (*ClientWithResponses) GetBillingOrderWithResponse

func (c *ClientWithResponses) GetBillingOrderWithResponse(ctx context.Context, orderId string, params *GetBillingOrderParams, reqEditors ...RequestEditorFn) (*GetBillingOrderResponse, error)

GetBillingOrderWithResponse request returning *GetBillingOrderResponse

func (*ClientWithResponses) GetBillingOveragesWithResponse

func (c *ClientWithResponses) GetBillingOveragesWithResponse(ctx context.Context, params *GetBillingOveragesParams, reqEditors ...RequestEditorFn) (*GetBillingOveragesResponse, error)

GetBillingOveragesWithResponse request returning *GetBillingOveragesResponse

func (*ClientWithResponses) GetBillingServiceWithResponse

func (c *ClientWithResponses) GetBillingServiceWithResponse(ctx context.Context, servicesId string, reqEditors ...RequestEditorFn) (*GetBillingServiceResponse, error)

GetBillingServiceWithResponse request returning *GetBillingServiceResponse

func (*ClientWithResponses) GetBillingServicesWithResponse

func (c *ClientWithResponses) GetBillingServicesWithResponse(ctx context.Context, params *GetBillingServicesParams, reqEditors ...RequestEditorFn) (*GetBillingServicesResponse, error)

GetBillingServicesWithResponse request returning *GetBillingServicesResponse

func (*ClientWithResponses) GetBillingStatusWithResponse added in v0.6.2

func (c *ClientWithResponses) GetBillingStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetBillingStatusResponse, error)

GetBillingStatusWithResponse request returning *GetBillingStatusResponse

func (*ClientWithResponses) GetBillingSupportPlansWithResponse

func (c *ClientWithResponses) GetBillingSupportPlansWithResponse(ctx context.Context, params *GetBillingSupportPlansParams, reqEditors ...RequestEditorFn) (*GetBillingSupportPlansResponse, error)

GetBillingSupportPlansWithResponse request returning *GetBillingSupportPlansResponse

func (*ClientWithResponses) GetBillingTiersWithResponse

func (c *ClientWithResponses) GetBillingTiersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetBillingTiersResponse, error)

GetBillingTiersWithResponse request returning *GetBillingTiersResponse

func (*ClientWithResponses) GetChangelogWithResponse added in v0.6.4

func (c *ClientWithResponses) GetChangelogWithResponse(ctx context.Context, params *GetChangelogParams, reqEditors ...RequestEditorFn) (*GetChangelogResponse, error)

GetChangelogWithResponse request returning *GetChangelogResponse

func (*ClientWithResponses) GetClusterMonitoringTiersWithResponse added in v0.6.3

func (c *ClientWithResponses) GetClusterMonitoringTiersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetClusterMonitoringTiersResponse, error)

GetClusterMonitoringTiersWithResponse request returning *GetClusterMonitoringTiersResponse

func (*ClientWithResponses) GetClusterWithResponse

func (c *ClientWithResponses) GetClusterWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetClusterResponse, error)

GetClusterWithResponse request returning *GetClusterResponse

func (*ClientWithResponses) GetClustersWithResponse

func (c *ClientWithResponses) GetClustersWithResponse(ctx context.Context, params *GetClustersParams, reqEditors ...RequestEditorFn) (*GetClustersResponse, error)

GetClustersWithResponse request returning *GetClustersResponse

func (*ClientWithResponses) GetCompatibleImagesWithResponse

func (c *ClientWithResponses) GetCompatibleImagesWithResponse(ctx context.Context, containerId string, params *GetCompatibleImagesParams, reqEditors ...RequestEditorFn) (*GetCompatibleImagesResponse, error)

GetCompatibleImagesWithResponse request returning *GetCompatibleImagesResponse

func (*ClientWithResponses) GetCompatibleServersWithResponse

func (c *ClientWithResponses) GetCompatibleServersWithResponse(ctx context.Context, containerId string, params *GetCompatibleServersParams, reqEditors ...RequestEditorFn) (*GetCompatibleServersResponse, error)

GetCompatibleServersWithResponse request returning *GetCompatibleServersResponse

func (*ClientWithResponses) GetContainerBackupLogsWithResponse

func (c *ClientWithResponses) GetContainerBackupLogsWithResponse(ctx context.Context, containerId string, backupId string, reqEditors ...RequestEditorFn) (*GetContainerBackupLogsResponse, error)

GetContainerBackupLogsWithResponse request returning *GetContainerBackupLogsResponse

func (*ClientWithResponses) GetContainerBackupWithResponse

func (c *ClientWithResponses) GetContainerBackupWithResponse(ctx context.Context, containerId string, backupId string, params *GetContainerBackupParams, reqEditors ...RequestEditorFn) (*GetContainerBackupResponse, error)

GetContainerBackupWithResponse request returning *GetContainerBackupResponse

func (*ClientWithResponses) GetContainerBackupsWithResponse

func (c *ClientWithResponses) GetContainerBackupsWithResponse(ctx context.Context, containerId string, params *GetContainerBackupsParams, reqEditors ...RequestEditorFn) (*GetContainerBackupsResponse, error)

GetContainerBackupsWithResponse request returning *GetContainerBackupsResponse

func (*ClientWithResponses) GetContainerServersWithResponse

func (c *ClientWithResponses) GetContainerServersWithResponse(ctx context.Context, containerId string, params *GetContainerServersParams, reqEditors ...RequestEditorFn) (*GetContainerServersResponse, error)

GetContainerServersWithResponse request returning *GetContainerServersResponse

func (*ClientWithResponses) GetContainerSummaryWithResponse

func (c *ClientWithResponses) GetContainerSummaryWithResponse(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*GetContainerSummaryResponse, error)

GetContainerSummaryWithResponse request returning *GetContainerSummaryResponse

func (*ClientWithResponses) GetContainerWithResponse

func (c *ClientWithResponses) GetContainerWithResponse(ctx context.Context, containerId string, params *GetContainerParams, reqEditors ...RequestEditorFn) (*GetContainerResponse, error)

GetContainerWithResponse request returning *GetContainerResponse

func (*ClientWithResponses) GetContainersWithResponse

func (c *ClientWithResponses) GetContainersWithResponse(ctx context.Context, params *GetContainersParams, reqEditors ...RequestEditorFn) (*GetContainersResponse, error)

GetContainersWithResponse request returning *GetContainersResponse

func (*ClientWithResponses) GetCreditWithResponse

func (c *ClientWithResponses) GetCreditWithResponse(ctx context.Context, creditsId string, reqEditors ...RequestEditorFn) (*GetCreditResponse, error)

GetCreditWithResponse request returning *GetCreditResponse

func (*ClientWithResponses) GetCreditsWithResponse

func (c *ClientWithResponses) GetCreditsWithResponse(ctx context.Context, params *GetCreditsParams, reqEditors ...RequestEditorFn) (*GetCreditsResponse, error)

GetCreditsWithResponse request returning *GetCreditsResponse

func (*ClientWithResponses) GetDNSZoneRecordsWithResponse

func (c *ClientWithResponses) GetDNSZoneRecordsWithResponse(ctx context.Context, zoneId string, params *GetDNSZoneRecordsParams, reqEditors ...RequestEditorFn) (*GetDNSZoneRecordsResponse, error)

GetDNSZoneRecordsWithResponse request returning *GetDNSZoneRecordsResponse

func (*ClientWithResponses) GetDNSZoneWithResponse

func (c *ClientWithResponses) GetDNSZoneWithResponse(ctx context.Context, zoneId string, reqEditors ...RequestEditorFn) (*GetDNSZoneResponse, error)

GetDNSZoneWithResponse request returning *GetDNSZoneResponse

func (*ClientWithResponses) GetDNSZonesWithResponse

func (c *ClientWithResponses) GetDNSZonesWithResponse(ctx context.Context, params *GetDNSZonesParams, reqEditors ...RequestEditorFn) (*GetDNSZonesResponse, error)

GetDNSZonesWithResponse request returning *GetDNSZonesResponse

func (*ClientWithResponses) GetDefaultHubRolesWithResponse

func (c *ClientWithResponses) GetDefaultHubRolesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetDefaultHubRolesResponse, error)

GetDefaultHubRolesWithResponse request returning *GetDefaultHubRolesResponse

func (*ClientWithResponses) GetDeploymentStrategiesWithResponse

func (c *ClientWithResponses) GetDeploymentStrategiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetDeploymentStrategiesResponse, error)

GetDeploymentStrategiesWithResponse request returning *GetDeploymentStrategiesResponse

func (*ClientWithResponses) GetEnvironmentDeploymentsWithResponse

func (c *ClientWithResponses) GetEnvironmentDeploymentsWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*GetEnvironmentDeploymentsResponse, error)

GetEnvironmentDeploymentsWithResponse request returning *GetEnvironmentDeploymentsResponse

func (*ClientWithResponses) GetEnvironmentSummaryWithResponse

func (c *ClientWithResponses) GetEnvironmentSummaryWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*GetEnvironmentSummaryResponse, error)

GetEnvironmentSummaryWithResponse request returning *GetEnvironmentSummaryResponse

func (*ClientWithResponses) GetEnvironmentWithResponse

func (c *ClientWithResponses) GetEnvironmentWithResponse(ctx context.Context, environmentId string, params *GetEnvironmentParams, reqEditors ...RequestEditorFn) (*GetEnvironmentResponse, error)

GetEnvironmentWithResponse request returning *GetEnvironmentResponse

func (*ClientWithResponses) GetEnvironmentsWithResponse

func (c *ClientWithResponses) GetEnvironmentsWithResponse(ctx context.Context, params *GetEnvironmentsParams, reqEditors ...RequestEditorFn) (*GetEnvironmentsResponse, error)

GetEnvironmentsWithResponse request returning *GetEnvironmentsResponse

func (*ClientWithResponses) GetEventsWithResponse

func (c *ClientWithResponses) GetEventsWithResponse(ctx context.Context, params *GetEventsParams, reqEditors ...RequestEditorFn) (*GetEventsResponse, error)

GetEventsWithResponse request returning *GetEventsResponse

func (*ClientWithResponses) GetExternalVolumeSourcesWithResponse added in v0.6.5

func (c *ClientWithResponses) GetExternalVolumeSourcesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetExternalVolumeSourcesResponse, error)

GetExternalVolumeSourcesWithResponse request returning *GetExternalVolumeSourcesResponse

func (*ClientWithResponses) GetExternalVolumeWithResponse added in v0.6.5

func (c *ClientWithResponses) GetExternalVolumeWithResponse(ctx context.Context, externalVolumeId string, params *GetExternalVolumeParams, reqEditors ...RequestEditorFn) (*GetExternalVolumeResponse, error)

GetExternalVolumeWithResponse request returning *GetExternalVolumeResponse

func (*ClientWithResponses) GetExternalVolumesWithResponse added in v0.6.5

func (c *ClientWithResponses) GetExternalVolumesWithResponse(ctx context.Context, params *GetExternalVolumesParams, reqEditors ...RequestEditorFn) (*GetExternalVolumesResponse, error)

GetExternalVolumesWithResponse request returning *GetExternalVolumesResponse

func (*ClientWithResponses) GetHubActivityWithResponse

func (c *ClientWithResponses) GetHubActivityWithResponse(ctx context.Context, params *GetHubActivityParams, reqEditors ...RequestEditorFn) (*GetHubActivityResponse, error)

GetHubActivityWithResponse request returning *GetHubActivityResponse

func (*ClientWithResponses) GetHubCapabilitiesWithResponse

func (c *ClientWithResponses) GetHubCapabilitiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHubCapabilitiesResponse, error)

GetHubCapabilitiesWithResponse request returning *GetHubCapabilitiesResponse

func (*ClientWithResponses) GetHubInvitesWithResponse

func (c *ClientWithResponses) GetHubInvitesWithResponse(ctx context.Context, params *GetHubInvitesParams, reqEditors ...RequestEditorFn) (*GetHubInvitesResponse, error)

GetHubInvitesWithResponse request returning *GetHubInvitesResponse

func (*ClientWithResponses) GetHubMemberAccountWithResponse

func (c *ClientWithResponses) GetHubMemberAccountWithResponse(ctx context.Context, accountId string, params *GetHubMemberAccountParams, reqEditors ...RequestEditorFn) (*GetHubMemberAccountResponse, error)

GetHubMemberAccountWithResponse request returning *GetHubMemberAccountResponse

func (*ClientWithResponses) GetHubMemberWithResponse

func (c *ClientWithResponses) GetHubMemberWithResponse(ctx context.Context, memberId string, params *GetHubMemberParams, reqEditors ...RequestEditorFn) (*GetHubMemberResponse, error)

GetHubMemberWithResponse request returning *GetHubMemberResponse

func (*ClientWithResponses) GetHubMembersWithResponse

func (c *ClientWithResponses) GetHubMembersWithResponse(ctx context.Context, params *GetHubMembersParams, reqEditors ...RequestEditorFn) (*GetHubMembersResponse, error)

GetHubMembersWithResponse request returning *GetHubMembersResponse

func (*ClientWithResponses) GetHubMembershipWithResponse

func (c *ClientWithResponses) GetHubMembershipWithResponse(ctx context.Context, params *GetHubMembershipParams, reqEditors ...RequestEditorFn) (*GetHubMembershipResponse, error)

GetHubMembershipWithResponse request returning *GetHubMembershipResponse

func (*ClientWithResponses) GetHubNotificationSocketAuthWithResponse

func (c *ClientWithResponses) GetHubNotificationSocketAuthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHubNotificationSocketAuthResponse, error)

GetHubNotificationSocketAuthWithResponse request returning *GetHubNotificationSocketAuthResponse

func (*ClientWithResponses) GetHubUsageWithResponse

func (c *ClientWithResponses) GetHubUsageWithResponse(ctx context.Context, params *GetHubUsageParams, reqEditors ...RequestEditorFn) (*GetHubUsageResponse, error)

GetHubUsageWithResponse request returning *GetHubUsageResponse

func (*ClientWithResponses) GetHubWithResponse

func (c *ClientWithResponses) GetHubWithResponse(ctx context.Context, params *GetHubParams, reqEditors ...RequestEditorFn) (*GetHubResponse, error)

GetHubWithResponse request returning *GetHubResponse

func (*ClientWithResponses) GetHubsWithResponse

func (c *ClientWithResponses) GetHubsWithResponse(ctx context.Context, params *GetHubsParams, reqEditors ...RequestEditorFn) (*GetHubsResponse, error)

GetHubsWithResponse request returning *GetHubsResponse

func (*ClientWithResponses) GetIPPoolWithResponse

func (c *ClientWithResponses) GetIPPoolWithResponse(ctx context.Context, poolId string, params *GetIPPoolParams, reqEditors ...RequestEditorFn) (*GetIPPoolResponse, error)

GetIPPoolWithResponse request returning *GetIPPoolResponse

func (*ClientWithResponses) GetImageBuildLogWithResponse

func (c *ClientWithResponses) GetImageBuildLogWithResponse(ctx context.Context, imageId string, reqEditors ...RequestEditorFn) (*GetImageBuildLogResponse, error)

GetImageBuildLogWithResponse request returning *GetImageBuildLogResponse

func (*ClientWithResponses) GetImageSourceWithResponse

func (c *ClientWithResponses) GetImageSourceWithResponse(ctx context.Context, sourceId string, params *GetImageSourceParams, reqEditors ...RequestEditorFn) (*GetImageSourceResponse, error)

GetImageSourceWithResponse request returning *GetImageSourceResponse

func (*ClientWithResponses) GetImageSourcesWithResponse

func (c *ClientWithResponses) GetImageSourcesWithResponse(ctx context.Context, params *GetImageSourcesParams, reqEditors ...RequestEditorFn) (*GetImageSourcesResponse, error)

GetImageSourcesWithResponse request returning *GetImageSourcesResponse

func (*ClientWithResponses) GetImageWithResponse

func (c *ClientWithResponses) GetImageWithResponse(ctx context.Context, imageId string, params *GetImageParams, reqEditors ...RequestEditorFn) (*GetImageResponse, error)

GetImageWithResponse request returning *GetImageResponse

func (*ClientWithResponses) GetImagesWithResponse

func (c *ClientWithResponses) GetImagesWithResponse(ctx context.Context, params *GetImagesParams, reqEditors ...RequestEditorFn) (*GetImagesResponse, error)

GetImagesWithResponse request returning *GetImagesResponse

func (*ClientWithResponses) GetInfrastructureSummaryWithResponse

func (c *ClientWithResponses) GetInfrastructureSummaryWithResponse(ctx context.Context, params *GetInfrastructureSummaryParams, reqEditors ...RequestEditorFn) (*GetInfrastructureSummaryResponse, error)

GetInfrastructureSummaryWithResponse request returning *GetInfrastructureSummaryResponse

func (*ClientWithResponses) GetInstanceConsoleStreamAuthWithResponse

func (c *ClientWithResponses) GetInstanceConsoleStreamAuthWithResponse(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*GetInstanceConsoleStreamAuthResponse, error)

GetInstanceConsoleStreamAuthWithResponse request returning *GetInstanceConsoleStreamAuthResponse

func (*ClientWithResponses) GetInstanceTelemetryReportWithResponse

func (c *ClientWithResponses) GetInstanceTelemetryReportWithResponse(ctx context.Context, containerId string, instanceId string, params *GetInstanceTelemetryReportParams, reqEditors ...RequestEditorFn) (*GetInstanceTelemetryReportResponse, error)

GetInstanceTelemetryReportWithResponse request returning *GetInstanceTelemetryReportResponse

func (*ClientWithResponses) GetInstanceTelemetryStreamAuthWithResponse

func (c *ClientWithResponses) GetInstanceTelemetryStreamAuthWithResponse(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*GetInstanceTelemetryStreamAuthResponse, error)

GetInstanceTelemetryStreamAuthWithResponse request returning *GetInstanceTelemetryStreamAuthResponse

func (*ClientWithResponses) GetInstanceVolumesWithResponse

func (c *ClientWithResponses) GetInstanceVolumesWithResponse(ctx context.Context, containerId string, instanceId string, params *GetInstanceVolumesParams, reqEditors ...RequestEditorFn) (*GetInstanceVolumesResponse, error)

GetInstanceVolumesWithResponse request returning *GetInstanceVolumesResponse

func (*ClientWithResponses) GetInstanceWithResponse

func (c *ClientWithResponses) GetInstanceWithResponse(ctx context.Context, containerId string, instanceId string, params *GetInstanceParams, reqEditors ...RequestEditorFn) (*GetInstanceResponse, error)

GetInstanceWithResponse request returning *GetInstanceResponse

func (*ClientWithResponses) GetInstancesWithResponse

func (c *ClientWithResponses) GetInstancesWithResponse(ctx context.Context, containerId string, params *GetInstancesParams, reqEditors ...RequestEditorFn) (*GetInstancesResponse, error)

GetInstancesWithResponse request returning *GetInstancesResponse

func (*ClientWithResponses) GetIntegrationWithResponse

func (c *ClientWithResponses) GetIntegrationWithResponse(ctx context.Context, integrationId string, params *GetIntegrationParams, reqEditors ...RequestEditorFn) (*GetIntegrationResponse, error)

GetIntegrationWithResponse request returning *GetIntegrationResponse

func (*ClientWithResponses) GetIntegrationsWithResponse

func (c *ClientWithResponses) GetIntegrationsWithResponse(ctx context.Context, params *GetIntegrationsParams, reqEditors ...RequestEditorFn) (*GetIntegrationsResponse, error)

GetIntegrationsWithResponse request returning *GetIntegrationsResponse

func (*ClientWithResponses) GetInvoiceWithResponse

func (c *ClientWithResponses) GetInvoiceWithResponse(ctx context.Context, invoiceId string, params *GetInvoiceParams, reqEditors ...RequestEditorFn) (*GetInvoiceResponse, error)

GetInvoiceWithResponse request returning *GetInvoiceResponse

func (*ClientWithResponses) GetInvoicesWithResponse

func (c *ClientWithResponses) GetInvoicesWithResponse(ctx context.Context, params *GetInvoicesParams, reqEditors ...RequestEditorFn) (*GetInvoicesResponse, error)

GetInvoicesWithResponse request returning *GetInvoicesResponse

func (*ClientWithResponses) GetIpPoolsWithResponse added in v0.6.3

func (c *ClientWithResponses) GetIpPoolsWithResponse(ctx context.Context, params *GetIpPoolsParams, reqEditors ...RequestEditorFn) (*GetIpPoolsResponse, error)

GetIpPoolsWithResponse request returning *GetIpPoolsResponse

func (*ClientWithResponses) GetJobWithResponse

func (c *ClientWithResponses) GetJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*GetJobResponse, error)

GetJobWithResponse request returning *GetJobResponse

func (*ClientWithResponses) GetJobsWithResponse

func (c *ClientWithResponses) GetJobsWithResponse(ctx context.Context, params *GetJobsParams, reqEditors ...RequestEditorFn) (*GetJobsResponse, error)

GetJobsWithResponse request returning *GetJobsResponse

func (*ClientWithResponses) GetLatestJobsWithResponse

func (c *ClientWithResponses) GetLatestJobsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetLatestJobsResponse, error)

GetLatestJobsWithResponse request returning *GetLatestJobsResponse

func (*ClientWithResponses) GetLoadBalancerLatestTelemetryReportWithResponse

func (c *ClientWithResponses) GetLoadBalancerLatestTelemetryReportWithResponse(ctx context.Context, environmentId string, params *GetLoadBalancerLatestTelemetryReportParams, reqEditors ...RequestEditorFn) (*GetLoadBalancerLatestTelemetryReportResponse, error)

GetLoadBalancerLatestTelemetryReportWithResponse request returning *GetLoadBalancerLatestTelemetryReportResponse

func (*ClientWithResponses) GetLoadBalancerServiceWithResponse

func (c *ClientWithResponses) GetLoadBalancerServiceWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*GetLoadBalancerServiceResponse, error)

GetLoadBalancerServiceWithResponse request returning *GetLoadBalancerServiceResponse

func (*ClientWithResponses) GetLoadBalancerTelemetryLatestControllersWithResponse

func (c *ClientWithResponses) GetLoadBalancerTelemetryLatestControllersWithResponse(ctx context.Context, environmentId string, params *GetLoadBalancerTelemetryLatestControllersParams, reqEditors ...RequestEditorFn) (*GetLoadBalancerTelemetryLatestControllersResponse, error)

GetLoadBalancerTelemetryLatestControllersWithResponse request returning *GetLoadBalancerTelemetryLatestControllersResponse

func (*ClientWithResponses) GetLoadBalancerTelemetryReportWithResponse

func (c *ClientWithResponses) GetLoadBalancerTelemetryReportWithResponse(ctx context.Context, environmentId string, params *GetLoadBalancerTelemetryReportParams, reqEditors ...RequestEditorFn) (*GetLoadBalancerTelemetryReportResponse, error)

GetLoadBalancerTelemetryReportWithResponse request returning *GetLoadBalancerTelemetryReportResponse

func (*ClientWithResponses) GetMetricsWithResponse

func (c *ClientWithResponses) GetMetricsWithResponse(ctx context.Context, params *GetMetricsParams, reqEditors ...RequestEditorFn) (*GetMetricsResponse, error)

GetMetricsWithResponse request returning *GetMetricsResponse

func (*ClientWithResponses) GetMonitoringMonitorsWithResponse

func (c *ClientWithResponses) GetMonitoringMonitorsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMonitoringMonitorsResponse, error)

GetMonitoringMonitorsWithResponse request returning *GetMonitoringMonitorsResponse

func (*ClientWithResponses) GetNetworkWithResponse

func (c *ClientWithResponses) GetNetworkWithResponse(ctx context.Context, networkId string, params *GetNetworkParams, reqEditors ...RequestEditorFn) (*GetNetworkResponse, error)

GetNetworkWithResponse request returning *GetNetworkResponse

func (*ClientWithResponses) GetNetworksWithResponse

func (c *ClientWithResponses) GetNetworksWithResponse(ctx context.Context, params *GetNetworksParams, reqEditors ...RequestEditorFn) (*GetNetworksResponse, error)

GetNetworksWithResponse request returning *GetNetworksResponse

func (*ClientWithResponses) GetOrdersWithResponse

func (c *ClientWithResponses) GetOrdersWithResponse(ctx context.Context, params *GetOrdersParams, reqEditors ...RequestEditorFn) (*GetOrdersResponse, error)

GetOrdersWithResponse request returning *GetOrdersResponse

func (*ClientWithResponses) GetPipelineRunWithResponse

func (c *ClientWithResponses) GetPipelineRunWithResponse(ctx context.Context, pipelineId string, runId string, params *GetPipelineRunParams, reqEditors ...RequestEditorFn) (*GetPipelineRunResponse, error)

GetPipelineRunWithResponse request returning *GetPipelineRunResponse

func (*ClientWithResponses) GetPipelineRunsWithResponse

func (c *ClientWithResponses) GetPipelineRunsWithResponse(ctx context.Context, pipelineId string, params *GetPipelineRunsParams, reqEditors ...RequestEditorFn) (*GetPipelineRunsResponse, error)

GetPipelineRunsWithResponse request returning *GetPipelineRunsResponse

func (*ClientWithResponses) GetPipelineTriggerKeyWithResponse

func (c *ClientWithResponses) GetPipelineTriggerKeyWithResponse(ctx context.Context, pipelineId string, triggerKeyId string, reqEditors ...RequestEditorFn) (*GetPipelineTriggerKeyResponse, error)

GetPipelineTriggerKeyWithResponse request returning *GetPipelineTriggerKeyResponse

func (*ClientWithResponses) GetPipelineTriggerKeysWithResponse

func (c *ClientWithResponses) GetPipelineTriggerKeysWithResponse(ctx context.Context, pipelineId string, params *GetPipelineTriggerKeysParams, reqEditors ...RequestEditorFn) (*GetPipelineTriggerKeysResponse, error)

GetPipelineTriggerKeysWithResponse request returning *GetPipelineTriggerKeysResponse

func (*ClientWithResponses) GetPipelineWithResponse

func (c *ClientWithResponses) GetPipelineWithResponse(ctx context.Context, pipelineId string, params *GetPipelineParams, reqEditors ...RequestEditorFn) (*GetPipelineResponse, error)

GetPipelineWithResponse request returning *GetPipelineResponse

func (*ClientWithResponses) GetPipelinesWithResponse

func (c *ClientWithResponses) GetPipelinesWithResponse(ctx context.Context, params *GetPipelinesParams, reqEditors ...RequestEditorFn) (*GetPipelinesResponse, error)

GetPipelinesWithResponse request returning *GetPipelinesResponse

func (*ClientWithResponses) GetPoolIPsWithResponse

func (c *ClientWithResponses) GetPoolIPsWithResponse(ctx context.Context, poolId string, reqEditors ...RequestEditorFn) (*GetPoolIPsResponse, error)

GetPoolIPsWithResponse request returning *GetPoolIPsResponse

func (*ClientWithResponses) GetProviderLocationsWithResponse

func (c *ClientWithResponses) GetProviderLocationsWithResponse(ctx context.Context, integrationId string, params *GetProviderLocationsParams, reqEditors ...RequestEditorFn) (*GetProviderLocationsResponse, error)

GetProviderLocationsWithResponse request returning *GetProviderLocationsResponse

func (*ClientWithResponses) GetProviderServerModelsWithResponse added in v0.6.6

func (c *ClientWithResponses) GetProviderServerModelsWithResponse(ctx context.Context, integrationId string, params *GetProviderServerModelsParams, reqEditors ...RequestEditorFn) (*GetProviderServerModelsResponse, error)

GetProviderServerModelsWithResponse request returning *GetProviderServerModelsResponse

func (*ClientWithResponses) GetRoleWithResponse

func (c *ClientWithResponses) GetRoleWithResponse(ctx context.Context, roleId string, params *GetRoleParams, reqEditors ...RequestEditorFn) (*GetRoleResponse, error)

GetRoleWithResponse request returning *GetRoleResponse

func (*ClientWithResponses) GetRolesWithResponse

func (c *ClientWithResponses) GetRolesWithResponse(ctx context.Context, params *GetRolesParams, reqEditors ...RequestEditorFn) (*GetRolesResponse, error)

GetRolesWithResponse request returning *GetRolesResponse

func (*ClientWithResponses) GetScopedVariableWithResponse

func (c *ClientWithResponses) GetScopedVariableWithResponse(ctx context.Context, environmentId string, scopedVariableId string, reqEditors ...RequestEditorFn) (*GetScopedVariableResponse, error)

GetScopedVariableWithResponse request returning *GetScopedVariableResponse

func (*ClientWithResponses) GetScopedVariablesWithResponse

func (c *ClientWithResponses) GetScopedVariablesWithResponse(ctx context.Context, environmentId string, params *GetScopedVariablesParams, reqEditors ...RequestEditorFn) (*GetScopedVariablesResponse, error)

GetScopedVariablesWithResponse request returning *GetScopedVariablesResponse

func (*ClientWithResponses) GetSearchIndexWithResponse

func (c *ClientWithResponses) GetSearchIndexWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSearchIndexResponse, error)

GetSearchIndexWithResponse request returning *GetSearchIndexResponse

func (*ClientWithResponses) GetServerConsoleWithResponse

func (c *ClientWithResponses) GetServerConsoleWithResponse(ctx context.Context, serverId string, reqEditors ...RequestEditorFn) (*GetServerConsoleResponse, error)

GetServerConsoleWithResponse request returning *GetServerConsoleResponse

func (*ClientWithResponses) GetServerInstancesWithResponse

func (c *ClientWithResponses) GetServerInstancesWithResponse(ctx context.Context, serverId string, params *GetServerInstancesParams, reqEditors ...RequestEditorFn) (*GetServerInstancesResponse, error)

GetServerInstancesWithResponse request returning *GetServerInstancesResponse

func (*ClientWithResponses) GetServerTagsWithResponse

func (c *ClientWithResponses) GetServerTagsWithResponse(ctx context.Context, params *GetServerTagsParams, reqEditors ...RequestEditorFn) (*GetServerTagsResponse, error)

GetServerTagsWithResponse request returning *GetServerTagsResponse

func (*ClientWithResponses) GetServerTelemetryWithResponse

func (c *ClientWithResponses) GetServerTelemetryWithResponse(ctx context.Context, serverId string, params *GetServerTelemetryParams, reqEditors ...RequestEditorFn) (*GetServerTelemetryResponse, error)

GetServerTelemetryWithResponse request returning *GetServerTelemetryResponse

func (*ClientWithResponses) GetServerUsageWithResponse

func (c *ClientWithResponses) GetServerUsageWithResponse(ctx context.Context, serverId string, reqEditors ...RequestEditorFn) (*GetServerUsageResponse, error)

GetServerUsageWithResponse request returning *GetServerUsageResponse

func (*ClientWithResponses) GetServerWithResponse

func (c *ClientWithResponses) GetServerWithResponse(ctx context.Context, serverId string, params *GetServerParams, reqEditors ...RequestEditorFn) (*GetServerResponse, error)

GetServerWithResponse request returning *GetServerResponse

func (*ClientWithResponses) GetServersWithResponse

func (c *ClientWithResponses) GetServersWithResponse(ctx context.Context, params *GetServersParams, reqEditors ...RequestEditorFn) (*GetServersResponse, error)

GetServersWithResponse request returning *GetServersResponse

func (*ClientWithResponses) GetStackBuildLogWithResponse

func (c *ClientWithResponses) GetStackBuildLogWithResponse(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*GetStackBuildLogResponse, error)

GetStackBuildLogWithResponse request returning *GetStackBuildLogResponse

func (*ClientWithResponses) GetStackBuildWithResponse

func (c *ClientWithResponses) GetStackBuildWithResponse(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*GetStackBuildResponse, error)

GetStackBuildWithResponse request returning *GetStackBuildResponse

func (*ClientWithResponses) GetStackBuildsWithResponse

func (c *ClientWithResponses) GetStackBuildsWithResponse(ctx context.Context, stackId string, params *GetStackBuildsParams, reqEditors ...RequestEditorFn) (*GetStackBuildsResponse, error)

GetStackBuildsWithResponse request returning *GetStackBuildsResponse

func (*ClientWithResponses) GetStackWithResponse

func (c *ClientWithResponses) GetStackWithResponse(ctx context.Context, stackId string, reqEditors ...RequestEditorFn) (*GetStackResponse, error)

GetStackWithResponse request returning *GetStackResponse

func (*ClientWithResponses) GetStacksWithResponse

func (c *ClientWithResponses) GetStacksWithResponse(ctx context.Context, params *GetStacksParams, reqEditors ...RequestEditorFn) (*GetStacksResponse, error)

GetStacksWithResponse request returning *GetStacksResponse

func (*ClientWithResponses) GetTLSGenerationAttemptsWithResponse

func (c *ClientWithResponses) GetTLSGenerationAttemptsWithResponse(ctx context.Context, params *GetTLSGenerationAttemptsParams, reqEditors ...RequestEditorFn) (*GetTLSGenerationAttemptsResponse, error)

GetTLSGenerationAttemptsWithResponse request returning *GetTLSGenerationAttemptsResponse

func (*ClientWithResponses) GetTwoFactorAuthSetupWithResponse

func (c *ClientWithResponses) GetTwoFactorAuthSetupWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetTwoFactorAuthSetupResponse, error)

GetTwoFactorAuthSetupWithResponse request returning *GetTwoFactorAuthSetupResponse

func (*ClientWithResponses) GetUserSuppliedCertificateWithResponse

func (c *ClientWithResponses) GetUserSuppliedCertificateWithResponse(ctx context.Context, certificateId string, reqEditors ...RequestEditorFn) (*GetUserSuppliedCertificateResponse, error)

GetUserSuppliedCertificateWithResponse request returning *GetUserSuppliedCertificateResponse

func (*ClientWithResponses) GetUserSuppliedCertificatesWithResponse

func (c *ClientWithResponses) GetUserSuppliedCertificatesWithResponse(ctx context.Context, params *GetUserSuppliedCertificatesParams, reqEditors ...RequestEditorFn) (*GetUserSuppliedCertificatesResponse, error)

GetUserSuppliedCertificatesWithResponse request returning *GetUserSuppliedCertificatesResponse

func (*ClientWithResponses) GetVPNLoginsWithResponse

func (c *ClientWithResponses) GetVPNLoginsWithResponse(ctx context.Context, environmentId string, params *GetVPNLoginsParams, reqEditors ...RequestEditorFn) (*GetVPNLoginsResponse, error)

GetVPNLoginsWithResponse request returning *GetVPNLoginsResponse

func (*ClientWithResponses) GetVPNServiceWithResponse

func (c *ClientWithResponses) GetVPNServiceWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*GetVPNServiceResponse, error)

GetVPNServiceWithResponse request returning *GetVPNServiceResponse

func (*ClientWithResponses) GetVPNUsersWithResponse

func (c *ClientWithResponses) GetVPNUsersWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*GetVPNUsersResponse, error)

GetVPNUsersWithResponse request returning *GetVPNUsersResponse

func (*ClientWithResponses) GetVirtualMachineBaseImagesWithResponse

func (c *ClientWithResponses) GetVirtualMachineBaseImagesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetVirtualMachineBaseImagesResponse, error)

GetVirtualMachineBaseImagesWithResponse request returning *GetVirtualMachineBaseImagesResponse

func (*ClientWithResponses) GetVirtualMachineSshKeyWithResponse

func (c *ClientWithResponses) GetVirtualMachineSshKeyWithResponse(ctx context.Context, sshKeyId string, params *GetVirtualMachineSshKeyParams, reqEditors ...RequestEditorFn) (*GetVirtualMachineSshKeyResponse, error)

GetVirtualMachineSshKeyWithResponse request returning *GetVirtualMachineSshKeyResponse

func (*ClientWithResponses) GetVirtualMachineSshKeysWithResponse

func (c *ClientWithResponses) GetVirtualMachineSshKeysWithResponse(ctx context.Context, params *GetVirtualMachineSshKeysParams, reqEditors ...RequestEditorFn) (*GetVirtualMachineSshKeysResponse, error)

GetVirtualMachineSshKeysWithResponse request returning *GetVirtualMachineSshKeysResponse

func (*ClientWithResponses) GetVirtualMachineWithResponse

func (c *ClientWithResponses) GetVirtualMachineWithResponse(ctx context.Context, virtualMachineId string, params *GetVirtualMachineParams, reqEditors ...RequestEditorFn) (*GetVirtualMachineResponse, error)

GetVirtualMachineWithResponse request returning *GetVirtualMachineResponse

func (*ClientWithResponses) GetVirtualMachinesWithResponse

func (c *ClientWithResponses) GetVirtualMachinesWithResponse(ctx context.Context, params *GetVirtualMachinesParams, reqEditors ...RequestEditorFn) (*GetVirtualMachinesResponse, error)

GetVirtualMachinesWithResponse request returning *GetVirtualMachinesResponse

func (*ClientWithResponses) GetVirtualProviderIsoDownloadUrlWithResponse added in v0.6.3

func (c *ClientWithResponses) GetVirtualProviderIsoDownloadUrlWithResponse(ctx context.Context, integrationId string, isoId string, reqEditors ...RequestEditorFn) (*GetVirtualProviderIsoDownloadUrlResponse, error)

GetVirtualProviderIsoDownloadUrlWithResponse request returning *GetVirtualProviderIsoDownloadUrlResponse

func (*ClientWithResponses) GetVirtualProviderIsoWithResponse added in v0.6.3

func (c *ClientWithResponses) GetVirtualProviderIsoWithResponse(ctx context.Context, integrationId string, isoId string, params *GetVirtualProviderIsoParams, reqEditors ...RequestEditorFn) (*GetVirtualProviderIsoResponse, error)

GetVirtualProviderIsoWithResponse request returning *GetVirtualProviderIsoResponse

func (*ClientWithResponses) GetVirtualProviderIsosWithResponse added in v0.6.3

func (c *ClientWithResponses) GetVirtualProviderIsosWithResponse(ctx context.Context, integrationId string, params *GetVirtualProviderIsosParams, reqEditors ...RequestEditorFn) (*GetVirtualProviderIsosResponse, error)

GetVirtualProviderIsosWithResponse request returning *GetVirtualProviderIsosResponse

func (*ClientWithResponses) LookupComponentsWithBodyWithResponse

func (c *ClientWithResponses) LookupComponentsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*LookupComponentsResponse, error)

LookupComponentsWithBodyWithResponse request with arbitrary body returning *LookupComponentsResponse

func (*ClientWithResponses) LookupComponentsWithResponse

func (c *ClientWithResponses) LookupComponentsWithResponse(ctx context.Context, body LookupComponentsJSONRequestBody, reqEditors ...RequestEditorFn) (*LookupComponentsResponse, error)

func (*ClientWithResponses) LookupIdentifierWithResponse

func (c *ClientWithResponses) LookupIdentifierWithResponse(ctx context.Context, params *LookupIdentifierParams, reqEditors ...RequestEditorFn) (*LookupIdentifierResponse, error)

LookupIdentifierWithResponse request returning *LookupIdentifierResponse

func (*ClientWithResponses) LookupStackBuildWithResponse

func (c *ClientWithResponses) LookupStackBuildWithResponse(ctx context.Context, buildId string, reqEditors ...RequestEditorFn) (*LookupStackBuildResponse, error)

LookupStackBuildWithResponse request returning *LookupStackBuildResponse

func (*ClientWithResponses) LookupTLSCertificateWithResponse

func (c *ClientWithResponses) LookupTLSCertificateWithResponse(ctx context.Context, params *LookupTLSCertificateParams, reqEditors ...RequestEditorFn) (*LookupTLSCertificateResponse, error)

LookupTLSCertificateWithResponse request returning *LookupTLSCertificateResponse

func (*ClientWithResponses) RecoverTwoFactorAuthWithBodyWithResponse

func (c *ClientWithResponses) RecoverTwoFactorAuthWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RecoverTwoFactorAuthResponse, error)

RecoverTwoFactorAuthWithBodyWithResponse request with arbitrary body returning *RecoverTwoFactorAuthResponse

func (*ClientWithResponses) RecoverTwoFactorAuthWithResponse

func (c *ClientWithResponses) RecoverTwoFactorAuthWithResponse(ctx context.Context, body RecoverTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*RecoverTwoFactorAuthResponse, error)

func (*ClientWithResponses) ResetPasswordWithBodyWithResponse

func (c *ClientWithResponses) ResetPasswordWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResetPasswordResponse, error)

ResetPasswordWithBodyWithResponse request with arbitrary body returning *ResetPasswordResponse

func (*ClientWithResponses) ResetPasswordWithResponse

func (c *ClientWithResponses) ResetPasswordWithResponse(ctx context.Context, body ResetPasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*ResetPasswordResponse, error)

func (*ClientWithResponses) TriggerPipelineWithBodyWithResponse

func (c *ClientWithResponses) TriggerPipelineWithBodyWithResponse(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TriggerPipelineResponse, error)

TriggerPipelineWithBodyWithResponse request with arbitrary body returning *TriggerPipelineResponse

func (*ClientWithResponses) TriggerPipelineWithResponse

func (c *ClientWithResponses) TriggerPipelineWithResponse(ctx context.Context, pipelineId string, body TriggerPipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*TriggerPipelineResponse, error)

func (*ClientWithResponses) UpdateAPIKeyWithBodyWithResponse

func (c *ClientWithResponses) UpdateAPIKeyWithBodyWithResponse(ctx context.Context, apikeyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResponse, error)

UpdateAPIKeyWithBodyWithResponse request with arbitrary body returning *UpdateAPIKeyResponse

func (*ClientWithResponses) UpdateAPIKeyWithResponse

func (c *ClientWithResponses) UpdateAPIKeyWithResponse(ctx context.Context, apikeyId string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResponse, error)

func (*ClientWithResponses) UpdateAccountInviteWithBodyWithResponse

func (c *ClientWithResponses) UpdateAccountInviteWithBodyWithResponse(ctx context.Context, inviteId string, params *UpdateAccountInviteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAccountInviteResponse, error)

UpdateAccountInviteWithBodyWithResponse request with arbitrary body returning *UpdateAccountInviteResponse

func (*ClientWithResponses) UpdateAccountInviteWithResponse

func (c *ClientWithResponses) UpdateAccountInviteWithResponse(ctx context.Context, inviteId string, params *UpdateAccountInviteParams, body UpdateAccountInviteJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAccountInviteResponse, error)

func (*ClientWithResponses) UpdateAccountWithBodyWithResponse

func (c *ClientWithResponses) UpdateAccountWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAccountResponse, error)

UpdateAccountWithBodyWithResponse request with arbitrary body returning *UpdateAccountResponse

func (*ClientWithResponses) UpdateAccountWithResponse

func (c *ClientWithResponses) UpdateAccountWithResponse(ctx context.Context, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAccountResponse, error)

func (*ClientWithResponses) UpdateAutoScaleGroupAccessWithBodyWithResponse

func (c *ClientWithResponses) UpdateAutoScaleGroupAccessWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAutoScaleGroupAccessResponse, error)

UpdateAutoScaleGroupAccessWithBodyWithResponse request with arbitrary body returning *UpdateAutoScaleGroupAccessResponse

func (*ClientWithResponses) UpdateAutoScaleGroupAccessWithResponse

func (c *ClientWithResponses) UpdateAutoScaleGroupAccessWithResponse(ctx context.Context, groupId string, body UpdateAutoScaleGroupAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAutoScaleGroupAccessResponse, error)

func (*ClientWithResponses) UpdateAutoScaleGroupWithBodyWithResponse

func (c *ClientWithResponses) UpdateAutoScaleGroupWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAutoScaleGroupResponse, error)

UpdateAutoScaleGroupWithBodyWithResponse request with arbitrary body returning *UpdateAutoScaleGroupResponse

func (*ClientWithResponses) UpdateAutoScaleGroupWithResponse

func (c *ClientWithResponses) UpdateAutoScaleGroupWithResponse(ctx context.Context, groupId string, body UpdateAutoScaleGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAutoScaleGroupResponse, error)

func (*ClientWithResponses) UpdateBillingMethodWithBodyWithResponse

func (c *ClientWithResponses) UpdateBillingMethodWithBodyWithResponse(ctx context.Context, methodId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateBillingMethodResponse, error)

UpdateBillingMethodWithBodyWithResponse request with arbitrary body returning *UpdateBillingMethodResponse

func (*ClientWithResponses) UpdateBillingMethodWithResponse

func (c *ClientWithResponses) UpdateBillingMethodWithResponse(ctx context.Context, methodId string, body UpdateBillingMethodJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateBillingMethodResponse, error)

func (*ClientWithResponses) UpdateBillingOrderWithBodyWithResponse

func (c *ClientWithResponses) UpdateBillingOrderWithBodyWithResponse(ctx context.Context, orderId string, params *UpdateBillingOrderParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateBillingOrderResponse, error)

UpdateBillingOrderWithBodyWithResponse request with arbitrary body returning *UpdateBillingOrderResponse

func (*ClientWithResponses) UpdateBillingOrderWithResponse

func (c *ClientWithResponses) UpdateBillingOrderWithResponse(ctx context.Context, orderId string, params *UpdateBillingOrderParams, body UpdateBillingOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateBillingOrderResponse, error)

func (*ClientWithResponses) UpdateClusterAccessWithBodyWithResponse

func (c *ClientWithResponses) UpdateClusterAccessWithBodyWithResponse(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateClusterAccessResponse, error)

UpdateClusterAccessWithBodyWithResponse request with arbitrary body returning *UpdateClusterAccessResponse

func (*ClientWithResponses) UpdateClusterAccessWithResponse

func (c *ClientWithResponses) UpdateClusterAccessWithResponse(ctx context.Context, clusterId string, body UpdateClusterAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateClusterAccessResponse, error)

func (*ClientWithResponses) UpdateClusterWithBodyWithResponse

func (c *ClientWithResponses) UpdateClusterWithBodyWithResponse(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateClusterResponse, error)

UpdateClusterWithBodyWithResponse request with arbitrary body returning *UpdateClusterResponse

func (*ClientWithResponses) UpdateClusterWithResponse

func (c *ClientWithResponses) UpdateClusterWithResponse(ctx context.Context, clusterId string, body UpdateClusterJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateClusterResponse, error)

func (*ClientWithResponses) UpdateContainerWithBodyWithResponse

func (c *ClientWithResponses) UpdateContainerWithBodyWithResponse(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateContainerResponse, error)

UpdateContainerWithBodyWithResponse request with arbitrary body returning *UpdateContainerResponse

func (*ClientWithResponses) UpdateContainerWithResponse

func (c *ClientWithResponses) UpdateContainerWithResponse(ctx context.Context, containerId string, body UpdateContainerJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateContainerResponse, error)

func (*ClientWithResponses) UpdateDNSZoneAccessWithBodyWithResponse

func (c *ClientWithResponses) UpdateDNSZoneAccessWithBodyWithResponse(ctx context.Context, zoneId string, params *UpdateDNSZoneAccessParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDNSZoneAccessResponse, error)

UpdateDNSZoneAccessWithBodyWithResponse request with arbitrary body returning *UpdateDNSZoneAccessResponse

func (*ClientWithResponses) UpdateDNSZoneAccessWithResponse

func (c *ClientWithResponses) UpdateDNSZoneAccessWithResponse(ctx context.Context, zoneId string, params *UpdateDNSZoneAccessParams, body UpdateDNSZoneAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDNSZoneAccessResponse, error)

func (*ClientWithResponses) UpdateDNSZoneRecordWithBodyWithResponse

func (c *ClientWithResponses) UpdateDNSZoneRecordWithBodyWithResponse(ctx context.Context, zoneId string, recordId string, params *UpdateDNSZoneRecordParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDNSZoneRecordResponse, error)

UpdateDNSZoneRecordWithBodyWithResponse request with arbitrary body returning *UpdateDNSZoneRecordResponse

func (*ClientWithResponses) UpdateDNSZoneRecordWithResponse

func (c *ClientWithResponses) UpdateDNSZoneRecordWithResponse(ctx context.Context, zoneId string, recordId string, params *UpdateDNSZoneRecordParams, body UpdateDNSZoneRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDNSZoneRecordResponse, error)

func (*ClientWithResponses) UpdateDNSZoneWithBodyWithResponse

func (c *ClientWithResponses) UpdateDNSZoneWithBodyWithResponse(ctx context.Context, zoneId string, params *UpdateDNSZoneParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDNSZoneResponse, error)

UpdateDNSZoneWithBodyWithResponse request with arbitrary body returning *UpdateDNSZoneResponse

func (*ClientWithResponses) UpdateDNSZoneWithResponse

func (c *ClientWithResponses) UpdateDNSZoneWithResponse(ctx context.Context, zoneId string, params *UpdateDNSZoneParams, body UpdateDNSZoneJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDNSZoneResponse, error)

func (*ClientWithResponses) UpdateEnvironmentAccessWithBodyWithResponse

func (c *ClientWithResponses) UpdateEnvironmentAccessWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEnvironmentAccessResponse, error)

UpdateEnvironmentAccessWithBodyWithResponse request with arbitrary body returning *UpdateEnvironmentAccessResponse

func (*ClientWithResponses) UpdateEnvironmentAccessWithResponse

func (c *ClientWithResponses) UpdateEnvironmentAccessWithResponse(ctx context.Context, environmentId string, body UpdateEnvironmentAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEnvironmentAccessResponse, error)

func (*ClientWithResponses) UpdateEnvironmentWithBodyWithResponse

func (c *ClientWithResponses) UpdateEnvironmentWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEnvironmentResponse, error)

UpdateEnvironmentWithBodyWithResponse request with arbitrary body returning *UpdateEnvironmentResponse

func (*ClientWithResponses) UpdateEnvironmentWithResponse

func (c *ClientWithResponses) UpdateEnvironmentWithResponse(ctx context.Context, environmentId string, body UpdateEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEnvironmentResponse, error)

func (*ClientWithResponses) UpdateExternalVolumeAccessWithBodyWithResponse added in v0.6.5

func (c *ClientWithResponses) UpdateExternalVolumeAccessWithBodyWithResponse(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateExternalVolumeAccessResponse, error)

UpdateExternalVolumeAccessWithBodyWithResponse request with arbitrary body returning *UpdateExternalVolumeAccessResponse

func (*ClientWithResponses) UpdateExternalVolumeAccessWithResponse added in v0.6.5

func (c *ClientWithResponses) UpdateExternalVolumeAccessWithResponse(ctx context.Context, externalVolumeId string, body UpdateExternalVolumeAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateExternalVolumeAccessResponse, error)

func (*ClientWithResponses) UpdateExternalVolumeWithBodyWithResponse added in v0.6.5

func (c *ClientWithResponses) UpdateExternalVolumeWithBodyWithResponse(ctx context.Context, externalVolumeId string, params *UpdateExternalVolumeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateExternalVolumeResponse, error)

UpdateExternalVolumeWithBodyWithResponse request with arbitrary body returning *UpdateExternalVolumeResponse

func (*ClientWithResponses) UpdateExternalVolumeWithResponse added in v0.6.5

func (c *ClientWithResponses) UpdateExternalVolumeWithResponse(ctx context.Context, externalVolumeId string, params *UpdateExternalVolumeParams, body UpdateExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateExternalVolumeResponse, error)

func (*ClientWithResponses) UpdateHubMemberWithBodyWithResponse

func (c *ClientWithResponses) UpdateHubMemberWithBodyWithResponse(ctx context.Context, memberId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateHubMemberResponse, error)

UpdateHubMemberWithBodyWithResponse request with arbitrary body returning *UpdateHubMemberResponse

func (*ClientWithResponses) UpdateHubMemberWithResponse

func (c *ClientWithResponses) UpdateHubMemberWithResponse(ctx context.Context, memberId string, body UpdateHubMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateHubMemberResponse, error)

func (*ClientWithResponses) UpdateHubWithBodyWithResponse

func (c *ClientWithResponses) UpdateHubWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateHubResponse, error)

UpdateHubWithBodyWithResponse request with arbitrary body returning *UpdateHubResponse

func (*ClientWithResponses) UpdateHubWithResponse

func (c *ClientWithResponses) UpdateHubWithResponse(ctx context.Context, body UpdateHubJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateHubResponse, error)

func (*ClientWithResponses) UpdateImageSourceAccessWithBodyWithResponse

func (c *ClientWithResponses) UpdateImageSourceAccessWithBodyWithResponse(ctx context.Context, sourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateImageSourceAccessResponse, error)

UpdateImageSourceAccessWithBodyWithResponse request with arbitrary body returning *UpdateImageSourceAccessResponse

func (*ClientWithResponses) UpdateImageSourceAccessWithResponse

func (c *ClientWithResponses) UpdateImageSourceAccessWithResponse(ctx context.Context, sourceId string, body UpdateImageSourceAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateImageSourceAccessResponse, error)

func (*ClientWithResponses) UpdateImageSourceWithBodyWithResponse

func (c *ClientWithResponses) UpdateImageSourceWithBodyWithResponse(ctx context.Context, sourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateImageSourceResponse, error)

UpdateImageSourceWithBodyWithResponse request with arbitrary body returning *UpdateImageSourceResponse

func (*ClientWithResponses) UpdateImageSourceWithResponse

func (c *ClientWithResponses) UpdateImageSourceWithResponse(ctx context.Context, sourceId string, body UpdateImageSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateImageSourceResponse, error)

func (*ClientWithResponses) UpdateImageWithBodyWithResponse

func (c *ClientWithResponses) UpdateImageWithBodyWithResponse(ctx context.Context, imageId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateImageResponse, error)

UpdateImageWithBodyWithResponse request with arbitrary body returning *UpdateImageResponse

func (*ClientWithResponses) UpdateImageWithResponse

func (c *ClientWithResponses) UpdateImageWithResponse(ctx context.Context, imageId string, body UpdateImageJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateImageResponse, error)

func (*ClientWithResponses) UpdateIntegrationWithBodyWithResponse

func (c *ClientWithResponses) UpdateIntegrationWithBodyWithResponse(ctx context.Context, integrationId string, params *UpdateIntegrationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateIntegrationResponse, error)

UpdateIntegrationWithBodyWithResponse request with arbitrary body returning *UpdateIntegrationResponse

func (*ClientWithResponses) UpdateIntegrationWithResponse

func (c *ClientWithResponses) UpdateIntegrationWithResponse(ctx context.Context, integrationId string, params *UpdateIntegrationParams, body UpdateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateIntegrationResponse, error)

func (*ClientWithResponses) UpdateNetworkAccessWithBodyWithResponse

func (c *ClientWithResponses) UpdateNetworkAccessWithBodyWithResponse(ctx context.Context, networkId string, params *UpdateNetworkAccessParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateNetworkAccessResponse, error)

UpdateNetworkAccessWithBodyWithResponse request with arbitrary body returning *UpdateNetworkAccessResponse

func (*ClientWithResponses) UpdateNetworkAccessWithResponse

func (c *ClientWithResponses) UpdateNetworkAccessWithResponse(ctx context.Context, networkId string, params *UpdateNetworkAccessParams, body UpdateNetworkAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateNetworkAccessResponse, error)

func (*ClientWithResponses) UpdateNetworkWithBodyWithResponse

func (c *ClientWithResponses) UpdateNetworkWithBodyWithResponse(ctx context.Context, networkId string, params *UpdateNetworkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateNetworkResponse, error)

UpdateNetworkWithBodyWithResponse request with arbitrary body returning *UpdateNetworkResponse

func (*ClientWithResponses) UpdateNetworkWithResponse

func (c *ClientWithResponses) UpdateNetworkWithResponse(ctx context.Context, networkId string, params *UpdateNetworkParams, body UpdateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateNetworkResponse, error)

func (*ClientWithResponses) UpdatePipelineAccessWithBodyWithResponse

func (c *ClientWithResponses) UpdatePipelineAccessWithBodyWithResponse(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePipelineAccessResponse, error)

UpdatePipelineAccessWithBodyWithResponse request with arbitrary body returning *UpdatePipelineAccessResponse

func (*ClientWithResponses) UpdatePipelineAccessWithResponse

func (c *ClientWithResponses) UpdatePipelineAccessWithResponse(ctx context.Context, pipelineId string, body UpdatePipelineAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePipelineAccessResponse, error)

func (*ClientWithResponses) UpdatePipelineTriggerKeyWithBodyWithResponse

func (c *ClientWithResponses) UpdatePipelineTriggerKeyWithBodyWithResponse(ctx context.Context, pipelineId string, triggerKeyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePipelineTriggerKeyResponse, error)

UpdatePipelineTriggerKeyWithBodyWithResponse request with arbitrary body returning *UpdatePipelineTriggerKeyResponse

func (*ClientWithResponses) UpdatePipelineTriggerKeyWithResponse

func (c *ClientWithResponses) UpdatePipelineTriggerKeyWithResponse(ctx context.Context, pipelineId string, triggerKeyId string, body UpdatePipelineTriggerKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePipelineTriggerKeyResponse, error)

func (*ClientWithResponses) UpdatePipelineWithBodyWithResponse

func (c *ClientWithResponses) UpdatePipelineWithBodyWithResponse(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePipelineResponse, error)

UpdatePipelineWithBodyWithResponse request with arbitrary body returning *UpdatePipelineResponse

func (*ClientWithResponses) UpdatePipelineWithResponse

func (c *ClientWithResponses) UpdatePipelineWithResponse(ctx context.Context, pipelineId string, body UpdatePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePipelineResponse, error)

func (*ClientWithResponses) UpdateRoleWithBodyWithResponse

func (c *ClientWithResponses) UpdateRoleWithBodyWithResponse(ctx context.Context, roleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRoleResponse, error)

UpdateRoleWithBodyWithResponse request with arbitrary body returning *UpdateRoleResponse

func (*ClientWithResponses) UpdateRoleWithResponse

func (c *ClientWithResponses) UpdateRoleWithResponse(ctx context.Context, roleId string, body UpdateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRoleResponse, error)

func (*ClientWithResponses) UpdateScopedVariableWithBodyWithResponse

func (c *ClientWithResponses) UpdateScopedVariableWithBodyWithResponse(ctx context.Context, environmentId string, scopedVariableId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateScopedVariableResponse, error)

UpdateScopedVariableWithBodyWithResponse request with arbitrary body returning *UpdateScopedVariableResponse

func (*ClientWithResponses) UpdateScopedVariableWithResponse

func (c *ClientWithResponses) UpdateScopedVariableWithResponse(ctx context.Context, environmentId string, scopedVariableId string, body UpdateScopedVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateScopedVariableResponse, error)

func (*ClientWithResponses) UpdateServerWithBodyWithResponse

func (c *ClientWithResponses) UpdateServerWithBodyWithResponse(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateServerResponse, error)

UpdateServerWithBodyWithResponse request with arbitrary body returning *UpdateServerResponse

func (*ClientWithResponses) UpdateServerWithResponse

func (c *ClientWithResponses) UpdateServerWithResponse(ctx context.Context, serverId string, body UpdateServerJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateServerResponse, error)

func (*ClientWithResponses) UpdateStackAccessWithBodyWithResponse

func (c *ClientWithResponses) UpdateStackAccessWithBodyWithResponse(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStackAccessResponse, error)

UpdateStackAccessWithBodyWithResponse request with arbitrary body returning *UpdateStackAccessResponse

func (*ClientWithResponses) UpdateStackAccessWithResponse

func (c *ClientWithResponses) UpdateStackAccessWithResponse(ctx context.Context, stackId string, body UpdateStackAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStackAccessResponse, error)

func (*ClientWithResponses) UpdateStackWithBodyWithResponse

func (c *ClientWithResponses) UpdateStackWithBodyWithResponse(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStackResponse, error)

UpdateStackWithBodyWithResponse request with arbitrary body returning *UpdateStackResponse

func (*ClientWithResponses) UpdateStackWithResponse

func (c *ClientWithResponses) UpdateStackWithResponse(ctx context.Context, stackId string, body UpdateStackJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStackResponse, error)

func (*ClientWithResponses) UpdateVirtualMachineSshKeyWithBodyWithResponse

func (c *ClientWithResponses) UpdateVirtualMachineSshKeyWithBodyWithResponse(ctx context.Context, sshKeyId string, params *UpdateVirtualMachineSshKeyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateVirtualMachineSshKeyResponse, error)

UpdateVirtualMachineSshKeyWithBodyWithResponse request with arbitrary body returning *UpdateVirtualMachineSshKeyResponse

func (*ClientWithResponses) UpdateVirtualMachineSshKeyWithResponse

func (*ClientWithResponses) UpdateVirtualMachineWithBodyWithResponse

func (c *ClientWithResponses) UpdateVirtualMachineWithBodyWithResponse(ctx context.Context, virtualMachineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateVirtualMachineResponse, error)

UpdateVirtualMachineWithBodyWithResponse request with arbitrary body returning *UpdateVirtualMachineResponse

func (*ClientWithResponses) UpdateVirtualMachineWithResponse

func (c *ClientWithResponses) UpdateVirtualMachineWithResponse(ctx context.Context, virtualMachineId string, body UpdateVirtualMachineJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateVirtualMachineResponse, error)

func (*ClientWithResponses) UpdateVirtualProviderIsoWithBodyWithResponse added in v0.6.3

func (c *ClientWithResponses) UpdateVirtualProviderIsoWithBodyWithResponse(ctx context.Context, integrationId string, isoId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateVirtualProviderIsoResponse, error)

UpdateVirtualProviderIsoWithBodyWithResponse request with arbitrary body returning *UpdateVirtualProviderIsoResponse

func (*ClientWithResponses) UpdateVirtualProviderIsoWithResponse added in v0.6.3

func (c *ClientWithResponses) UpdateVirtualProviderIsoWithResponse(ctx context.Context, integrationId string, isoId string, body UpdateVirtualProviderIsoJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateVirtualProviderIsoResponse, error)

func (*ClientWithResponses) UploadUserSuppliedCertificateWithBodyWithResponse

func (c *ClientWithResponses) UploadUserSuppliedCertificateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadUserSuppliedCertificateResponse, error)

UploadUserSuppliedCertificateWithBodyWithResponse request with arbitrary body returning *UploadUserSuppliedCertificateResponse

func (*ClientWithResponses) UploadUserSuppliedCertificateWithResponse

func (c *ClientWithResponses) UploadUserSuppliedCertificateWithResponse(ctx context.Context, body UploadUserSuppliedCertificateJSONRequestBody, reqEditors ...RequestEditorFn) (*UploadUserSuppliedCertificateResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// DeleteAccountWithResponse request
	DeleteAccountWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*DeleteAccountResponse, error)

	// GetAccountWithResponse request
	GetAccountWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAccountResponse, error)

	// UpdateAccountWithBodyWithResponse request with any body
	UpdateAccountWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAccountResponse, error)

	UpdateAccountWithResponse(ctx context.Context, body UpdateAccountJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAccountResponse, error)

	// DisableTwoFactorAuthWithBodyWithResponse request with any body
	DisableTwoFactorAuthWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DisableTwoFactorAuthResponse, error)

	DisableTwoFactorAuthWithResponse(ctx context.Context, body DisableTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*DisableTwoFactorAuthResponse, error)

	// RecoverTwoFactorAuthWithBodyWithResponse request with any body
	RecoverTwoFactorAuthWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RecoverTwoFactorAuthResponse, error)

	RecoverTwoFactorAuthWithResponse(ctx context.Context, body RecoverTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*RecoverTwoFactorAuthResponse, error)

	// GetTwoFactorAuthSetupWithResponse request
	GetTwoFactorAuthSetupWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetTwoFactorAuthSetupResponse, error)

	// EnableTwoFactorAuthWithBodyWithResponse request with any body
	EnableTwoFactorAuthWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EnableTwoFactorAuthResponse, error)

	EnableTwoFactorAuthWithResponse(ctx context.Context, body EnableTwoFactorAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*EnableTwoFactorAuthResponse, error)

	// GetAccountInvitesWithResponse request
	GetAccountInvitesWithResponse(ctx context.Context, params *GetAccountInvitesParams, reqEditors ...RequestEditorFn) (*GetAccountInvitesResponse, error)

	// UpdateAccountInviteWithBodyWithResponse request with any body
	UpdateAccountInviteWithBodyWithResponse(ctx context.Context, inviteId string, params *UpdateAccountInviteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAccountInviteResponse, error)

	UpdateAccountInviteWithResponse(ctx context.Context, inviteId string, params *UpdateAccountInviteParams, body UpdateAccountInviteJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAccountInviteResponse, error)

	// GetAccountLoginsWithResponse request
	GetAccountLoginsWithResponse(ctx context.Context, params *GetAccountLoginsParams, reqEditors ...RequestEditorFn) (*GetAccountLoginsResponse, error)

	// GetAccountMembershipsWithResponse request
	GetAccountMembershipsWithResponse(ctx context.Context, params *GetAccountMembershipsParams, reqEditors ...RequestEditorFn) (*GetAccountMembershipsResponse, error)

	// ChangePasswordWithBodyWithResponse request with any body
	ChangePasswordWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ChangePasswordResponse, error)

	ChangePasswordWithResponse(ctx context.Context, body ChangePasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*ChangePasswordResponse, error)

	// ResetPasswordWithBodyWithResponse request with any body
	ResetPasswordWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResetPasswordResponse, error)

	ResetPasswordWithResponse(ctx context.Context, body ResetPasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*ResetPasswordResponse, error)

	// GetAnnouncementsWithResponse request
	GetAnnouncementsWithResponse(ctx context.Context, params *GetAnnouncementsParams, reqEditors ...RequestEditorFn) (*GetAnnouncementsResponse, error)

	// GetCreditsWithResponse request
	GetCreditsWithResponse(ctx context.Context, params *GetCreditsParams, reqEditors ...RequestEditorFn) (*GetCreditsResponse, error)

	// GetCreditWithResponse request
	GetCreditWithResponse(ctx context.Context, creditsId string, reqEditors ...RequestEditorFn) (*GetCreditResponse, error)

	// GetInvoicesWithResponse request
	GetInvoicesWithResponse(ctx context.Context, params *GetInvoicesParams, reqEditors ...RequestEditorFn) (*GetInvoicesResponse, error)

	// GetInvoiceWithResponse request
	GetInvoiceWithResponse(ctx context.Context, invoiceId string, params *GetInvoiceParams, reqEditors ...RequestEditorFn) (*GetInvoiceResponse, error)

	// CreateInvoiceJobWithBodyWithResponse request with any body
	CreateInvoiceJobWithBodyWithResponse(ctx context.Context, invoiceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateInvoiceJobResponse, error)

	CreateInvoiceJobWithResponse(ctx context.Context, invoiceId string, body CreateInvoiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateInvoiceJobResponse, error)

	// GetBillingMethodsWithResponse request
	GetBillingMethodsWithResponse(ctx context.Context, params *GetBillingMethodsParams, reqEditors ...RequestEditorFn) (*GetBillingMethodsResponse, error)

	// CreateBillingMethodWithBodyWithResponse request with any body
	CreateBillingMethodWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateBillingMethodResponse, error)

	CreateBillingMethodWithResponse(ctx context.Context, body CreateBillingMethodJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBillingMethodResponse, error)

	// DeleteBillingMethodWithResponse request
	DeleteBillingMethodWithResponse(ctx context.Context, methodId string, reqEditors ...RequestEditorFn) (*DeleteBillingMethodResponse, error)

	// GetBillingMethodWithResponse request
	GetBillingMethodWithResponse(ctx context.Context, methodId string, reqEditors ...RequestEditorFn) (*GetBillingMethodResponse, error)

	// UpdateBillingMethodWithBodyWithResponse request with any body
	UpdateBillingMethodWithBodyWithResponse(ctx context.Context, methodId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateBillingMethodResponse, error)

	UpdateBillingMethodWithResponse(ctx context.Context, methodId string, body UpdateBillingMethodJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateBillingMethodResponse, error)

	// CreateBillingMethodJobWithBodyWithResponse request with any body
	CreateBillingMethodJobWithBodyWithResponse(ctx context.Context, methodId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateBillingMethodJobResponse, error)

	CreateBillingMethodJobWithResponse(ctx context.Context, methodId string, body CreateBillingMethodJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBillingMethodJobResponse, error)

	// GetOrdersWithResponse request
	GetOrdersWithResponse(ctx context.Context, params *GetOrdersParams, reqEditors ...RequestEditorFn) (*GetOrdersResponse, error)

	// CreateOrderWithBodyWithResponse request with any body
	CreateOrderWithBodyWithResponse(ctx context.Context, params *CreateOrderParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrderResponse, error)

	CreateOrderWithResponse(ctx context.Context, params *CreateOrderParams, body CreateOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrderResponse, error)

	// GetBillingOrderWithResponse request
	GetBillingOrderWithResponse(ctx context.Context, orderId string, params *GetBillingOrderParams, reqEditors ...RequestEditorFn) (*GetBillingOrderResponse, error)

	// UpdateBillingOrderWithBodyWithResponse request with any body
	UpdateBillingOrderWithBodyWithResponse(ctx context.Context, orderId string, params *UpdateBillingOrderParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateBillingOrderResponse, error)

	UpdateBillingOrderWithResponse(ctx context.Context, orderId string, params *UpdateBillingOrderParams, body UpdateBillingOrderJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateBillingOrderResponse, error)

	// CreateOrderJobWithBodyWithResponse request with any body
	CreateOrderJobWithBodyWithResponse(ctx context.Context, orderId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrderJobResponse, error)

	CreateOrderJobWithResponse(ctx context.Context, orderId string, body CreateOrderJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrderJobResponse, error)

	// GetBillingSupportPlansWithResponse request
	GetBillingSupportPlansWithResponse(ctx context.Context, params *GetBillingSupportPlansParams, reqEditors ...RequestEditorFn) (*GetBillingSupportPlansResponse, error)

	// GetBillingTiersWithResponse request
	GetBillingTiersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetBillingTiersResponse, error)

	// GetBillingServicesWithResponse request
	GetBillingServicesWithResponse(ctx context.Context, params *GetBillingServicesParams, reqEditors ...RequestEditorFn) (*GetBillingServicesResponse, error)

	// GetBillingOveragesWithResponse request
	GetBillingOveragesWithResponse(ctx context.Context, params *GetBillingOveragesParams, reqEditors ...RequestEditorFn) (*GetBillingOveragesResponse, error)

	// GetBillingServiceWithResponse request
	GetBillingServiceWithResponse(ctx context.Context, servicesId string, reqEditors ...RequestEditorFn) (*GetBillingServiceResponse, error)

	// GetBillingStatusWithResponse request
	GetBillingStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetBillingStatusResponse, error)

	// GetChangelogWithResponse request
	GetChangelogWithResponse(ctx context.Context, params *GetChangelogParams, reqEditors ...RequestEditorFn) (*GetChangelogResponse, error)

	// GetContainersWithResponse request
	GetContainersWithResponse(ctx context.Context, params *GetContainersParams, reqEditors ...RequestEditorFn) (*GetContainersResponse, error)

	// CreateContainerWithBodyWithResponse request with any body
	CreateContainerWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateContainerResponse, error)

	CreateContainerWithResponse(ctx context.Context, body CreateContainerJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateContainerResponse, error)

	// DeleteContainerWithResponse request
	DeleteContainerWithResponse(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*DeleteContainerResponse, error)

	// GetContainerWithResponse request
	GetContainerWithResponse(ctx context.Context, containerId string, params *GetContainerParams, reqEditors ...RequestEditorFn) (*GetContainerResponse, error)

	// UpdateContainerWithBodyWithResponse request with any body
	UpdateContainerWithBodyWithResponse(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateContainerResponse, error)

	UpdateContainerWithResponse(ctx context.Context, containerId string, body UpdateContainerJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateContainerResponse, error)

	// GetContainerBackupsWithResponse request
	GetContainerBackupsWithResponse(ctx context.Context, containerId string, params *GetContainerBackupsParams, reqEditors ...RequestEditorFn) (*GetContainerBackupsResponse, error)

	// DeleteContainerBackupWithResponse request
	DeleteContainerBackupWithResponse(ctx context.Context, containerId string, backupId string, reqEditors ...RequestEditorFn) (*DeleteContainerBackupResponse, error)

	// GetContainerBackupWithResponse request
	GetContainerBackupWithResponse(ctx context.Context, containerId string, backupId string, params *GetContainerBackupParams, reqEditors ...RequestEditorFn) (*GetContainerBackupResponse, error)

	// GetContainerBackupLogsWithResponse request
	GetContainerBackupLogsWithResponse(ctx context.Context, containerId string, backupId string, reqEditors ...RequestEditorFn) (*GetContainerBackupLogsResponse, error)

	// CreateContainerBackupJobWithBodyWithResponse request with any body
	CreateContainerBackupJobWithBodyWithResponse(ctx context.Context, containerId string, backupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateContainerBackupJobResponse, error)

	CreateContainerBackupJobWithResponse(ctx context.Context, containerId string, backupId string, body CreateContainerBackupJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateContainerBackupJobResponse, error)

	// GetCompatibleImagesWithResponse request
	GetCompatibleImagesWithResponse(ctx context.Context, containerId string, params *GetCompatibleImagesParams, reqEditors ...RequestEditorFn) (*GetCompatibleImagesResponse, error)

	// CreateFunctionJobWithBodyWithResponse request with any body
	CreateFunctionJobWithBodyWithResponse(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFunctionJobResponse, error)

	CreateFunctionJobWithResponse(ctx context.Context, containerId string, body CreateFunctionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFunctionJobResponse, error)

	// DeleteContainerInstancesWithResponse request
	DeleteContainerInstancesWithResponse(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*DeleteContainerInstancesResponse, error)

	// GetInstancesWithResponse request
	GetInstancesWithResponse(ctx context.Context, containerId string, params *GetInstancesParams, reqEditors ...RequestEditorFn) (*GetInstancesResponse, error)

	// CreateInstancesWithBodyWithResponse request with any body
	CreateInstancesWithBodyWithResponse(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateInstancesResponse, error)

	CreateInstancesWithResponse(ctx context.Context, containerId string, body CreateInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateInstancesResponse, error)

	// DeleteInstanceWithResponse request
	DeleteInstanceWithResponse(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*DeleteInstanceResponse, error)

	// GetInstanceWithResponse request
	GetInstanceWithResponse(ctx context.Context, containerId string, instanceId string, params *GetInstanceParams, reqEditors ...RequestEditorFn) (*GetInstanceResponse, error)

	// GetInstanceConsoleStreamAuthWithResponse request
	GetInstanceConsoleStreamAuthWithResponse(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*GetInstanceConsoleStreamAuthResponse, error)

	// ExpireInstanceSSHCredentialsWithResponse request
	ExpireInstanceSSHCredentialsWithResponse(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*ExpireInstanceSSHCredentialsResponse, error)

	// GenerateInstanceSSHCredentialsWithResponse request
	GenerateInstanceSSHCredentialsWithResponse(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*GenerateInstanceSSHCredentialsResponse, error)

	// CreateInstanceJobWithBodyWithResponse request with any body
	CreateInstanceJobWithBodyWithResponse(ctx context.Context, containerId string, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateInstanceJobResponse, error)

	CreateInstanceJobWithResponse(ctx context.Context, containerId string, instanceId string, body CreateInstanceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateInstanceJobResponse, error)

	// GetInstanceTelemetryReportWithResponse request
	GetInstanceTelemetryReportWithResponse(ctx context.Context, containerId string, instanceId string, params *GetInstanceTelemetryReportParams, reqEditors ...RequestEditorFn) (*GetInstanceTelemetryReportResponse, error)

	// GetInstanceTelemetryStreamAuthWithResponse request
	GetInstanceTelemetryStreamAuthWithResponse(ctx context.Context, containerId string, instanceId string, reqEditors ...RequestEditorFn) (*GetInstanceTelemetryStreamAuthResponse, error)

	// GetInstanceVolumesWithResponse request
	GetInstanceVolumesWithResponse(ctx context.Context, containerId string, instanceId string, params *GetInstanceVolumesParams, reqEditors ...RequestEditorFn) (*GetInstanceVolumesResponse, error)

	// GetContainerServersWithResponse request
	GetContainerServersWithResponse(ctx context.Context, containerId string, params *GetContainerServersParams, reqEditors ...RequestEditorFn) (*GetContainerServersResponse, error)

	// GetCompatibleServersWithResponse request
	GetCompatibleServersWithResponse(ctx context.Context, containerId string, params *GetCompatibleServersParams, reqEditors ...RequestEditorFn) (*GetCompatibleServersResponse, error)

	// GetContainerSummaryWithResponse request
	GetContainerSummaryWithResponse(ctx context.Context, containerId string, reqEditors ...RequestEditorFn) (*GetContainerSummaryResponse, error)

	// CreateContainerJobWithBodyWithResponse request with any body
	CreateContainerJobWithBodyWithResponse(ctx context.Context, containerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateContainerJobResponse, error)

	CreateContainerJobWithResponse(ctx context.Context, containerId string, body CreateContainerJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateContainerJobResponse, error)

	// GetTLSGenerationAttemptsWithResponse request
	GetTLSGenerationAttemptsWithResponse(ctx context.Context, params *GetTLSGenerationAttemptsParams, reqEditors ...RequestEditorFn) (*GetTLSGenerationAttemptsResponse, error)

	// GetAllTlsCertificatesWithResponse request
	GetAllTlsCertificatesWithResponse(ctx context.Context, params *GetAllTlsCertificatesParams, reqEditors ...RequestEditorFn) (*GetAllTlsCertificatesResponse, error)

	// LookupTLSCertificateWithResponse request
	LookupTLSCertificateWithResponse(ctx context.Context, params *LookupTLSCertificateParams, reqEditors ...RequestEditorFn) (*LookupTLSCertificateResponse, error)

	// GetUserSuppliedCertificatesWithResponse request
	GetUserSuppliedCertificatesWithResponse(ctx context.Context, params *GetUserSuppliedCertificatesParams, reqEditors ...RequestEditorFn) (*GetUserSuppliedCertificatesResponse, error)

	// UploadUserSuppliedCertificateWithBodyWithResponse request with any body
	UploadUserSuppliedCertificateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadUserSuppliedCertificateResponse, error)

	UploadUserSuppliedCertificateWithResponse(ctx context.Context, body UploadUserSuppliedCertificateJSONRequestBody, reqEditors ...RequestEditorFn) (*UploadUserSuppliedCertificateResponse, error)

	// GetUserSuppliedCertificateWithResponse request
	GetUserSuppliedCertificateWithResponse(ctx context.Context, certificateId string, reqEditors ...RequestEditorFn) (*GetUserSuppliedCertificateResponse, error)

	// CreateUserSuppliedCertificateJobWithBodyWithResponse request with any body
	CreateUserSuppliedCertificateJobWithBodyWithResponse(ctx context.Context, certificateId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateUserSuppliedCertificateJobResponse, error)

	CreateUserSuppliedCertificateJobWithResponse(ctx context.Context, certificateId string, body CreateUserSuppliedCertificateJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUserSuppliedCertificateJobResponse, error)

	// GetDNSZonesWithResponse request
	GetDNSZonesWithResponse(ctx context.Context, params *GetDNSZonesParams, reqEditors ...RequestEditorFn) (*GetDNSZonesResponse, error)

	// CreateDNSZoneWithBodyWithResponse request with any body
	CreateDNSZoneWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSZoneResponse, error)

	CreateDNSZoneWithResponse(ctx context.Context, body CreateDNSZoneJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSZoneResponse, error)

	// DeleteDNSZoneWithResponse request
	DeleteDNSZoneWithResponse(ctx context.Context, zoneId string, reqEditors ...RequestEditorFn) (*DeleteDNSZoneResponse, error)

	// GetDNSZoneWithResponse request
	GetDNSZoneWithResponse(ctx context.Context, zoneId string, reqEditors ...RequestEditorFn) (*GetDNSZoneResponse, error)

	// UpdateDNSZoneWithBodyWithResponse request with any body
	UpdateDNSZoneWithBodyWithResponse(ctx context.Context, zoneId string, params *UpdateDNSZoneParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDNSZoneResponse, error)

	UpdateDNSZoneWithResponse(ctx context.Context, zoneId string, params *UpdateDNSZoneParams, body UpdateDNSZoneJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDNSZoneResponse, error)

	// UpdateDNSZoneAccessWithBodyWithResponse request with any body
	UpdateDNSZoneAccessWithBodyWithResponse(ctx context.Context, zoneId string, params *UpdateDNSZoneAccessParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDNSZoneAccessResponse, error)

	UpdateDNSZoneAccessWithResponse(ctx context.Context, zoneId string, params *UpdateDNSZoneAccessParams, body UpdateDNSZoneAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDNSZoneAccessResponse, error)

	// GetDNSZoneRecordsWithResponse request
	GetDNSZoneRecordsWithResponse(ctx context.Context, zoneId string, params *GetDNSZoneRecordsParams, reqEditors ...RequestEditorFn) (*GetDNSZoneRecordsResponse, error)

	// CreateDNSZoneRecordWithBodyWithResponse request with any body
	CreateDNSZoneRecordWithBodyWithResponse(ctx context.Context, zoneId string, params *CreateDNSZoneRecordParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSZoneRecordResponse, error)

	CreateDNSZoneRecordWithResponse(ctx context.Context, zoneId string, params *CreateDNSZoneRecordParams, body CreateDNSZoneRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSZoneRecordResponse, error)

	// DeleteDNSZoneRecordWithResponse request
	DeleteDNSZoneRecordWithResponse(ctx context.Context, zoneId string, recordId string, reqEditors ...RequestEditorFn) (*DeleteDNSZoneRecordResponse, error)

	// UpdateDNSZoneRecordWithBodyWithResponse request with any body
	UpdateDNSZoneRecordWithBodyWithResponse(ctx context.Context, zoneId string, recordId string, params *UpdateDNSZoneRecordParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDNSZoneRecordResponse, error)

	UpdateDNSZoneRecordWithResponse(ctx context.Context, zoneId string, recordId string, params *UpdateDNSZoneRecordParams, body UpdateDNSZoneRecordJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDNSZoneRecordResponse, error)

	// CreateDNSZoneRecordJobWithBodyWithResponse request with any body
	CreateDNSZoneRecordJobWithBodyWithResponse(ctx context.Context, zoneId string, recordId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSZoneRecordJobResponse, error)

	CreateDNSZoneRecordJobWithResponse(ctx context.Context, zoneId string, recordId string, body CreateDNSZoneRecordJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSZoneRecordJobResponse, error)

	// CreateDNSZoneJobWithBodyWithResponse request with any body
	CreateDNSZoneJobWithBodyWithResponse(ctx context.Context, zoneId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSZoneJobResponse, error)

	CreateDNSZoneJobWithResponse(ctx context.Context, zoneId string, body CreateDNSZoneJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSZoneJobResponse, error)

	// GetEnvironmentsWithResponse request
	GetEnvironmentsWithResponse(ctx context.Context, params *GetEnvironmentsParams, reqEditors ...RequestEditorFn) (*GetEnvironmentsResponse, error)

	// CreateEnvironmentWithBodyWithResponse request with any body
	CreateEnvironmentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnvironmentResponse, error)

	CreateEnvironmentWithResponse(ctx context.Context, body CreateEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnvironmentResponse, error)

	// DeleteEnvironmentWithResponse request
	DeleteEnvironmentWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*DeleteEnvironmentResponse, error)

	// GetEnvironmentWithResponse request
	GetEnvironmentWithResponse(ctx context.Context, environmentId string, params *GetEnvironmentParams, reqEditors ...RequestEditorFn) (*GetEnvironmentResponse, error)

	// UpdateEnvironmentWithBodyWithResponse request with any body
	UpdateEnvironmentWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEnvironmentResponse, error)

	UpdateEnvironmentWithResponse(ctx context.Context, environmentId string, body UpdateEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEnvironmentResponse, error)

	// UpdateEnvironmentAccessWithBodyWithResponse request with any body
	UpdateEnvironmentAccessWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEnvironmentAccessResponse, error)

	UpdateEnvironmentAccessWithResponse(ctx context.Context, environmentId string, body UpdateEnvironmentAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEnvironmentAccessResponse, error)

	// GetEnvironmentDeploymentsWithResponse request
	GetEnvironmentDeploymentsWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*GetEnvironmentDeploymentsResponse, error)

	// ExportStackWithBodyWithResponse request with any body
	ExportStackWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExportStackResponse, error)

	ExportStackWithResponse(ctx context.Context, environmentId string, body ExportStackJSONRequestBody, reqEditors ...RequestEditorFn) (*ExportStackResponse, error)

	// GetScopedVariablesWithResponse request
	GetScopedVariablesWithResponse(ctx context.Context, environmentId string, params *GetScopedVariablesParams, reqEditors ...RequestEditorFn) (*GetScopedVariablesResponse, error)

	// CreateScopedVariableWithBodyWithResponse request with any body
	CreateScopedVariableWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateScopedVariableResponse, error)

	CreateScopedVariableWithResponse(ctx context.Context, environmentId string, body CreateScopedVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateScopedVariableResponse, error)

	// DeleteScopedVariableWithResponse request
	DeleteScopedVariableWithResponse(ctx context.Context, environmentId string, scopedVariableId string, reqEditors ...RequestEditorFn) (*DeleteScopedVariableResponse, error)

	// GetScopedVariableWithResponse request
	GetScopedVariableWithResponse(ctx context.Context, environmentId string, scopedVariableId string, reqEditors ...RequestEditorFn) (*GetScopedVariableResponse, error)

	// UpdateScopedVariableWithBodyWithResponse request with any body
	UpdateScopedVariableWithBodyWithResponse(ctx context.Context, environmentId string, scopedVariableId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateScopedVariableResponse, error)

	UpdateScopedVariableWithResponse(ctx context.Context, environmentId string, scopedVariableId string, body UpdateScopedVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateScopedVariableResponse, error)

	// CreateDiscoveryServiceJobWithBodyWithResponse request with any body
	CreateDiscoveryServiceJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDiscoveryServiceJobResponse, error)

	CreateDiscoveryServiceJobWithResponse(ctx context.Context, environmentId string, body CreateDiscoveryServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDiscoveryServiceJobResponse, error)

	// CreateGatewayServiceJobWithBodyWithResponse request with any body
	CreateGatewayServiceJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateGatewayServiceJobResponse, error)

	CreateGatewayServiceJobWithResponse(ctx context.Context, environmentId string, body CreateGatewayServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateGatewayServiceJobResponse, error)

	// GetLoadBalancerServiceWithResponse request
	GetLoadBalancerServiceWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*GetLoadBalancerServiceResponse, error)

	// CreateLoadBalancerServiceJobWithBodyWithResponse request with any body
	CreateLoadBalancerServiceJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateLoadBalancerServiceJobResponse, error)

	CreateLoadBalancerServiceJobWithResponse(ctx context.Context, environmentId string, body CreateLoadBalancerServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateLoadBalancerServiceJobResponse, error)

	// GetLoadBalancerLatestTelemetryReportWithResponse request
	GetLoadBalancerLatestTelemetryReportWithResponse(ctx context.Context, environmentId string, params *GetLoadBalancerLatestTelemetryReportParams, reqEditors ...RequestEditorFn) (*GetLoadBalancerLatestTelemetryReportResponse, error)

	// GetLoadBalancerTelemetryLatestControllersWithResponse request
	GetLoadBalancerTelemetryLatestControllersWithResponse(ctx context.Context, environmentId string, params *GetLoadBalancerTelemetryLatestControllersParams, reqEditors ...RequestEditorFn) (*GetLoadBalancerTelemetryLatestControllersResponse, error)

	// GetLoadBalancerTelemetryReportWithResponse request
	GetLoadBalancerTelemetryReportWithResponse(ctx context.Context, environmentId string, params *GetLoadBalancerTelemetryReportParams, reqEditors ...RequestEditorFn) (*GetLoadBalancerTelemetryReportResponse, error)

	// CreateSchedulerServiceJobWithBodyWithResponse request with any body
	CreateSchedulerServiceJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSchedulerServiceJobResponse, error)

	CreateSchedulerServiceJobWithResponse(ctx context.Context, environmentId string, body CreateSchedulerServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSchedulerServiceJobResponse, error)

	// GetVPNServiceWithResponse request
	GetVPNServiceWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*GetVPNServiceResponse, error)

	// GetVPNLoginsWithResponse request
	GetVPNLoginsWithResponse(ctx context.Context, environmentId string, params *GetVPNLoginsParams, reqEditors ...RequestEditorFn) (*GetVPNLoginsResponse, error)

	// CreateVPNServiceJobWithBodyWithResponse request with any body
	CreateVPNServiceJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVPNServiceJobResponse, error)

	CreateVPNServiceJobWithResponse(ctx context.Context, environmentId string, body CreateVPNServiceJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVPNServiceJobResponse, error)

	// GetVPNUsersWithResponse request
	GetVPNUsersWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*GetVPNUsersResponse, error)

	// CreateVPNUserWithBodyWithResponse request with any body
	CreateVPNUserWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVPNUserResponse, error)

	CreateVPNUserWithResponse(ctx context.Context, environmentId string, body CreateVPNUserJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVPNUserResponse, error)

	// DeleteVPNUserWithResponse request
	DeleteVPNUserWithResponse(ctx context.Context, environmentId string, userId string, reqEditors ...RequestEditorFn) (*DeleteVPNUserResponse, error)

	// GetEnvironmentSummaryWithResponse request
	GetEnvironmentSummaryWithResponse(ctx context.Context, environmentId string, reqEditors ...RequestEditorFn) (*GetEnvironmentSummaryResponse, error)

	// CreateEnvironmentJobWithBodyWithResponse request with any body
	CreateEnvironmentJobWithBodyWithResponse(ctx context.Context, environmentId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnvironmentJobResponse, error)

	CreateEnvironmentJobWithResponse(ctx context.Context, environmentId string, body CreateEnvironmentJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnvironmentJobResponse, error)

	// GetHubsWithResponse request
	GetHubsWithResponse(ctx context.Context, params *GetHubsParams, reqEditors ...RequestEditorFn) (*GetHubsResponse, error)

	// CreateHubWithBodyWithResponse request with any body
	CreateHubWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateHubResponse, error)

	CreateHubWithResponse(ctx context.Context, body CreateHubJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateHubResponse, error)

	// GetHubCapabilitiesWithResponse request
	GetHubCapabilitiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHubCapabilitiesResponse, error)

	// DeleteHubWithBodyWithResponse request with any body
	DeleteHubWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteHubResponse, error)

	DeleteHubWithResponse(ctx context.Context, body DeleteHubJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteHubResponse, error)

	// GetHubWithResponse request
	GetHubWithResponse(ctx context.Context, params *GetHubParams, reqEditors ...RequestEditorFn) (*GetHubResponse, error)

	// UpdateHubWithBodyWithResponse request with any body
	UpdateHubWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateHubResponse, error)

	UpdateHubWithResponse(ctx context.Context, body UpdateHubJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateHubResponse, error)

	// GetHubActivityWithResponse request
	GetHubActivityWithResponse(ctx context.Context, params *GetHubActivityParams, reqEditors ...RequestEditorFn) (*GetHubActivityResponse, error)

	// GetApiKeysWithResponse request
	GetApiKeysWithResponse(ctx context.Context, params *GetApiKeysParams, reqEditors ...RequestEditorFn) (*GetApiKeysResponse, error)

	// CreateApiKeyWithBodyWithResponse request with any body
	CreateApiKeyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateApiKeyResponse, error)

	CreateApiKeyWithResponse(ctx context.Context, body CreateApiKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateApiKeyResponse, error)

	// DeleteAPIKeyWithResponse request
	DeleteAPIKeyWithResponse(ctx context.Context, apikeyId string, reqEditors ...RequestEditorFn) (*DeleteAPIKeyResponse, error)

	// GetAPIKeyWithResponse request
	GetAPIKeyWithResponse(ctx context.Context, apikeyId string, params *GetAPIKeyParams, reqEditors ...RequestEditorFn) (*GetAPIKeyResponse, error)

	// UpdateAPIKeyWithBodyWithResponse request with any body
	UpdateAPIKeyWithBodyWithResponse(ctx context.Context, apikeyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResponse, error)

	UpdateAPIKeyWithResponse(ctx context.Context, apikeyId string, body UpdateAPIKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAPIKeyResponse, error)

	// GetIntegrationsWithResponse request
	GetIntegrationsWithResponse(ctx context.Context, params *GetIntegrationsParams, reqEditors ...RequestEditorFn) (*GetIntegrationsResponse, error)

	// CreateIntegrationWithBodyWithResponse request with any body
	CreateIntegrationWithBodyWithResponse(ctx context.Context, params *CreateIntegrationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateIntegrationResponse, error)

	CreateIntegrationWithResponse(ctx context.Context, params *CreateIntegrationParams, body CreateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateIntegrationResponse, error)

	// GetAvailableIntegrationsWithResponse request
	GetAvailableIntegrationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAvailableIntegrationsResponse, error)

	// DeleteIntegrationWithResponse request
	DeleteIntegrationWithResponse(ctx context.Context, integrationId string, reqEditors ...RequestEditorFn) (*DeleteIntegrationResponse, error)

	// GetIntegrationWithResponse request
	GetIntegrationWithResponse(ctx context.Context, integrationId string, params *GetIntegrationParams, reqEditors ...RequestEditorFn) (*GetIntegrationResponse, error)

	// UpdateIntegrationWithBodyWithResponse request with any body
	UpdateIntegrationWithBodyWithResponse(ctx context.Context, integrationId string, params *UpdateIntegrationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateIntegrationResponse, error)

	UpdateIntegrationWithResponse(ctx context.Context, integrationId string, params *UpdateIntegrationParams, body UpdateIntegrationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateIntegrationResponse, error)

	// CreateIntegrationJobWithBodyWithResponse request with any body
	CreateIntegrationJobWithBodyWithResponse(ctx context.Context, integrationId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateIntegrationJobResponse, error)

	CreateIntegrationJobWithResponse(ctx context.Context, integrationId string, body CreateIntegrationJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateIntegrationJobResponse, error)

	// GetHubInvitesWithResponse request
	GetHubInvitesWithResponse(ctx context.Context, params *GetHubInvitesParams, reqEditors ...RequestEditorFn) (*GetHubInvitesResponse, error)

	// CreateHubInviteWithBodyWithResponse request with any body
	CreateHubInviteWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateHubInviteResponse, error)

	CreateHubInviteWithResponse(ctx context.Context, body CreateHubInviteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateHubInviteResponse, error)

	// DeleteHubInviteWithResponse request
	DeleteHubInviteWithResponse(ctx context.Context, inviteId string, reqEditors ...RequestEditorFn) (*DeleteHubInviteResponse, error)

	// GetHubMembersWithResponse request
	GetHubMembersWithResponse(ctx context.Context, params *GetHubMembersParams, reqEditors ...RequestEditorFn) (*GetHubMembersResponse, error)

	// GetHubMemberAccountWithResponse request
	GetHubMemberAccountWithResponse(ctx context.Context, accountId string, params *GetHubMemberAccountParams, reqEditors ...RequestEditorFn) (*GetHubMemberAccountResponse, error)

	// DeleteHubMemberWithResponse request
	DeleteHubMemberWithResponse(ctx context.Context, memberId string, reqEditors ...RequestEditorFn) (*DeleteHubMemberResponse, error)

	// GetHubMemberWithResponse request
	GetHubMemberWithResponse(ctx context.Context, memberId string, params *GetHubMemberParams, reqEditors ...RequestEditorFn) (*GetHubMemberResponse, error)

	// UpdateHubMemberWithBodyWithResponse request with any body
	UpdateHubMemberWithBodyWithResponse(ctx context.Context, memberId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateHubMemberResponse, error)

	UpdateHubMemberWithResponse(ctx context.Context, memberId string, body UpdateHubMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateHubMemberResponse, error)

	// GetHubMembershipWithResponse request
	GetHubMembershipWithResponse(ctx context.Context, params *GetHubMembershipParams, reqEditors ...RequestEditorFn) (*GetHubMembershipResponse, error)

	// GetHubNotificationSocketAuthWithResponse request
	GetHubNotificationSocketAuthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHubNotificationSocketAuthResponse, error)

	// GetRolesWithResponse request
	GetRolesWithResponse(ctx context.Context, params *GetRolesParams, reqEditors ...RequestEditorFn) (*GetRolesResponse, error)

	// CreateRoleWithBodyWithResponse request with any body
	CreateRoleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRoleResponse, error)

	CreateRoleWithResponse(ctx context.Context, body CreateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRoleResponse, error)

	// GetDefaultHubRolesWithResponse request
	GetDefaultHubRolesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetDefaultHubRolesResponse, error)

	// DeleteRoleWithResponse request
	DeleteRoleWithResponse(ctx context.Context, roleId string, reqEditors ...RequestEditorFn) (*DeleteRoleResponse, error)

	// GetRoleWithResponse request
	GetRoleWithResponse(ctx context.Context, roleId string, params *GetRoleParams, reqEditors ...RequestEditorFn) (*GetRoleResponse, error)

	// UpdateRoleWithBodyWithResponse request with any body
	UpdateRoleWithBodyWithResponse(ctx context.Context, roleId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRoleResponse, error)

	UpdateRoleWithResponse(ctx context.Context, roleId string, body UpdateRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRoleResponse, error)

	// GetHubUsageWithResponse request
	GetHubUsageWithResponse(ctx context.Context, params *GetHubUsageParams, reqEditors ...RequestEditorFn) (*GetHubUsageResponse, error)

	// GetImagesWithResponse request
	GetImagesWithResponse(ctx context.Context, params *GetImagesParams, reqEditors ...RequestEditorFn) (*GetImagesResponse, error)

	// CreateImageWithBodyWithResponse request with any body
	CreateImageWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateImageResponse, error)

	CreateImageWithResponse(ctx context.Context, body CreateImageJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateImageResponse, error)

	// GetImageSourcesWithResponse request
	GetImageSourcesWithResponse(ctx context.Context, params *GetImageSourcesParams, reqEditors ...RequestEditorFn) (*GetImageSourcesResponse, error)

	// CreateImageSourceWithBodyWithResponse request with any body
	CreateImageSourceWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateImageSourceResponse, error)

	CreateImageSourceWithResponse(ctx context.Context, body CreateImageSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateImageSourceResponse, error)

	// DeleteImageSourceWithResponse request
	DeleteImageSourceWithResponse(ctx context.Context, sourceId string, reqEditors ...RequestEditorFn) (*DeleteImageSourceResponse, error)

	// GetImageSourceWithResponse request
	GetImageSourceWithResponse(ctx context.Context, sourceId string, params *GetImageSourceParams, reqEditors ...RequestEditorFn) (*GetImageSourceResponse, error)

	// UpdateImageSourceWithBodyWithResponse request with any body
	UpdateImageSourceWithBodyWithResponse(ctx context.Context, sourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateImageSourceResponse, error)

	UpdateImageSourceWithResponse(ctx context.Context, sourceId string, body UpdateImageSourceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateImageSourceResponse, error)

	// UpdateImageSourceAccessWithBodyWithResponse request with any body
	UpdateImageSourceAccessWithBodyWithResponse(ctx context.Context, sourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateImageSourceAccessResponse, error)

	UpdateImageSourceAccessWithResponse(ctx context.Context, sourceId string, body UpdateImageSourceAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateImageSourceAccessResponse, error)

	// CreateImagesJobWithBodyWithResponse request with any body
	CreateImagesJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateImagesJobResponse, error)

	CreateImagesJobWithResponse(ctx context.Context, body CreateImagesJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateImagesJobResponse, error)

	// DeleteImageWithResponse request
	DeleteImageWithResponse(ctx context.Context, imageId string, reqEditors ...RequestEditorFn) (*DeleteImageResponse, error)

	// GetImageWithResponse request
	GetImageWithResponse(ctx context.Context, imageId string, params *GetImageParams, reqEditors ...RequestEditorFn) (*GetImageResponse, error)

	// UpdateImageWithBodyWithResponse request with any body
	UpdateImageWithBodyWithResponse(ctx context.Context, imageId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateImageResponse, error)

	UpdateImageWithResponse(ctx context.Context, imageId string, body UpdateImageJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateImageResponse, error)

	// GetImageBuildLogWithResponse request
	GetImageBuildLogWithResponse(ctx context.Context, imageId string, reqEditors ...RequestEditorFn) (*GetImageBuildLogResponse, error)

	// CreateImageJobWithBodyWithResponse request with any body
	CreateImageJobWithBodyWithResponse(ctx context.Context, imageId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateImageJobResponse, error)

	CreateImageJobWithResponse(ctx context.Context, imageId string, body CreateImageJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateImageJobResponse, error)

	// GetAutoScaleGroupsWithResponse request
	GetAutoScaleGroupsWithResponse(ctx context.Context, params *GetAutoScaleGroupsParams, reqEditors ...RequestEditorFn) (*GetAutoScaleGroupsResponse, error)

	// CreateAutoScaleGroupWithBodyWithResponse request with any body
	CreateAutoScaleGroupWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAutoScaleGroupResponse, error)

	CreateAutoScaleGroupWithResponse(ctx context.Context, body CreateAutoScaleGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAutoScaleGroupResponse, error)

	// DeleteAutoScaleGroupWithResponse request
	DeleteAutoScaleGroupWithResponse(ctx context.Context, groupId string, reqEditors ...RequestEditorFn) (*DeleteAutoScaleGroupResponse, error)

	// GetAutoScaleGroupWithResponse request
	GetAutoScaleGroupWithResponse(ctx context.Context, groupId string, params *GetAutoScaleGroupParams, reqEditors ...RequestEditorFn) (*GetAutoScaleGroupResponse, error)

	// UpdateAutoScaleGroupWithBodyWithResponse request with any body
	UpdateAutoScaleGroupWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAutoScaleGroupResponse, error)

	UpdateAutoScaleGroupWithResponse(ctx context.Context, groupId string, body UpdateAutoScaleGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAutoScaleGroupResponse, error)

	// UpdateAutoScaleGroupAccessWithBodyWithResponse request with any body
	UpdateAutoScaleGroupAccessWithBodyWithResponse(ctx context.Context, groupId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAutoScaleGroupAccessResponse, error)

	UpdateAutoScaleGroupAccessWithResponse(ctx context.Context, groupId string, body UpdateAutoScaleGroupAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAutoScaleGroupAccessResponse, error)

	// GetClustersWithResponse request
	GetClustersWithResponse(ctx context.Context, params *GetClustersParams, reqEditors ...RequestEditorFn) (*GetClustersResponse, error)

	// CreateClusterWithBodyWithResponse request with any body
	CreateClusterWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateClusterResponse, error)

	CreateClusterWithResponse(ctx context.Context, body CreateClusterJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateClusterResponse, error)

	// DeleteClusterWithResponse request
	DeleteClusterWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*DeleteClusterResponse, error)

	// GetClusterWithResponse request
	GetClusterWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetClusterResponse, error)

	// UpdateClusterWithBodyWithResponse request with any body
	UpdateClusterWithBodyWithResponse(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateClusterResponse, error)

	UpdateClusterWithResponse(ctx context.Context, clusterId string, body UpdateClusterJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateClusterResponse, error)

	// UpdateClusterAccessWithBodyWithResponse request with any body
	UpdateClusterAccessWithBodyWithResponse(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateClusterAccessResponse, error)

	UpdateClusterAccessWithResponse(ctx context.Context, clusterId string, body UpdateClusterAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateClusterAccessResponse, error)

	// CreateClusterJobWithBodyWithResponse request with any body
	CreateClusterJobWithBodyWithResponse(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateClusterJobResponse, error)

	CreateClusterJobWithResponse(ctx context.Context, clusterId string, body CreateClusterJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateClusterJobResponse, error)

	// GetDeploymentStrategiesWithResponse request
	GetDeploymentStrategiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetDeploymentStrategiesResponse, error)

	// GetExternalVolumesWithResponse request
	GetExternalVolumesWithResponse(ctx context.Context, params *GetExternalVolumesParams, reqEditors ...RequestEditorFn) (*GetExternalVolumesResponse, error)

	// CreateExternalVolumeWithBodyWithResponse request with any body
	CreateExternalVolumeWithBodyWithResponse(ctx context.Context, params *CreateExternalVolumeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateExternalVolumeResponse, error)

	CreateExternalVolumeWithResponse(ctx context.Context, params *CreateExternalVolumeParams, body CreateExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateExternalVolumeResponse, error)

	// GetExternalVolumeSourcesWithResponse request
	GetExternalVolumeSourcesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetExternalVolumeSourcesResponse, error)

	// CreateExternalVolumesJobWithBodyWithResponse request with any body
	CreateExternalVolumesJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateExternalVolumesJobResponse, error)

	CreateExternalVolumesJobWithResponse(ctx context.Context, body CreateExternalVolumesJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateExternalVolumesJobResponse, error)

	// DeleteExternalVolumeWithBodyWithResponse request with any body
	DeleteExternalVolumeWithBodyWithResponse(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteExternalVolumeResponse, error)

	DeleteExternalVolumeWithResponse(ctx context.Context, externalVolumeId string, body DeleteExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteExternalVolumeResponse, error)

	// GetExternalVolumeWithResponse request
	GetExternalVolumeWithResponse(ctx context.Context, externalVolumeId string, params *GetExternalVolumeParams, reqEditors ...RequestEditorFn) (*GetExternalVolumeResponse, error)

	// UpdateExternalVolumeWithBodyWithResponse request with any body
	UpdateExternalVolumeWithBodyWithResponse(ctx context.Context, externalVolumeId string, params *UpdateExternalVolumeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateExternalVolumeResponse, error)

	UpdateExternalVolumeWithResponse(ctx context.Context, externalVolumeId string, params *UpdateExternalVolumeParams, body UpdateExternalVolumeJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateExternalVolumeResponse, error)

	// UpdateExternalVolumeAccessWithBodyWithResponse request with any body
	UpdateExternalVolumeAccessWithBodyWithResponse(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateExternalVolumeAccessResponse, error)

	UpdateExternalVolumeAccessWithResponse(ctx context.Context, externalVolumeId string, body UpdateExternalVolumeAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateExternalVolumeAccessResponse, error)

	// CreateExternalVolumeJobWithBodyWithResponse request with any body
	CreateExternalVolumeJobWithBodyWithResponse(ctx context.Context, externalVolumeId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateExternalVolumeJobResponse, error)

	CreateExternalVolumeJobWithResponse(ctx context.Context, externalVolumeId string, body CreateExternalVolumeJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateExternalVolumeJobResponse, error)

	// GetIpPoolsWithResponse request
	GetIpPoolsWithResponse(ctx context.Context, params *GetIpPoolsParams, reqEditors ...RequestEditorFn) (*GetIpPoolsResponse, error)

	// CreateIpPoolWithBodyWithResponse request with any body
	CreateIpPoolWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateIpPoolResponse, error)

	CreateIpPoolWithResponse(ctx context.Context, body CreateIpPoolJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateIpPoolResponse, error)

	// DeleteIPPoolWithResponse request
	DeleteIPPoolWithResponse(ctx context.Context, poolId string, reqEditors ...RequestEditorFn) (*DeleteIPPoolResponse, error)

	// GetIPPoolWithResponse request
	GetIPPoolWithResponse(ctx context.Context, poolId string, params *GetIPPoolParams, reqEditors ...RequestEditorFn) (*GetIPPoolResponse, error)

	// GetPoolIPsWithResponse request
	GetPoolIPsWithResponse(ctx context.Context, poolId string, reqEditors ...RequestEditorFn) (*GetPoolIPsResponse, error)

	// CreateIpPoolJobWithBodyWithResponse request with any body
	CreateIpPoolJobWithBodyWithResponse(ctx context.Context, poolId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateIpPoolJobResponse, error)

	CreateIpPoolJobWithResponse(ctx context.Context, poolId string, body CreateIpPoolJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateIpPoolJobResponse, error)

	// GetClusterMonitoringTiersWithResponse request
	GetClusterMonitoringTiersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetClusterMonitoringTiersResponse, error)

	// GetProviderLocationsWithResponse request
	GetProviderLocationsWithResponse(ctx context.Context, integrationId string, params *GetProviderLocationsParams, reqEditors ...RequestEditorFn) (*GetProviderLocationsResponse, error)

	// GetProviderServerModelsWithResponse request
	GetProviderServerModelsWithResponse(ctx context.Context, integrationId string, params *GetProviderServerModelsParams, reqEditors ...RequestEditorFn) (*GetProviderServerModelsResponse, error)

	// GetServersWithResponse request
	GetServersWithResponse(ctx context.Context, params *GetServersParams, reqEditors ...RequestEditorFn) (*GetServersResponse, error)

	// CreateServersWithBodyWithResponse request with any body
	CreateServersWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateServersResponse, error)

	CreateServersWithResponse(ctx context.Context, body CreateServersJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateServersResponse, error)

	// GetServerTagsWithResponse request
	GetServerTagsWithResponse(ctx context.Context, params *GetServerTagsParams, reqEditors ...RequestEditorFn) (*GetServerTagsResponse, error)

	// DeleteServerWithBodyWithResponse request with any body
	DeleteServerWithBodyWithResponse(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteServerResponse, error)

	DeleteServerWithResponse(ctx context.Context, serverId string, body DeleteServerJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteServerResponse, error)

	// GetServerWithResponse request
	GetServerWithResponse(ctx context.Context, serverId string, params *GetServerParams, reqEditors ...RequestEditorFn) (*GetServerResponse, error)

	// UpdateServerWithBodyWithResponse request with any body
	UpdateServerWithBodyWithResponse(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateServerResponse, error)

	UpdateServerWithResponse(ctx context.Context, serverId string, body UpdateServerJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateServerResponse, error)

	// GetServerConsoleWithResponse request
	GetServerConsoleWithResponse(ctx context.Context, serverId string, reqEditors ...RequestEditorFn) (*GetServerConsoleResponse, error)

	// GetServerInstancesWithResponse request
	GetServerInstancesWithResponse(ctx context.Context, serverId string, params *GetServerInstancesParams, reqEditors ...RequestEditorFn) (*GetServerInstancesResponse, error)

	// CreateServerJobWithBodyWithResponse request with any body
	CreateServerJobWithBodyWithResponse(ctx context.Context, serverId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateServerJobResponse, error)

	CreateServerJobWithResponse(ctx context.Context, serverId string, body CreateServerJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateServerJobResponse, error)

	// GetServerTelemetryWithResponse request
	GetServerTelemetryWithResponse(ctx context.Context, serverId string, params *GetServerTelemetryParams, reqEditors ...RequestEditorFn) (*GetServerTelemetryResponse, error)

	// GetServerUsageWithResponse request
	GetServerUsageWithResponse(ctx context.Context, serverId string, reqEditors ...RequestEditorFn) (*GetServerUsageResponse, error)

	// GetInfrastructureSummaryWithResponse request
	GetInfrastructureSummaryWithResponse(ctx context.Context, params *GetInfrastructureSummaryParams, reqEditors ...RequestEditorFn) (*GetInfrastructureSummaryResponse, error)

	// GetVirtualProviderIsosWithResponse request
	GetVirtualProviderIsosWithResponse(ctx context.Context, integrationId string, params *GetVirtualProviderIsosParams, reqEditors ...RequestEditorFn) (*GetVirtualProviderIsosResponse, error)

	// CreateVirtualProviderIsoWithBodyWithResponse request with any body
	CreateVirtualProviderIsoWithBodyWithResponse(ctx context.Context, integrationId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVirtualProviderIsoResponse, error)

	CreateVirtualProviderIsoWithResponse(ctx context.Context, integrationId string, body CreateVirtualProviderIsoJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVirtualProviderIsoResponse, error)

	// DeleteVirtualProviderIsoWithResponse request
	DeleteVirtualProviderIsoWithResponse(ctx context.Context, integrationId string, isoId string, reqEditors ...RequestEditorFn) (*DeleteVirtualProviderIsoResponse, error)

	// GetVirtualProviderIsoWithResponse request
	GetVirtualProviderIsoWithResponse(ctx context.Context, integrationId string, isoId string, params *GetVirtualProviderIsoParams, reqEditors ...RequestEditorFn) (*GetVirtualProviderIsoResponse, error)

	// UpdateVirtualProviderIsoWithBodyWithResponse request with any body
	UpdateVirtualProviderIsoWithBodyWithResponse(ctx context.Context, integrationId string, isoId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateVirtualProviderIsoResponse, error)

	UpdateVirtualProviderIsoWithResponse(ctx context.Context, integrationId string, isoId string, body UpdateVirtualProviderIsoJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateVirtualProviderIsoResponse, error)

	// GetVirtualProviderIsoDownloadUrlWithResponse request
	GetVirtualProviderIsoDownloadUrlWithResponse(ctx context.Context, integrationId string, isoId string, reqEditors ...RequestEditorFn) (*GetVirtualProviderIsoDownloadUrlResponse, error)

	// CreateVirtualProviderIsoJobWithBodyWithResponse request with any body
	CreateVirtualProviderIsoJobWithBodyWithResponse(ctx context.Context, integrationId string, isoId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVirtualProviderIsoJobResponse, error)

	CreateVirtualProviderIsoJobWithResponse(ctx context.Context, integrationId string, isoId string, body CreateVirtualProviderIsoJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVirtualProviderIsoJobResponse, error)

	// GetJobsWithResponse request
	GetJobsWithResponse(ctx context.Context, params *GetJobsParams, reqEditors ...RequestEditorFn) (*GetJobsResponse, error)

	// GetLatestJobsWithResponse request
	GetLatestJobsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetLatestJobsResponse, error)

	// GetJobWithResponse request
	GetJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*GetJobResponse, error)

	// GetEventsWithResponse request
	GetEventsWithResponse(ctx context.Context, params *GetEventsParams, reqEditors ...RequestEditorFn) (*GetEventsResponse, error)

	// GenerateAggregatedEventsWithBodyWithResponse request with any body
	GenerateAggregatedEventsWithBodyWithResponse(ctx context.Context, params *GenerateAggregatedEventsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GenerateAggregatedEventsResponse, error)

	GenerateAggregatedEventsWithResponse(ctx context.Context, params *GenerateAggregatedEventsParams, body GenerateAggregatedEventsJSONRequestBody, reqEditors ...RequestEditorFn) (*GenerateAggregatedEventsResponse, error)

	// AggregateLogsWithBodyWithResponse request with any body
	AggregateLogsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AggregateLogsResponse, error)

	AggregateLogsWithResponse(ctx context.Context, body AggregateLogsJSONRequestBody, reqEditors ...RequestEditorFn) (*AggregateLogsResponse, error)

	// GetMetricsWithResponse request
	GetMetricsWithResponse(ctx context.Context, params *GetMetricsParams, reqEditors ...RequestEditorFn) (*GetMetricsResponse, error)

	// GenerateAggregatedMetricsWithBodyWithResponse request with any body
	GenerateAggregatedMetricsWithBodyWithResponse(ctx context.Context, params *GenerateAggregatedMetricsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GenerateAggregatedMetricsResponse, error)

	GenerateAggregatedMetricsWithResponse(ctx context.Context, params *GenerateAggregatedMetricsParams, body GenerateAggregatedMetricsJSONRequestBody, reqEditors ...RequestEditorFn) (*GenerateAggregatedMetricsResponse, error)

	// GetMonitoringMonitorsWithResponse request
	GetMonitoringMonitorsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMonitoringMonitorsResponse, error)

	// GetPipelinesWithResponse request
	GetPipelinesWithResponse(ctx context.Context, params *GetPipelinesParams, reqEditors ...RequestEditorFn) (*GetPipelinesResponse, error)

	// CreatePipelineWithBodyWithResponse request with any body
	CreatePipelineWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePipelineResponse, error)

	CreatePipelineWithResponse(ctx context.Context, body CreatePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePipelineResponse, error)

	// ClonePipelineWithBodyWithResponse request with any body
	ClonePipelineWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClonePipelineResponse, error)

	ClonePipelineWithResponse(ctx context.Context, body ClonePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*ClonePipelineResponse, error)

	// GetAllPipelineRunsWithResponse request
	GetAllPipelineRunsWithResponse(ctx context.Context, params *GetAllPipelineRunsParams, reqEditors ...RequestEditorFn) (*GetAllPipelineRunsResponse, error)

	// DeletePipelineWithResponse request
	DeletePipelineWithResponse(ctx context.Context, pipelineId string, reqEditors ...RequestEditorFn) (*DeletePipelineResponse, error)

	// GetPipelineWithResponse request
	GetPipelineWithResponse(ctx context.Context, pipelineId string, params *GetPipelineParams, reqEditors ...RequestEditorFn) (*GetPipelineResponse, error)

	// UpdatePipelineWithBodyWithResponse request with any body
	UpdatePipelineWithBodyWithResponse(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePipelineResponse, error)

	UpdatePipelineWithResponse(ctx context.Context, pipelineId string, body UpdatePipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePipelineResponse, error)

	// UpdatePipelineAccessWithBodyWithResponse request with any body
	UpdatePipelineAccessWithBodyWithResponse(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePipelineAccessResponse, error)

	UpdatePipelineAccessWithResponse(ctx context.Context, pipelineId string, body UpdatePipelineAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePipelineAccessResponse, error)

	// GetPipelineTriggerKeysWithResponse request
	GetPipelineTriggerKeysWithResponse(ctx context.Context, pipelineId string, params *GetPipelineTriggerKeysParams, reqEditors ...RequestEditorFn) (*GetPipelineTriggerKeysResponse, error)

	// CreatePipelineTriggerKeyWithBodyWithResponse request with any body
	CreatePipelineTriggerKeyWithBodyWithResponse(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePipelineTriggerKeyResponse, error)

	CreatePipelineTriggerKeyWithResponse(ctx context.Context, pipelineId string, body CreatePipelineTriggerKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePipelineTriggerKeyResponse, error)

	// DeletePipelineTriggerKeyWithResponse request
	DeletePipelineTriggerKeyWithResponse(ctx context.Context, pipelineId string, triggerKeyId string, reqEditors ...RequestEditorFn) (*DeletePipelineTriggerKeyResponse, error)

	// GetPipelineTriggerKeyWithResponse request
	GetPipelineTriggerKeyWithResponse(ctx context.Context, pipelineId string, triggerKeyId string, reqEditors ...RequestEditorFn) (*GetPipelineTriggerKeyResponse, error)

	// UpdatePipelineTriggerKeyWithBodyWithResponse request with any body
	UpdatePipelineTriggerKeyWithBodyWithResponse(ctx context.Context, pipelineId string, triggerKeyId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePipelineTriggerKeyResponse, error)

	UpdatePipelineTriggerKeyWithResponse(ctx context.Context, pipelineId string, triggerKeyId string, body UpdatePipelineTriggerKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePipelineTriggerKeyResponse, error)

	// GetPipelineRunsWithResponse request
	GetPipelineRunsWithResponse(ctx context.Context, pipelineId string, params *GetPipelineRunsParams, reqEditors ...RequestEditorFn) (*GetPipelineRunsResponse, error)

	// GetPipelineRunWithResponse request
	GetPipelineRunWithResponse(ctx context.Context, pipelineId string, runId string, params *GetPipelineRunParams, reqEditors ...RequestEditorFn) (*GetPipelineRunResponse, error)

	// CreatePipelineJobWithBodyWithResponse request with any body
	CreatePipelineJobWithBodyWithResponse(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePipelineJobResponse, error)

	CreatePipelineJobWithResponse(ctx context.Context, pipelineId string, body CreatePipelineJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePipelineJobResponse, error)

	// TriggerPipelineWithBodyWithResponse request with any body
	TriggerPipelineWithBodyWithResponse(ctx context.Context, pipelineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TriggerPipelineResponse, error)

	TriggerPipelineWithResponse(ctx context.Context, pipelineId string, body TriggerPipelineJSONRequestBody, reqEditors ...RequestEditorFn) (*TriggerPipelineResponse, error)

	// GetNetworksWithResponse request
	GetNetworksWithResponse(ctx context.Context, params *GetNetworksParams, reqEditors ...RequestEditorFn) (*GetNetworksResponse, error)

	// CreateNetworkWithBodyWithResponse request with any body
	CreateNetworkWithBodyWithResponse(ctx context.Context, params *CreateNetworkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateNetworkResponse, error)

	CreateNetworkWithResponse(ctx context.Context, params *CreateNetworkParams, body CreateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateNetworkResponse, error)

	// DeleteNetworkWithResponse request
	DeleteNetworkWithResponse(ctx context.Context, networkId string, reqEditors ...RequestEditorFn) (*DeleteNetworkResponse, error)

	// GetNetworkWithResponse request
	GetNetworkWithResponse(ctx context.Context, networkId string, params *GetNetworkParams, reqEditors ...RequestEditorFn) (*GetNetworkResponse, error)

	// UpdateNetworkWithBodyWithResponse request with any body
	UpdateNetworkWithBodyWithResponse(ctx context.Context, networkId string, params *UpdateNetworkParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateNetworkResponse, error)

	UpdateNetworkWithResponse(ctx context.Context, networkId string, params *UpdateNetworkParams, body UpdateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateNetworkResponse, error)

	// UpdateNetworkAccessWithBodyWithResponse request with any body
	UpdateNetworkAccessWithBodyWithResponse(ctx context.Context, networkId string, params *UpdateNetworkAccessParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateNetworkAccessResponse, error)

	UpdateNetworkAccessWithResponse(ctx context.Context, networkId string, params *UpdateNetworkAccessParams, body UpdateNetworkAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateNetworkAccessResponse, error)

	// CreateNetworkJobWithBodyWithResponse request with any body
	CreateNetworkJobWithBodyWithResponse(ctx context.Context, networkId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateNetworkJobResponse, error)

	CreateNetworkJobWithResponse(ctx context.Context, networkId string, body CreateNetworkJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateNetworkJobResponse, error)

	// GetSearchIndexWithResponse request
	GetSearchIndexWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetSearchIndexResponse, error)

	// GetStacksWithResponse request
	GetStacksWithResponse(ctx context.Context, params *GetStacksParams, reqEditors ...RequestEditorFn) (*GetStacksResponse, error)

	// CreateStackWithBodyWithResponse request with any body
	CreateStackWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStackResponse, error)

	CreateStackWithResponse(ctx context.Context, body CreateStackJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStackResponse, error)

	// GetAllStackBuildsWithResponse request
	GetAllStackBuildsWithResponse(ctx context.Context, params *GetAllStackBuildsParams, reqEditors ...RequestEditorFn) (*GetAllStackBuildsResponse, error)

	// LookupStackBuildWithResponse request
	LookupStackBuildWithResponse(ctx context.Context, buildId string, reqEditors ...RequestEditorFn) (*LookupStackBuildResponse, error)

	// DeleteStackWithResponse request
	DeleteStackWithResponse(ctx context.Context, stackId string, reqEditors ...RequestEditorFn) (*DeleteStackResponse, error)

	// GetStackWithResponse request
	GetStackWithResponse(ctx context.Context, stackId string, reqEditors ...RequestEditorFn) (*GetStackResponse, error)

	// UpdateStackWithBodyWithResponse request with any body
	UpdateStackWithBodyWithResponse(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStackResponse, error)

	UpdateStackWithResponse(ctx context.Context, stackId string, body UpdateStackJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStackResponse, error)

	// UpdateStackAccessWithBodyWithResponse request with any body
	UpdateStackAccessWithBodyWithResponse(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStackAccessResponse, error)

	UpdateStackAccessWithResponse(ctx context.Context, stackId string, body UpdateStackAccessJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStackAccessResponse, error)

	// GetStackBuildsWithResponse request
	GetStackBuildsWithResponse(ctx context.Context, stackId string, params *GetStackBuildsParams, reqEditors ...RequestEditorFn) (*GetStackBuildsResponse, error)

	// CreateStackBuildWithBodyWithResponse request with any body
	CreateStackBuildWithBodyWithResponse(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStackBuildResponse, error)

	CreateStackBuildWithResponse(ctx context.Context, stackId string, body CreateStackBuildJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStackBuildResponse, error)

	// DeleteStackBuildWithResponse request
	DeleteStackBuildWithResponse(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*DeleteStackBuildResponse, error)

	// GetStackBuildWithResponse request
	GetStackBuildWithResponse(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*GetStackBuildResponse, error)

	// GetStackBuildLogWithResponse request
	GetStackBuildLogWithResponse(ctx context.Context, stackId string, buildId string, reqEditors ...RequestEditorFn) (*GetStackBuildLogResponse, error)

	// CreateStackBuildJobWithBodyWithResponse request with any body
	CreateStackBuildJobWithBodyWithResponse(ctx context.Context, stackId string, buildId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStackBuildJobResponse, error)

	CreateStackBuildJobWithResponse(ctx context.Context, stackId string, buildId string, body CreateStackBuildJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStackBuildJobResponse, error)

	// CreateStackJobWithBodyWithResponse request with any body
	CreateStackJobWithBodyWithResponse(ctx context.Context, stackId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStackJobResponse, error)

	CreateStackJobWithResponse(ctx context.Context, stackId string, body CreateStackJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStackJobResponse, error)

	// LookupComponentsWithBodyWithResponse request with any body
	LookupComponentsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*LookupComponentsResponse, error)

	LookupComponentsWithResponse(ctx context.Context, body LookupComponentsJSONRequestBody, reqEditors ...RequestEditorFn) (*LookupComponentsResponse, error)

	// LookupIdentifierWithResponse request
	LookupIdentifierWithResponse(ctx context.Context, params *LookupIdentifierParams, reqEditors ...RequestEditorFn) (*LookupIdentifierResponse, error)

	// GetVirtualMachinesWithResponse request
	GetVirtualMachinesWithResponse(ctx context.Context, params *GetVirtualMachinesParams, reqEditors ...RequestEditorFn) (*GetVirtualMachinesResponse, error)

	// CreateVirtualMachineWithBodyWithResponse request with any body
	CreateVirtualMachineWithBodyWithResponse(ctx context.Context, params *CreateVirtualMachineParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVirtualMachineResponse, error)

	CreateVirtualMachineWithResponse(ctx context.Context, params *CreateVirtualMachineParams, body CreateVirtualMachineJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVirtualMachineResponse, error)

	// GetVirtualMachineBaseImagesWithResponse request
	GetVirtualMachineBaseImagesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetVirtualMachineBaseImagesResponse, error)

	// GetVirtualMachineSshKeysWithResponse request
	GetVirtualMachineSshKeysWithResponse(ctx context.Context, params *GetVirtualMachineSshKeysParams, reqEditors ...RequestEditorFn) (*GetVirtualMachineSshKeysResponse, error)

	// CreateVirtualMachineSshKeyWithBodyWithResponse request with any body
	CreateVirtualMachineSshKeyWithBodyWithResponse(ctx context.Context, params *CreateVirtualMachineSshKeyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVirtualMachineSshKeyResponse, error)

	CreateVirtualMachineSshKeyWithResponse(ctx context.Context, params *CreateVirtualMachineSshKeyParams, body CreateVirtualMachineSshKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVirtualMachineSshKeyResponse, error)

	// DeleteVirtualMachineSshKeyWithResponse request
	DeleteVirtualMachineSshKeyWithResponse(ctx context.Context, sshKeyId string, reqEditors ...RequestEditorFn) (*DeleteVirtualMachineSshKeyResponse, error)

	// GetVirtualMachineSshKeyWithResponse request
	GetVirtualMachineSshKeyWithResponse(ctx context.Context, sshKeyId string, params *GetVirtualMachineSshKeyParams, reqEditors ...RequestEditorFn) (*GetVirtualMachineSshKeyResponse, error)

	// UpdateVirtualMachineSshKeyWithBodyWithResponse request with any body
	UpdateVirtualMachineSshKeyWithBodyWithResponse(ctx context.Context, sshKeyId string, params *UpdateVirtualMachineSshKeyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateVirtualMachineSshKeyResponse, error)

	UpdateVirtualMachineSshKeyWithResponse(ctx context.Context, sshKeyId string, params *UpdateVirtualMachineSshKeyParams, body UpdateVirtualMachineSshKeyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateVirtualMachineSshKeyResponse, error)

	// DeleteVirtualMachineWithResponse request
	DeleteVirtualMachineWithResponse(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*DeleteVirtualMachineResponse, error)

	// GetVirtualMachineWithResponse request
	GetVirtualMachineWithResponse(ctx context.Context, virtualMachineId string, params *GetVirtualMachineParams, reqEditors ...RequestEditorFn) (*GetVirtualMachineResponse, error)

	// UpdateVirtualMachineWithBodyWithResponse request with any body
	UpdateVirtualMachineWithBodyWithResponse(ctx context.Context, virtualMachineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateVirtualMachineResponse, error)

	UpdateVirtualMachineWithResponse(ctx context.Context, virtualMachineId string, body UpdateVirtualMachineJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateVirtualMachineResponse, error)

	// GetAvailableIpsWithResponse request
	GetAvailableIpsWithResponse(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*GetAvailableIpsResponse, error)

	// ExpireVirtualMachineSosCredentialsWithResponse request
	ExpireVirtualMachineSosCredentialsWithResponse(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*ExpireVirtualMachineSosCredentialsResponse, error)

	// GenerateVirtualMachineSosCredentialsWithResponse request
	GenerateVirtualMachineSosCredentialsWithResponse(ctx context.Context, virtualMachineId string, reqEditors ...RequestEditorFn) (*GenerateVirtualMachineSosCredentialsResponse, error)

	// CreateVirtualMachineJobWithBodyWithResponse request with any body
	CreateVirtualMachineJobWithBodyWithResponse(ctx context.Context, virtualMachineId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVirtualMachineJobResponse, error)

	CreateVirtualMachineJobWithResponse(ctx context.Context, virtualMachineId string, body CreateVirtualMachineJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVirtualMachineJobResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type ClonePipelineJSONBody

type ClonePipelineJSONBody struct {
	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Name The name of the cloned pipeline.
	Name string `json:"name"`

	// PipelineId A 24 character hex string used to identify a unique resource.
	PipelineId ID `json:"pipeline_id"`
}

ClonePipelineJSONBody defines parameters for ClonePipeline.

type ClonePipelineJSONRequestBody

type ClonePipelineJSONRequestBody ClonePipelineJSONBody

ClonePipelineJSONRequestBody defines body for ClonePipeline for application/json ContentType.

type ClonePipelineResponse

type ClonePipelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data A pipeline resource.
		Data Pipeline `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseClonePipelineResponse

func ParseClonePipelineResponse(rsp *http.Response) (*ClonePipelineResponse, error)

ParseClonePipelineResponse parses an HTTP response from a ClonePipelineWithResponse call

func (ClonePipelineResponse) Status

func (r ClonePipelineResponse) Status() string

Status returns HTTPResponse.Status

func (ClonePipelineResponse) StatusCode

func (r ClonePipelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Cluster

type Cluster struct {
	Acl *ACL `json:"acl"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the cluster's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`
	Features struct {
		// Monitoring The level of monitoring to enable for this cluster. There is a cost associated with higher levels of monitoring.
		Monitoring *struct {
			// Tier The tier of monitoring, that determines the frequency that metrics are aggregated by the platform, on a per-environment basis.
			Tier MonitoringTier `json:"tier"`
		} `json:"monitoring"`
	} `json:"features"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID  `json:"hub_id"`
	Id    string `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// NonEssential Marks a cluster as non-essential. Non-essential cluster resources are excluded by default from certain metrics and summaries unless opted in.
	NonEssential bool         `json:"non_essential"`
	State        ClusterState `json:"state"`
}

Cluster Clusters are groups of servers that allow physical separation of resources.

type ClusterIncludes added in v0.6.3

type ClusterIncludes map[string]Cluster

ClusterIncludes A resource associated with a cluster.

type ClusterReconfigureMonitoringTierAction added in v0.6.3

type ClusterReconfigureMonitoringTierAction struct {
	// Action The action to take.
	Action   ClusterReconfigureMonitoringTierActionAction `json:"action"`
	Contents *struct {
		// Tier The tier of monitoring, that determines the frequency that metrics are aggregated by the platform, on a per-environment basis.
		Tier *MonitoringTier `json:"tier,omitempty"`
	} `json:"contents,omitempty"`
}

ClusterReconfigureMonitoringTierAction A job that reconfigures the monitoring tier for the cluster.

type ClusterReconfigureMonitoringTierActionAction added in v0.6.3

type ClusterReconfigureMonitoringTierActionAction string

ClusterReconfigureMonitoringTierActionAction The action to take.

const (
	FeaturesMonitoringTierReconfigure ClusterReconfigureMonitoringTierActionAction = "features.monitoring.tier.reconfigure"
)

Defines values for ClusterReconfigureMonitoringTierActionAction.

type ClusterState

type ClusterState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the cluster.
	Current ClusterStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

ClusterState defines model for ClusterState.

type ClusterStateCurrent

type ClusterStateCurrent string

ClusterStateCurrent The current state of the cluster.

const (
	ClusterStateCurrentDeleted  ClusterStateCurrent = "deleted"
	ClusterStateCurrentDeleting ClusterStateCurrent = "deleting"
	ClusterStateCurrentLive     ClusterStateCurrent = "live"
)

Defines values for ClusterStateCurrent.

type ClusterTask added in v0.6.3

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

ClusterTask defines model for ClusterTask.

func (ClusterTask) AsClusterReconfigureMonitoringTierAction added in v0.6.3

func (t ClusterTask) AsClusterReconfigureMonitoringTierAction() (ClusterReconfigureMonitoringTierAction, error)

AsClusterReconfigureMonitoringTierAction returns the union data inside the ClusterTask as a ClusterReconfigureMonitoringTierAction

func (ClusterTask) Discriminator added in v0.6.3

func (t ClusterTask) Discriminator() (string, error)

func (*ClusterTask) FromClusterReconfigureMonitoringTierAction added in v0.6.3

func (t *ClusterTask) FromClusterReconfigureMonitoringTierAction(v ClusterReconfigureMonitoringTierAction) error

FromClusterReconfigureMonitoringTierAction overwrites any union data inside the ClusterTask as the provided ClusterReconfigureMonitoringTierAction

func (ClusterTask) MarshalJSON added in v0.6.3

func (t ClusterTask) MarshalJSON() ([]byte, error)

func (*ClusterTask) MergeClusterReconfigureMonitoringTierAction added in v0.6.3

func (t *ClusterTask) MergeClusterReconfigureMonitoringTierAction(v ClusterReconfigureMonitoringTierAction) error

MergeClusterReconfigureMonitoringTierAction performs a merge with any union data inside the ClusterTask, using the provided ClusterReconfigureMonitoringTierAction

func (*ClusterTask) UnmarshalJSON added in v0.6.3

func (t *ClusterTask) UnmarshalJSON(b []byte) error

func (ClusterTask) ValueByDiscriminator added in v0.6.3

func (t ClusterTask) ValueByDiscriminator() (interface{}, error)

type ClusterVersionServerCount

type ClusterVersionServerCount struct {
	Agent          map[string]float32 `json:"agent"`
	AgentSpawner   map[string]float32 `json:"agent-spawner"`
	Compute        map[string]float32 `json:"compute"`
	ComputeSpawner map[string]float32 `json:"compute-spawner"`
}

ClusterVersionServerCount A count of servers in a cluster with the given version of Cycle software

type Component

type Component struct {
	// Associations Component associations
	Associations struct {
		// Container Associated container Id
		Container *string `json:"container,omitempty"`

		// Environment Associated environment Id
		Environment *string `json:"environment,omitempty"`

		// Image Associated image Id
		Image *string `json:"image,omitempty"`

		// ImageSource Associated image source Id
		ImageSource *string `json:"image-source,omitempty"`

		// Pipeline Associated pipeline source Id
		Pipeline *string `json:"pipeline,omitempty"`

		// ProviderLocation Associated provider location Id
		ProviderLocation *string `json:"provider-location,omitempty"`

		// Server Associated server Id
		Server *string `json:"server,omitempty"`

		// Stack Associated stack Id
		Stack *string `json:"stack,omitempty"`

		// VirtualMachine Associated virtual machine source Id
		VirtualMachine *string `json:"virtual-machine,omitempty"`
	} `json:"associations"`

	// ContextBlobs related strings for fuzzy search
	ContextBlobs []string `json:"context_blobs"`

	// Events Describes the date and time at which certain events occurred in the lifetime of this resource.
	Events Events `json:"events"`

	// Id ID of the component
	Id string `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Name Name of the component
	Name string `json:"name"`

	// State State of the component
	State string `json:"state"`
}

Component Generic component format for describing resources for the search index

type ComponentsIncludes

type ComponentsIncludes map[string]map[string]interface{}

ComponentsIncludes A resource that is associated with activity.

type Config

type Config struct {
	// Deploy Deployment configuration for the given container.
	Deploy ContainerDeploy `json:"deploy"`

	// Integrations Configuration settings for integrations with a given container.
	Integrations *ContainerIntegrations `json:"integrations,omitempty"`

	// Network Network configuration for a container.
	Network ContainerNetwork `json:"network"`

	// Resources Configuration settings for the resource allocations and limits of a given container.
	Resources *ContainerResources `json:"resources,omitempty"`

	// Runtime Runtime configurations for a given container.
	Runtime *ContainerRuntime `json:"runtime,omitempty"`

	// Scale Network configuration for a container.
	Scale *ContainerScale `json:"scale,omitempty"`
}

Config A container configuration.

type Container

type Container struct {
	// Annotations Custom meta data for a given container
	Annotations *map[string]interface{} `json:"annotations"`

	// Config A container configuration.
	Config Config `json:"config"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator    CreatorScope `json:"creator"`
	Deployment *Deployment  `json:"deployment"`

	// Deprecate A boolean where true signifies the container is marked as deprecated.
	Deprecate bool `json:"deprecate"`

	// Environment A summary of supplemental environment and network information specific to a container.
	Environment ContainerEnvironmentSummary `json:"environment"`

	// Events A collection of timestamps for each event in the container's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Started DateTime `json:"started"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Image A summary of the image this container was created from.
	Image ImageSummary `json:"image"`

	// Instances The number of instances for a given container.
	Instances int `json:"instances"`

	// Lock When set to true, prevents this container from being deleted.
	Lock bool `json:"lock"`

	// Meta A list of meta fields that can be applied to a container.
	Meta *ContainersMeta `json:"meta,omitempty"`

	// Name A user defined name for the container resource.
	Name string `json:"name"`

	// Role The role of a given container if it has one.
	Role  *ContainerRole `json:"role"`
	Stack *StackSummary  `json:"stack"`
	State ContainerState `json:"state"`

	// Stateful A boolean where true signifies the container is stateful.
	Stateful bool             `json:"stateful"`
	Volumes  *[]VolumeSummary `json:"volumes,omitempty"`
}

Container Containers are a way to package together your application along with it's dependencies, and run in a resource isolated process. They provide consistency across different hosts, efficiency over traditional hosting methods, and facilitate a micro-service based approach, where each logical piece of your application is split into multiple, easily testable parts (such as API, Backend, Frontend, etc).

type ContainerBackup

type ContainerBackup struct {
	// ContainerId The ID of the given container.
	ContainerId string `json:"container_id"`

	// Events A collection of timestamps for each event in the backup's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// InstanceId The ID of the instance the backup belongs to.
	InstanceId string               `json:"instance_id"`
	State      ContainerBackupState `json:"state"`

	// Target A target for the given Container Backup.
	Target ContainerBackupTarget `json:"target"`
}

ContainerBackup A Container Backup.

type ContainerBackupIncludes

type ContainerBackupIncludes struct {
	// Integrations A resource that is associated with an integration.
	Integrations *IntegrationsIncludes `json:"integrations,omitempty"`
}

ContainerBackupIncludes All includable resources linkable to the given Zone.

type ContainerBackupLogs

type ContainerBackupLogs struct {
	// BackupId An identifier for the backup.
	BackupId string `json:"backup_id"`

	// ContainerId An identifier for the container.
	ContainerId string `json:"container_id"`
	Error       *struct {
		Message         string  `json:"message"`
		MessageInternal *string `json:"message_internal,omitempty"`
		Stack           *[]struct {
			File     string `json:"file"`
			Function string `json:"function"`
			Line     int    `json:"line"`
		} `json:"stack,omitempty"`
	} `json:"error"`

	// Events A collection of timestamps for each event in the backup log's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// InstanceId An identifier for the instance.
	InstanceId string `json:"instance_id"`

	// Log The log.
	Log string `json:"log"`

	// Type The type of the backup log.
	Type ContainerBackupLogsType `json:"type"`
}

ContainerBackupLogs Backup logs for a given container.

type ContainerBackupLogsType

type ContainerBackupLogsType string

ContainerBackupLogsType The type of the backup log.

const (
	ContainerBackupLogsTypeBackup  ContainerBackupLogsType = "backup"
	ContainerBackupLogsTypeRestore ContainerBackupLogsType = "restore"
)

Defines values for ContainerBackupLogsType.

type ContainerBackupState

type ContainerBackupState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the Container Backup.
	Current ContainerBackupStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

ContainerBackupState defines model for ContainerBackupState.

type ContainerBackupStateCurrent

type ContainerBackupStateCurrent string

ContainerBackupStateCurrent The current state of the Container Backup.

const (
	ContainerBackupStateCurrentDeleted  ContainerBackupStateCurrent = "deleted"
	ContainerBackupStateCurrentDeleting ContainerBackupStateCurrent = "deleting"
	ContainerBackupStateCurrentLive     ContainerBackupStateCurrent = "live"
	ContainerBackupStateCurrentSaving   ContainerBackupStateCurrent = "saving"
)

Defines values for ContainerBackupStateCurrent.

type ContainerBackupTarget

type ContainerBackupTarget struct {
	FileId string `json:"file_id"`

	// IntegrationId Either a resource ID (objectid - i.e. 651586fca6078e98982dbd90) or a resource Identifier (human-readable)
	IntegrationId HybridIdentifier `json:"integration_id"`

	// Path The target for where to store the Container Backup on the destination service.
	Path string `json:"path"`

	// Size The total size of the backup.
	Size int `json:"size"`
}

ContainerBackupTarget A target for the given Container Backup.

type ContainerCreateStep

type ContainerCreateStep struct {
	// Action The action that the step takes.
	Action  ContainerCreateStepAction `json:"action"`
	Details struct {
		// Annotations Additional information about a container
		Annotations *map[string]interface{} `json:"annotations"`

		// Config A container configuration.
		Config     Config      `json:"config"`
		Deployment *Deployment `json:"deployment"`

		// Environment An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Environment FluidIdentifier `json:"environment"`
		Identifier  *string         `json:"identifier"`

		// Image An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Image    FluidIdentifier   `json:"image"`
		Name     string            `json:"name"`
		Stateful bool              `json:"stateful"`
		Volumes  []ContainerVolume `json:"volumes"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ContainerCreateStep Settings for the create container step for a pipeline.

type ContainerCreateStepAction

type ContainerCreateStepAction string

ContainerCreateStepAction The action that the step takes.

const (
	ContainerCreateStepActionContainerCreate ContainerCreateStepAction = "container.create"
)

Defines values for ContainerCreateStepAction.

type ContainerDeleteStep

type ContainerDeleteStep struct {
	// Action The action that the step takes.
	Action  ContainerDeleteStepAction `json:"action"`
	Details struct {
		// Container An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Container FluidIdentifier `json:"container"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ContainerDeleteStep Settings for deleting a container in a pipeline

type ContainerDeleteStepAction

type ContainerDeleteStepAction string

ContainerDeleteStepAction The action that the step takes.

const (
	ContainerDeleteStepActionContainerDelete ContainerDeleteStepAction = "container.delete"
)

Defines values for ContainerDeleteStepAction.

type ContainerDeploy

type ContainerDeploy struct {
	// Constraints Settings that give more granular control over deployment targets and conditions.
	Constraints *struct {
		// Node Constraint settings related to which nodes an instance can be deployed to.
		Node *struct {
			// Tags Lists of server tags that formally declair servers that match the criteria for deployment.
			Tags struct {
				// All A list of tags where a server matching all tags from the list is the only scenario where the server is qualified as a deployment target.
				All *[]string `json:"all"`

				// Any A list of tags where a server matching any tags from the list is qualified as a deployment target.
				Any *[]string `json:"any"`
			} `json:"tags"`
		} `json:"node"`

		// Secrets A list of secret identifiers that will be made available to the container.
		Secrets *[]string `json:"secrets"`
	} `json:"constraints"`

	// Function Configuration options for containers using the 'function' deployment strategy.
	Function *struct {
		// MaxPoolSize The maximum number of instances that Cycle can pre-allocate (includes auto-scaled instances).
		MaxPoolSize *int `json:"max_pool_size"`

		// MaxQueueTime The maximum amount of time Cycle will wait for an instance to be available.
		MaxQueueTime *Duration `json:"max_queue_time"`

		// MaxRuntime The maximum amount of time a function instance can run before timing out.
		MaxRuntime *Duration `json:"max_runtime"`

		// MaxShardConcurrency For each shard (scheduler), the maximum number of tasks it can run in parallel.
		MaxShardConcurrency *int `json:"max_shard_concurrency"`
	} `json:"function"`

	// HealthCheck Configuration for determining the health of a container.
	HealthCheck *struct {
		// Command The command that will be run to verify the health of the container.
		Command string `json:"command"`

		// Delay A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Delay Duration `json:"delay"`

		// Interval A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Interval Duration `json:"interval"`

		// Restart A boolean where `true` represents the desire for a container to restart if unhealthy.
		Restart bool `json:"restart"`

		// Retries The number of times the platform will retry the command before marking the container unhealthy.
		Retries int `json:"retries"`

		// Timeout A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Timeout Duration `json:"timeout"`
	} `json:"health_check"`

	// Instances The number of initial desired instances for a given container.
	Instances int `json:"instances"`

	// ReadinessCheck Configuration for determining readiness of a container.
	ReadinessCheck *struct {
		// Command The command that will be run to verify readiness of the container.
		Command string `json:"command"`

		// Interval A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Interval Duration `json:"interval"`

		// Timeout A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Timeout Duration `json:"timeout"`
	} `json:"readiness_check"`

	// Restart Configurations for container restart events.
	Restart *struct {
		// Condition Policy for what should happen in the event of a container dying.
		Condition ContainerDeployRestartCondition `json:"condition"`

		// Delay A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Delay Duration `json:"delay"`

		// MaxAttempts The amount of times the platform will attempt the restart policies.
		MaxAttempts int `json:"max_attempts"`
	} `json:"restart"`

	// Shutdown Configuration for what to do during container shutdown.
	Shutdown *struct {
		// GracefulTimeout How long the platform will wait for a container to stop gracefully.
		GracefulTimeout *Duration `json:"graceful_timeout"`

		// Signals Process signal sent to the container process.
		Signals *[]ShutdownSignal `json:"signals"`
	} `json:"shutdown"`

	// Startup Configurations for container startup.
	Startup *struct {
		// Delay A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Delay *Duration `json:"delay,omitempty"`
	} `json:"startup"`

	// Stateful Configuration options for stateful deployments.
	Stateful *struct {
		// Options Options that modify behavior for stateful deployments.
		Options *struct {
			// UseBaseHostname When set, the base hostname will be used instead of a generated hostname.
			UseBaseHostname *bool `json:"use_base_hostname"`
		} `json:"options"`
	} `json:"stateful"`
	Strategy *DeploymentStrategyName `json:"strategy,omitempty"`

	// Telemetry Configuration settings for container telemetery reporting.
	Telemetry *struct {
		// Disable A boolean where true disables all telemetry reporting for this container.
		Disable bool `json:"disable"`

		// Interval A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Interval Duration `json:"interval"`

		// Retention A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Retention Duration `json:"retention"`
	} `json:"telemetry"`

	// Update Configurations for container updates.
	Update *struct {
		// Stagger A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Stagger *Duration `json:"stagger,omitempty"`
	} `json:"update"`
}

ContainerDeploy Deployment configuration for the given container.

type ContainerDeployRestartCondition

type ContainerDeployRestartCondition string

ContainerDeployRestartCondition Policy for what should happen in the event of a container dying.

const (
	Always  ContainerDeployRestartCondition = "always"
	Failure ContainerDeployRestartCondition = "failure"
	Never   ContainerDeployRestartCondition = "never"
)

Defines values for ContainerDeployRestartCondition.

type ContainerEnvironmentSummary

type ContainerEnvironmentSummary struct {
	// Cluster The cluster this environment is associated with.
	Cluster string `json:"cluster"`

	// ContainerSubnet The private network subnet ID for this container and its instances.
	ContainerSubnet *string `json:"container_subnet"`

	// Id A 24 character hex string used to identify a unique resource.
	Id     ID             `json:"id"`
	Ipv6   *IPNet         `json:"ipv6"`
	Legacy *LegacyNetwork `json:"legacy"`
}

ContainerEnvironmentSummary A summary of supplemental environment and network information specific to a container.

type ContainerExtension

type ContainerExtension struct {
	// Id A 24 character hex string used to identify a unique resource.
	Id         *ID                          `json:"id,omitempty"`
	Identifier ContainerExtensionIdentifier `json:"identifier"`
}

ContainerExtension Reference to container functionality that is added by the Cycle platform.

type ContainerExtensionIdentifier

type ContainerExtensionIdentifier string

ContainerExtensionIdentifier defines model for ContainerExtension.Identifier.

const (
	VirtualMachineV1 ContainerExtensionIdentifier = "virtual-machine-v1"
)

Defines values for ContainerExtensionIdentifier.

type ContainerFunctionTriggerStep

type ContainerFunctionTriggerStep struct {
	// Action The action that the step takes.
	Action  ContainerFunctionTriggerStepAction `json:"action"`
	Details struct {
		// Container An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Container FluidIdentifier `json:"container"`

		// RuntimeVariables Variables that affect the runtime of a function container.
		RuntimeVariables FunctionRuntimeVariables `json:"runtime_variables"`

		// Token A custom token used for identifying and managing a claim. Can be any valid string.
		Token *VariableString `json:"token"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ContainerFunctionTriggerStep Settings for triggering a function in a pipeline.

type ContainerFunctionTriggerStepAction

type ContainerFunctionTriggerStepAction string

ContainerFunctionTriggerStepAction The action that the step takes.

const (
	ContainerFunctionTrigger ContainerFunctionTriggerStepAction = "container.function.trigger"
)

Defines values for ContainerFunctionTriggerStepAction.

type ContainerImageSummary

type ContainerImageSummary struct {
	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Service If this image is a service container this will say either `discovery` | `loadbalancer` | `vpn`.
	Service ContainerImageSummaryService `json:"service"`
}

ContainerImageSummary The Id of the image and information on if it is a service.

type ContainerImageSummaryService

type ContainerImageSummaryService string

ContainerImageSummaryService If this image is a service container this will say either `discovery` | `loadbalancer` | `vpn`.

const (
	ContainerImageSummaryServiceDiscovery    ContainerImageSummaryService = "discovery"
	ContainerImageSummaryServiceLoadbalancer ContainerImageSummaryService = "loadbalancer"
	ContainerImageSummaryServiceVpn          ContainerImageSummaryService = "vpn"
)

Defines values for ContainerImageSummaryService.

type ContainerIncludes

type ContainerIncludes struct {
	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`

	// Environments An identity that is associated with an environment.
	Environments *EnvironmentIncludes `json:"environments,omitempty"`

	// EnvironmentsIdentifiers A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.
	EnvironmentsIdentifiers *IdentifierIncludes `json:"environments:identifiers,omitempty"`

	// Images A resource associated with an image.
	Images *ImagesIncludes `json:"images,omitempty"`

	// StackBuilds A resource that is associated with a stack build.
	StackBuilds *StackBuildIncludes `json:"stack_builds,omitempty"`

	// Stacks A resource associated with a stack.
	Stacks *StackIncludes `json:"stacks,omitempty"`

	// StacksIdentifiers A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.
	StacksIdentifiers *IdentifierIncludes `json:"stacks:identifiers,omitempty"`
}

ContainerIncludes All includable resources linkable to the given container.

type ContainerIntegrations

type ContainerIntegrations struct {
	// Backups Automated backups configuration for the given container.
	Backups *struct {
		// Backup Configuration settings for each backup.
		Backup struct {
			// Command The command to run for the backup.
			Command string `json:"command"`

			// CronString A cron string that configures how often the backup will run.
			CronString *string `json:"cron_string,omitempty"`

			// Timeout How long the backup will attempt to run before timing out.
			Timeout *Duration `json:"timeout"`
		} `json:"backup"`

		// IntegrationId Either a resource ID (objectid - i.e. 651586fca6078e98982dbd90) or a resource Identifier (human-readable)
		IntegrationId *HybridIdentifier `json:"integration_id,omitempty"`

		// Restore Configuration settings for restoring from a backup.
		Restore *struct {
			// Command The command to run for restoring from a backup.
			Command string `json:"command"`

			// Timeout The time in seconds for the restore to attempt to complete before timing out.
			Timeout *Duration `json:"timeout,omitempty"`
		} `json:"restore"`

		// Retention How long the platform will keep backups. Default is 1 year.
		Retention *Duration `json:"retention"`
	} `json:"backups,omitempty"`

	// Files Inject remotely hosted files into container instances at runtime.
	Files *[]struct {
		// Destination The path in the container for these files to be injected.
		Destination string `json:"destination"`

		// Source The http endpoint that is hosting the files to be used.
		Source string `json:"source"`
	} `json:"files,omitempty"`

	// LetsEncrypt Configuration settings to embed a TLS certificate in the container.
	LetsEncrypt *struct {
		// AdditionalCertsPath File path where any remaining certificate files will be stored.
		AdditionalCertsPath *string `json:"additional_certs_path,omitempty"`

		// BundlePath Path where the `certificate.bundle` will be saved.
		BundlePath *string `json:"bundle_path,omitempty"`

		// CertificatePath Path where the `certificate.cert` will be saved.
		CertificatePath *string `json:"certificate_path,omitempty"`

		// ChainPath Path where the `certificate.chain` will be saved.
		ChainPath *string `json:"chain_path,omitempty"`

		// KeyPath Path where the `certificate.key` will be saved.
		KeyPath *string `json:"key_path,omitempty"`
	} `json:"lets_encrypt"`
	SharedFileSystems *map[string]struct {
		MountPoint string `json:"mount_point"`
		Writable   bool   `json:"writable"`
	} `json:"shared_file_systems"`

	// Webhooks Webhooks that can be set for specific event reporting and advanced container configurations.
	Webhooks *struct {
		// Config An endpoint that the platform will react out to with a get request.  This endpoint serves a partial container config which can modify `runtime`, `resources`, and `integrations` configurations.
		Config *string `json:"config,omitempty"`

		// Events Container events that can be configured to report to a webhook.
		Events *struct {
			// Deploy A webhook to hit when a container deploy event happens.
			Deploy *string `json:"deploy,omitempty"`

			// Start A webhook to hit when a container start event happens.
			Start *string `json:"start,omitempty"`

			// Stop A webhook to hit when a container stop event happens.
			Stop *string `json:"stop,omitempty"`
		} `json:"events,omitempty"`
	} `json:"webhooks,omitempty"`
}

ContainerIntegrations Configuration settings for integrations with a given container.

type ContainerNetwork

type ContainerNetwork struct {
	// Hostname The hostname for the given container.
	Hostname string `json:"hostname"`

	// L2 Layer 2 network configuration options for containers running on virtual provider servers.
	L2 *map[string]interface{} `json:"l2,omitempty"`

	// Ports An array of port mappings for the container.
	Ports *[]string `json:"ports,omitempty"`

	// Public The public network settings for the given container
	Public ContainerNetworkPublic `json:"public"`
}

ContainerNetwork Network configuration for a container.

type ContainerNetworkPublic

type ContainerNetworkPublic string

ContainerNetworkPublic The public network settings for the given container

const (
	ContainerNetworkPublicDisable    ContainerNetworkPublic = "disable"
	ContainerNetworkPublicEgressOnly ContainerNetworkPublic = "egress-only"
	ContainerNetworkPublicEnable     ContainerNetworkPublic = "enable"
)

Defines values for ContainerNetworkPublic.

type ContainerReconfigureAction added in v0.6.1

type ContainerReconfigureAction struct {
	// Action The action to take.
	Action ContainerReconfigureActionAction `json:"action"`

	// Contents A container configuration.
	Contents Config `json:"contents"`
}

ContainerReconfigureAction defines model for ContainerReconfigureAction.

type ContainerReconfigureActionAction added in v0.6.1

type ContainerReconfigureActionAction string

ContainerReconfigureActionAction The action to take.

const (
	ContainerReconfigureActionActionReconfigure ContainerReconfigureActionAction = "reconfigure"
)

Defines values for ContainerReconfigureActionAction.

type ContainerReconfigureVolumesAction added in v0.6.1

type ContainerReconfigureVolumesAction struct {
	// Action The action to take.
	Action ContainerReconfigureVolumesActionAction `json:"action"`

	// Contents A map of volume objects where the key is the id and the value is the volume's config.
	Contents map[string]ContainerVolume `json:"contents"`
}

ContainerReconfigureVolumesAction defines model for ContainerReconfigureVolumesAction.

type ContainerReconfigureVolumesActionAction added in v0.6.1

type ContainerReconfigureVolumesActionAction string

ContainerReconfigureVolumesActionAction The action to take.

const (
	ContainerReconfigureVolumesActionActionVolumesReconfigure ContainerReconfigureVolumesActionAction = "volumes.reconfigure"
)

Defines values for ContainerReconfigureVolumesActionAction.

type ContainerReimageAction added in v0.6.1

type ContainerReimageAction struct {
	// Action The action to take.
	Action ContainerReimageActionAction `json:"action"`

	// Contents Additional information needed to complete the job.
	Contents struct {
		// AllowIncompatible A boolean where true signifies the image being used to reimage does not have to have compatibility with the image being replaced.
		AllowIncompatible *bool `json:"allow_incompatible,omitempty"`

		// ImageId The ID of the image to use when reimaging.
		ImageId string `json:"image_id"`

		// OverwriteRuntimeConfig A boolean where true signifies the user wishes to overwrite the current runtime configuration for the given container during the reimage process.
		OverwriteRuntimeConfig *bool `json:"overwrite_runtime_config,omitempty"`
	} `json:"contents"`
}

ContainerReimageAction defines model for ContainerReimageAction.

type ContainerReimageActionAction added in v0.6.1

type ContainerReimageActionAction string

ContainerReimageActionAction The action to take.

const (
	Reimage ContainerReimageActionAction = "reimage"
)

Defines values for ContainerReimageActionAction.

type ContainerReimageStep

type ContainerReimageStep struct {
	// Action The action that the step takes.
	Action  ContainerReimageStepAction `json:"action"`
	Details struct {
		// Container An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Container FluidIdentifier `json:"container"`

		// Image An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Image   FluidIdentifier `json:"image"`
		Options *struct {
			// AllowIncompatible A boolean where true signifies the image being used to reimage does not have to have compatibility with the image being replaced.
			AllowIncompatible bool `json:"allow_incompatible"`

			// OverwriteRuntimeConfig A boolean where true signifies the user wishes to overwrite the current runtime configuration for the given container during the reimage process.
			OverwriteRuntimeConfig bool `json:"overwrite_runtime_config"`
		} `json:"options,omitempty"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ContainerReimageStep Settings for reimaging a container in a pipeline

type ContainerReimageStepAction

type ContainerReimageStepAction string

ContainerReimageStepAction The action that the step takes.

const (
	ContainerReimage ContainerReimageStepAction = "container.reimage"
)

Defines values for ContainerReimageStepAction.

type ContainerResources

type ContainerResources struct {
	// Cpu Configurations settings related to CPU usage.
	Cpu struct {
		Cpus *string `json:"cpus,omitempty"`

		// Shares A share represents 1/10th of the available compute time on a single thread.
		Shares *struct {
			// Limit The limit (maximum) amount of shares each instance of a container can use.
			Limit int `json:"limit"`

			// Reserve The reserve (allocation) number of shares for each instance of a given container.
			Reserve int `json:"reserve"`
		} `json:"shares,omitempty"`
	} `json:"cpu"`

	// Ram Configuration settings for limits and reserves of RAM resources for the given container.
	Ram struct {
		// Limit The limit (maximum) amount of RAM each instance of the given container can use.
		Limit *string `json:"limit,omitempty"`

		// Reserve The reserve (allocation) of RAM given to each instance of the container.
		Reserve *string `json:"reserve,omitempty"`
	} `json:"ram"`
}

ContainerResources Configuration settings for the resource allocations and limits of a given container.

type ContainerRestartAction added in v0.6.3

type ContainerRestartAction struct {
	// Action The name of the action to perform.
	Action ContainerRestartActionAction `json:"action"`
}

ContainerRestartAction defines model for ContainerRestartAction.

type ContainerRestartActionAction added in v0.6.3

type ContainerRestartActionAction string

ContainerRestartActionAction The name of the action to perform.

const (
	ContainerRestartActionActionRestart ContainerRestartActionAction = "restart"
)

Defines values for ContainerRestartActionAction.

type ContainerRestartStep

type ContainerRestartStep struct {
	// Action The action that the step takes.
	Action  ContainerRestartStepAction `json:"action"`
	Details struct {
		// Container An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Container FluidIdentifier `json:"container"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ContainerRestartStep Settings for restarting a container in a pipeline

type ContainerRestartStepAction

type ContainerRestartStepAction string

ContainerRestartStepAction The action that the step takes.

const (
	ContainerRestart ContainerRestartStepAction = "container.restart"
)

Defines values for ContainerRestartStepAction.

type ContainerRole

type ContainerRole string

ContainerRole The role of a given container if it has one.

const (
	Orchestrator ContainerRole = "orchestrator"
)

Defines values for ContainerRole.

type ContainerRuntime

type ContainerRuntime struct {
	// Capabilities A list of linux kernel capabilites for the given container.
	Capabilities *[]ContainerRuntimeCapabilities `json:"capabilities,omitempty"`

	// Command A command that will be run in place of the images defined startup command.
	Command *struct {
		// Args Arguments to pass to the command.
		Args *string `json:"args"`

		// Path System path for the command.
		Path *string `json:"path"`
	} `json:"command"`
	Devices *struct {
		// Expose An array of devices to expose to the container.
		Expose *[]RuntimeExposedDevice `json:"expose,omitempty"`

		// Permissions Rules for granting or denying access to a device node.
		Permissions *[]RuntimeDevicePermission `json:"permissions,omitempty"`

		// ShmSize The size of the shared host memory device (/dev/shm).
		ShmSize *string `json:"shm_size"`
	} `json:"devices"`

	// EnvironmentVars A record of environment variables for the given container.
	EnvironmentVars *map[string]string `json:"environment_vars,omitempty"`
	Host            *struct {
		// ExposeCgroups If true, Cycle will mount the host's `/sys/fs/cgroups` directory into the container at `/var/run/cycle/host/cgroups`.
		ExposeCgroups *bool `json:"expose_cgroups"`

		// ExposeProc If true, Cycle will mount the `/proc` directory into the container, giving it access to the host metrics. This is useful if you're running i.e. a monitoring agent.
		ExposeProc *bool `json:"expose_proc"`

		// PowerManagement If true, Cycle will give the container instances access via internal api to power off or reboot the host server.
		PowerManagement *bool `json:"power_management"`
	} `json:"host"`

	// Namespaces Namespaces the given container will have access to.
	Namespaces *[]ContainerRuntimeNamespaces `json:"namespaces,omitempty"`

	// Privileged Selecting this option will give this container full permissions on the server. This is not recommended and increases the likelihood of your server being compromised.
	Privileged bool `json:"privileged"`

	// Rlimits A record of rlimits and their values.
	Rlimits *map[string]struct {
		// Hard The hard limit for the rlimit.
		Hard *int `json:"hard,omitempty"`

		// Soft The soft limit for the rlimit.
		Soft *int `json:"soft,omitempty"`
	} `json:"rlimits,omitempty"`
	Rootfs *struct {
		// Readonly Enabling this option will set the containers filesystem to readonly. Volumes associated with the container will not be affected by this.
		Readonly *bool `json:"readonly,omitempty"`
	} `json:"rootfs,omitempty"`
	Seccomp *struct {
		Disable *bool          `json:"disable,omitempty"`
		Rules   *[]SeccompRule `json:"rules,omitempty"`
	} `json:"seccomp"`

	// Sysctl A record of sysctl fields and values for a given container.
	Sysctl *map[string]string `json:"sysctl,omitempty"`

	// Workdir Configure the working directory for the given container.
	Workdir *string `json:"workdir,omitempty"`
}

ContainerRuntime Runtime configurations for a given container.

type ContainerRuntimeCapabilities

type ContainerRuntimeCapabilities string

ContainerRuntimeCapabilities defines model for ContainerRuntime.Capabilities.

const (
	CAPAUDITCONTROL   ContainerRuntimeCapabilities = "CAP_AUDIT_CONTROL"
	CAPAUDITREAD      ContainerRuntimeCapabilities = "CAP_AUDIT_READ"
	CAPAUDITWRITE     ContainerRuntimeCapabilities = "CAP_AUDIT_WRITE"
	CAPBLOCKSUSPEND   ContainerRuntimeCapabilities = "CAP_BLOCK_SUSPEND"
	CAPCHOWN          ContainerRuntimeCapabilities = "CAP_CHOWN"
	CAPDACOVERRIDE    ContainerRuntimeCapabilities = "CAP_DAC_OVERRIDE"
	CAPDACREADSEARCH  ContainerRuntimeCapabilities = "CAP_DAC_READ_SEARCH"
	CAPFOWNER         ContainerRuntimeCapabilities = "CAP_FOWNER"
	CAPFSETID         ContainerRuntimeCapabilities = "CAP_FSETID"
	CAPIPCLOCK        ContainerRuntimeCapabilities = "CAP_IPC_LOCK"
	CAPIPCOWNER       ContainerRuntimeCapabilities = "CAP_IPC_OWNER"
	CAPKILL           ContainerRuntimeCapabilities = "CAP_KILL"
	CAPLEASE          ContainerRuntimeCapabilities = "CAP_LEASE"
	CAPLINUXIMMUTABLE ContainerRuntimeCapabilities = "CAP_LINUX_IMMUTABLE"
	CAPMACADMIN       ContainerRuntimeCapabilities = "CAP_MAC_ADMIN"
	CAPMACOVERRIDE    ContainerRuntimeCapabilities = "CAP_MAC_OVERRIDE"
	CAPMKNOD          ContainerRuntimeCapabilities = "CAP_MKNOD"
	CAPNETADMIN       ContainerRuntimeCapabilities = "CAP_NET_ADMIN"
	CAPNETBINDSERVICE ContainerRuntimeCapabilities = "CAP_NET_BIND_SERVICE"
	CAPNETBROADCAST   ContainerRuntimeCapabilities = "CAP_NET_BROADCAST"
	CAPNETRAW         ContainerRuntimeCapabilities = "CAP_NET_RAW"
	CAPSETFCAP        ContainerRuntimeCapabilities = "CAP_SETFCAP"
	CAPSETGID         ContainerRuntimeCapabilities = "CAP_SETGID"
	CAPSETPCAP        ContainerRuntimeCapabilities = "CAP_SETPCAP"
	CAPSETUID         ContainerRuntimeCapabilities = "CAP_SETUID"
	CAPSYSADMIN       ContainerRuntimeCapabilities = "CAP_SYS_ADMIN"
	CAPSYSBOOT        ContainerRuntimeCapabilities = "CAP_SYS_BOOT"
	CAPSYSCHROOT      ContainerRuntimeCapabilities = "CAP_SYS_CHROOT"
	CAPSYSLOG         ContainerRuntimeCapabilities = "CAP_SYSLOG"
	CAPSYSMODULE      ContainerRuntimeCapabilities = "CAP_SYS_MODULE"
	CAPSYSNICE        ContainerRuntimeCapabilities = "CAP_SYS_NICE"
	CAPSYSPACCT       ContainerRuntimeCapabilities = "CAP_SYS_PACCT"
	CAPSYSPTRACE      ContainerRuntimeCapabilities = "CAP_SYS_PTRACE"
	CAPSYSRAWIO       ContainerRuntimeCapabilities = "CAP_SYS_RAWIO"
	CAPSYSRESOURCE    ContainerRuntimeCapabilities = "CAP_SYS_RESOURCE"
	CAPSYSTIME        ContainerRuntimeCapabilities = "CAP_SYS_TIME"
	CAPSYSTTYCONFIG   ContainerRuntimeCapabilities = "CAP_SYS_TTY_CONFIG"
	CAPWAKEALARM      ContainerRuntimeCapabilities = "CAP_WAKE_ALARM"
)

Defines values for ContainerRuntimeCapabilities.

type ContainerRuntimeNamespaces

type ContainerRuntimeNamespaces string

ContainerRuntimeNamespaces defines model for ContainerRuntime.Namespaces.

const (
	ContainerRuntimeNamespacesCgroup  ContainerRuntimeNamespaces = "cgroup"
	ContainerRuntimeNamespacesIpc     ContainerRuntimeNamespaces = "ipc"
	ContainerRuntimeNamespacesMount   ContainerRuntimeNamespaces = "mount"
	ContainerRuntimeNamespacesNetwork ContainerRuntimeNamespaces = "network"
	ContainerRuntimeNamespacesPid     ContainerRuntimeNamespaces = "pid"
	ContainerRuntimeNamespacesUser    ContainerRuntimeNamespaces = "user"
	ContainerRuntimeNamespacesUts     ContainerRuntimeNamespaces = "uts"
)

Defines values for ContainerRuntimeNamespaces.

type ContainerScale

type ContainerScale struct {
	// AutoscaleGroup The autoscaling group describes which servers should be deployed
	AutoscaleGroup *string `json:"autoscale_group"`

	// Instances Describes how many instances should be running
	Instances struct {
		// Max Maximum additional instances the auto-scaler will run at any time
		Max int `json:"max"`

		// MaxServer Minimum number of instances per server
		MaxServer int `json:"max_server"`

		// MinTtl A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		MinTtl Duration `json:"min_ttl"`
	} `json:"instances"`

	// Thresholds An array of rules that dictate when a scaling event will be triggered
	Thresholds []ScaleThresholdMetric `json:"thresholds"`

	// Window A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
	Window Duration `json:"window"`
}

ContainerScale Network configuration for a container.

type ContainerScaleAction added in v0.6.1

type ContainerScaleAction struct {
	// Action The action to take.
	Action ContainerScaleActionAction `json:"action"`

	// Contents Additional information needed to complete the job.
	Contents struct {
		// Instances The number of desired instances to scale to.
		Instances int `json:"instances"`
	} `json:"contents"`
}

ContainerScaleAction defines model for ContainerScaleAction.

type ContainerScaleActionAction added in v0.6.1

type ContainerScaleActionAction string

ContainerScaleActionAction The action to take.

const (
	ContainerScaleActionActionScale ContainerScaleActionAction = "scale"
)

Defines values for ContainerScaleActionAction.

type ContainerStartAction

type ContainerStartAction struct {
	// Action The name of the action to perform.
	Action ContainerStartActionAction `json:"action"`
}

ContainerStartAction defines model for ContainerStartAction.

type ContainerStartActionAction

type ContainerStartActionAction string

ContainerStartActionAction The name of the action to perform.

const (
	ContainerStartActionActionStart ContainerStartActionAction = "start"
)

Defines values for ContainerStartActionAction.

type ContainerStartStep

type ContainerStartStep struct {
	// Action The action that the step takes.
	Action  ContainerStartStepAction `json:"action"`
	Details struct {
		// Container An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Container FluidIdentifier `json:"container"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ContainerStartStep Settings for starting a container in a pipeline

type ContainerStartStepAction

type ContainerStartStepAction string

ContainerStartStepAction The action that the step takes.

const (
	ContainerStart ContainerStartStepAction = "container.start"
)

Defines values for ContainerStartStepAction.

type ContainerState

type ContainerState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the container.
	Current ContainerStateCurrent `json:"current"`

	// Desired The desired state of the container.
	Desired *ContainerStateDesired `json:"desired,omitempty"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

ContainerState defines model for ContainerState.

type ContainerStateCurrent

type ContainerStateCurrent string

ContainerStateCurrent The current state of the container.

const (
	ContainerStateCurrentDeleted  ContainerStateCurrent = "deleted"
	ContainerStateCurrentDeleting ContainerStateCurrent = "deleting"
	ContainerStateCurrentFunction ContainerStateCurrent = "function"
	ContainerStateCurrentNew      ContainerStateCurrent = "new"
	ContainerStateCurrentRunning  ContainerStateCurrent = "running"
	ContainerStateCurrentStarting ContainerStateCurrent = "starting"
	ContainerStateCurrentStopped  ContainerStateCurrent = "stopped"
	ContainerStateCurrentStopping ContainerStateCurrent = "stopping"
)

Defines values for ContainerStateCurrent.

type ContainerStateDesired

type ContainerStateDesired string

ContainerStateDesired The desired state of the container.

const (
	ContainerStateDesiredDeleted  ContainerStateDesired = "deleted"
	ContainerStateDesiredDeleting ContainerStateDesired = "deleting"
	ContainerStateDesiredFunction ContainerStateDesired = "function"
	ContainerStateDesiredNew      ContainerStateDesired = "new"
	ContainerStateDesiredRunning  ContainerStateDesired = "running"
	ContainerStateDesiredStarting ContainerStateDesired = "starting"
	ContainerStateDesiredStopped  ContainerStateDesired = "stopped"
	ContainerStateDesiredStopping ContainerStateDesired = "stopping"
)

Defines values for ContainerStateDesired.

type ContainerStopAction

type ContainerStopAction struct {
	// Action The name of the action to perform.
	Action ContainerStopActionAction `json:"action"`
}

ContainerStopAction defines model for ContainerStopAction.

type ContainerStopActionAction

type ContainerStopActionAction string

ContainerStopActionAction The name of the action to perform.

const (
	ContainerStopActionActionStop ContainerStopActionAction = "stop"
)

Defines values for ContainerStopActionAction.

type ContainerStopStep

type ContainerStopStep struct {
	// Action The action that the step takes.
	Action  ContainerStopStepAction `json:"action"`
	Details struct {
		// Container An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Container FluidIdentifier `json:"container"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ContainerStopStep Settings for stopping a container in a pipeline

type ContainerStopStepAction

type ContainerStopStepAction string

ContainerStopStepAction The action that the step takes.

const (
	ContainerStop ContainerStopStepAction = "container.stop"
)

Defines values for ContainerStopStepAction.

type ContainerSummary added in v0.6.5

type ContainerSummary struct {
	// Environment A summary of supplemental environment and network information specific to a container.
	Environment ContainerEnvironmentSummary `json:"environment"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Image A summary of the image this container was created from.
	Image ImageSummary `json:"image"`

	// Name A user defined name for the container.
	Name    string          `json:"name"`
	State   ContainerState  `json:"state"`
	Volumes []VolumeSummary `json:"volumes"`
}

ContainerSummary Lightweight summary of a container for environment pages and lists.

type ContainerTask added in v0.6.1

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

ContainerTask defines model for ContainerTask.

func (ContainerTask) AsContainerReconfigureAction added in v0.6.1

func (t ContainerTask) AsContainerReconfigureAction() (ContainerReconfigureAction, error)

AsContainerReconfigureAction returns the union data inside the ContainerTask as a ContainerReconfigureAction

func (ContainerTask) AsContainerReconfigureVolumesAction added in v0.6.1

func (t ContainerTask) AsContainerReconfigureVolumesAction() (ContainerReconfigureVolumesAction, error)

AsContainerReconfigureVolumesAction returns the union data inside the ContainerTask as a ContainerReconfigureVolumesAction

func (ContainerTask) AsContainerReimageAction added in v0.6.1

func (t ContainerTask) AsContainerReimageAction() (ContainerReimageAction, error)

AsContainerReimageAction returns the union data inside the ContainerTask as a ContainerReimageAction

func (ContainerTask) AsContainerRestartAction added in v0.6.3

func (t ContainerTask) AsContainerRestartAction() (ContainerRestartAction, error)

AsContainerRestartAction returns the union data inside the ContainerTask as a ContainerRestartAction

func (ContainerTask) AsContainerScaleAction added in v0.6.1

func (t ContainerTask) AsContainerScaleAction() (ContainerScaleAction, error)

AsContainerScaleAction returns the union data inside the ContainerTask as a ContainerScaleAction

func (ContainerTask) AsContainerStartAction added in v0.6.1

func (t ContainerTask) AsContainerStartAction() (ContainerStartAction, error)

AsContainerStartAction returns the union data inside the ContainerTask as a ContainerStartAction

func (ContainerTask) AsContainerStopAction added in v0.6.1

func (t ContainerTask) AsContainerStopAction() (ContainerStopAction, error)

AsContainerStopAction returns the union data inside the ContainerTask as a ContainerStopAction

func (ContainerTask) Discriminator added in v0.6.1

func (t ContainerTask) Discriminator() (string, error)

func (*ContainerTask) FromContainerReconfigureAction added in v0.6.1

func (t *ContainerTask) FromContainerReconfigureAction(v ContainerReconfigureAction) error

FromContainerReconfigureAction overwrites any union data inside the ContainerTask as the provided ContainerReconfigureAction

func (*ContainerTask) FromContainerReconfigureVolumesAction added in v0.6.1

func (t *ContainerTask) FromContainerReconfigureVolumesAction(v ContainerReconfigureVolumesAction) error

FromContainerReconfigureVolumesAction overwrites any union data inside the ContainerTask as the provided ContainerReconfigureVolumesAction

func (*ContainerTask) FromContainerReimageAction added in v0.6.1

func (t *ContainerTask) FromContainerReimageAction(v ContainerReimageAction) error

FromContainerReimageAction overwrites any union data inside the ContainerTask as the provided ContainerReimageAction

func (*ContainerTask) FromContainerRestartAction added in v0.6.3

func (t *ContainerTask) FromContainerRestartAction(v ContainerRestartAction) error

FromContainerRestartAction overwrites any union data inside the ContainerTask as the provided ContainerRestartAction

func (*ContainerTask) FromContainerScaleAction added in v0.6.1

func (t *ContainerTask) FromContainerScaleAction(v ContainerScaleAction) error

FromContainerScaleAction overwrites any union data inside the ContainerTask as the provided ContainerScaleAction

func (*ContainerTask) FromContainerStartAction added in v0.6.1

func (t *ContainerTask) FromContainerStartAction(v ContainerStartAction) error

FromContainerStartAction overwrites any union data inside the ContainerTask as the provided ContainerStartAction

func (*ContainerTask) FromContainerStopAction added in v0.6.1

func (t *ContainerTask) FromContainerStopAction(v ContainerStopAction) error

FromContainerStopAction overwrites any union data inside the ContainerTask as the provided ContainerStopAction

func (ContainerTask) MarshalJSON added in v0.6.1

func (t ContainerTask) MarshalJSON() ([]byte, error)

func (*ContainerTask) MergeContainerReconfigureAction added in v0.6.1

func (t *ContainerTask) MergeContainerReconfigureAction(v ContainerReconfigureAction) error

MergeContainerReconfigureAction performs a merge with any union data inside the ContainerTask, using the provided ContainerReconfigureAction

func (*ContainerTask) MergeContainerReconfigureVolumesAction added in v0.6.1

func (t *ContainerTask) MergeContainerReconfigureVolumesAction(v ContainerReconfigureVolumesAction) error

MergeContainerReconfigureVolumesAction performs a merge with any union data inside the ContainerTask, using the provided ContainerReconfigureVolumesAction

func (*ContainerTask) MergeContainerReimageAction added in v0.6.1

func (t *ContainerTask) MergeContainerReimageAction(v ContainerReimageAction) error

MergeContainerReimageAction performs a merge with any union data inside the ContainerTask, using the provided ContainerReimageAction

func (*ContainerTask) MergeContainerRestartAction added in v0.6.3

func (t *ContainerTask) MergeContainerRestartAction(v ContainerRestartAction) error

MergeContainerRestartAction performs a merge with any union data inside the ContainerTask, using the provided ContainerRestartAction

func (*ContainerTask) MergeContainerScaleAction added in v0.6.1

func (t *ContainerTask) MergeContainerScaleAction(v ContainerScaleAction) error

MergeContainerScaleAction performs a merge with any union data inside the ContainerTask, using the provided ContainerScaleAction

func (*ContainerTask) MergeContainerStartAction added in v0.6.1

func (t *ContainerTask) MergeContainerStartAction(v ContainerStartAction) error

MergeContainerStartAction performs a merge with any union data inside the ContainerTask, using the provided ContainerStartAction

func (*ContainerTask) MergeContainerStopAction added in v0.6.1

func (t *ContainerTask) MergeContainerStopAction(v ContainerStopAction) error

MergeContainerStopAction performs a merge with any union data inside the ContainerTask, using the provided ContainerStopAction

func (*ContainerTask) UnmarshalJSON added in v0.6.1

func (t *ContainerTask) UnmarshalJSON(b []byte) error

func (ContainerTask) ValueByDiscriminator added in v0.6.1

func (t ContainerTask) ValueByDiscriminator() (interface{}, error)

type ContainerVolume

type ContainerVolume struct {
	// BlockDevice Indicates that the volume will be used as unformatted block storage.
	BlockDevice bool `json:"block_device"`

	// Destination The mountpoint path for the container.
	Destination string `json:"destination"`
	External    *struct {
		// Id A 24 character hex string used to identify a unique resource.
		Id *ID `json:"id,omitempty"`
	} `json:"external,omitempty"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Local Configuration for settings local to the container filesystem.
	Local *struct {
		// MaxSize A human-readable data size string. Values are expressed as an integer followed by a unit suffix, without spaces. Supported units:
		//   - b, k, m, g, t, p (bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes)
		//   - An optional "b" suffix may be added (e.g., "mb", "gb").
		// Units are case-insensitive. Example: "512M", "10GB", "1t".
		MaxSize DataSize `json:"max_size"`

		// StoragePool A boolean where true signifies using the largest drive over 2TB for the target server.
		StoragePool *bool `json:"storage_pool"`
	} `json:"local"`

	// ReadOnly A boolean where true marks the volume as read only.
	ReadOnly bool `json:"read_only"`

	// RemoteAccess Configuration settings for remotely accessing the container volume.
	RemoteAccess *struct {
		// Enable A boolean where true represents this container volume being open to remote access connections over SFTP.
		Enable bool      `json:"enable"`
		Ips    *[]string `json:"ips,omitempty"`

		// Password Password configuration settings for the remote access of the container volume.
		Password *struct {
			// Algorithm The hashing algorithm used to has the password.
			Algorithm ContainerVolumeRemoteAccessPasswordAlgorithm `json:"algorithm"`

			// Data The raw or hashed password.
			Data string `json:"data"`
		} `json:"password"`

		// Webhook Call out to a webhook to authenticate usernames/passwords if an organization manages their own accounts
		Webhook *string `json:"webhook,omitempty"`
	} `json:"remote_access,omitempty"`
}

ContainerVolume Configuration settings for container volumes.

type ContainerVolumeRemoteAccessPasswordAlgorithm

type ContainerVolumeRemoteAccessPasswordAlgorithm string

ContainerVolumeRemoteAccessPasswordAlgorithm The hashing algorithm used to has the password.

const (
	ContainerVolumeRemoteAccessPasswordAlgorithmMd5    ContainerVolumeRemoteAccessPasswordAlgorithm = "md5"
	ContainerVolumeRemoteAccessPasswordAlgorithmRaw    ContainerVolumeRemoteAccessPasswordAlgorithm = "raw"
	ContainerVolumeRemoteAccessPasswordAlgorithmSha512 ContainerVolumeRemoteAccessPasswordAlgorithm = "sha512"
)

Defines values for ContainerVolumeRemoteAccessPasswordAlgorithm.

type ContainersIncludes

type ContainersIncludes map[string]Container

ContainersIncludes A resource that is associated with a container.

type ContainersMeta

type ContainersMeta struct {
	Domains *[]struct {
		// Fqdn The fully qualified domain name.
		Fqdn string `json:"fqdn"`

		// Record A DNS record.
		Record *DnsRecord `json:"record,omitempty"`
	} `json:"domains"`

	// InstancesCount A summary of resources by state
	InstancesCount *StateCountSummary `json:"instances_count,omitempty"`

	// Ips An array of IP resources.
	Ips *[]Ip `json:"ips,omitempty"`
}

ContainersMeta A list of meta fields that can be applied to a container.

type Context

type Context struct {
	// Cluster The identifier of a specific cluster.
	Cluster *string `json:"cluster,omitempty"`

	// ContainerId An ID for the given resource.
	ContainerId *string `json:"container_id,omitempty"`

	// DnsZoneId An ID for the given resource.
	DnsZoneId *string `json:"dns_zone_id,omitempty"`

	// EnvironmentId An ID for the given resource.
	EnvironmentId *string `json:"environment_id,omitempty"`

	// InstanceId An ID for the given resource.
	InstanceId *string `json:"instance_id,omitempty"`

	// ServerId An ID for the given resource.
	ServerId *string `json:"server_id,omitempty"`

	// StackId An ID for the given resource.
	StackId *string `json:"stack_id,omitempty"`

	// VirtualMachineId A virtual machine ID.
	VirtualMachineId *string `json:"virtual_machine_id,omitempty"`
}

Context ID context for resources associated with an activity.

type Controllers

type Controllers struct {
	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`

	// Sources A resource associated with an image source.
	Sources *ImageSourceIncludes `json:"sources,omitempty"`

	// StackBuilds A resource that is associated with a stack build.
	StackBuilds *StackBuildIncludes `json:"stack_builds,omitempty"`

	// Stacks A resource associated with a stack.
	Stacks *StackIncludes `json:"stacks,omitempty"`
}

Controllers Optionally included resources for load balancer controllers

type CreateApiKeyJSONBody

type CreateApiKeyJSONBody struct {
	// Ips An array of approved IPs from which this API Key can be used.
	Ips *[]string `json:"ips"`

	// Name A name given to the API Key.
	Name string `json:"name"`

	// RoleId A 24 character hex string used to identify a unique resource.
	RoleId ID `json:"role_id"`
}

CreateApiKeyJSONBody defines parameters for CreateApiKey.

type CreateApiKeyJSONRequestBody

type CreateApiKeyJSONRequestBody CreateApiKeyJSONBody

CreateApiKeyJSONRequestBody defines body for CreateApiKey for application/json ContentType.

type CreateApiKeyResponse

type CreateApiKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data An API key resource
		Data ApiKey `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateApiKeyResponse

func ParseCreateApiKeyResponse(rsp *http.Response) (*CreateApiKeyResponse, error)

ParseCreateApiKeyResponse parses an HTTP response from a CreateApiKeyWithResponse call

func (CreateApiKeyResponse) Status

func (r CreateApiKeyResponse) Status() string

Status returns HTTPResponse.Status

func (CreateApiKeyResponse) StatusCode

func (r CreateApiKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateAutoScaleGroupJSONBody

type CreateAutoScaleGroupJSONBody struct {
	Acl            *ACL                         `json:"acl"`
	Cluster        string                       `json:"cluster"`
	Identifier     string                       `json:"identifier"`
	Infrastructure AutoScaleGroupInfrastructure `json:"infrastructure"`
	Name           string                       `json:"name"`
	Scale          AutoScaleGroupScale          `json:"scale"`
}

CreateAutoScaleGroupJSONBody defines parameters for CreateAutoScaleGroup.

type CreateAutoScaleGroupJSONRequestBody

type CreateAutoScaleGroupJSONRequestBody CreateAutoScaleGroupJSONBody

CreateAutoScaleGroupJSONRequestBody defines body for CreateAutoScaleGroup for application/json ContentType.

type CreateAutoScaleGroupResponse

type CreateAutoScaleGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		Data AutoScaleGroup `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateAutoScaleGroupResponse

func ParseCreateAutoScaleGroupResponse(rsp *http.Response) (*CreateAutoScaleGroupResponse, error)

ParseCreateAutoScaleGroupResponse parses an HTTP response from a CreateAutoScaleGroupWithResponse call

func (CreateAutoScaleGroupResponse) Status

Status returns HTTPResponse.Status

func (CreateAutoScaleGroupResponse) StatusCode

func (r CreateAutoScaleGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateBillingMethodJSONBody

type CreateBillingMethodJSONBody struct {
	// Address Address information for a given billing method.
	Address    Address `json:"address"`
	CreditCard *struct {
		Cvv        string `json:"cvv"`
		Expiration struct {
			Month float32 `json:"month"`
			Year  float32 `json:"year"`
		} `json:"expiration"`
		Name   string `json:"name"`
		Number string `json:"number"`
	} `json:"credit_card"`

	// DirectPayment Only available for hubs that have direct billing enabled. Contact Cycle staff at support@cycle.io for any questions.
	DirectPayment *struct {
		// Instructions Any additional instructions for an organization's billing dept., etc. that should be known about this payment method.
		Instructions string `json:"instructions"`

		// Preference The preference for how the payment will be sent.
		Preference CreateBillingMethodJSONBodyDirectPaymentPreference `json:"preference"`
	} `json:"direct_payment"`

	// Name A name for the billing method.
	Name string `json:"name"`

	// Primary A boolean where true represents a billing method being primary.
	Primary    bool `json:"primary"`
	UsBankAcct *struct {
		// AccountHolderName The name of the account holder.
		AccountHolderName string `json:"account_holder_name"`

		// AccountHolderType Whether this account is owned by a business or an individual.
		AccountHolderType CreateBillingMethodJSONBodyUsBankAcctAccountHolderType `json:"account_holder_type"`

		// AccountNumber The number of the bank account.
		AccountNumber string `json:"account_number"`

		// RoutingNumber The routing number of the bank where the account lives.
		RoutingNumber string `json:"routing_number"`
	} `json:"us_bank_acct"`
}

CreateBillingMethodJSONBody defines parameters for CreateBillingMethod.

type CreateBillingMethodJSONBodyDirectPaymentPreference added in v0.6.3

type CreateBillingMethodJSONBodyDirectPaymentPreference string

CreateBillingMethodJSONBodyDirectPaymentPreference defines parameters for CreateBillingMethod.

const (
	CreateBillingMethodJSONBodyDirectPaymentPreferenceAch   CreateBillingMethodJSONBodyDirectPaymentPreference = "ach"
	CreateBillingMethodJSONBodyDirectPaymentPreferenceCheck CreateBillingMethodJSONBodyDirectPaymentPreference = "check"
	CreateBillingMethodJSONBodyDirectPaymentPreferenceWire  CreateBillingMethodJSONBodyDirectPaymentPreference = "wire"
)

Defines values for CreateBillingMethodJSONBodyDirectPaymentPreference.

type CreateBillingMethodJSONBodyUsBankAcctAccountHolderType

type CreateBillingMethodJSONBodyUsBankAcctAccountHolderType string

CreateBillingMethodJSONBodyUsBankAcctAccountHolderType defines parameters for CreateBillingMethod.

Defines values for CreateBillingMethodJSONBodyUsBankAcctAccountHolderType.

type CreateBillingMethodJSONRequestBody

type CreateBillingMethodJSONRequestBody CreateBillingMethodJSONBody

CreateBillingMethodJSONRequestBody defines body for CreateBillingMethod for application/json ContentType.

type CreateBillingMethodJobJSONBody

type CreateBillingMethodJobJSONBody struct {
	// Action The name of the action to perform.
	Action   CreateBillingMethodJobJSONBodyAction `json:"action"`
	Contents struct {
		MicroDeposits []int `json:"micro_deposits"`
	} `json:"contents"`
}

CreateBillingMethodJobJSONBody defines parameters for CreateBillingMethodJob.

type CreateBillingMethodJobJSONBodyAction

type CreateBillingMethodJobJSONBodyAction string

CreateBillingMethodJobJSONBodyAction defines parameters for CreateBillingMethodJob.

const (
	CreateBillingMethodJobJSONBodyActionVerify CreateBillingMethodJobJSONBodyAction = "verify"
)

Defines values for CreateBillingMethodJobJSONBodyAction.

type CreateBillingMethodJobJSONRequestBody

type CreateBillingMethodJobJSONRequestBody CreateBillingMethodJobJSONBody

CreateBillingMethodJobJSONRequestBody defines body for CreateBillingMethodJob for application/json ContentType.

type CreateBillingMethodJobResponse

type CreateBillingMethodJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateBillingMethodJobResponse

func ParseCreateBillingMethodJobResponse(rsp *http.Response) (*CreateBillingMethodJobResponse, error)

ParseCreateBillingMethodJobResponse parses an HTTP response from a CreateBillingMethodJobWithResponse call

func (CreateBillingMethodJobResponse) Status

Status returns HTTPResponse.Status

func (CreateBillingMethodJobResponse) StatusCode

func (r CreateBillingMethodJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateBillingMethodResponse

type CreateBillingMethodResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data Information about a billing method, usable to pay invoices.
		Data Method `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateBillingMethodResponse

func ParseCreateBillingMethodResponse(rsp *http.Response) (*CreateBillingMethodResponse, error)

ParseCreateBillingMethodResponse parses an HTTP response from a CreateBillingMethodWithResponse call

func (CreateBillingMethodResponse) Status

Status returns HTTPResponse.Status

func (CreateBillingMethodResponse) StatusCode

func (r CreateBillingMethodResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateClusterJSONBody

type CreateClusterJSONBody struct {
	Acl *ACL `json:"acl"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`
}

CreateClusterJSONBody defines parameters for CreateCluster.

type CreateClusterJSONRequestBody

type CreateClusterJSONRequestBody CreateClusterJSONBody

CreateClusterJSONRequestBody defines body for CreateCluster for application/json ContentType.

type CreateClusterJobJSONRequestBody added in v0.6.3

type CreateClusterJobJSONRequestBody = ClusterTask

CreateClusterJobJSONRequestBody defines body for CreateClusterJob for application/json ContentType.

type CreateClusterJobResponse added in v0.6.3

type CreateClusterJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateClusterJobResponse added in v0.6.3

func ParseCreateClusterJobResponse(rsp *http.Response) (*CreateClusterJobResponse, error)

ParseCreateClusterJobResponse parses an HTTP response from a CreateClusterJobWithResponse call

func (CreateClusterJobResponse) Status added in v0.6.3

func (r CreateClusterJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateClusterJobResponse) StatusCode added in v0.6.3

func (r CreateClusterJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateClusterResponse

type CreateClusterResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data Clusters are groups of servers that allow physical separation of resources.
		Data Cluster `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateClusterResponse

func ParseCreateClusterResponse(rsp *http.Response) (*CreateClusterResponse, error)

ParseCreateClusterResponse parses an HTTP response from a CreateClusterWithResponse call

func (CreateClusterResponse) Status

func (r CreateClusterResponse) Status() string

Status returns HTTPResponse.Status

func (CreateClusterResponse) StatusCode

func (r CreateClusterResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateContainerBackupJobJSONBody

type CreateContainerBackupJobJSONBody struct {
	// Action The action to take.
	Action CreateContainerBackupJobJSONBodyAction `json:"action"`

	// Contents Additional information the platform needs to create this Job.
	Contents struct {
		// InstanceId The ID of the instance this Container Backup is being restored to.
		InstanceId string `json:"instance_id"`
	} `json:"contents"`
}

CreateContainerBackupJobJSONBody defines parameters for CreateContainerBackupJob.

type CreateContainerBackupJobJSONBodyAction

type CreateContainerBackupJobJSONBodyAction string

CreateContainerBackupJobJSONBodyAction defines parameters for CreateContainerBackupJob.

const (
	CreateContainerBackupJobJSONBodyActionRestore CreateContainerBackupJobJSONBodyAction = "restore"
)

Defines values for CreateContainerBackupJobJSONBodyAction.

type CreateContainerBackupJobJSONRequestBody

type CreateContainerBackupJobJSONRequestBody CreateContainerBackupJobJSONBody

CreateContainerBackupJobJSONRequestBody defines body for CreateContainerBackupJob for application/json ContentType.

type CreateContainerBackupJobResponse

type CreateContainerBackupJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateContainerBackupJobResponse

func ParseCreateContainerBackupJobResponse(rsp *http.Response) (*CreateContainerBackupJobResponse, error)

ParseCreateContainerBackupJobResponse parses an HTTP response from a CreateContainerBackupJobWithResponse call

func (CreateContainerBackupJobResponse) Status

Status returns HTTPResponse.Status

func (CreateContainerBackupJobResponse) StatusCode

func (r CreateContainerBackupJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateContainerJSONBody

type CreateContainerJSONBody struct {
	// Annotations Custom meta data. Not utilized by Cycle.
	Annotations *map[string]interface{} `json:"annotations"`

	// Config A container configuration.
	Config     Config      `json:"config"`
	Deployment *Deployment `json:"deployment"`

	// EnvironmentId An identifier for the Environment this Container will be deployed to.
	EnvironmentId string      `json:"environment_id"`
	Identifier    *Identifier `json:"identifier"`

	// ImageId An identifier for the Image used to create this Container.
	ImageId string `json:"image_id"`

	// Lock When set to true, prevents this Container from being deleted.
	Lock *bool `json:"lock,omitempty"`

	// Name A user defined name for the Container.
	Name string `json:"name"`

	// Stateful A boolean where true represents this Container is stateful.
	Stateful bool               `json:"stateful"`
	Volumes  *[]ContainerVolume `json:"volumes,omitempty"`
}

CreateContainerJSONBody defines parameters for CreateContainer.

type CreateContainerJSONRequestBody

type CreateContainerJSONRequestBody CreateContainerJSONBody

CreateContainerJSONRequestBody defines body for CreateContainer for application/json ContentType.

type CreateContainerJobJSONRequestBody

type CreateContainerJobJSONRequestBody = ContainerTask

CreateContainerJobJSONRequestBody defines body for CreateContainerJob for application/json ContentType.

type CreateContainerJobResponse

type CreateContainerJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateContainerJobResponse

func ParseCreateContainerJobResponse(rsp *http.Response) (*CreateContainerJobResponse, error)

ParseCreateContainerJobResponse parses an HTTP response from a CreateContainerJobWithResponse call

func (CreateContainerJobResponse) Status

Status returns HTTPResponse.Status

func (CreateContainerJobResponse) StatusCode

func (r CreateContainerJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateContainerResponse

type CreateContainerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data Containers are a way to package together your application along with it's dependencies, and run in a resource isolated process. They provide consistency across different hosts, efficiency over traditional hosting methods, and facilitate a micro-service based approach, where each logical piece of your application is split into multiple, easily testable parts (such as API, Backend, Frontend, etc).
		Data Container `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateContainerResponse

func ParseCreateContainerResponse(rsp *http.Response) (*CreateContainerResponse, error)

ParseCreateContainerResponse parses an HTTP response from a CreateContainerWithResponse call

func (CreateContainerResponse) Status

func (r CreateContainerResponse) Status() string

Status returns HTTPResponse.Status

func (CreateContainerResponse) StatusCode

func (r CreateContainerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDNSZoneJSONBody

type CreateDNSZoneJSONBody struct {
	Acl *ACL `json:"acl"`

	// Hosted A boolean where true represents the desire for the origin to be of the type `hosted`.
	Hosted bool `json:"hosted"`

	// Origin The origin that will be created.
	Origin string `json:"origin"`
}

CreateDNSZoneJSONBody defines parameters for CreateDNSZone.

type CreateDNSZoneJSONRequestBody

type CreateDNSZoneJSONRequestBody CreateDNSZoneJSONBody

CreateDNSZoneJSONRequestBody defines body for CreateDNSZone for application/json ContentType.

type CreateDNSZoneJobJSONBody

type CreateDNSZoneJobJSONBody struct {
	// Action The action that the job will take.
	Action CreateDNSZoneJobJSONBodyAction `json:"action"`
}

CreateDNSZoneJobJSONBody defines parameters for CreateDNSZoneJob.

type CreateDNSZoneJobJSONBodyAction

type CreateDNSZoneJobJSONBodyAction string

CreateDNSZoneJobJSONBodyAction defines parameters for CreateDNSZoneJob.

const (
	CreateDNSZoneJobJSONBodyActionVerify CreateDNSZoneJobJSONBodyAction = "verify"
)

Defines values for CreateDNSZoneJobJSONBodyAction.

type CreateDNSZoneJobJSONRequestBody

type CreateDNSZoneJobJSONRequestBody CreateDNSZoneJobJSONBody

CreateDNSZoneJobJSONRequestBody defines body for CreateDNSZoneJob for application/json ContentType.

type CreateDNSZoneJobResponse

type CreateDNSZoneJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateDNSZoneJobResponse

func ParseCreateDNSZoneJobResponse(rsp *http.Response) (*CreateDNSZoneJobResponse, error)

ParseCreateDNSZoneJobResponse parses an HTTP response from a CreateDNSZoneJobWithResponse call

func (CreateDNSZoneJobResponse) Status

func (r CreateDNSZoneJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateDNSZoneJobResponse) StatusCode

func (r CreateDNSZoneJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDNSZoneRecordJSONBody

type CreateDNSZoneRecordJSONBody struct {
	// Name A name for the given record where `@` represents the desire to use the root of the origin.
	Name string `json:"name"`

	// Type DNS record types the platform supports.
	Type DnsRecordTypes `json:"type"`
}

CreateDNSZoneRecordJSONBody defines parameters for CreateDNSZoneRecord.

type CreateDNSZoneRecordJSONRequestBody

type CreateDNSZoneRecordJSONRequestBody CreateDNSZoneRecordJSONBody

CreateDNSZoneRecordJSONRequestBody defines body for CreateDNSZoneRecord for application/json ContentType.

type CreateDNSZoneRecordJobJSONBody

type CreateDNSZoneRecordJobJSONBody struct {
	// Action The action that the job will take.
	Action CreateDNSZoneRecordJobJSONBodyAction `json:"action"`
}

CreateDNSZoneRecordJobJSONBody defines parameters for CreateDNSZoneRecordJob.

type CreateDNSZoneRecordJobJSONBodyAction

type CreateDNSZoneRecordJobJSONBodyAction string

CreateDNSZoneRecordJobJSONBodyAction defines parameters for CreateDNSZoneRecordJob.

const (
	CertGenerate CreateDNSZoneRecordJobJSONBodyAction = "cert.generate"
)

Defines values for CreateDNSZoneRecordJobJSONBodyAction.

type CreateDNSZoneRecordJobJSONRequestBody

type CreateDNSZoneRecordJobJSONRequestBody CreateDNSZoneRecordJobJSONBody

CreateDNSZoneRecordJobJSONRequestBody defines body for CreateDNSZoneRecordJob for application/json ContentType.

type CreateDNSZoneRecordJobResponse

type CreateDNSZoneRecordJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateDNSZoneRecordJobResponse

func ParseCreateDNSZoneRecordJobResponse(rsp *http.Response) (*CreateDNSZoneRecordJobResponse, error)

ParseCreateDNSZoneRecordJobResponse parses an HTTP response from a CreateDNSZoneRecordJobWithResponse call

func (CreateDNSZoneRecordJobResponse) Status

Status returns HTTPResponse.Status

func (CreateDNSZoneRecordJobResponse) StatusCode

func (r CreateDNSZoneRecordJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDNSZoneRecordParams

type CreateDNSZoneRecordParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *RecordIncludeParam `form:"include,omitempty" json:"include,omitempty"`
}

CreateDNSZoneRecordParams defines parameters for CreateDNSZoneRecord.

type CreateDNSZoneRecordParamsInclude

type CreateDNSZoneRecordParamsInclude string

CreateDNSZoneRecordParamsInclude defines parameters for CreateDNSZoneRecord.

const (
	CreateDNSZoneRecordParamsIncludeContainers                 CreateDNSZoneRecordParamsInclude = "containers"
	CreateDNSZoneRecordParamsIncludeContainersIdentifiers      CreateDNSZoneRecordParamsInclude = "containers:identifiers"
	CreateDNSZoneRecordParamsIncludeCreators                   CreateDNSZoneRecordParamsInclude = "creators"
	CreateDNSZoneRecordParamsIncludeVirtualMachines            CreateDNSZoneRecordParamsInclude = "virtual-machines"
	CreateDNSZoneRecordParamsIncludeVirtualMachinesIdentifiers CreateDNSZoneRecordParamsInclude = "virtual-machines:identifiers"
)

Defines values for CreateDNSZoneRecordParamsInclude.

type CreateDNSZoneRecordResponse

type CreateDNSZoneRecordResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data A DNS record.
		Data DnsRecord `json:"data"`

		// Includes All includable resources linkable to the given records.
		Includes *RecordIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseCreateDNSZoneRecordResponse

func ParseCreateDNSZoneRecordResponse(rsp *http.Response) (*CreateDNSZoneRecordResponse, error)

ParseCreateDNSZoneRecordResponse parses an HTTP response from a CreateDNSZoneRecordWithResponse call

func (CreateDNSZoneRecordResponse) Status

Status returns HTTPResponse.Status

func (CreateDNSZoneRecordResponse) StatusCode

func (r CreateDNSZoneRecordResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDNSZoneResponse

type CreateDNSZoneResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data DNS (Domain Name System), in short, is a decentralized naming system for computers, services, or other resources connected to the internet or a private network. It is what allows the translation of a URL, such as http://example.com, to an IP address.
		Data DnsZone `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateDNSZoneResponse

func ParseCreateDNSZoneResponse(rsp *http.Response) (*CreateDNSZoneResponse, error)

ParseCreateDNSZoneResponse parses an HTTP response from a CreateDNSZoneWithResponse call

func (CreateDNSZoneResponse) Status

func (r CreateDNSZoneResponse) Status() string

Status returns HTTPResponse.Status

func (CreateDNSZoneResponse) StatusCode

func (r CreateDNSZoneResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDiscoveryServiceJobJSONBody

type CreateDiscoveryServiceJobJSONBody struct {
	// Action The name of the action to perform.
	Action   CreateDiscoveryServiceJobJSONBodyAction `json:"action"`
	Contents struct {
		// AutoUpdate A boolean where `true` represents the desire to automatically update the environment discovery service.
		AutoUpdate *bool            `json:"auto_update"`
		Config     *DiscoveryConfig `json:"config"`

		// HighAvailability A boolean where `true` represents the desire to run the environment discovery service in high availability mode.
		HighAvailability *bool `json:"high_availability"`
	} `json:"contents"`
}

CreateDiscoveryServiceJobJSONBody defines parameters for CreateDiscoveryServiceJob.

type CreateDiscoveryServiceJobJSONBodyAction

type CreateDiscoveryServiceJobJSONBodyAction string

CreateDiscoveryServiceJobJSONBodyAction defines parameters for CreateDiscoveryServiceJob.

const (
	CreateDiscoveryServiceJobJSONBodyActionReconfigure CreateDiscoveryServiceJobJSONBodyAction = "reconfigure"
)

Defines values for CreateDiscoveryServiceJobJSONBodyAction.

type CreateDiscoveryServiceJobJSONRequestBody

type CreateDiscoveryServiceJobJSONRequestBody CreateDiscoveryServiceJobJSONBody

CreateDiscoveryServiceJobJSONRequestBody defines body for CreateDiscoveryServiceJob for application/json ContentType.

type CreateDiscoveryServiceJobResponse

type CreateDiscoveryServiceJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateDiscoveryServiceJobResponse

func ParseCreateDiscoveryServiceJobResponse(rsp *http.Response) (*CreateDiscoveryServiceJobResponse, error)

ParseCreateDiscoveryServiceJobResponse parses an HTTP response from a CreateDiscoveryServiceJobWithResponse call

func (CreateDiscoveryServiceJobResponse) Status

Status returns HTTPResponse.Status

func (CreateDiscoveryServiceJobResponse) StatusCode

func (r CreateDiscoveryServiceJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateEnvironmentJSONBody

type CreateEnvironmentJSONBody struct {
	// About Contains details regarding the Environment.
	About struct {
		// Description A custom description for this Environment.
		Description string `json:"description"`
	} `json:"about"`
	Acl *ACL `json:"acl"`

	// Cluster The cluster this Environment is associated with.
	Cluster string `json:"cluster"`

	// Features An object representing specialized features configured for this environment.
	Features EnvironmentFeatures `json:"features"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Name A user defined name for the Environment.
	Name string `json:"name"`
}

CreateEnvironmentJSONBody defines parameters for CreateEnvironment.

type CreateEnvironmentJSONRequestBody

type CreateEnvironmentJSONRequestBody CreateEnvironmentJSONBody

CreateEnvironmentJSONRequestBody defines body for CreateEnvironment for application/json ContentType.

type CreateEnvironmentJobJSONRequestBody

type CreateEnvironmentJobJSONRequestBody = EnvironmentTask

CreateEnvironmentJobJSONRequestBody defines body for CreateEnvironmentJob for application/json ContentType.

type CreateEnvironmentJobResponse

type CreateEnvironmentJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateEnvironmentJobResponse

func ParseCreateEnvironmentJobResponse(rsp *http.Response) (*CreateEnvironmentJobResponse, error)

ParseCreateEnvironmentJobResponse parses an HTTP response from a CreateEnvironmentJobWithResponse call

func (CreateEnvironmentJobResponse) Status

Status returns HTTPResponse.Status

func (CreateEnvironmentJobResponse) StatusCode

func (r CreateEnvironmentJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateEnvironmentResponse

type CreateEnvironmentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data Environments are groups of containers with a private network built between them. For more information on environments, see the [main docs](https://cycle.io/docs/platform/introduction-to-environments).
		Data Environment `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateEnvironmentResponse

func ParseCreateEnvironmentResponse(rsp *http.Response) (*CreateEnvironmentResponse, error)

ParseCreateEnvironmentResponse parses an HTTP response from a CreateEnvironmentWithResponse call

func (CreateEnvironmentResponse) Status

func (r CreateEnvironmentResponse) Status() string

Status returns HTTPResponse.Status

func (CreateEnvironmentResponse) StatusCode

func (r CreateEnvironmentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateExternalVolumeJSONBody added in v0.6.5

type CreateExternalVolumeJSONBody struct {
	// About Additional details about the external volume.
	About *struct {
		// Description A custom description for this external volume.
		Description string `json:"description"`
	} `json:"about"`
	Acl *ACL `json:"acl"`

	// Attachment Attachment configuration for an external volume.
	Attachment ExternalVolumeAttachment `json:"attachment"`

	// Cluster The cluster this external volume is associated with.
	Cluster string `json:"cluster"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// LocationId A 24 character hex string used to identify a unique resource.
	LocationId ID `json:"location_id"`

	// Name A custom name for the external volume.
	Name string `json:"name"`

	// Options Configuration options controlling the behavior of the volume.
	Options   ExternalVolumeOptions `json:"options"`
	ServerIds []ID                  `json:"server_ids"`

	// Source The source information for this volume.
	Source ExternalVolumeSource `json:"source"`
}

CreateExternalVolumeJSONBody defines parameters for CreateExternalVolume.

type CreateExternalVolumeJSONRequestBody added in v0.6.5

type CreateExternalVolumeJSONRequestBody CreateExternalVolumeJSONBody

CreateExternalVolumeJSONRequestBody defines body for CreateExternalVolume for application/json ContentType.

type CreateExternalVolumeJobJSONRequestBody added in v0.6.5

type CreateExternalVolumeJobJSONRequestBody = ExternalVolumeTask

CreateExternalVolumeJobJSONRequestBody defines body for CreateExternalVolumeJob for application/json ContentType.

type CreateExternalVolumeJobResponse added in v0.6.5

type CreateExternalVolumeJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateExternalVolumeJobResponse added in v0.6.5

func ParseCreateExternalVolumeJobResponse(rsp *http.Response) (*CreateExternalVolumeJobResponse, error)

ParseCreateExternalVolumeJobResponse parses an HTTP response from a CreateExternalVolumeJobWithResponse call

func (CreateExternalVolumeJobResponse) Status added in v0.6.5

Status returns HTTPResponse.Status

func (CreateExternalVolumeJobResponse) StatusCode added in v0.6.5

func (r CreateExternalVolumeJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateExternalVolumeParams added in v0.6.5

type CreateExternalVolumeParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]CreateExternalVolumeParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]CreateExternalVolumeParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

CreateExternalVolumeParams defines parameters for CreateExternalVolume.

type CreateExternalVolumeParamsInclude added in v0.6.5

type CreateExternalVolumeParamsInclude string

CreateExternalVolumeParamsInclude defines parameters for CreateExternalVolume.

const (
	CreateExternalVolumeParamsIncludeLocations CreateExternalVolumeParamsInclude = "locations"
	CreateExternalVolumeParamsIncludeServers   CreateExternalVolumeParamsInclude = "servers"
)

Defines values for CreateExternalVolumeParamsInclude.

type CreateExternalVolumeParamsMeta added in v0.6.5

type CreateExternalVolumeParamsMeta string

CreateExternalVolumeParamsMeta defines parameters for CreateExternalVolume.

const (
	CreateExternalVolumeParamsMetaContainers CreateExternalVolumeParamsMeta = "containers"
)

Defines values for CreateExternalVolumeParamsMeta.

type CreateExternalVolumeResponse added in v0.6.5

type CreateExternalVolumeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data A persistent storage volume within a cluster. Volumes may be attached to containers or VMs and can originate from different storage sources.
		Data ExternalVolume `json:"data"`

		// Includes All includable resources linked to the given external volume.
		Includes *ExternalVolumeIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseCreateExternalVolumeResponse added in v0.6.5

func ParseCreateExternalVolumeResponse(rsp *http.Response) (*CreateExternalVolumeResponse, error)

ParseCreateExternalVolumeResponse parses an HTTP response from a CreateExternalVolumeWithResponse call

func (CreateExternalVolumeResponse) Status added in v0.6.5

Status returns HTTPResponse.Status

func (CreateExternalVolumeResponse) StatusCode added in v0.6.5

func (r CreateExternalVolumeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateExternalVolumesJobJSONRequestBody added in v0.6.6

type CreateExternalVolumesJobJSONRequestBody = ExternalVolumesTask

CreateExternalVolumesJobJSONRequestBody defines body for CreateExternalVolumesJob for application/json ContentType.

type CreateExternalVolumesJobResponse added in v0.6.6

type CreateExternalVolumesJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateExternalVolumesJobResponse added in v0.6.6

func ParseCreateExternalVolumesJobResponse(rsp *http.Response) (*CreateExternalVolumesJobResponse, error)

ParseCreateExternalVolumesJobResponse parses an HTTP response from a CreateExternalVolumesJobWithResponse call

func (CreateExternalVolumesJobResponse) Status added in v0.6.6

Status returns HTTPResponse.Status

func (CreateExternalVolumesJobResponse) StatusCode added in v0.6.6

func (r CreateExternalVolumesJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateFunctionJobJSONRequestBody

type CreateFunctionJobJSONRequestBody = FunctionTask

CreateFunctionJobJSONRequestBody defines body for CreateFunctionJob for application/json ContentType.

type CreateFunctionJobResponse

type CreateFunctionJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateFunctionJobResponse

func ParseCreateFunctionJobResponse(rsp *http.Response) (*CreateFunctionJobResponse, error)

ParseCreateFunctionJobResponse parses an HTTP response from a CreateFunctionJobWithResponse call

func (CreateFunctionJobResponse) Status

func (r CreateFunctionJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateFunctionJobResponse) StatusCode

func (r CreateFunctionJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateGatewayServiceJobJSONBody

type CreateGatewayServiceJobJSONBody struct {
	// Action The name of the action to perform.
	Action   CreateGatewayServiceJobJSONBodyAction `json:"action"`
	Contents struct {
		// AutoUpdate A boolean where `true` represents the desire to automatically update the environment gateway service.
		AutoUpdate *bool `json:"auto_update"`
	} `json:"contents"`
}

CreateGatewayServiceJobJSONBody defines parameters for CreateGatewayServiceJob.

type CreateGatewayServiceJobJSONBodyAction

type CreateGatewayServiceJobJSONBodyAction string

CreateGatewayServiceJobJSONBodyAction defines parameters for CreateGatewayServiceJob.

const (
	CreateGatewayServiceJobJSONBodyActionReconfigure CreateGatewayServiceJobJSONBodyAction = "reconfigure"
)

Defines values for CreateGatewayServiceJobJSONBodyAction.

type CreateGatewayServiceJobJSONRequestBody

type CreateGatewayServiceJobJSONRequestBody CreateGatewayServiceJobJSONBody

CreateGatewayServiceJobJSONRequestBody defines body for CreateGatewayServiceJob for application/json ContentType.

type CreateGatewayServiceJobResponse

type CreateGatewayServiceJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateGatewayServiceJobResponse

func ParseCreateGatewayServiceJobResponse(rsp *http.Response) (*CreateGatewayServiceJobResponse, error)

ParseCreateGatewayServiceJobResponse parses an HTTP response from a CreateGatewayServiceJobWithResponse call

func (CreateGatewayServiceJobResponse) Status

Status returns HTTPResponse.Status

func (CreateGatewayServiceJobResponse) StatusCode

func (r CreateGatewayServiceJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateHubInviteJSONBody

type CreateHubInviteJSONBody struct {
	// Permissions The Environment permissions the invitee will have
	Permissions *struct {
		// AllEnvironments Boolean value that indicates the user has access to all Environments
		AllEnvironments bool `json:"all_environments"`

		// Environments A list of objects that describe the specific environments the invitee will have access to
		Environments []struct {
			// Id The ID of the Environment
			Id string `json:"id"`

			// Manage Boolean indicating the invitee has manage rights to Environment
			Manage bool `json:"manage"`
		} `json:"environments"`
	} `json:"permissions,omitempty"`

	// Recipient The email address of the invitee.
	Recipient *string `json:"recipient,omitempty"`

	// RoleId A 24 character hex string used to identify a unique resource.
	RoleId *ID `json:"role_id,omitempty"`
}

CreateHubInviteJSONBody defines parameters for CreateHubInvite.

type CreateHubInviteJSONRequestBody

type CreateHubInviteJSONRequestBody CreateHubInviteJSONBody

CreateHubInviteJSONRequestBody defines body for CreateHubInvite for application/json ContentType.

type CreateHubInviteResponse

type CreateHubInviteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data A membership resource that is scoped to an individual hub.
		Data HubMembership `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateHubInviteResponse

func ParseCreateHubInviteResponse(rsp *http.Response) (*CreateHubInviteResponse, error)

ParseCreateHubInviteResponse parses an HTTP response from a CreateHubInviteWithResponse call

func (CreateHubInviteResponse) Status

func (r CreateHubInviteResponse) Status() string

Status returns HTTPResponse.Status

func (CreateHubInviteResponse) StatusCode

func (r CreateHubInviteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateHubJSONBody

type CreateHubJSONBody struct {
	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Name A name for the Hub.
	Name *string `json:"name,omitempty"`

	// Webhooks Hub related webhooks. When supplied, the given webhook will be called with a payload any time one of these events occurs.
	Webhooks *HubWebhooks `json:"webhooks,omitempty"`
}

CreateHubJSONBody defines parameters for CreateHub.

type CreateHubJSONRequestBody

type CreateHubJSONRequestBody CreateHubJSONBody

CreateHubJSONRequestBody defines body for CreateHub for application/json ContentType.

type CreateHubResponse

type CreateHubResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A hub resource.
		Data Hub `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateHubResponse

func ParseCreateHubResponse(rsp *http.Response) (*CreateHubResponse, error)

ParseCreateHubResponse parses an HTTP response from a CreateHubWithResponse call

func (CreateHubResponse) Status

func (r CreateHubResponse) Status() string

Status returns HTTPResponse.Status

func (CreateHubResponse) StatusCode

func (r CreateHubResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateImageJSONBody

type CreateImageJSONBody struct {
	// Build A build object, holding information important to the Image build.
	Build *struct {
		// Args An object holding key value build time arguments needed for the Image during build time.
		Args *map[string]string `json:"args,omitempty"`

		// UseDisk If true, will skip using /dev/shm when building an image on factory. Allows for building much larger images.
		UseDisk *bool `json:"use_disk,omitempty"`
	} `json:"build,omitempty"`

	// Name A name for the Image.
	Name *string `json:"name,omitempty"`

	// Override An override object to be used for a single Image create request.
	Override *struct {
		// Target For Image sources with `docker-hub` or `docker-registry` origin types. A target to be used for overridding the default target - should include an Image and a tag.
		Target *string `json:"target,omitempty"`

		// TargzUrl For Image sources with `docker-file` origin types. A URL pointing to a .tar.gz file of a repo with a Dockerfile in it - can be used instead of linking Cycle directly to a repository.
		TargzUrl *string `json:"targz_url,omitempty"`
	} `json:"override,omitempty"`

	// SourceId The ID for the Image source to be used.
	SourceId string `json:"source_id"`
}

CreateImageJSONBody defines parameters for CreateImage.

type CreateImageJSONRequestBody

type CreateImageJSONRequestBody CreateImageJSONBody

CreateImageJSONRequestBody defines body for CreateImage for application/json ContentType.

type CreateImageJobJSONBody

type CreateImageJobJSONBody struct {
	Action CreateImageJobJSONBodyAction `json:"action"`
}

CreateImageJobJSONBody defines parameters for CreateImageJob.

type CreateImageJobJSONBodyAction

type CreateImageJobJSONBodyAction string

CreateImageJobJSONBodyAction defines parameters for CreateImageJob.

const (
	Import CreateImageJobJSONBodyAction = "import"
)

Defines values for CreateImageJobJSONBodyAction.

type CreateImageJobJSONRequestBody

type CreateImageJobJSONRequestBody CreateImageJobJSONBody

CreateImageJobJSONRequestBody defines body for CreateImageJob for application/json ContentType.

type CreateImageJobResponse

type CreateImageJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateImageJobResponse

func ParseCreateImageJobResponse(rsp *http.Response) (*CreateImageJobResponse, error)

ParseCreateImageJobResponse parses an HTTP response from a CreateImageJobWithResponse call

func (CreateImageJobResponse) Status

func (r CreateImageJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateImageJobResponse) StatusCode

func (r CreateImageJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateImageResponse

type CreateImageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data An image is a point in time build on a given image source, and what is distributed by Cycle to run containers.
		Data Image `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateImageResponse

func ParseCreateImageResponse(rsp *http.Response) (*CreateImageResponse, error)

ParseCreateImageResponse parses an HTTP response from a CreateImageWithResponse call

func (CreateImageResponse) Status

func (r CreateImageResponse) Status() string

Status returns HTTPResponse.Status

func (CreateImageResponse) StatusCode

func (r CreateImageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateImageSourceJSONBody

type CreateImageSourceJSONBody struct {
	// About User defined information about the Image Source.
	About *struct {
		// Description A description of the Image Source.
		Description *string `json:"description"`
	} `json:"about,omitempty"`
	Acl     *ACL `json:"acl"`
	Builder *struct {
		// IntegrationId Either a resource ID (objectid - i.e. 651586fca6078e98982dbd90) or a resource Identifier (human-readable)
		IntegrationId HybridIdentifier `json:"integration_id"`
	} `json:"builder"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Name A name for the Image Source.
	Name *string `json:"name,omitempty"`

	// Origin The origin of the image.
	Origin ImageOrigin `json:"origin"`

	// Type The type of images in this source.
	Type ImageSourceType `json:"type"`
}

CreateImageSourceJSONBody defines parameters for CreateImageSource.

type CreateImageSourceJSONRequestBody

type CreateImageSourceJSONRequestBody CreateImageSourceJSONBody

CreateImageSourceJSONRequestBody defines body for CreateImageSource for application/json ContentType.

type CreateImageSourceResponse

type CreateImageSourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data An image source is a set of resources that direct the platform on where it can find the resources needed to build an image resource.
		Data ImageSource `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateImageSourceResponse

func ParseCreateImageSourceResponse(rsp *http.Response) (*CreateImageSourceResponse, error)

ParseCreateImageSourceResponse parses an HTTP response from a CreateImageSourceWithResponse call

func (CreateImageSourceResponse) Status

func (r CreateImageSourceResponse) Status() string

Status returns HTTPResponse.Status

func (CreateImageSourceResponse) StatusCode

func (r CreateImageSourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateImagesJobJSONBody

type CreateImagesJobJSONBody struct {
	// Action The action is the Job type to create.
	Action CreateImagesJobJSONBodyAction `json:"action"`

	// Contents Additional contents needed by the platform to create the job.
	Contents struct {
		// SourceIds A list of IDs to be pruned.
		SourceIds []string `json:"source_ids"`
	} `json:"contents"`
}

CreateImagesJobJSONBody defines parameters for CreateImagesJob.

type CreateImagesJobJSONBodyAction

type CreateImagesJobJSONBodyAction string

CreateImagesJobJSONBodyAction defines parameters for CreateImagesJob.

const (
	CreateImagesJobJSONBodyActionPrune CreateImagesJobJSONBodyAction = "prune"
)

Defines values for CreateImagesJobJSONBodyAction.

type CreateImagesJobJSONRequestBody

type CreateImagesJobJSONRequestBody CreateImagesJobJSONBody

CreateImagesJobJSONRequestBody defines body for CreateImagesJob for application/json ContentType.

type CreateImagesJobResponse

type CreateImagesJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateImagesJobResponse

func ParseCreateImagesJobResponse(rsp *http.Response) (*CreateImagesJobResponse, error)

ParseCreateImagesJobResponse parses an HTTP response from a CreateImagesJobWithResponse call

func (CreateImagesJobResponse) Status

func (r CreateImagesJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateImagesJobResponse) StatusCode

func (r CreateImagesJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateInstanceJobJSONRequestBody

type CreateInstanceJobJSONRequestBody = InstanceTask

CreateInstanceJobJSONRequestBody defines body for CreateInstanceJob for application/json ContentType.

type CreateInstanceJobResponse

type CreateInstanceJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateInstanceJobResponse

func ParseCreateInstanceJobResponse(rsp *http.Response) (*CreateInstanceJobResponse, error)

ParseCreateInstanceJobResponse parses an HTTP response from a CreateInstanceJobWithResponse call

func (CreateInstanceJobResponse) Status

func (r CreateInstanceJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateInstanceJobResponse) StatusCode

func (r CreateInstanceJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateInstancesJSONBody

type CreateInstancesJSONBody = []struct {
	// NewInstances The number of new Instances to be created on the given Server.
	NewInstances int `json:"new_instances"`

	// ServerId The ID of the Server the new Instance(s) should be deployed to.
	ServerId string `json:"server_id"`
}

CreateInstancesJSONBody defines parameters for CreateInstances.

type CreateInstancesJSONRequestBody

type CreateInstancesJSONRequestBody = CreateInstancesJSONBody

CreateInstancesJSONRequestBody defines body for CreateInstances for application/json ContentType.

type CreateInstancesResponse

type CreateInstancesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateInstancesResponse

func ParseCreateInstancesResponse(rsp *http.Response) (*CreateInstancesResponse, error)

ParseCreateInstancesResponse parses an HTTP response from a CreateInstancesWithResponse call

func (CreateInstancesResponse) Status

func (r CreateInstancesResponse) Status() string

Status returns HTTPResponse.Status

func (CreateInstancesResponse) StatusCode

func (r CreateInstancesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateIntegrationJSONBody

type CreateIntegrationJSONBody struct {
	// Auth Authentication information for the integration.
	Auth *struct {
		// ApiKey API key for accessing the integration.
		ApiKey *string `json:"api_key"`

		// Base64Config Base64 encoded configuration for the integration.
		Base64Config *string `json:"base64_config"`

		// ClientId Client ID for the integration.
		ClientId *string `json:"client_id"`

		// KeyId Key ID for accessing the integration.
		KeyId *string `json:"key_id"`

		// Namespace The namespace associated with the integration.
		Namespace *string `json:"namespace"`

		// Region The region associated with the integration.
		Region *string `json:"region"`

		// Secret Secret for accessing the integration.
		Secret *string `json:"secret"`

		// SubscriptionId Subscription ID for the integration.
		SubscriptionId *string `json:"subscription_id"`
	} `json:"auth,omitempty"`

	// Extra Additional key-value pairs associated with the integration.
	Extra *map[string]string `json:"extra,omitempty"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Name A name for the integration.
	Name string `json:"name"`

	// Vendor Unique vendor for the integration, subject to validation.
	Vendor string `json:"vendor"`
}

CreateIntegrationJSONBody defines parameters for CreateIntegration.

type CreateIntegrationJSONRequestBody

type CreateIntegrationJSONRequestBody CreateIntegrationJSONBody

CreateIntegrationJSONRequestBody defines body for CreateIntegration for application/json ContentType.

type CreateIntegrationJobJSONBody

type CreateIntegrationJobJSONBody struct {
	// Action The type of Job/selected Job action to create.
	Action CreateIntegrationJobJSONBodyAction `json:"action"`
}

CreateIntegrationJobJSONBody defines parameters for CreateIntegrationJob.

type CreateIntegrationJobJSONBodyAction

type CreateIntegrationJobJSONBodyAction string

CreateIntegrationJobJSONBodyAction defines parameters for CreateIntegrationJob.

const (
	Verify CreateIntegrationJobJSONBodyAction = "verify"
)

Defines values for CreateIntegrationJobJSONBodyAction.

type CreateIntegrationJobJSONRequestBody

type CreateIntegrationJobJSONRequestBody CreateIntegrationJobJSONBody

CreateIntegrationJobJSONRequestBody defines body for CreateIntegrationJob for application/json ContentType.

type CreateIntegrationJobResponse

type CreateIntegrationJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateIntegrationJobResponse

func ParseCreateIntegrationJobResponse(rsp *http.Response) (*CreateIntegrationJobResponse, error)

ParseCreateIntegrationJobResponse parses an HTTP response from a CreateIntegrationJobWithResponse call

func (CreateIntegrationJobResponse) Status

Status returns HTTPResponse.Status

func (CreateIntegrationJobResponse) StatusCode

func (r CreateIntegrationJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateIntegrationParams

type CreateIntegrationParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]CreateIntegrationParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
}

CreateIntegrationParams defines parameters for CreateIntegration.

type CreateIntegrationParamsMeta

type CreateIntegrationParamsMeta string

CreateIntegrationParamsMeta defines parameters for CreateIntegration.

const (
	CreateIntegrationParamsMetaDefinition CreateIntegrationParamsMeta = "definition"
)

Defines values for CreateIntegrationParamsMeta.

type CreateIntegrationResponse

type CreateIntegrationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		Data Integration `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateIntegrationResponse

func ParseCreateIntegrationResponse(rsp *http.Response) (*CreateIntegrationResponse, error)

ParseCreateIntegrationResponse parses an HTTP response from a CreateIntegrationWithResponse call

func (CreateIntegrationResponse) Status

func (r CreateIntegrationResponse) Status() string

Status returns HTTPResponse.Status

func (CreateIntegrationResponse) StatusCode

func (r CreateIntegrationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateInvoiceJobJSONBody

type CreateInvoiceJobJSONBody struct {
	// Action The name of the action to perform.
	Action CreateInvoiceJobJSONBodyAction `json:"action"`
}

CreateInvoiceJobJSONBody defines parameters for CreateInvoiceJob.

type CreateInvoiceJobJSONBodyAction

type CreateInvoiceJobJSONBodyAction string

CreateInvoiceJobJSONBodyAction defines parameters for CreateInvoiceJob.

const (
	Pay CreateInvoiceJobJSONBodyAction = "pay"
)

Defines values for CreateInvoiceJobJSONBodyAction.

type CreateInvoiceJobJSONRequestBody

type CreateInvoiceJobJSONRequestBody CreateInvoiceJobJSONBody

CreateInvoiceJobJSONRequestBody defines body for CreateInvoiceJob for application/json ContentType.

type CreateInvoiceJobResponse

type CreateInvoiceJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateInvoiceJobResponse

func ParseCreateInvoiceJobResponse(rsp *http.Response) (*CreateInvoiceJobResponse, error)

ParseCreateInvoiceJobResponse parses an HTTP response from a CreateInvoiceJobWithResponse call

func (CreateInvoiceJobResponse) Status

func (r CreateInvoiceJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateInvoiceJobResponse) StatusCode

func (r CreateInvoiceJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateIpPoolJSONBody added in v0.6.3

type CreateIpPoolJSONBody struct {
	Block struct {
		// Cidr A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix.
		// It combines an IP address with a suffix that indicates how many bits are fixed for routing.
		Cidr Cidr `json:"cidr"`

		// Gateway An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.
		Gateway IpAddress `json:"gateway"`

		// Network A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix.
		// It combines an IP address with a suffix that indicates how many bits are fixed for routing.
		Network *Cidr `json:"network,omitempty"`
	} `json:"block"`

	// Options Options for an IP.
	Options *IpOptions `json:"options,omitempty"`

	// ServerId A 24 character hex string used to identify a unique resource.
	ServerId ID `json:"server_id"`
}

CreateIpPoolJSONBody defines parameters for CreateIpPool.

type CreateIpPoolJSONRequestBody added in v0.6.3

type CreateIpPoolJSONRequestBody CreateIpPoolJSONBody

CreateIpPoolJSONRequestBody defines body for CreateIpPool for application/json ContentType.

type CreateIpPoolJobJSONRequestBody added in v0.6.4

type CreateIpPoolJobJSONRequestBody = IpPoolTask

CreateIpPoolJobJSONRequestBody defines body for CreateIpPoolJob for application/json ContentType.

type CreateIpPoolJobResponse added in v0.6.4

type CreateIpPoolJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateIpPoolJobResponse added in v0.6.4

func ParseCreateIpPoolJobResponse(rsp *http.Response) (*CreateIpPoolJobResponse, error)

ParseCreateIpPoolJobResponse parses an HTTP response from a CreateIpPoolJobWithResponse call

func (CreateIpPoolJobResponse) Status added in v0.6.4

func (r CreateIpPoolJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateIpPoolJobResponse) StatusCode added in v0.6.4

func (r CreateIpPoolJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateIpPoolResponse added in v0.6.3

type CreateIpPoolResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data An IP Pool
		Data IpPool `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateIpPoolResponse added in v0.6.3

func ParseCreateIpPoolResponse(rsp *http.Response) (*CreateIpPoolResponse, error)

ParseCreateIpPoolResponse parses an HTTP response from a CreateIpPoolWithResponse call

func (CreateIpPoolResponse) Status added in v0.6.3

func (r CreateIpPoolResponse) Status() string

Status returns HTTPResponse.Status

func (CreateIpPoolResponse) StatusCode added in v0.6.3

func (r CreateIpPoolResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateLoadBalancerServiceJobJSONBody

type CreateLoadBalancerServiceJobJSONBody struct {
	// Action The name of the action to perform.
	Action   CreateLoadBalancerServiceJobJSONBodyAction `json:"action"`
	Contents struct {
		// AutoUpdate A boolean representing if this service container is set to autoupdate or not
		AutoUpdate *bool               `json:"auto_update"`
		Config     *LoadBalancerConfig `json:"config"`

		// HighAvailability A boolean where `true` represents the desire to run the environment load balancer service in high availability mode.
		HighAvailability *bool `json:"high_availability"`
	} `json:"contents"`
}

CreateLoadBalancerServiceJobJSONBody defines parameters for CreateLoadBalancerServiceJob.

type CreateLoadBalancerServiceJobJSONBodyAction

type CreateLoadBalancerServiceJobJSONBodyAction string

CreateLoadBalancerServiceJobJSONBodyAction defines parameters for CreateLoadBalancerServiceJob.

const (
	CreateLoadBalancerServiceJobJSONBodyActionReconfigure CreateLoadBalancerServiceJobJSONBodyAction = "reconfigure"
)

Defines values for CreateLoadBalancerServiceJobJSONBodyAction.

type CreateLoadBalancerServiceJobJSONRequestBody

type CreateLoadBalancerServiceJobJSONRequestBody CreateLoadBalancerServiceJobJSONBody

CreateLoadBalancerServiceJobJSONRequestBody defines body for CreateLoadBalancerServiceJob for application/json ContentType.

type CreateLoadBalancerServiceJobResponse

type CreateLoadBalancerServiceJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateLoadBalancerServiceJobResponse

func ParseCreateLoadBalancerServiceJobResponse(rsp *http.Response) (*CreateLoadBalancerServiceJobResponse, error)

ParseCreateLoadBalancerServiceJobResponse parses an HTTP response from a CreateLoadBalancerServiceJobWithResponse call

func (CreateLoadBalancerServiceJobResponse) Status

Status returns HTTPResponse.Status

func (CreateLoadBalancerServiceJobResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CreateNetworkJSONBody

type CreateNetworkJSONBody struct {
	Acl *ACL `json:"acl"`

	// Cluster The infrastructure cluster the environments belonging to this network belong to.
	Cluster string `json:"cluster"`

	// Environments An array of environment Ids
	Environments []string `json:"environments"`

	// Identifier A network identifier used to construct http calls that specifically use this network over another.
	Identifier string     `json:"identifier"`
	L2         *NetworkL2 `json:"l2"`

	// Name The name of the network.
	Name string `json:"name"`
}

CreateNetworkJSONBody defines parameters for CreateNetwork.

type CreateNetworkJSONRequestBody

type CreateNetworkJSONRequestBody CreateNetworkJSONBody

CreateNetworkJSONRequestBody defines body for CreateNetwork for application/json ContentType.

type CreateNetworkJobJSONRequestBody

type CreateNetworkJobJSONRequestBody = SdnNetworkTask

CreateNetworkJobJSONRequestBody defines body for CreateNetworkJob for application/json ContentType.

type CreateNetworkJobResponse

type CreateNetworkJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateNetworkJobResponse

func ParseCreateNetworkJobResponse(rsp *http.Response) (*CreateNetworkJobResponse, error)

ParseCreateNetworkJobResponse parses an HTTP response from a CreateNetworkJobWithResponse call

func (CreateNetworkJobResponse) Status

func (r CreateNetworkJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateNetworkJobResponse) StatusCode

func (r CreateNetworkJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateNetworkParams

type CreateNetworkParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]CreateNetworkParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

CreateNetworkParams defines parameters for CreateNetwork.

type CreateNetworkParamsInclude

type CreateNetworkParamsInclude string

CreateNetworkParamsInclude defines parameters for CreateNetwork.

const (
	CreateNetworkParamsIncludeCreators     CreateNetworkParamsInclude = "creators"
	CreateNetworkParamsIncludeEnvironments CreateNetworkParamsInclude = "environments"
)

Defines values for CreateNetworkParamsInclude.

type CreateNetworkResponse

type CreateNetworkResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data SDN Network resource.
		Data Network `json:"data"`

		// Includes All includable resource linkable to the given network.
		Includes *NetworkIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseCreateNetworkResponse

func ParseCreateNetworkResponse(rsp *http.Response) (*CreateNetworkResponse, error)

ParseCreateNetworkResponse parses an HTTP response from a CreateNetworkWithResponse call

func (CreateNetworkResponse) Status

func (r CreateNetworkResponse) Status() string

Status returns HTTPResponse.Status

func (CreateNetworkResponse) StatusCode

func (r CreateNetworkResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOrderJSONBody

type CreateOrderJSONBody struct {
	// PromoCode String that defines a promo code
	PromoCode *string `json:"promo_code,omitempty"`

	// SupportPlanId ID associated with the support plan
	SupportPlanId *string `json:"support_plan_id,omitempty"`

	// TermLength String that defines term length
	TermLength *CreateOrderJSONBodyTermLength `json:"term_length,omitempty"`

	// TierPlanId ID associated with the tier plan
	TierPlanId *string `json:"tier_plan_id,omitempty"`
}

CreateOrderJSONBody defines parameters for CreateOrder.

type CreateOrderJSONBodyTermLength

type CreateOrderJSONBodyTermLength string

CreateOrderJSONBodyTermLength defines parameters for CreateOrder.

const (
	CreateOrderJSONBodyTermLengthMonthly CreateOrderJSONBodyTermLength = "monthly"
	CreateOrderJSONBodyTermLengthOnce    CreateOrderJSONBodyTermLength = "once"
	CreateOrderJSONBodyTermLengthYearly  CreateOrderJSONBodyTermLength = "yearly"
)

Defines values for CreateOrderJSONBodyTermLength.

type CreateOrderJSONRequestBody

type CreateOrderJSONRequestBody CreateOrderJSONBody

CreateOrderJSONRequestBody defines body for CreateOrder for application/json ContentType.

type CreateOrderJobJSONBody

type CreateOrderJobJSONBody struct {
	// Action The name of the action to perform
	Action CreateOrderJobJSONBodyAction `json:"action"`
}

CreateOrderJobJSONBody defines parameters for CreateOrderJob.

type CreateOrderJobJSONBodyAction

type CreateOrderJobJSONBodyAction string

CreateOrderJobJSONBodyAction defines parameters for CreateOrderJob.

const (
	Confirm CreateOrderJobJSONBodyAction = "confirm"
)

Defines values for CreateOrderJobJSONBodyAction.

type CreateOrderJobJSONRequestBody

type CreateOrderJobJSONRequestBody CreateOrderJobJSONBody

CreateOrderJobJSONRequestBody defines body for CreateOrderJob for application/json ContentType.

type CreateOrderJobResponse

type CreateOrderJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateOrderJobResponse

func ParseCreateOrderJobResponse(rsp *http.Response) (*CreateOrderJobResponse, error)

ParseCreateOrderJobResponse parses an HTTP response from a CreateOrderJobWithResponse call

func (CreateOrderJobResponse) Status

func (r CreateOrderJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateOrderJobResponse) StatusCode

func (r CreateOrderJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOrderParams

type CreateOrderParams struct {
	Meta    *[]CreateOrderParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
	Include *OrderIncludeParam       `form:"include,omitempty" json:"include,omitempty"`
}

CreateOrderParams defines parameters for CreateOrder.

type CreateOrderParamsInclude

type CreateOrderParamsInclude string

CreateOrderParamsInclude defines parameters for CreateOrder.

const (
	CreateOrderParamsIncludePromoCodes CreateOrderParamsInclude = "promo_codes"
)

Defines values for CreateOrderParamsInclude.

type CreateOrderParamsMeta

type CreateOrderParamsMeta string

CreateOrderParamsMeta defines parameters for CreateOrder.

const (
	CreateOrderParamsMetaDue CreateOrderParamsMeta = "due"
)

Defines values for CreateOrderParamsMeta.

type CreateOrderResponse

type CreateOrderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data Information about an order.
		Data     BillingOrder          `json:"data"`
		Includes *BillingOrderIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseCreateOrderResponse

func ParseCreateOrderResponse(rsp *http.Response) (*CreateOrderResponse, error)

ParseCreateOrderResponse parses an HTTP response from a CreateOrderWithResponse call

func (CreateOrderResponse) Status

func (r CreateOrderResponse) Status() string

Status returns HTTPResponse.Status

func (CreateOrderResponse) StatusCode

func (r CreateOrderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreatePipelineJSONBody

type CreatePipelineJSONBody struct {
	Acl *ACL `json:"acl"`

	// Disable A boolean where true signifies the Pipeline is disabled.
	Disable *bool `json:"disable,omitempty"`

	// Dynamic Setting to true enables variable and other advanced logic support on this Pipeline. This is a one-way toggle. Once set to true, it cannot be set back to false.
	Dynamic *bool `json:"dynamic,omitempty"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Name A name for the Pipeline.
	Name string `json:"name"`

	// Stages An array of stages.
	Stages *[]PipelineStage `json:"stages,omitempty"`
}

CreatePipelineJSONBody defines parameters for CreatePipeline.

type CreatePipelineJSONRequestBody

type CreatePipelineJSONRequestBody CreatePipelineJSONBody

CreatePipelineJSONRequestBody defines body for CreatePipeline for application/json ContentType.

type CreatePipelineJobJSONRequestBody

type CreatePipelineJobJSONRequestBody = PipelineTask

CreatePipelineJobJSONRequestBody defines body for CreatePipelineJob for application/json ContentType.

type CreatePipelineJobResponse

type CreatePipelineJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreatePipelineJobResponse

func ParseCreatePipelineJobResponse(rsp *http.Response) (*CreatePipelineJobResponse, error)

ParseCreatePipelineJobResponse parses an HTTP response from a CreatePipelineJobWithResponse call

func (CreatePipelineJobResponse) Status

func (r CreatePipelineJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreatePipelineJobResponse) StatusCode

func (r CreatePipelineJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreatePipelineResponse

type CreatePipelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data A pipeline resource.
		Data Pipeline `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreatePipelineResponse

func ParseCreatePipelineResponse(rsp *http.Response) (*CreatePipelineResponse, error)

ParseCreatePipelineResponse parses an HTTP response from a CreatePipelineWithResponse call

func (CreatePipelineResponse) Status

func (r CreatePipelineResponse) Status() string

Status returns HTTPResponse.Status

func (CreatePipelineResponse) StatusCode

func (r CreatePipelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreatePipelineTriggerKeyJSONBody

type CreatePipelineTriggerKeyJSONBody struct {
	// Ips An array of ips this Trigger Key is usable from.
	Ips *[]string `json:"ips,omitempty"`

	// Name A name for the Trigger Key.
	Name string `json:"name"`
}

CreatePipelineTriggerKeyJSONBody defines parameters for CreatePipelineTriggerKey.

type CreatePipelineTriggerKeyJSONRequestBody

type CreatePipelineTriggerKeyJSONRequestBody CreatePipelineTriggerKeyJSONBody

CreatePipelineTriggerKeyJSONRequestBody defines body for CreatePipelineTriggerKey for application/json ContentType.

type CreatePipelineTriggerKeyResponse

type CreatePipelineTriggerKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data A pipeline trigger key resource.
		Data TriggerKey `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreatePipelineTriggerKeyResponse

func ParseCreatePipelineTriggerKeyResponse(rsp *http.Response) (*CreatePipelineTriggerKeyResponse, error)

ParseCreatePipelineTriggerKeyResponse parses an HTTP response from a CreatePipelineTriggerKeyWithResponse call

func (CreatePipelineTriggerKeyResponse) Status

Status returns HTTPResponse.Status

func (CreatePipelineTriggerKeyResponse) StatusCode

func (r CreatePipelineTriggerKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRoleJSONBody

type CreateRoleJSONBody struct {
	// Capabilities The list of platform level capabilities assigned to this Role.
	Capabilities *struct {
		All      bool         `json:"all"`
		Specific []Capability `json:"specific"`
	} `json:"capabilities"`

	// Extra Custom user-defined properties for storing extra information on the Role. Not utilized by Cycle.
	Extra      *map[string]string `json:"extra"`
	Identifier string             `json:"identifier"`

	// Name A name given to the Role.
	Name *string `json:"name"`

	// Rank An integer between 0 and 10 that indicates the Role hierarchy. An account can only edit a Role that is less than their rank. The 'owner' Role is rank 10.
	Rank int `json:"rank"`
}

CreateRoleJSONBody defines parameters for CreateRole.

type CreateRoleJSONRequestBody

type CreateRoleJSONRequestBody CreateRoleJSONBody

CreateRoleJSONRequestBody defines body for CreateRole for application/json ContentType.

type CreateRoleResponse

type CreateRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data A Role is a custom combination of platform-level capabilities, allowing for fully customizable role-based access controls across the platform.
		Data Role `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateRoleResponse

func ParseCreateRoleResponse(rsp *http.Response) (*CreateRoleResponse, error)

ParseCreateRoleResponse parses an HTTP response from a CreateRoleWithResponse call

func (CreateRoleResponse) Status

func (r CreateRoleResponse) Status() string

Status returns HTTPResponse.Status

func (CreateRoleResponse) StatusCode

func (r CreateRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateSchedulerServiceJobJSONBody

type CreateSchedulerServiceJobJSONBody struct {
	// Action The name of the action to perform.
	Action   CreateSchedulerServiceJobJSONBodyAction `json:"action"`
	Contents struct {
		// AutoUpdate A boolean where `true` represents the desire to automatically update the environment scheduler service.
		AutoUpdate *bool            `json:"auto_update"`
		Config     *SchedulerConfig `json:"config"`
	} `json:"contents"`
}

CreateSchedulerServiceJobJSONBody defines parameters for CreateSchedulerServiceJob.

type CreateSchedulerServiceJobJSONBodyAction

type CreateSchedulerServiceJobJSONBodyAction string

CreateSchedulerServiceJobJSONBodyAction defines parameters for CreateSchedulerServiceJob.

const (
	CreateSchedulerServiceJobJSONBodyActionReconfigure CreateSchedulerServiceJobJSONBodyAction = "reconfigure"
)

Defines values for CreateSchedulerServiceJobJSONBodyAction.

type CreateSchedulerServiceJobJSONRequestBody

type CreateSchedulerServiceJobJSONRequestBody CreateSchedulerServiceJobJSONBody

CreateSchedulerServiceJobJSONRequestBody defines body for CreateSchedulerServiceJob for application/json ContentType.

type CreateSchedulerServiceJobResponse

type CreateSchedulerServiceJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateSchedulerServiceJobResponse

func ParseCreateSchedulerServiceJobResponse(rsp *http.Response) (*CreateSchedulerServiceJobResponse, error)

ParseCreateSchedulerServiceJobResponse parses an HTTP response from a CreateSchedulerServiceJobWithResponse call

func (CreateSchedulerServiceJobResponse) Status

Status returns HTTPResponse.Status

func (CreateSchedulerServiceJobResponse) StatusCode

func (r CreateSchedulerServiceJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateScopedVariableJSONBody

type CreateScopedVariableJSONBody struct {
	// Access The way the scoped variable is accessed.
	Access     *ScopedVariableAccess `json:"access,omitempty"`
	Deployment *Deployment           `json:"deployment"`

	// Identifier An identifier for this Scoped Variable.
	Identifier string `json:"identifier"`

	// Scope Information about the assignment of the scoped variable and how it is invoked.
	Scope ScopedVariableScope `json:"scope"`

	// Source The source or value of the Scoped Variable.
	Source CreateScopedVariableJSONBody_Source `json:"source"`
}

CreateScopedVariableJSONBody defines parameters for CreateScopedVariable.

type CreateScopedVariableJSONBody_Source

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

CreateScopedVariableJSONBody_Source defines parameters for CreateScopedVariable.

type CreateScopedVariableJSONRequestBody

type CreateScopedVariableJSONRequestBody CreateScopedVariableJSONBody

CreateScopedVariableJSONRequestBody defines body for CreateScopedVariable for application/json ContentType.

type CreateScopedVariableResponse

type CreateScopedVariableResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data Scoped variables are a way for users to dynamically allocate runtime specific environment variables across any number of containers in an environment.
		Data ScopedVariable `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateScopedVariableResponse

func ParseCreateScopedVariableResponse(rsp *http.Response) (*CreateScopedVariableResponse, error)

ParseCreateScopedVariableResponse parses an HTTP response from a CreateScopedVariableWithResponse call

func (CreateScopedVariableResponse) Status

Status returns HTTPResponse.Status

func (CreateScopedVariableResponse) StatusCode

func (r CreateScopedVariableResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateServerJobJSONRequestBody

type CreateServerJobJSONRequestBody = ServerTask

CreateServerJobJSONRequestBody defines body for CreateServerJob for application/json ContentType.

type CreateServerJobResponse

type CreateServerJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateServerJobResponse

func ParseCreateServerJobResponse(rsp *http.Response) (*CreateServerJobResponse, error)

ParseCreateServerJobResponse parses an HTTP response from a CreateServerJobWithResponse call

func (CreateServerJobResponse) Status

func (r CreateServerJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateServerJobResponse) StatusCode

func (r CreateServerJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateServersJSONBody added in v0.6.6

type CreateServersJSONBody struct {
	// Cluster The existing or new cluster this infrastructure should be provisioned in.
	Cluster string `json:"cluster"`

	// Servers An array of servers to provision.
	Servers []struct {
		Advanced *struct {
			// ProvisionOptions Advanced options to apply to the provisioning of a server.
			ProvisionOptions *struct {
				// AttachedStorageSize For providers that support setting this value dynamically;
				// A number representing the GB size of the volume to be attached to the server.
				AttachedStorageSize *int `json:"attached_storage_size"`

				// EncryptStorage For providers that support this setting, this option will encrypt storage for server.
				EncryptStorage *bool `json:"encrypt_storage"`

				// ReservationId A reservation ID to be used to provision a server that has been reserved at the provider.
				ReservationId *string `json:"reservation_id"`
			} `json:"provision_options"`
			Zone *string `json:"zone"`
		} `json:"advanced"`

		// IntegrationId A 24 character hex string used to identify a unique resource.
		IntegrationId ID `json:"integration_id"`

		// LocationId The location ID of the Server.
		LocationId string `json:"location_id"`

		// ModelId The model ID of the Server.
		ModelId string `json:"model_id"`
	} `json:"servers"`
}

CreateServersJSONBody defines parameters for CreateServers.

type CreateServersJSONRequestBody added in v0.6.6

type CreateServersJSONRequestBody CreateServersJSONBody

CreateServersJSONRequestBody defines body for CreateServers for application/json ContentType.

type CreateServersResponse added in v0.6.6

type CreateServersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateServersResponse added in v0.6.6

func ParseCreateServersResponse(rsp *http.Response) (*CreateServersResponse, error)

ParseCreateServersResponse parses an HTTP response from a CreateServersWithResponse call

func (CreateServersResponse) Status added in v0.6.6

func (r CreateServersResponse) Status() string

Status returns HTTPResponse.Status

func (CreateServersResponse) StatusCode added in v0.6.6

func (r CreateServersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateStackBuildJSONBody

type CreateStackBuildJSONBody struct {
	// About Information about the stack build.
	About *StackBuildAbout `json:"about,omitempty"`

	// Instructions Additional instructions used when generating this stack build.
	Instructions *StackBuildInstructions `json:"instructions,omitempty"`
}

CreateStackBuildJSONBody defines parameters for CreateStackBuild.

type CreateStackBuildJSONRequestBody

type CreateStackBuildJSONRequestBody CreateStackBuildJSONBody

CreateStackBuildJSONRequestBody defines body for CreateStackBuild for application/json ContentType.

type CreateStackBuildJobJSONRequestBody

type CreateStackBuildJobJSONRequestBody = StackBuildTask

CreateStackBuildJobJSONRequestBody defines body for CreateStackBuildJob for application/json ContentType.

type CreateStackBuildJobResponse

type CreateStackBuildJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateStackBuildJobResponse

func ParseCreateStackBuildJobResponse(rsp *http.Response) (*CreateStackBuildJobResponse, error)

ParseCreateStackBuildJobResponse parses an HTTP response from a CreateStackBuildJobWithResponse call

func (CreateStackBuildJobResponse) Status

Status returns HTTPResponse.Status

func (CreateStackBuildJobResponse) StatusCode

func (r CreateStackBuildJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateStackBuildResponse

type CreateStackBuildResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data A stack build resource.
		Data StackBuild `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateStackBuildResponse

func ParseCreateStackBuildResponse(rsp *http.Response) (*CreateStackBuildResponse, error)

ParseCreateStackBuildResponse parses an HTTP response from a CreateStackBuildWithResponse call

func (CreateStackBuildResponse) Status

func (r CreateStackBuildResponse) Status() string

Status returns HTTPResponse.Status

func (CreateStackBuildResponse) StatusCode

func (r CreateStackBuildResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateStackJSONBody

type CreateStackJSONBody struct {
	Acl *ACL `json:"acl"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Name A name for the Stack.
	Name string `json:"name"`

	// Source A source for a stack to be created from.
	Source StackSource `json:"source"`

	// Variables A map of default variable values used when building this Stack. A variable can be added anywhere in a Stack using the format `{{var}}` where `var` would be a key in this map.
	Variables *map[string]string `json:"variables,omitempty"`
}

CreateStackJSONBody defines parameters for CreateStack.

type CreateStackJSONRequestBody

type CreateStackJSONRequestBody CreateStackJSONBody

CreateStackJSONRequestBody defines body for CreateStack for application/json ContentType.

type CreateStackJobJSONBody

type CreateStackJobJSONBody struct {
	// Action The Job to do.
	Action CreateStackJobJSONBodyAction `json:"action"`
}

CreateStackJobJSONBody defines parameters for CreateStackJob.

type CreateStackJobJSONBodyAction

type CreateStackJobJSONBodyAction string

CreateStackJobJSONBodyAction defines parameters for CreateStackJob.

const (
	CreateStackJobJSONBodyActionPrune CreateStackJobJSONBodyAction = "prune"
)

Defines values for CreateStackJobJSONBodyAction.

type CreateStackJobJSONRequestBody

type CreateStackJobJSONRequestBody CreateStackJobJSONBody

CreateStackJobJSONRequestBody defines body for CreateStackJob for application/json ContentType.

type CreateStackJobResponse

type CreateStackJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateStackJobResponse

func ParseCreateStackJobResponse(rsp *http.Response) (*CreateStackJobResponse, error)

ParseCreateStackJobResponse parses an HTTP response from a CreateStackJobWithResponse call

func (CreateStackJobResponse) Status

func (r CreateStackJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateStackJobResponse) StatusCode

func (r CreateStackJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateStackResponse

type CreateStackResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data Stacks are a way to orchestrate multiple containers atomically and automatically.
		Data Stack `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateStackResponse

func ParseCreateStackResponse(rsp *http.Response) (*CreateStackResponse, error)

ParseCreateStackResponse parses an HTTP response from a CreateStackWithResponse call

func (CreateStackResponse) Status

func (r CreateStackResponse) Status() string

Status returns HTTPResponse.Status

func (CreateStackResponse) StatusCode

func (r CreateStackResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateUserSuppliedCertificateJobJSONBody

type CreateUserSuppliedCertificateJobJSONBody struct {
	// Action The action that the job will take.
	//
	// **deprecate**: Cycle will deprecate this certificate, and try to find another usable certificate. If none exists, it will generate a new one
	// for the applicable domains.
	Action CreateUserSuppliedCertificateJobJSONBodyAction `json:"action"`
}

CreateUserSuppliedCertificateJobJSONBody defines parameters for CreateUserSuppliedCertificateJob.

type CreateUserSuppliedCertificateJobJSONBodyAction

type CreateUserSuppliedCertificateJobJSONBodyAction string

CreateUserSuppliedCertificateJobJSONBodyAction defines parameters for CreateUserSuppliedCertificateJob.

const (
	Deprecate CreateUserSuppliedCertificateJobJSONBodyAction = "deprecate"
)

Defines values for CreateUserSuppliedCertificateJobJSONBodyAction.

type CreateUserSuppliedCertificateJobJSONRequestBody

type CreateUserSuppliedCertificateJobJSONRequestBody CreateUserSuppliedCertificateJobJSONBody

CreateUserSuppliedCertificateJobJSONRequestBody defines body for CreateUserSuppliedCertificateJob for application/json ContentType.

type CreateUserSuppliedCertificateJobResponse

type CreateUserSuppliedCertificateJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateUserSuppliedCertificateJobResponse

func ParseCreateUserSuppliedCertificateJobResponse(rsp *http.Response) (*CreateUserSuppliedCertificateJobResponse, error)

ParseCreateUserSuppliedCertificateJobResponse parses an HTTP response from a CreateUserSuppliedCertificateJobWithResponse call

func (CreateUserSuppliedCertificateJobResponse) Status

Status returns HTTPResponse.Status

func (CreateUserSuppliedCertificateJobResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CreateVPNServiceJobJSONRequestBody

type CreateVPNServiceJobJSONRequestBody = VpnTask

CreateVPNServiceJobJSONRequestBody defines body for CreateVPNServiceJob for application/json ContentType.

type CreateVPNServiceJobResponse

type CreateVPNServiceJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateVPNServiceJobResponse

func ParseCreateVPNServiceJobResponse(rsp *http.Response) (*CreateVPNServiceJobResponse, error)

ParseCreateVPNServiceJobResponse parses an HTTP response from a CreateVPNServiceJobWithResponse call

func (CreateVPNServiceJobResponse) Status

Status returns HTTPResponse.Status

func (CreateVPNServiceJobResponse) StatusCode

func (r CreateVPNServiceJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateVPNUserJSONBody

type CreateVPNUserJSONBody struct {
	Password string `json:"password"`
	Username string `json:"username"`
}

CreateVPNUserJSONBody defines parameters for CreateVPNUser.

type CreateVPNUserJSONRequestBody

type CreateVPNUserJSONRequestBody CreateVPNUserJSONBody

CreateVPNUserJSONRequestBody defines body for CreateVPNUser for application/json ContentType.

type CreateVPNUserResponse

type CreateVPNUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data A VPN user for a given VPN.
		Data VPNUsers `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateVPNUserResponse

func ParseCreateVPNUserResponse(rsp *http.Response) (*CreateVPNUserResponse, error)

ParseCreateVPNUserResponse parses an HTTP response from a CreateVPNUserWithResponse call

func (CreateVPNUserResponse) Status

func (r CreateVPNUserResponse) Status() string

Status returns HTTPResponse.Status

func (CreateVPNUserResponse) StatusCode

func (r CreateVPNUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateVirtualMachineJSONBody

type CreateVirtualMachineJSONBody struct {
	// Annotations Custom meta data. Not utilized by Cycle.
	Annotations *map[string]interface{} `json:"annotations"`

	// Config Defines the network and deployment configurations for a virtual machine.
	Config VirtualMachineConfig `json:"config"`

	// EnvironmentId The ID of the environment this virtual machine will be deployed to.
	EnvironmentId string `json:"environment_id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Image Represents the image used by a virtual machine. It can either reference a URL where the image is located or specify a base image provided by Cycle.
	Image VirtualMachineImage `json:"image"`

	// Lock Prevents this virtual machine from being deleted when true.
	Lock bool `json:"lock"`

	// Name A user-defined name for the virtual machine.
	Name string `json:"name"`

	// SshKeys An array of SSH key IDs that should be applied to this virtual machine.
	SshKeys *[]ID                         `json:"ssh_keys,omitempty"`
	Volumes *[]VirtualMachineVolumeConfig `json:"volumes,omitempty"`
}

CreateVirtualMachineJSONBody defines parameters for CreateVirtualMachine.

type CreateVirtualMachineJSONRequestBody

type CreateVirtualMachineJSONRequestBody CreateVirtualMachineJSONBody

CreateVirtualMachineJSONRequestBody defines body for CreateVirtualMachine for application/json ContentType.

type CreateVirtualMachineJobJSONRequestBody

type CreateVirtualMachineJobJSONRequestBody = VirtualMachineTask

CreateVirtualMachineJobJSONRequestBody defines body for CreateVirtualMachineJob for application/json ContentType.

type CreateVirtualMachineJobResponse

type CreateVirtualMachineJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateVirtualMachineJobResponse

func ParseCreateVirtualMachineJobResponse(rsp *http.Response) (*CreateVirtualMachineJobResponse, error)

ParseCreateVirtualMachineJobResponse parses an HTTP response from a CreateVirtualMachineJobWithResponse call

func (CreateVirtualMachineJobResponse) Status

Status returns HTTPResponse.Status

func (CreateVirtualMachineJobResponse) StatusCode

func (r CreateVirtualMachineJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateVirtualMachineParams

type CreateVirtualMachineParams struct {
	// Meta A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
	// In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
	// In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]CreateVirtualMachineParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]CreateVirtualMachineParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

CreateVirtualMachineParams defines parameters for CreateVirtualMachine.

type CreateVirtualMachineParamsInclude

type CreateVirtualMachineParamsInclude string

CreateVirtualMachineParamsInclude defines parameters for CreateVirtualMachine.

const (
	CreateVirtualMachineParamsIncludeClusters     CreateVirtualMachineParamsInclude = "clusters"
	CreateVirtualMachineParamsIncludeCreators     CreateVirtualMachineParamsInclude = "creators"
	CreateVirtualMachineParamsIncludeEnvironments CreateVirtualMachineParamsInclude = "environments"
)

Defines values for CreateVirtualMachineParamsInclude.

type CreateVirtualMachineParamsMeta

type CreateVirtualMachineParamsMeta string

CreateVirtualMachineParamsMeta defines parameters for CreateVirtualMachine.

const (
	CreateVirtualMachineParamsMetaDomains CreateVirtualMachineParamsMeta = "domains"
	CreateVirtualMachineParamsMetaIps     CreateVirtualMachineParamsMeta = "ips"
	CreateVirtualMachineParamsMetaServer  CreateVirtualMachineParamsMeta = "server"
)

Defines values for CreateVirtualMachineParamsMeta.

type CreateVirtualMachineResponse

type CreateVirtualMachineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data Describes a virtual machine running on the Cycle Platform.
		Data VirtualMachine `json:"data"`

		// Includes All includable resources linkable to the given virtual machine.
		Includes *VirtualMachineIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseCreateVirtualMachineResponse

func ParseCreateVirtualMachineResponse(rsp *http.Response) (*CreateVirtualMachineResponse, error)

ParseCreateVirtualMachineResponse parses an HTTP response from a CreateVirtualMachineWithResponse call

func (CreateVirtualMachineResponse) Status

Status returns HTTPResponse.Status

func (CreateVirtualMachineResponse) StatusCode

func (r CreateVirtualMachineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateVirtualMachineSshKeyJSONBody

type CreateVirtualMachineSshKeyJSONBody struct {
	// EnvironmentId A 24 character hex string used to identify a unique resource.
	EnvironmentId ID `json:"environment_id"`

	// Name A user-defined name for the SSH key.
	Name string `json:"name"`

	// PublicKey The public key of the SSH key.
	PublicKey string `json:"public_key"`
}

CreateVirtualMachineSshKeyJSONBody defines parameters for CreateVirtualMachineSshKey.

type CreateVirtualMachineSshKeyJSONRequestBody

type CreateVirtualMachineSshKeyJSONRequestBody CreateVirtualMachineSshKeyJSONBody

CreateVirtualMachineSshKeyJSONRequestBody defines body for CreateVirtualMachineSshKey for application/json ContentType.

type CreateVirtualMachineSshKeyParams

type CreateVirtualMachineSshKeyParams struct {
	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]CreateVirtualMachineSshKeyParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

CreateVirtualMachineSshKeyParams defines parameters for CreateVirtualMachineSshKey.

type CreateVirtualMachineSshKeyParamsInclude

type CreateVirtualMachineSshKeyParamsInclude string

CreateVirtualMachineSshKeyParamsInclude defines parameters for CreateVirtualMachineSshKey.

const (
	CreateVirtualMachineSshKeyParamsIncludeCreators     CreateVirtualMachineSshKeyParamsInclude = "creators"
	CreateVirtualMachineSshKeyParamsIncludeEnvironments CreateVirtualMachineSshKeyParamsInclude = "environments"
)

Defines values for CreateVirtualMachineSshKeyParamsInclude.

type CreateVirtualMachineSshKeyResponse

type CreateVirtualMachineSshKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data Describes an SSH key used to access a virtual machine.
		Data VirtualMachineSshKey `json:"data"`

		// Includes All includable resources linkable to the given virtual machine SSH key.
		Includes *VirtualMachineSshIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseCreateVirtualMachineSshKeyResponse

func ParseCreateVirtualMachineSshKeyResponse(rsp *http.Response) (*CreateVirtualMachineSshKeyResponse, error)

ParseCreateVirtualMachineSshKeyResponse parses an HTTP response from a CreateVirtualMachineSshKeyWithResponse call

func (CreateVirtualMachineSshKeyResponse) Status

Status returns HTTPResponse.Status

func (CreateVirtualMachineSshKeyResponse) StatusCode

func (r CreateVirtualMachineSshKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateVirtualProviderIsoJSONBody added in v0.6.3

type CreateVirtualProviderIsoJSONBody struct {
	Config struct {
		Ipxe *struct {
			// DnsIp DNS IP assigned to the IPXE boot.
			DnsIp *string `json:"dns_ip"`

			// GatewayIp Gateway IP assigned to the IPXE boot.
			GatewayIp *string `json:"gateway_ip"`

			// Netmask Netmask assigned to the IPXE boot.
			Netmask *string `json:"netmask"`

			// NetworkInterface Network interface for the IPXE boot.
			NetworkInterface *int `json:"network_interface"`

			// StaticIp Static IP assigned to the IPXE boot.
			StaticIp *string `json:"static_ip"`

			// VlanId VLAN ID for the IPXE boot.
			VlanId *int `json:"vlan_id"`
		} `json:"ipxe"`
		Server *struct {
			// AdditionalKernelArgs Appends additional kernel arguments when booting CycleOS.
			AdditionalKernelArgs *string `json:"additional_kernel_args"`

			// Bonds An array of bonds
			Bonds *[]VirtualProviderIsoBond `json:"bonds,omitempty"`

			// Nics An array of server network interfaces.
			Nics                  *[]VirtualProviderIsoNic                                           `json:"nics,omitempty"`
			SdnNeighborPreference *CreateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference `json:"sdn_neighbor_preference"`
			Storage               *struct {
				ConditionalFormat *bool `json:"conditional_format,omitempty"`
			} `json:"storage"`
		} `json:"server"`

		// Token Authentication token for the ISO.
		Token string `json:"token"`
	} `json:"config"`

	// Name The name of the ISO.
	Name string `json:"name"`
}

CreateVirtualProviderIsoJSONBody defines parameters for CreateVirtualProviderIso.

type CreateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference added in v0.6.3

type CreateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference string

CreateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference defines parameters for CreateVirtualProviderIso.

const (
	CreateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreferenceIpv4 CreateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference = "ipv4"
	CreateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreferenceIpv6 CreateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference = "ipv6"
)

Defines values for CreateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference.

type CreateVirtualProviderIsoJSONRequestBody added in v0.6.3

type CreateVirtualProviderIsoJSONRequestBody CreateVirtualProviderIsoJSONBody

CreateVirtualProviderIsoJSONRequestBody defines body for CreateVirtualProviderIso for application/json ContentType.

type CreateVirtualProviderIsoJobJSONRequestBody added in v0.6.3

type CreateVirtualProviderIsoJobJSONRequestBody = VirtualProviderIsoTask

CreateVirtualProviderIsoJobJSONRequestBody defines body for CreateVirtualProviderIsoJob for application/json ContentType.

type CreateVirtualProviderIsoJobResponse added in v0.6.3

type CreateVirtualProviderIsoJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateVirtualProviderIsoJobResponse added in v0.6.3

func ParseCreateVirtualProviderIsoJobResponse(rsp *http.Response) (*CreateVirtualProviderIsoJobResponse, error)

ParseCreateVirtualProviderIsoJobResponse parses an HTTP response from a CreateVirtualProviderIsoJobWithResponse call

func (CreateVirtualProviderIsoJobResponse) Status added in v0.6.3

Status returns HTTPResponse.Status

func (CreateVirtualProviderIsoJobResponse) StatusCode added in v0.6.3

StatusCode returns HTTPResponse.StatusCode

type CreateVirtualProviderIsoResponse added in v0.6.3

type CreateVirtualProviderIsoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data The ISO image for a virtual provider.
		Data VirtualProviderIso `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseCreateVirtualProviderIsoResponse added in v0.6.3

func ParseCreateVirtualProviderIsoResponse(rsp *http.Response) (*CreateVirtualProviderIsoResponse, error)

ParseCreateVirtualProviderIsoResponse parses an HTTP response from a CreateVirtualProviderIsoWithResponse call

func (CreateVirtualProviderIsoResponse) Status added in v0.6.3

Status returns HTTPResponse.Status

func (CreateVirtualProviderIsoResponse) StatusCode added in v0.6.3

func (r CreateVirtualProviderIsoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreatorInclude

type CreatorInclude struct {
	// Accounts Included creators that are public accounts, keyed by ID.
	Accounts *map[string]PublicAccount `json:"accounts,omitempty"`

	// ApiKeys Included creators that are Cycle API Keys, keyed by ID.
	ApiKeys *map[string]ApiKeyCreator `json:"api_keys,omitempty"`

	// Employees Included creators that are employees of Cycle, keyed by ID.
	Employees *map[string]PublicAccount `json:"employees,omitempty"`

	// Environments Included creators that are Cycle environments (usually automatically created resources), keyed by ID.
	Environments *map[string]Environment `json:"environments,omitempty"`

	// Visitors Included creators that are not Cycle accounts, keyed by ID.
	Visitors *map[string]PublicAccount `json:"visitors,omitempty"`
}

CreatorInclude An identity that created a resource.

type CreatorScope

type CreatorScope struct {
	// Id A 24 character hex string used to identify a unique resource.
	Id   ID               `json:"id"`
	Type CreatorScopeType `json:"type"`
}

CreatorScope The creator scope is embedded in resource objects to describe who created them

type CreatorScopeType

type CreatorScopeType string

CreatorScopeType defines model for CreatorScope.Type.

const (
	CreatorScopeTypeAccount          CreatorScopeType = "account"
	CreatorScopeTypeApiKey           CreatorScopeType = "api-key"
	CreatorScopeTypeEmployee         CreatorScopeType = "employee"
	CreatorScopeTypeEnvironment      CreatorScopeType = "environment"
	CreatorScopeTypePlatform         CreatorScopeType = "platform"
	CreatorScopeTypePlatformPipeline CreatorScopeType = "platform-pipeline"
	CreatorScopeTypeVisitor          CreatorScopeType = "visitor"
)

Defines values for CreatorScopeType.

type CredentialsHTTP

type CredentialsHTTP struct {
	// Credentials Authentication credentails for the Dockerfile image source type when authenticating over HTTP.
	Credentials struct {
		// Password For authentication, the password.
		Password string `json:"password"`

		// Username For authentication, the username.
		Username string `json:"username"`
	} `json:"credentials"`
	Type CredentialsHTTPType `json:"type"`
}

CredentialsHTTP defines model for CredentialsHTTP.

type CredentialsHTTPType

type CredentialsHTTPType string

CredentialsHTTPType defines model for CredentialsHTTP.Type.

const (
	CredentialsHTTPTypeHttp CredentialsHTTPType = "http"
)

Defines values for CredentialsHTTPType.

type CredentialsSSH

type CredentialsSSH struct {
	// Credentials Authentication credentials for the Dockerfile image source type when authenticating with SSH.
	Credentials struct {
		// Passphrase The passphrase used for the key.
		Passphrase string `json:"passphrase"`

		// PrivateKey A pem encoded private key.
		PrivateKey string `json:"private_key"`

		// Username The username for the repo service, that is used to authenticate an ssh key.
		Username string `json:"username"`
	} `json:"credentials"`
	Type CredentialsSSHType `json:"type"`
}

CredentialsSSH defines model for CredentialsSSH.

type CredentialsSSHType

type CredentialsSSHType string

CredentialsSSHType defines model for CredentialsSSH.Type.

const (
	Ssh CredentialsSSHType = "ssh"
)

Defines values for CredentialsSSHType.

type Credit

type Credit struct {
	// AccountId The account the credit was issued to.
	AccountId string `json:"account_id"`

	// Amount The amount of credit.
	Amount int `json:"amount"`

	// AmountRemaining The amount of the credit that remains after being applied to invoices.
	AmountRemaining int `json:"amount_remaining"`

	// Description Some extra information about the billing credit.
	Description string `json:"description"`

	// Events A collection of timestamps for each event in the billing order's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// Expires Information on when the billing credit expires.
	Expires *struct {
		Date *DateTime `json:"date,omitempty"`
	} `json:"expires"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id    ID `json:"id"`
	State struct {
		Changed DateTime `json:"changed"`

		// Current The current state of the credit.
		Current CreditStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`
}

Credit Information about a billing credit.

type CreditStateCurrent

type CreditStateCurrent string

CreditStateCurrent The current state of the credit.

const (
	CreditStateCurrentExpired CreditStateCurrent = "expired"
	CreditStateCurrentLive    CreditStateCurrent = "live"
	CreditStateCurrentNew     CreditStateCurrent = "new"
)

Defines values for CreditStateCurrent.

type CycleSourceOrigin

type CycleSourceOrigin struct {
	Details struct {
		// SourceId A 24 character hex string used to identify a unique resource.
		SourceId ID `json:"source_id"`
	} `json:"details"`
	Type CycleSourceOriginType `json:"type"`
}

CycleSourceOrigin An image origin that references an image source on Cycle.

This origin will never be embedded in an image source. It is for use in stacks, describing an image which is already a part of an image source on Cycle.

type CycleSourceOriginType

type CycleSourceOriginType string

CycleSourceOriginType defines model for CycleSourceOrigin.Type.

const (
	CycleSource CycleSourceOriginType = "cycle-source"
)

Defines values for CycleSourceOriginType.

type CycleUploadOrigin

type CycleUploadOrigin struct {
	Details struct {
		Expires DateTime `json:"expires"`

		// Token The token that is required by the factory to accept an upload for this image.
		Token string `json:"token"`
	} `json:"details"`
	Type CycleUploadOriginType `json:"type"`
}

CycleUploadOrigin An image origin where the image is pushed directly to the factory, bypassing the need for a registry or external source.

In order to utilize this image origin type, a tar file of an OCI compliant image will need to be generated and pushed directly to the factory. The authentication token is generated when this image is created, and expires at the provided time. Once you have a token, it can be uploaded as multipart form data under the key `file.tar`, directly to the factory at `https://factory.cycle.io:9414/v1/images/<IMAGE ID>/upload?hub-id=<HUB ID>&token=<TOKEN>`.

type CycleUploadOriginType

type CycleUploadOriginType string

CycleUploadOriginType defines model for CycleUploadOrigin.Type.

const (
	CycleUpload CycleUploadOriginType = "cycle-upload"
)

Defines values for CycleUploadOriginType.

type DataSize added in v0.6.5

type DataSize = string

DataSize A human-readable data size string. Values are expressed as an integer followed by a unit suffix, without spaces. Supported units:

  • b, k, m, g, t, p (bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes)
  • An optional "b" suffix may be added (e.g., "mb", "gb").

Units are case-insensitive. Example: "512M", "10GB", "1t".

type DateTime

type DateTime = time.Time

DateTime defines model for DateTime.

type DefaultError

type DefaultError = ErrorEnvelope

DefaultError An error response.

type DefaultLbType

type DefaultLbType struct {
	Details V1LbConfig `json:"details"`

	// Ipv4 Allow / disallow traffic to be routed via IPv4.
	Ipv4 bool `json:"ipv4"`

	// Ipv6 Allow / disallow traffic to be routed via IPv6.
	Ipv6 bool              `json:"ipv6"`
	Type DefaultLbTypeType `json:"type"`
}

DefaultLbType defines model for DefaultLbType.

type DefaultLbTypeType

type DefaultLbTypeType string

DefaultLbTypeType defines model for DefaultLbType.Type.

const (
	DefaultLbTypeTypeDefault DefaultLbTypeType = "default"
)

Defines values for DefaultLbTypeType.

type DeleteAPIKeyResponse

type DeleteAPIKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An API key resource
		Data ApiKey `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteAPIKeyResponse

func ParseDeleteAPIKeyResponse(rsp *http.Response) (*DeleteAPIKeyResponse, error)

ParseDeleteAPIKeyResponse parses an HTTP response from a DeleteAPIKeyWithResponse call

func (DeleteAPIKeyResponse) Status

func (r DeleteAPIKeyResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteAPIKeyResponse) StatusCode

func (r DeleteAPIKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteAccountResponse

type DeleteAccountResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteAccountResponse

func ParseDeleteAccountResponse(rsp *http.Response) (*DeleteAccountResponse, error)

ParseDeleteAccountResponse parses an HTTP response from a DeleteAccountWithResponse call

func (DeleteAccountResponse) Status

func (r DeleteAccountResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteAccountResponse) StatusCode

func (r DeleteAccountResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteAutoScaleGroupResponse

type DeleteAutoScaleGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteAutoScaleGroupResponse

func ParseDeleteAutoScaleGroupResponse(rsp *http.Response) (*DeleteAutoScaleGroupResponse, error)

ParseDeleteAutoScaleGroupResponse parses an HTTP response from a DeleteAutoScaleGroupWithResponse call

func (DeleteAutoScaleGroupResponse) Status

Status returns HTTPResponse.Status

func (DeleteAutoScaleGroupResponse) StatusCode

func (r DeleteAutoScaleGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteBillingMethodResponse

type DeleteBillingMethodResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteBillingMethodResponse

func ParseDeleteBillingMethodResponse(rsp *http.Response) (*DeleteBillingMethodResponse, error)

ParseDeleteBillingMethodResponse parses an HTTP response from a DeleteBillingMethodWithResponse call

func (DeleteBillingMethodResponse) Status

Status returns HTTPResponse.Status

func (DeleteBillingMethodResponse) StatusCode

func (r DeleteBillingMethodResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteClusterResponse

type DeleteClusterResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteClusterResponse

func ParseDeleteClusterResponse(rsp *http.Response) (*DeleteClusterResponse, error)

ParseDeleteClusterResponse parses an HTTP response from a DeleteClusterWithResponse call

func (DeleteClusterResponse) Status

func (r DeleteClusterResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteClusterResponse) StatusCode

func (r DeleteClusterResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteContainerBackupResponse

type DeleteContainerBackupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteContainerBackupResponse

func ParseDeleteContainerBackupResponse(rsp *http.Response) (*DeleteContainerBackupResponse, error)

ParseDeleteContainerBackupResponse parses an HTTP response from a DeleteContainerBackupWithResponse call

func (DeleteContainerBackupResponse) Status

Status returns HTTPResponse.Status

func (DeleteContainerBackupResponse) StatusCode

func (r DeleteContainerBackupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteContainerInstancesResponse

type DeleteContainerInstancesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteContainerInstancesResponse

func ParseDeleteContainerInstancesResponse(rsp *http.Response) (*DeleteContainerInstancesResponse, error)

ParseDeleteContainerInstancesResponse parses an HTTP response from a DeleteContainerInstancesWithResponse call

func (DeleteContainerInstancesResponse) Status

Status returns HTTPResponse.Status

func (DeleteContainerInstancesResponse) StatusCode

func (r DeleteContainerInstancesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteContainerResponse

type DeleteContainerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteContainerResponse

func ParseDeleteContainerResponse(rsp *http.Response) (*DeleteContainerResponse, error)

ParseDeleteContainerResponse parses an HTTP response from a DeleteContainerWithResponse call

func (DeleteContainerResponse) Status

func (r DeleteContainerResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteContainerResponse) StatusCode

func (r DeleteContainerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteDNSZoneRecordResponse

type DeleteDNSZoneRecordResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data *JobDescriptor `json:"data,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteDNSZoneRecordResponse

func ParseDeleteDNSZoneRecordResponse(rsp *http.Response) (*DeleteDNSZoneRecordResponse, error)

ParseDeleteDNSZoneRecordResponse parses an HTTP response from a DeleteDNSZoneRecordWithResponse call

func (DeleteDNSZoneRecordResponse) Status

Status returns HTTPResponse.Status

func (DeleteDNSZoneRecordResponse) StatusCode

func (r DeleteDNSZoneRecordResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteDNSZoneResponse

type DeleteDNSZoneResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteDNSZoneResponse

func ParseDeleteDNSZoneResponse(rsp *http.Response) (*DeleteDNSZoneResponse, error)

ParseDeleteDNSZoneResponse parses an HTTP response from a DeleteDNSZoneWithResponse call

func (DeleteDNSZoneResponse) Status

func (r DeleteDNSZoneResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteDNSZoneResponse) StatusCode

func (r DeleteDNSZoneResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteEnvironmentResponse

type DeleteEnvironmentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteEnvironmentResponse

func ParseDeleteEnvironmentResponse(rsp *http.Response) (*DeleteEnvironmentResponse, error)

ParseDeleteEnvironmentResponse parses an HTTP response from a DeleteEnvironmentWithResponse call

func (DeleteEnvironmentResponse) Status

func (r DeleteEnvironmentResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteEnvironmentResponse) StatusCode

func (r DeleteEnvironmentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteExternalVolumeJSONBody added in v0.6.5

type DeleteExternalVolumeJSONBody struct {
	Options *struct {
		// SourceDevice If source device is set to true, this will delete the underlying source device.
		SourceDevice *bool `json:"source_device,omitempty"`
	} `json:"options,omitempty"`
}

DeleteExternalVolumeJSONBody defines parameters for DeleteExternalVolume.

type DeleteExternalVolumeJSONRequestBody added in v0.6.5

type DeleteExternalVolumeJSONRequestBody DeleteExternalVolumeJSONBody

DeleteExternalVolumeJSONRequestBody defines body for DeleteExternalVolume for application/json ContentType.

type DeleteExternalVolumeResponse added in v0.6.5

type DeleteExternalVolumeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteExternalVolumeResponse added in v0.6.5

func ParseDeleteExternalVolumeResponse(rsp *http.Response) (*DeleteExternalVolumeResponse, error)

ParseDeleteExternalVolumeResponse parses an HTTP response from a DeleteExternalVolumeWithResponse call

func (DeleteExternalVolumeResponse) Status added in v0.6.5

Status returns HTTPResponse.Status

func (DeleteExternalVolumeResponse) StatusCode added in v0.6.5

func (r DeleteExternalVolumeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteHubInviteResponse

type DeleteHubInviteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A membership resource that is scoped to an individual hub.
		Data HubMembership `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteHubInviteResponse

func ParseDeleteHubInviteResponse(rsp *http.Response) (*DeleteHubInviteResponse, error)

ParseDeleteHubInviteResponse parses an HTTP response from a DeleteHubInviteWithResponse call

func (DeleteHubInviteResponse) Status

func (r DeleteHubInviteResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteHubInviteResponse) StatusCode

func (r DeleteHubInviteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteHubJSONBody

type DeleteHubJSONBody struct {
	Options *struct {
		// Force If force is set to true, this will force delete the hub, even if there are servers running on it.
		Force *bool `json:"force,omitempty"`
	} `json:"options,omitempty"`
}

DeleteHubJSONBody defines parameters for DeleteHub.

type DeleteHubJSONRequestBody

type DeleteHubJSONRequestBody DeleteHubJSONBody

DeleteHubJSONRequestBody defines body for DeleteHub for application/json ContentType.

type DeleteHubMemberResponse

type DeleteHubMemberResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteHubMemberResponse

func ParseDeleteHubMemberResponse(rsp *http.Response) (*DeleteHubMemberResponse, error)

ParseDeleteHubMemberResponse parses an HTTP response from a DeleteHubMemberWithResponse call

func (DeleteHubMemberResponse) Status

func (r DeleteHubMemberResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteHubMemberResponse) StatusCode

func (r DeleteHubMemberResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteHubResponse

type DeleteHubResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteHubResponse

func ParseDeleteHubResponse(rsp *http.Response) (*DeleteHubResponse, error)

ParseDeleteHubResponse parses an HTTP response from a DeleteHubWithResponse call

func (DeleteHubResponse) Status

func (r DeleteHubResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteHubResponse) StatusCode

func (r DeleteHubResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteIPPoolResponse

type DeleteIPPoolResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteIPPoolResponse

func ParseDeleteIPPoolResponse(rsp *http.Response) (*DeleteIPPoolResponse, error)

ParseDeleteIPPoolResponse parses an HTTP response from a DeleteIPPoolWithResponse call

func (DeleteIPPoolResponse) Status

func (r DeleteIPPoolResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteIPPoolResponse) StatusCode

func (r DeleteIPPoolResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteImageResponse

type DeleteImageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteImageResponse

func ParseDeleteImageResponse(rsp *http.Response) (*DeleteImageResponse, error)

ParseDeleteImageResponse parses an HTTP response from a DeleteImageWithResponse call

func (DeleteImageResponse) Status

func (r DeleteImageResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteImageResponse) StatusCode

func (r DeleteImageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteImageSourceResponse

type DeleteImageSourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteImageSourceResponse

func ParseDeleteImageSourceResponse(rsp *http.Response) (*DeleteImageSourceResponse, error)

ParseDeleteImageSourceResponse parses an HTTP response from a DeleteImageSourceWithResponse call

func (DeleteImageSourceResponse) Status

func (r DeleteImageSourceResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteImageSourceResponse) StatusCode

func (r DeleteImageSourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteInstanceResponse

type DeleteInstanceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteInstanceResponse

func ParseDeleteInstanceResponse(rsp *http.Response) (*DeleteInstanceResponse, error)

ParseDeleteInstanceResponse parses an HTTP response from a DeleteInstanceWithResponse call

func (DeleteInstanceResponse) Status

func (r DeleteInstanceResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteInstanceResponse) StatusCode

func (r DeleteInstanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteIntegrationResponse

type DeleteIntegrationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteIntegrationResponse

func ParseDeleteIntegrationResponse(rsp *http.Response) (*DeleteIntegrationResponse, error)

ParseDeleteIntegrationResponse parses an HTTP response from a DeleteIntegrationWithResponse call

func (DeleteIntegrationResponse) Status

func (r DeleteIntegrationResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteIntegrationResponse) StatusCode

func (r DeleteIntegrationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteNetworkResponse

type DeleteNetworkResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteNetworkResponse

func ParseDeleteNetworkResponse(rsp *http.Response) (*DeleteNetworkResponse, error)

ParseDeleteNetworkResponse parses an HTTP response from a DeleteNetworkWithResponse call

func (DeleteNetworkResponse) Status

func (r DeleteNetworkResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteNetworkResponse) StatusCode

func (r DeleteNetworkResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeletePipelineResponse

type DeletePipelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeletePipelineResponse

func ParseDeletePipelineResponse(rsp *http.Response) (*DeletePipelineResponse, error)

ParseDeletePipelineResponse parses an HTTP response from a DeletePipelineWithResponse call

func (DeletePipelineResponse) Status

func (r DeletePipelineResponse) Status() string

Status returns HTTPResponse.Status

func (DeletePipelineResponse) StatusCode

func (r DeletePipelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeletePipelineTriggerKeyResponse

type DeletePipelineTriggerKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeletePipelineTriggerKeyResponse

func ParseDeletePipelineTriggerKeyResponse(rsp *http.Response) (*DeletePipelineTriggerKeyResponse, error)

ParseDeletePipelineTriggerKeyResponse parses an HTTP response from a DeletePipelineTriggerKeyWithResponse call

func (DeletePipelineTriggerKeyResponse) Status

Status returns HTTPResponse.Status

func (DeletePipelineTriggerKeyResponse) StatusCode

func (r DeletePipelineTriggerKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteRoleResponse

type DeleteRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteRoleResponse

func ParseDeleteRoleResponse(rsp *http.Response) (*DeleteRoleResponse, error)

ParseDeleteRoleResponse parses an HTTP response from a DeleteRoleWithResponse call

func (DeleteRoleResponse) Status

func (r DeleteRoleResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteRoleResponse) StatusCode

func (r DeleteRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteScopedVariableResponse

type DeleteScopedVariableResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteScopedVariableResponse

func ParseDeleteScopedVariableResponse(rsp *http.Response) (*DeleteScopedVariableResponse, error)

ParseDeleteScopedVariableResponse parses an HTTP response from a DeleteScopedVariableWithResponse call

func (DeleteScopedVariableResponse) Status

Status returns HTTPResponse.Status

func (DeleteScopedVariableResponse) StatusCode

func (r DeleteScopedVariableResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteServerJSONBody

type DeleteServerJSONBody struct {
	Options *struct {
		// Force If force is set to true, this will force delete the server, even if there are instances running on it.
		Force *bool `json:"force,omitempty"`
	} `json:"options,omitempty"`
}

DeleteServerJSONBody defines parameters for DeleteServer.

type DeleteServerJSONRequestBody

type DeleteServerJSONRequestBody DeleteServerJSONBody

DeleteServerJSONRequestBody defines body for DeleteServer for application/json ContentType.

type DeleteServerResponse

type DeleteServerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteServerResponse

func ParseDeleteServerResponse(rsp *http.Response) (*DeleteServerResponse, error)

ParseDeleteServerResponse parses an HTTP response from a DeleteServerWithResponse call

func (DeleteServerResponse) Status

func (r DeleteServerResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteServerResponse) StatusCode

func (r DeleteServerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteStackBuildResponse

type DeleteStackBuildResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteStackBuildResponse

func ParseDeleteStackBuildResponse(rsp *http.Response) (*DeleteStackBuildResponse, error)

ParseDeleteStackBuildResponse parses an HTTP response from a DeleteStackBuildWithResponse call

func (DeleteStackBuildResponse) Status

func (r DeleteStackBuildResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteStackBuildResponse) StatusCode

func (r DeleteStackBuildResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteStackResponse

type DeleteStackResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteStackResponse

func ParseDeleteStackResponse(rsp *http.Response) (*DeleteStackResponse, error)

ParseDeleteStackResponse parses an HTTP response from a DeleteStackWithResponse call

func (DeleteStackResponse) Status

func (r DeleteStackResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteStackResponse) StatusCode

func (r DeleteStackResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteVPNUserResponse

type DeleteVPNUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data string `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteVPNUserResponse

func ParseDeleteVPNUserResponse(rsp *http.Response) (*DeleteVPNUserResponse, error)

ParseDeleteVPNUserResponse parses an HTTP response from a DeleteVPNUserWithResponse call

func (DeleteVPNUserResponse) Status

func (r DeleteVPNUserResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteVPNUserResponse) StatusCode

func (r DeleteVPNUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteVirtualMachineResponse

type DeleteVirtualMachineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteVirtualMachineResponse

func ParseDeleteVirtualMachineResponse(rsp *http.Response) (*DeleteVirtualMachineResponse, error)

ParseDeleteVirtualMachineResponse parses an HTTP response from a DeleteVirtualMachineWithResponse call

func (DeleteVirtualMachineResponse) Status

Status returns HTTPResponse.Status

func (DeleteVirtualMachineResponse) StatusCode

func (r DeleteVirtualMachineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteVirtualMachineSshKeyResponse

type DeleteVirtualMachineSshKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteVirtualMachineSshKeyResponse

func ParseDeleteVirtualMachineSshKeyResponse(rsp *http.Response) (*DeleteVirtualMachineSshKeyResponse, error)

ParseDeleteVirtualMachineSshKeyResponse parses an HTTP response from a DeleteVirtualMachineSshKeyWithResponse call

func (DeleteVirtualMachineSshKeyResponse) Status

Status returns HTTPResponse.Status

func (DeleteVirtualMachineSshKeyResponse) StatusCode

func (r DeleteVirtualMachineSshKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteVirtualProviderIsoResponse added in v0.6.3

type DeleteVirtualProviderIsoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDeleteVirtualProviderIsoResponse added in v0.6.3

func ParseDeleteVirtualProviderIsoResponse(rsp *http.Response) (*DeleteVirtualProviderIsoResponse, error)

ParseDeleteVirtualProviderIsoResponse parses an HTTP response from a DeleteVirtualProviderIsoWithResponse call

func (DeleteVirtualProviderIsoResponse) Status added in v0.6.3

Status returns HTTPResponse.Status

func (DeleteVirtualProviderIsoResponse) StatusCode added in v0.6.3

func (r DeleteVirtualProviderIsoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeployedVolume

type DeployedVolume struct {
	// ContainerId The ID of the container the instance was created from.
	ContainerId string `json:"container_id"`

	// ContainerVolumeId The ID for the volume withing the context of the container.
	ContainerVolumeId string `json:"container_volume_id"`

	// Hash A hash used as part of the identification mechanisms for the platform and API.
	Hash string `json:"hash"`

	// Id The ID of the deployed volume.
	Id string `json:"id"`

	// InstanceId The ID for the container instance this volume is attached to.
	InstanceId string `json:"instance_id"`

	// Path The path where the volume is mounted on the instnace filesystem.
	Path string `json:"path"`

	// ServerId The ID of the server the instance is deployed to.
	ServerId string `json:"server_id"`

	// Storage Storage information for the volume.
	Storage struct {
		// Total The total amount of volume storage available, in MB's.
		Total int `json:"total"`

		// Used The amount of volume storage used, in MB's
		Used int `json:"used"`
	} `json:"storage"`
}

DeployedVolume A deployed volume resource.

type Deployment

type Deployment struct {
	// Version Version can be any string, but if it begins with a "v", semantic version will be enforced. A [Semantic Version](https://semver.org/) string. Follows the format vMAJOR.MINOR.PATCH-build.
	Version Version `json:"version"`
}

Deployment A logical grouping of containers inside of an Environment. Facilitates zero-downtime deployments by separating multiple versions of the same application within an environment.

If a container is a member of a deployment, it can only resolve containers in that same deployment, or containers NOT in a deployment. If a container is NOT a member of a deployment, it can resolve all containers in the environment.

type DeploymentStrategy

type DeploymentStrategy struct {
	// Description A description for the deployment strategy.
	Description string `json:"description"`

	// Disabled A boolean where true signifies a strategy is either not yet or no longer available.
	Disabled bool `json:"disabled"`

	// Name The human-friendly name of the deployment strategy.
	Name string `json:"name"`
}

DeploymentStrategy Information about supported container deployment strategies.

type DeploymentStrategyName

type DeploymentStrategyName string

DeploymentStrategyName defines model for DeploymentStrategyName.

const (
	DeploymentStrategyNameDistributed      DeploymentStrategyName = "distributed"
	DeploymentStrategyNameEdge             DeploymentStrategyName = "edge"
	DeploymentStrategyNameFirstAvailable   DeploymentStrategyName = "first-available"
	DeploymentStrategyNameFunction         DeploymentStrategyName = "function"
	DeploymentStrategyNameHighAvailability DeploymentStrategyName = "high-availability"
	DeploymentStrategyNameManual           DeploymentStrategyName = "manual"
	DeploymentStrategyNameNode             DeploymentStrategyName = "node"
	DeploymentStrategyNameResourceDensity  DeploymentStrategyName = "resource-density"
)

Defines values for DeploymentStrategyName.

type Detail

type Detail struct {
	// Boolean A boolean describing if a resource exists or not.
	Boolean *string `json:"boolean,omitempty"`

	// Id A 24 character hex string used to identify a unique resource.
	Id *ID `json:"id,omitempty"`

	// Number A number describing the amount of the resource that exists.
	Number *int `json:"number,omitempty"`

	// String Additional information.
	String *string `json:"string,omitempty"`
}

Detail Details about a given event that is part of an activity.

type DirectImageSourceType

type DirectImageSourceType struct {
	Details struct {
		Id string `json:"id"`

		// Origin The origin of the image.
		Origin ImageOrigin `json:"origin"`
	} `json:"details"`
	Override *struct {
		Target   *string `json:"target,omitempty"`
		TargzUrl *string `json:"targz_url,omitempty"`
	} `json:"override,omitempty"`
	Type DirectImageSourceTypeType `json:"type"`
}

DirectImageSourceType defines model for DirectImageSourceType.

type DirectImageSourceTypeType

type DirectImageSourceTypeType string

DirectImageSourceTypeType defines model for DirectImageSourceType.Type.

const (
	Direct DirectImageSourceTypeType = "direct"
)

Defines values for DirectImageSourceTypeType.

type DirectPayment added in v0.6.3

type DirectPayment struct {
	Details struct {
		// Instructions Any additional instructions for an organization's billing dept., etc. that should be known about this payment method.
		Instructions string `json:"instructions"`

		// Preference The preference for how the payment will be sent.
		Preference DirectPaymentDetailsPreference `json:"preference"`
	} `json:"details"`
	Type DirectPaymentType `json:"type"`
}

DirectPayment A payment method that must be enabled by Cycle staff, solely for telling us they're going to send us checks, wires, ach, outside of Cycle.

type DirectPaymentDetailsPreference added in v0.6.3

type DirectPaymentDetailsPreference string

DirectPaymentDetailsPreference The preference for how the payment will be sent.

const (
	DirectPaymentDetailsPreferenceAch   DirectPaymentDetailsPreference = "ach"
	DirectPaymentDetailsPreferenceCheck DirectPaymentDetailsPreference = "check"
	DirectPaymentDetailsPreferenceWire  DirectPaymentDetailsPreference = "wire"
)

Defines values for DirectPaymentDetailsPreference.

type DirectPaymentType added in v0.6.3

type DirectPaymentType string

DirectPaymentType defines model for DirectPayment.Type.

const (
	DirectPaymentTypeDirectPayment DirectPaymentType = "direct-payment"
)

Defines values for DirectPaymentType.

type DisableTwoFactorAuthJSONBody

type DisableTwoFactorAuthJSONBody struct {
	// Token A valid existing two-factor auth token, for verification.
	Token string `json:"token"`
}

DisableTwoFactorAuthJSONBody defines parameters for DisableTwoFactorAuth.

type DisableTwoFactorAuthJSONRequestBody

type DisableTwoFactorAuthJSONRequestBody DisableTwoFactorAuthJSONBody

DisableTwoFactorAuthJSONRequestBody defines body for DisableTwoFactorAuth for application/json ContentType.

type DisableTwoFactorAuthResponse

type DisableTwoFactorAuthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An object representing information about the currently logged-in user.
		Data Account `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseDisableTwoFactorAuthResponse

func ParseDisableTwoFactorAuthResponse(rsp *http.Response) (*DisableTwoFactorAuthResponse, error)

ParseDisableTwoFactorAuthResponse parses an HTTP response from a DisableTwoFactorAuthWithResponse call

func (DisableTwoFactorAuthResponse) Status

Status returns HTTPResponse.Status

func (DisableTwoFactorAuthResponse) StatusCode

func (r DisableTwoFactorAuthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DiscoveryConfig

type DiscoveryConfig struct {
	// CustomResolvers A list of custom DNS resolver strings.  Can specifify domains or ips.
	CustomResolvers *[]string `json:"custom_resolvers"`

	// DualStackLegacy When enabled, discovery will return both IPv6 and IPv4 when in legacy mode.  Otherwise, only IPv4 will be returned.
	DualStackLegacy    *bool     `json:"dual_stack_legacy,omitempty"`
	EmptySetDelay      *Duration `json:"empty_set_delay"`
	ExternalResolution *struct {
		Preference DiscoveryConfigExternalResolutionPreference `json:"preference"`
	} `json:"external_resolution,omitempty"`

	// Hosts A mapping of hostnames to IP addresses for custom internal resolutions. Acts as a custom /etc/resolv.conf file that works environment wide.
	Hosts *map[string]struct {
		// Ipv4 The IPv4 address the discovery server should return to any container instance requesting this hostname.
		Ipv4 *[]string `json:"ipv4"`

		// Ipv6 The IPv6 address the discovery server should return to any container instance requesting this hostname.
		Ipv6 *[]string `json:"ipv6"`
	} `json:"hosts"`
}

DiscoveryConfig The config object for the discovery service.

type DiscoveryConfigExternalResolutionPreference added in v0.6.6

type DiscoveryConfigExternalResolutionPreference string

DiscoveryConfigExternalResolutionPreference defines model for DiscoveryConfig.ExternalResolution.Preference.

const (
	DiscoveryConfigExternalResolutionPreferenceDefault DiscoveryConfigExternalResolutionPreference = "default"
	DiscoveryConfigExternalResolutionPreferenceIpv4    DiscoveryConfigExternalResolutionPreference = "ipv4"
	DiscoveryConfigExternalResolutionPreferenceIpv6    DiscoveryConfigExternalResolutionPreference = "ipv6"
)

Defines values for DiscoveryConfigExternalResolutionPreference.

type DiscoveryEnvironmentService

type DiscoveryEnvironmentService struct {
	// AutoUpdate A boolean where `true` represents the desire to automatically update the environment discovery service.
	AutoUpdate *bool `json:"auto_update,omitempty"`

	// Config The config object for the discovery service.
	Config *DiscoveryConfig `json:"config"`

	// ContainerId The ID of the discovery service container
	ContainerId string `json:"container_id"`

	// Enable Whether or not the discovery service is enabled.
	Enable bool `json:"enable"`

	// HighAvailability A boolean representing if this service container is set to high availability mode or not.
	HighAvailability bool `json:"high_availability"`
}

DiscoveryEnvironmentService Information about the environments discovery service(s).

type DnsRecord added in v0.6.2

type DnsRecord struct {
	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events Describes the date and time at which certain events occurred in the lifetime of this resource.
	Events Events `json:"events"`

	// Features TLS features for the record.
	Features *struct {
		Certificate *DnsRecordTlsCertificate `json:"certificate"`
	} `json:"features"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Name A name used for the record, where `@` signifies the use of the root domain.
	Name string `json:"name"`

	// ResolvedDomain The name of the record and the origin as a domain name.
	ResolvedDomain string         `json:"resolved_domain"`
	State          DnsRecordState `json:"state"`

	// Type DNS record types the platform supports.
	Type DnsRecordTypes `json:"type"`

	// ZoneId A unique identifier for the zone
	ZoneId string `json:"zone_id"`
}

DnsRecord A DNS record.

type DnsRecordState added in v0.6.2

type DnsRecordState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the record.
	Current DnsRecordStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

DnsRecordState defines model for DnsRecordState.

type DnsRecordStateCurrent added in v0.6.2

type DnsRecordStateCurrent string

DnsRecordStateCurrent The current state of the record.

const (
	DnsRecordStateCurrentDeleted  DnsRecordStateCurrent = "deleted"
	DnsRecordStateCurrentDeleting DnsRecordStateCurrent = "deleting"
	DnsRecordStateCurrentLive     DnsRecordStateCurrent = "live"
	DnsRecordStateCurrentPending  DnsRecordStateCurrent = "pending"
)

Defines values for DnsRecordStateCurrent.

type DnsRecordTlsCertificate added in v0.6.2

type DnsRecordTlsCertificate struct {
	Expires   *DateTime `json:"expires,omitempty"`
	Generated DateTime  `json:"generated"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// UserSupplied If true, this certificate was manually supplied, and was not auto-generated by the platform.
	UserSupplied bool `json:"user_supplied"`

	// WildcardChild A value where true represents that the certificate is using a shared wildcard cert.
	WildcardChild bool `json:"wildcard_child"`
}

DnsRecordTlsCertificate A TLS certificate assigned to a DNS record.

type DnsRecordTypes added in v0.6.2

type DnsRecordTypes struct {
	// A A DNS A record
	A *struct {
		// Ip The IPv4 address that the A record should map to.
		Ip string `json:"ip"`
	} `json:"a,omitempty"`

	// Aaaa A DNS AAAA record
	Aaaa *struct {
		// Ip The IPv6 address that the AAAA record should map to.
		Ip string `json:"ip"`
	} `json:"aaaa,omitempty"`

	// Alias A DNS ALIAS record.
	Alias *struct {
		// Domain The domain string returned from the DNS server when this alias record is requested.
		Domain string `json:"domain"`
	} `json:"alias,omitempty"`

	// Caa A DNS CAA record.
	Caa *struct {
		// Tag The ASCII string that represents the identifier of the property represented by the record.
		Tag string `json:"tag"`

		// Value The value associated with the tag.
		Value string `json:"value"`
	} `json:"caa,omitempty"`

	// Cname A DNS CNAME record
	Cname *struct {
		// Domain The domain string the record resolves to.
		Domain string `json:"domain"`
	} `json:"cname,omitempty"`

	// Linked A LINKED record is a record special to Cycle.  It represents a URL that points to a specific container or deployment of a container, however the IP address mapping in handled automatically by the platform.
	Linked *struct {
		// Features Features associated with this record.
		Features struct {
			// Geodns Options for the GeoDNS LINKED record feature.
			Geodns struct {
				// Enable If enabled, Cycle will attempt to match inbound requests to the closest load balancer geographically.
				Enable bool `json:"enable"`
			} `json:"geodns"`

			// Tls TLS properties of the record.
			Tls struct {
				// Enable A boolean, where true represents this record will be paired with a TLS certificate automatically maintained by the platform.
				Enable bool `json:"enable"`
			} `json:"tls"`
			Wildcard *struct {
				// ResolveSubDomains If enabled, subdomains will resolve for wildcard records. If disabled, only the primary domain will resolve.
				ResolveSubDomains bool `json:"resolve_sub_domains"`
			} `json:"wildcard"`
		} `json:"features"`

		// Routing Rules for routing traffic at the load balancer for this linked record.
		Routing struct {
			Http *struct {
				// MatchPath If set, this record will configure the load balancer to only match for paths of this domain matching this string.
				// If the string starts with a /, it will be a literal prefix match (/test matches /test*). Otherwise, regex is used.
				MatchPath *string `json:"match_path"`
			} `json:"http"`
		} `json:"routing"`
	} `json:"linked,omitempty"`

	// Mx A DNS MX record
	Mx *struct {
		// Domain The domain this mx record points to.
		Domain string `json:"domain"`

		// Priority The priority setting for this mx record.
		Priority int `json:"priority"`
	} `json:"mx,omitempty"`

	// Ns A DNS NS record
	Ns *struct {
		// Domain The domain of the nameserver for this record.
		Domain string `json:"domain"`
	} `json:"ns,omitempty"`

	// Srv A DNS SRV record.
	Srv *struct {
		// Domain The domain for the record.
		Domain string `json:"domain"`

		// Port The port number for the service.
		Port int `json:"port"`

		// Priority The priority for the record.
		Priority int `json:"priority"`

		// Weight Teh weight configured for this record - breaks ties for priority.
		Weight int `json:"weight"`
	} `json:"srv,omitempty"`

	// Txt A DNS TXT record.
	Txt *struct {
		// Value The value for this TXT record.
		Value string `json:"value"`
	} `json:"txt,omitempty"`
}

DnsRecordTypes DNS record types the platform supports.

type DnsZone added in v0.6.2

type DnsZone struct {
	Acl *ACL `json:"acl"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the DNS zone's lifetime.
	Events struct {
		Created          DateTime `json:"created"`
		Deleted          DateTime `json:"deleted"`
		LastVerification DateTime `json:"last_verification"`
		Updated          DateTime `json:"updated"`
		Verified         DateTime `json:"verified"`
	} `json:"events"`

	// Hosted A boolean where true represents this zone is a hosted zone.
	Hosted bool `json:"hosted"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Origin The origin for the given DNS zone.
	Origin string       `json:"origin"`
	State  DnsZoneState `json:"state"`
}

DnsZone DNS (Domain Name System), in short, is a decentralized naming system for computers, services, or other resources connected to the internet or a private network. It is what allows the translation of a URL, such as http://example.com, to an IP address.

type DnsZoneIncludes added in v0.6.2

type DnsZoneIncludes struct {
	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`
}

DnsZoneIncludes All includable resources linkable to the given Zone.

type DnsZoneState added in v0.6.2

type DnsZoneState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the zone.
	Current DnsZoneStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

DnsZoneState defines model for DnsZoneState.

type DnsZoneStateCurrent added in v0.6.2

type DnsZoneStateCurrent string

DnsZoneStateCurrent The current state of the zone.

const (
	DnsZoneStateCurrentDeleted   DnsZoneStateCurrent = "deleted"
	DnsZoneStateCurrentDeleting  DnsZoneStateCurrent = "deleting"
	DnsZoneStateCurrentDisabled  DnsZoneStateCurrent = "disabled"
	DnsZoneStateCurrentLive      DnsZoneStateCurrent = "live"
	DnsZoneStateCurrentNew       DnsZoneStateCurrent = "new"
	DnsZoneStateCurrentPending   DnsZoneStateCurrent = "pending"
	DnsZoneStateCurrentVerifying DnsZoneStateCurrent = "verifying"
)

Defines values for DnsZoneStateCurrent.

type DockerFileOrigin

type DockerFileOrigin struct {
	Details struct {
		// BuildFile The path to the Dockerfile to be used for buiding the image.
		BuildFile *string `json:"build_file"`

		// ContextDir The path to the directory to use as the context when building the image.
		ContextDir  *string                `json:"context_dir"`
		Credentials *DockerfileCredentials `json:"credentials"`
		Existing    *ExistingSource        `json:"existing"`
		Repo        *RepoType              `json:"repo"`

		// TargzUrl An endpoint that serves the tar file.
		TargzUrl *string `json:"targz_url"`
	} `json:"details"`
	Type DockerFileOriginType `json:"type"`
}

DockerFileOrigin An image origin where the image is built from a Dockerfile located in a git repository.

type DockerFileOriginType

type DockerFileOriginType string

DockerFileOriginType defines model for DockerFileOrigin.Type.

const (
	DockerFile DockerFileOriginType = "docker-file"
)

Defines values for DockerFileOriginType.

type DockerHubOrigin

type DockerHubOrigin struct {
	Details struct {
		Existing *ExistingSource `json:"existing"`

		// Target The DockerHub target string. ex - `mysql:5.7`
		Target string `json:"target"`

		// Token For authentication, a token.
		Token *string `json:"token,omitempty"`

		// Username For authentication, a username.
		Username *string `json:"username,omitempty"`
	} `json:"details"`
	Type DockerHubOriginType `json:"type"`
}

DockerHubOrigin An image origin where the image is pulled from DockerHub.

type DockerHubOriginType

type DockerHubOriginType string

DockerHubOriginType defines model for DockerHubOrigin.Type.

const (
	DockerHub DockerHubOriginType = "docker-hub"
)

Defines values for DockerHubOriginType.

type DockerRegistryOrigin

type DockerRegistryOrigin struct {
	Details struct {
		// Existing In a stack, specifies an image source ID from which Cycle will derive any values not specified in the stack file. This is useful for avoiding direct placement of credentials in a stack file, for example.
		Existing *ExistingSource `json:"existing,omitempty"`

		// Password For authentication, a password.
		Password *string `json:"password,omitempty"`

		// Target The image name on the registry.
		Target string `json:"target"`

		// Token For authentication, a token.
		Token *string `json:"token,omitempty"`

		// Url The url of the remote registry.
		Url string `json:"url"`

		// Username For authentication, a username.
		Username *string `json:"username,omitempty"`
	} `json:"details"`
	Type DockerRegistryOriginType `json:"type"`
}

DockerRegistryOrigin An image origin where the image is pulled from a private Docker registry.

type DockerRegistryOriginType

type DockerRegistryOriginType string

DockerRegistryOriginType defines model for DockerRegistryOrigin.Type.

const (
	DockerRegistry DockerRegistryOriginType = "docker-registry"
)

Defines values for DockerRegistryOriginType.

type DockerfileCredentials

type DockerfileCredentials = []struct {
	// Token A token for authentication.
	Token *string `json:"token,omitempty"`

	// Url The url the resource is located at.
	Url *string `json:"url,omitempty"`

	// Username A username for authentication.
	Username *string `json:"username,omitempty"`
}

DockerfileCredentials An array of credentials objects to be used when authenticating against private images used by the Dockerfile.

type Duration

type Duration = string

Duration A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".

type EnableTwoFactorAuthJSONBody

type EnableTwoFactorAuthJSONBody struct {
	// Token The token used to authenticate the two-factor setup.
	Token string `json:"token"`
}

EnableTwoFactorAuthJSONBody defines parameters for EnableTwoFactorAuth.

type EnableTwoFactorAuthJSONRequestBody

type EnableTwoFactorAuthJSONRequestBody EnableTwoFactorAuthJSONBody

EnableTwoFactorAuthJSONRequestBody defines body for EnableTwoFactorAuth for application/json ContentType.

type EnableTwoFactorAuthResponse

type EnableTwoFactorAuthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data TwoFactorAuthRecovery `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseEnableTwoFactorAuthResponse

func ParseEnableTwoFactorAuthResponse(rsp *http.Response) (*EnableTwoFactorAuthResponse, error)

ParseEnableTwoFactorAuthResponse parses an HTTP response from a EnableTwoFactorAuthWithResponse call

func (EnableTwoFactorAuthResponse) Status

Status returns HTTPResponse.Status

func (EnableTwoFactorAuthResponse) StatusCode

func (r EnableTwoFactorAuthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Environment

type Environment struct {
	// About Contains details regarding the environment.
	About EnvironmentAbout `json:"about"`
	Acl   *ACL             `json:"acl"`

	// Cluster The cluster this environment is associated with.
	Cluster string `json:"cluster"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Deployments A map of custom tags to deployment versions.
	Deployments *struct {
		// Tags A map of custom tags to deployment versions. Allows for defining a custom, persistent tag with a changing version number.
		// For example, `dev -> v1.2.3-dev`. This is useful when dealing with DNS LINKED records, where you always want dev.example.com to point to the
		// `dev` version of your app within an environment, where you can continuously deploy and update it without needing to change the record. It is
		// even more useful when you have multiple LINKED records, and you update i.e. `prod“ tag to point to a new version, all records using the `prod` tag
		// are switched at once.
		Tags EnvironmentDeploymentTags `json:"tags"`
	} `json:"deployments"`

	// Events A collection of timestamps for each event in the environment's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// Features An object representing specialized features configured for this environment.
	Features EnvironmentFeatures `json:"features"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Meta A list of meta fields that can be applied to this environment.
	Meta *EnvironmentMeta `json:"meta,omitempty"`

	// Name A user defined name for the environment resource.
	Name           string          `json:"name"`
	PrivateNetwork *PrivateNetwork `json:"private_network"`

	// Services Service containers run by this environment and their configurations.
	Services EnvironmentServices `json:"services"`
	State    EnvironmentState    `json:"state"`
}

Environment Environments are groups of containers with a private network built between them. For more information on environments, see the [main docs](https://cycle.io/docs/platform/introduction-to-environments).

type EnvironmentAbout

type EnvironmentAbout struct {
	// Description A custom description for this environment.
	Description string `json:"description"`

	// Favorite If true, this environment has been marked as a favorite.
	Favorite bool `json:"favorite"`
}

EnvironmentAbout Contains details regarding the environment.

type EnvironmentCreateStep

type EnvironmentCreateStep struct {
	// Action The action that the step takes.
	Action  EnvironmentCreateStepAction `json:"action"`
	Details struct {
		About   *EnvironmentAbout `json:"about"`
		Cluster string            `json:"cluster"`

		// Features An object representing specialized features configured for this environment.
		Features EnvironmentFeatures `json:"features"`
		Name     string              `json:"name"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

EnvironmentCreateStep Settings for creating an environment in a pipeline.

type EnvironmentCreateStepAction

type EnvironmentCreateStepAction string

EnvironmentCreateStepAction The action that the step takes.

const (
	EnvironmentCreate EnvironmentCreateStepAction = "environment.create"
)

Defines values for EnvironmentCreateStepAction.

type EnvironmentDeleteStep

type EnvironmentDeleteStep struct {
	// Action The action that the step takes.
	Action  EnvironmentDeleteStepAction `json:"action"`
	Details struct {
		// Environment An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Environment FluidIdentifier `json:"environment"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

EnvironmentDeleteStep Settings for deleting an environment in a pipeline.

type EnvironmentDeleteStepAction

type EnvironmentDeleteStepAction string

EnvironmentDeleteStepAction The action that the step takes.

const (
	EnvironmentDelete EnvironmentDeleteStepAction = "environment.delete"
)

Defines values for EnvironmentDeleteStepAction.

type EnvironmentDeploymentHealthyWatchStep

type EnvironmentDeploymentHealthyWatchStep struct {
	// Action The action that the step takes.
	Action  EnvironmentDeploymentHealthyWatchStepAction `json:"action"`
	Details struct {
		// Environment An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Environment FluidIdentifier `json:"environment"`

		// MaxWait The maximum amount of time to wait for the deployment to become healthy before failing this step.
		MaxWait *Duration `json:"max_wait"`
		Tag     *string   `json:"tag"`
		Version *string   `json:"version"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

EnvironmentDeploymentHealthyWatchStep Waits for a deployment to be considered 'healthy' before allowing the pipeline to continue. A deployement is considered 'healthy' when all instances of all containers that have had a state change in the last 15 minutes that have health checks defined, become healthy.

type EnvironmentDeploymentHealthyWatchStepAction

type EnvironmentDeploymentHealthyWatchStepAction string

EnvironmentDeploymentHealthyWatchStepAction The action that the step takes.

const (
	EnvironmentDeploymentHealthyWatch EnvironmentDeploymentHealthyWatchStepAction = "environment.deployment.healthy.watch"
)

Defines values for EnvironmentDeploymentHealthyWatchStepAction.

type EnvironmentDeploymentStartStep

type EnvironmentDeploymentStartStep struct {
	// Action The action that the step takes.
	Action  EnvironmentDeploymentStartStepAction `json:"action"`
	Details struct {
		// Environment An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Environment FluidIdentifier `json:"environment"`
		Tag         *string         `json:"tag"`
		Version     *string         `json:"version"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

EnvironmentDeploymentStartStep Start all containers with a specific deployment version/tag within an environment.

type EnvironmentDeploymentStartStepAction

type EnvironmentDeploymentStartStepAction string

EnvironmentDeploymentStartStepAction The action that the step takes.

const (
	EnvironmentDeploymentStart EnvironmentDeploymentStartStepAction = "environment.deployment.start"
)

Defines values for EnvironmentDeploymentStartStepAction.

type EnvironmentDeploymentStopStep

type EnvironmentDeploymentStopStep struct {
	// Action The action that the step takes.
	Action  EnvironmentDeploymentStopStepAction `json:"action"`
	Details struct {
		// Environment An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Environment FluidIdentifier `json:"environment"`
		Tag         *string         `json:"tag"`
		Version     *string         `json:"version"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

EnvironmentDeploymentStopStep Stop all containers with a specific deployment version/tag within an environment.

type EnvironmentDeploymentStopStepAction

type EnvironmentDeploymentStopStepAction string

EnvironmentDeploymentStopStepAction The action that the step takes.

const (
	EnvironmentDeploymentStop EnvironmentDeploymentStopStepAction = "environment.deployment.stop"
)

Defines values for EnvironmentDeploymentStopStepAction.

type EnvironmentDeploymentTags

type EnvironmentDeploymentTags map[string]Version

EnvironmentDeploymentTags A map of custom tags to deployment versions. Allows for defining a custom, persistent tag with a changing version number. For example, `dev -> v1.2.3-dev`. This is useful when dealing with DNS LINKED records, where you always want dev.example.com to point to the `dev` version of your app within an environment, where you can continuously deploy and update it without needing to change the record. It is even more useful when you have multiple LINKED records, and you update i.e. `prod“ tag to point to a new version, all records using the `prod` tag are switched at once.

type EnvironmentDeploymentsPruneStep

type EnvironmentDeploymentsPruneStep struct {
	// Action The action that the step takes.
	Action  EnvironmentDeploymentsPruneStepAction `json:"action"`
	Details struct {
		// Environment An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Environment FluidIdentifier `json:"environment"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

EnvironmentDeploymentsPruneStep Remove any containers that are part of a deployment that does NOT have a tag associated with it.

type EnvironmentDeploymentsPruneStepAction

type EnvironmentDeploymentsPruneStepAction string

EnvironmentDeploymentsPruneStepAction The action that the step takes.

const (
	EnvironmentDeploymentsPrune EnvironmentDeploymentsPruneStepAction = "environment.deployments.prune"
)

Defines values for EnvironmentDeploymentsPruneStepAction.

type EnvironmentDeploymentsTagStep

type EnvironmentDeploymentsTagStep struct {
	// Action The action that the step takes.
	Action  EnvironmentDeploymentsTagStepAction `json:"action"`
	Details struct {
		// Deployment The selector for which deployment to apply the new tag to.
		Deployment map[string]interface{} `json:"deployment"`

		// Environment An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Environment FluidIdentifier `json:"environment"`

		// Tag A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
		// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
		// have the identifier of `my-container` and is automatically created by the platform.
		//
		// The identifier does not have to be unique.
		Tag Identifier `json:"tag"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

EnvironmentDeploymentsTagStep Settings for updating a deployment tag to another deployment version.

type EnvironmentDeploymentsTagStepAction

type EnvironmentDeploymentsTagStepAction string

EnvironmentDeploymentsTagStepAction The action that the step takes.

const (
	EnvironmentDeploymentsTag EnvironmentDeploymentsTagStepAction = "environment.deployments.tag"
)

Defines values for EnvironmentDeploymentsTagStepAction.

type EnvironmentFeatures

type EnvironmentFeatures struct {
	// LegacyNetworking Whether or not legacy networking mode is enabled on this environment.
	LegacyNetworking bool `json:"legacy_networking"`

	// Monitoring The level of monitoring to enable for this environment. There is a cost associated with higher levels of monitoring.
	Monitoring *struct {
		// Config The configuration for environment monitoring.
		Config *EnvironmentMonitoringConfig `json:"config,omitempty"`

		// Tier The tier of monitoring, that determines the frequency that metrics are aggregated by the platform, on a per-environment basis.
		Tier MonitoringTier `json:"tier"`
	} `json:"monitoring"`
}

EnvironmentFeatures An object representing specialized features configured for this environment.

type EnvironmentIncludes

type EnvironmentIncludes map[string]Environment

EnvironmentIncludes An identity that is associated with an environment.

type EnvironmentInitializeAction

type EnvironmentInitializeAction struct {
	// Action The name of the action to perform.
	Action EnvironmentInitializeActionAction `json:"action"`
}

EnvironmentInitializeAction A task to initialize an environment.

type EnvironmentInitializeActionAction

type EnvironmentInitializeActionAction string

EnvironmentInitializeActionAction The name of the action to perform.

const (
	EnvironmentInitializeActionActionInitialize EnvironmentInitializeActionAction = "initialize"
)

Defines values for EnvironmentInitializeActionAction.

type EnvironmentMeta

type EnvironmentMeta struct {
	Containers *[]struct {
		// Environment A summary of supplemental environment and network information specific to a container.
		Environment ContainerEnvironmentSummary `json:"environment"`

		// Id A 24 character hex string used to identify a unique resource.
		Id ID `json:"id"`

		// Image The Id of the image and information on if it is a service.
		Image ContainerImageSummary `json:"image"`

		// Name A user defined name for the container resource.
		Name  string         `json:"name"`
		State ContainerState `json:"state"`
	} `json:"containers,omitempty"`

	// ContainersCount A summary of resources by state
	ContainersCount *StateCountSummary `json:"containers_count,omitempty"`

	// InstancesCount A summary of resources by state
	InstancesCount *StateCountSummary `json:"instances_count,omitempty"`

	// ServiceVersions A map where the key is the service and the value describes the version and date of last update.
	ServiceVersions *map[string]struct {
		LastUpdated DateTime `json:"last_updated"`

		// Version A string depicting the service version.
		Version string `json:"version"`
	} `json:"service_versions,omitempty"`
}

EnvironmentMeta A list of meta fields that can be applied to this environment.

type EnvironmentMonitoringConfig added in v0.6.3

type EnvironmentMonitoringConfig struct {
	// Events An object describing the events monitoring configuration for the environment.
	Events *struct {
		// Endpoint Configuration options for pushing events externally.
		// For payload see webhook `environmentEventsPush`
		Endpoint *struct {
			// Url The destination URL for events.
			Url string `json:"url"`
		} `json:"endpoint"`
	} `json:"events"`

	// Logs An object describing the log monitoring configuration for the environment.
	Logs *struct {
		// Drain An object describing log drain configuration for the environment.
		Drain *struct {
			// ExcludeServices If enabled, service logs will not be included in log drain.
			ExcludeServices bool       `json:"exclude_services"`
			Format          *LogFormat `json:"format,omitempty"`

			// Url The destination URL for the log drain.
			Url string `json:"url"`
		} `json:"drain"`
	} `json:"logs"`

	// Metrics An object describing the metrics monitoring configuration for the environment.
	Metrics *struct {
		// Endpoint Configuration options for pushing metrics externally.
		// For payload see webhook `environmentMetricsPush`
		Endpoint *struct {
			// Url The destination URL for the metrics.
			Url string `json:"url"`
		} `json:"endpoint"`
	} `json:"metrics"`
}

EnvironmentMonitoringConfig The configuration for environment monitoring.

type EnvironmentNetworkSummary

type EnvironmentNetworkSummary struct {
	// Id A 24 character hex string used to identify a unique resource.
	Id     ID     `json:"id"`
	Ipv6   *IPNet `json:"ipv6"`
	Legacy *struct {
		Host   int    `json:"host"`
		Ipv4   *IPNet `json:"ipv4"`
		Subnet int    `json:"subnet"`
	} `json:"legacy"`
	MacAddr       string `json:"mac_addr"`
	NetworkSubnet string `json:"network_subnet"`
	Subnet        string `json:"subnet"`
	VxlanTag      int    `json:"vxlan_tag"`
}

EnvironmentNetworkSummary Details about the environment network this instance is a member of.

type EnvironmentReconfigureDeploymentsAction

type EnvironmentReconfigureDeploymentsAction struct {
	// Action The action to take.
	Action   EnvironmentReconfigureDeploymentsActionAction `json:"action"`
	Contents struct {
		// Tags A map of custom tags to deployment versions. Allows for defining a custom, persistent tag with a changing version number.
		// For example, `dev -> v1.2.3-dev`. This is useful when dealing with DNS LINKED records, where you always want dev.example.com to point to the
		// `dev` version of your app within an environment, where you can continuously deploy and update it without needing to change the record. It is
		// even more useful when you have multiple LINKED records, and you update i.e. `prod“ tag to point to a new version, all records using the `prod` tag
		// are switched at once.
		Tags EnvironmentDeploymentTags `json:"tags"`
	} `json:"contents"`
}

EnvironmentReconfigureDeploymentsAction A task to reconfigure deployment mappings on an environment.

type EnvironmentReconfigureDeploymentsActionAction

type EnvironmentReconfigureDeploymentsActionAction string

EnvironmentReconfigureDeploymentsActionAction The action to take.

const (
	DeploymentsReconfigure EnvironmentReconfigureDeploymentsActionAction = "deployments.reconfigure"
)

Defines values for EnvironmentReconfigureDeploymentsActionAction.

type EnvironmentReconfigureMonitoringAction added in v0.6.3

type EnvironmentReconfigureMonitoringAction struct {
	// Action The action to take.
	Action   EnvironmentReconfigureMonitoringActionAction `json:"action"`
	Contents struct {
		// Config The configuration for environment monitoring.
		Config EnvironmentMonitoringConfig `json:"config"`
	} `json:"contents"`
}

EnvironmentReconfigureMonitoringAction A task to reconfigure monitoring on an environment.

type EnvironmentReconfigureMonitoringActionAction added in v0.6.3

type EnvironmentReconfigureMonitoringActionAction string

EnvironmentReconfigureMonitoringActionAction The action to take.

const (
	MonitoringReconfigure EnvironmentReconfigureMonitoringActionAction = "monitoring.reconfigure"
)

Defines values for EnvironmentReconfigureMonitoringActionAction.

type EnvironmentServiceContainerSummary

type EnvironmentServiceContainerSummary struct {
	// AutoUpdate Whether or not the service will be automatically updated as new versions are released. Otherwise, the service will need to be restarted manually.
	AutoUpdate  *bool `json:"auto_update,omitempty"`
	ContainerId *ID   `json:"container_id"`

	// Enable Whether or not the service is enabled.
	Enable bool `json:"enable"`

	// HighAvailability Whether or not the service is deployed in high availability
	HighAvailability bool           `json:"high_availability"`
	State            ContainerState `json:"state"`
}

EnvironmentServiceContainerSummary An object containing information about a service container associated with this environment.

type EnvironmentServices

type EnvironmentServices struct {
	Discovery    *DiscoveryEnvironmentService    `json:"discovery"`
	Gateway      *GatewayEnvironmentService      `json:"gateway"`
	Loadbalancer *LoadBalancerEnvironmentService `json:"loadbalancer"`
	Scheduler    *SchedulerEnvironmentService    `json:"scheduler"`
	Vpn          *VpnEnvironmentService          `json:"vpn"`
}

EnvironmentServices Service containers run by this environment and their configurations.

type EnvironmentStartAction

type EnvironmentStartAction struct {
	// Action The name of the action to perform.
	Action EnvironmentStartActionAction `json:"action"`
}

EnvironmentStartAction A task to start an environment.

type EnvironmentStartActionAction

type EnvironmentStartActionAction string

EnvironmentStartActionAction The name of the action to perform.

const (
	EnvironmentStartActionActionStart EnvironmentStartActionAction = "start"
)

Defines values for EnvironmentStartActionAction.

type EnvironmentStartStep

type EnvironmentStartStep struct {
	// Action The action that the step takes.
	Action  EnvironmentStartStepAction `json:"action"`
	Details struct {
		// Environment An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Environment FluidIdentifier `json:"environment"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

EnvironmentStartStep Settings for starting an environment in a pipeline.

type EnvironmentStartStepAction

type EnvironmentStartStepAction string

EnvironmentStartStepAction The action that the step takes.

const (
	EnvironmentStart EnvironmentStartStepAction = "environment.start"
)

Defines values for EnvironmentStartStepAction.

type EnvironmentState

type EnvironmentState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the environment.
	Current EnvironmentStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

EnvironmentState defines model for EnvironmentState.

type EnvironmentStateCurrent

type EnvironmentStateCurrent string

EnvironmentStateCurrent The current state of the environment.

const (
	EnvironmentStateCurrentCloning  EnvironmentStateCurrent = "cloning"
	EnvironmentStateCurrentDeleted  EnvironmentStateCurrent = "deleted"
	EnvironmentStateCurrentDeleting EnvironmentStateCurrent = "deleting"
	EnvironmentStateCurrentLive     EnvironmentStateCurrent = "live"
	EnvironmentStateCurrentNew      EnvironmentStateCurrent = "new"
)

Defines values for EnvironmentStateCurrent.

type EnvironmentStopAction

type EnvironmentStopAction struct {
	// Action The name of the action to perform.
	Action EnvironmentStopActionAction `json:"action"`
}

EnvironmentStopAction A task to stop an environment.

type EnvironmentStopActionAction

type EnvironmentStopActionAction string

EnvironmentStopActionAction The name of the action to perform.

const (
	EnvironmentStopActionActionStop EnvironmentStopActionAction = "stop"
)

Defines values for EnvironmentStopActionAction.

type EnvironmentStopStep

type EnvironmentStopStep struct {
	// Action The action that the step takes.
	Action  EnvironmentStopStepAction `json:"action"`
	Details struct {
		// Environment An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Environment FluidIdentifier `json:"environment"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

EnvironmentStopStep Settings for stopping an environment in a pipeline.

type EnvironmentStopStepAction

type EnvironmentStopStepAction string

EnvironmentStopStepAction The action that the step takes.

const (
	EnvironmentStop EnvironmentStopStepAction = "environment.stop"
)

Defines values for EnvironmentStopStepAction.

type EnvironmentSummary

type EnvironmentSummary struct {
	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Services An object containing information about the service containers associated with this container. Each key is the name of a service, one of `discovery`, `vpn`, or `loadbalancer`.
	Services struct {
		Discovery    *EnvironmentServiceContainerSummary `json:"discovery"`
		Gateway      *EnvironmentServiceContainerSummary `json:"gateway"`
		Loadbalancer *EnvironmentServiceContainerSummary `json:"loadbalancer"`
		Scheduler    *EnvironmentServiceContainerSummary `json:"scheduler"`
		Vpn          *EnvironmentServiceContainerSummary `json:"vpn"`
	} `json:"services"`
	State EnvironmentState `json:"state"`

	// Stats Statistics about the containers and instances associated with this environment.
	Stats struct {
		// Containers A summary of resources by state
		Containers StateCountSummary `json:"containers"`

		// Instances A summary of resources by state
		Instances StateCountSummary `json:"instances"`

		// Servers A summary of instance counts, keyed by the host server ID.
		Servers *map[string]StateCountSummary `json:"servers,omitempty"`
	} `json:"stats"`
}

EnvironmentSummary Contains useful and relevant data/statistics for an environment that would otherwise be several separate API calls.

type EnvironmentTask added in v0.6.1

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

EnvironmentTask defines model for EnvironmentTask.

func (EnvironmentTask) AsEnvironmentInitializeAction added in v0.6.1

func (t EnvironmentTask) AsEnvironmentInitializeAction() (EnvironmentInitializeAction, error)

AsEnvironmentInitializeAction returns the union data inside the EnvironmentTask as a EnvironmentInitializeAction

func (EnvironmentTask) AsEnvironmentReconfigureDeploymentsAction added in v0.6.1

func (t EnvironmentTask) AsEnvironmentReconfigureDeploymentsAction() (EnvironmentReconfigureDeploymentsAction, error)

AsEnvironmentReconfigureDeploymentsAction returns the union data inside the EnvironmentTask as a EnvironmentReconfigureDeploymentsAction

func (EnvironmentTask) AsEnvironmentReconfigureMonitoringAction added in v0.6.3

func (t EnvironmentTask) AsEnvironmentReconfigureMonitoringAction() (EnvironmentReconfigureMonitoringAction, error)

AsEnvironmentReconfigureMonitoringAction returns the union data inside the EnvironmentTask as a EnvironmentReconfigureMonitoringAction

func (EnvironmentTask) AsEnvironmentStartAction added in v0.6.1

func (t EnvironmentTask) AsEnvironmentStartAction() (EnvironmentStartAction, error)

AsEnvironmentStartAction returns the union data inside the EnvironmentTask as a EnvironmentStartAction

func (EnvironmentTask) AsEnvironmentStopAction added in v0.6.1

func (t EnvironmentTask) AsEnvironmentStopAction() (EnvironmentStopAction, error)

AsEnvironmentStopAction returns the union data inside the EnvironmentTask as a EnvironmentStopAction

func (EnvironmentTask) Discriminator added in v0.6.1

func (t EnvironmentTask) Discriminator() (string, error)

func (*EnvironmentTask) FromEnvironmentInitializeAction added in v0.6.1

func (t *EnvironmentTask) FromEnvironmentInitializeAction(v EnvironmentInitializeAction) error

FromEnvironmentInitializeAction overwrites any union data inside the EnvironmentTask as the provided EnvironmentInitializeAction

func (*EnvironmentTask) FromEnvironmentReconfigureDeploymentsAction added in v0.6.1

func (t *EnvironmentTask) FromEnvironmentReconfigureDeploymentsAction(v EnvironmentReconfigureDeploymentsAction) error

FromEnvironmentReconfigureDeploymentsAction overwrites any union data inside the EnvironmentTask as the provided EnvironmentReconfigureDeploymentsAction

func (*EnvironmentTask) FromEnvironmentReconfigureMonitoringAction added in v0.6.3

func (t *EnvironmentTask) FromEnvironmentReconfigureMonitoringAction(v EnvironmentReconfigureMonitoringAction) error

FromEnvironmentReconfigureMonitoringAction overwrites any union data inside the EnvironmentTask as the provided EnvironmentReconfigureMonitoringAction

func (*EnvironmentTask) FromEnvironmentStartAction added in v0.6.1

func (t *EnvironmentTask) FromEnvironmentStartAction(v EnvironmentStartAction) error

FromEnvironmentStartAction overwrites any union data inside the EnvironmentTask as the provided EnvironmentStartAction

func (*EnvironmentTask) FromEnvironmentStopAction added in v0.6.1

func (t *EnvironmentTask) FromEnvironmentStopAction(v EnvironmentStopAction) error

FromEnvironmentStopAction overwrites any union data inside the EnvironmentTask as the provided EnvironmentStopAction

func (EnvironmentTask) MarshalJSON added in v0.6.1

func (t EnvironmentTask) MarshalJSON() ([]byte, error)

func (*EnvironmentTask) MergeEnvironmentInitializeAction added in v0.6.1

func (t *EnvironmentTask) MergeEnvironmentInitializeAction(v EnvironmentInitializeAction) error

MergeEnvironmentInitializeAction performs a merge with any union data inside the EnvironmentTask, using the provided EnvironmentInitializeAction

func (*EnvironmentTask) MergeEnvironmentReconfigureDeploymentsAction added in v0.6.1

func (t *EnvironmentTask) MergeEnvironmentReconfigureDeploymentsAction(v EnvironmentReconfigureDeploymentsAction) error

MergeEnvironmentReconfigureDeploymentsAction performs a merge with any union data inside the EnvironmentTask, using the provided EnvironmentReconfigureDeploymentsAction

func (*EnvironmentTask) MergeEnvironmentReconfigureMonitoringAction added in v0.6.3

func (t *EnvironmentTask) MergeEnvironmentReconfigureMonitoringAction(v EnvironmentReconfigureMonitoringAction) error

MergeEnvironmentReconfigureMonitoringAction performs a merge with any union data inside the EnvironmentTask, using the provided EnvironmentReconfigureMonitoringAction

func (*EnvironmentTask) MergeEnvironmentStartAction added in v0.6.1

func (t *EnvironmentTask) MergeEnvironmentStartAction(v EnvironmentStartAction) error

MergeEnvironmentStartAction performs a merge with any union data inside the EnvironmentTask, using the provided EnvironmentStartAction

func (*EnvironmentTask) MergeEnvironmentStopAction added in v0.6.1

func (t *EnvironmentTask) MergeEnvironmentStopAction(v EnvironmentStopAction) error

MergeEnvironmentStopAction performs a merge with any union data inside the EnvironmentTask, using the provided EnvironmentStopAction

func (*EnvironmentTask) UnmarshalJSON added in v0.6.1

func (t *EnvironmentTask) UnmarshalJSON(b []byte) error

func (EnvironmentTask) ValueByDiscriminator added in v0.6.1

func (t EnvironmentTask) ValueByDiscriminator() (interface{}, error)

type Error

type Error struct {
	// Code A Cycle standard error code.
	Code *ErrorCode `json:"code,omitempty"`

	// Detail A more detailed description of the error.
	Detail *string `json:"detail,omitempty"`

	// Extra Additional entries on the error object to provide extra details.
	Extra *struct {
		// Capability A capability that a user or API key that represents what an API key or a user can do.
		Capability *Capability `json:"capability,omitempty"`
	} `json:"extra,omitempty"`

	// Source A [JSON pointer](https://tools.ietf.org/html/rfc6901/) describing the source of an error.
	Source *string `json:"source,omitempty"`

	// Status The HTTP response code.
	Status *ErrorStatus `json:"status,omitempty"`

	// Title The main text describing the error.
	Title *string `json:"title,omitempty"`
}

Error The Cycle API uses standard HTTP response codes to indicate the success or failure of an API request. Codes in the `2xx` range indicate success. Codes in the `4xx` range indicate a request that failed due to input, and codes in the `5xx` range indicate an error on Cycle's part (rare). There are two types of error response objects. Errors with authentication are formatted to follow the OAuth spec, while all other errors follow the same convention. If you're using one of our API Libraries, they will standardize OAuth errors to fit the general convention.

type ErrorCode

type ErrorCode string

ErrorCode A Cycle standard error code.

const (
	N400InvalidSyntax                ErrorCode = "400.invalid-syntax"
	N401AuthExpired                  ErrorCode = "401.auth-expired"
	N401AuthInvalid                  ErrorCode = "401.auth-invalid"
	N401NoCookie                     ErrorCode = "401.no-cookie"
	N401UnauthorizedApplication      ErrorCode = "401.unauthorized-application"
	N4032faFailed                    ErrorCode = "403.2fa-failed"
	N4032faRequired                  ErrorCode = "403.2fa-required"
	N403Expired                      ErrorCode = "403.expired"
	N403InvalidIp                    ErrorCode = "403.invalid-ip"
	N403InvalidState                 ErrorCode = "403.invalid-state"
	N403Mismatch                     ErrorCode = "403.mismatch"
	N403NewApplicationCapabilities   ErrorCode = "403.new-application-capabilities"
	N403NotAllowed                   ErrorCode = "403.not-allowed"
	N403NotApproved                  ErrorCode = "403.not-approved"
	N403NotReady                     ErrorCode = "403.not-ready"
	N403Permissions                  ErrorCode = "403.permissions"
	N403PlatformDisabled             ErrorCode = "403.platform-disabled"
	N403RestrictedPortal             ErrorCode = "403.restricted-portal"
	N403TierRestricted               ErrorCode = "403.tier-restricted"
	N403WrongHub                     ErrorCode = "403.wrong-hub"
	N404Account                      ErrorCode = "404.account"
	N404Announcement                 ErrorCode = "404.announcement"
	N404BillingCredit                ErrorCode = "404.billing.credit"
	N404BillingInvoice               ErrorCode = "404.billing.invoice"
	N404BillingOrder                 ErrorCode = "404.billing.order"
	N404BillingPaymentMethod         ErrorCode = "404.billing.payment-method"
	N404BillingPromoCode             ErrorCode = "404.billing.promo-code"
	N404BillingService               ErrorCode = "404.billing.service"
	N404BillingSupport               ErrorCode = "404.billing.support"
	N404BillingTier                  ErrorCode = "404.billing.tier"
	N404Cluster                      ErrorCode = "404.cluster"
	N404CommunityThread              ErrorCode = "404.community.thread"
	N404CommunityThreadReply         ErrorCode = "404.community.thread.reply"
	N404Container                    ErrorCode = "404.container"
	N404ContainerBackup              ErrorCode = "404.container.backup"
	N404CycleosBuild                 ErrorCode = "404.cycleos-build"
	N404DnsRecord                    ErrorCode = "404.dns.record"
	N404DnsZone                      ErrorCode = "404.dns.zone"
	N404EmailVerification            ErrorCode = "404.email-verification"
	N404Environment                  ErrorCode = "404.environment"
	N404EnvironmentScopedVariable    ErrorCode = "404.environment.scoped-variable"
	N404HaServiceSession             ErrorCode = "404.ha-service.session"
	N404Hub                          ErrorCode = "404.hub"
	N404HubApiKey                    ErrorCode = "404.hub.api-key"
	N404HubIntegration               ErrorCode = "404.hub.integration"
	N404HubInvitation                ErrorCode = "404.hub.invitation"
	N404HubMembership                ErrorCode = "404.hub.membership"
	N404HubRole                      ErrorCode = "404.hub.role"
	N404Image                        ErrorCode = "404.image"
	N404ImageBuildLog                ErrorCode = "404.image.build-log"
	N404ImageSource                  ErrorCode = "404.image.source"
	N404InfrastructureAutoscaleGroup ErrorCode = "404.infrastructure.autoscale.group"
	N404InfrastructureCluster        ErrorCode = "404.infrastructure.cluster"
	N404InfrastructureExternalVolume ErrorCode = "404.infrastructure.external-volume"
	N404InfrastructureIpsPool        ErrorCode = "404.infrastructure.ips.pool"
	N404InfrastructureLocation       ErrorCode = "404.infrastructure.location"
	N404InfrastructureModel          ErrorCode = "404.infrastructure.model"
	N404InfrastructureProvider       ErrorCode = "404.infrastructure.provider"
	N404InfrastructureServer         ErrorCode = "404.infrastructure.server"
	N404Instance                     ErrorCode = "404.instance"
	N404Job                          ErrorCode = "404.job"
	N404MonitoringLogsAnalyticsRule  ErrorCode = "404.monitoring.logs.analytics.rule"
	N404Node                         ErrorCode = "404.node"
	N404Notification                 ErrorCode = "404.notification"
	N404Pipeline                     ErrorCode = "404.pipeline"
	N404PipelineKey                  ErrorCode = "404.pipeline.key"
	N404PipelineRun                  ErrorCode = "404.pipeline.run"
	N404PlatformBuild                ErrorCode = "404.platform-build"
	N404Provider                     ErrorCode = "404.provider"
	N404SalesLead                    ErrorCode = "404.sales.lead"
	N404SdnNetwork                   ErrorCode = "404.sdn.network"
	N404Stack                        ErrorCode = "404.stack"
	N404StackBuild                   ErrorCode = "404.stack-build"
	N404StackBuildLog                ErrorCode = "404.stack.build-log"
	N404Survey                       ErrorCode = "404.survey"
	N404SurveyResponse               ErrorCode = "404.survey-response"
	N404Uri                          ErrorCode = "404.uri"
	N404VirtualMachine               ErrorCode = "404.virtual-machine"
	N404VirtualMachineSshKey         ErrorCode = "404.virtual-machine.ssh-key"
	N404VpnAccount                   ErrorCode = "404.vpn.account"
	N409DuplicateFound               ErrorCode = "409.duplicate-found"
	N415InvalidContentType           ErrorCode = "415.invalid-content-type"
	N422AlreadyExists                ErrorCode = "422.already-exists"
	N422InvalidArgument              ErrorCode = "422.invalid-argument"
	N422InvalidInput                 ErrorCode = "422.invalid-input"
	N422MaxExceeded                  ErrorCode = "422.max-exceeded"
	N422MissingArgument              ErrorCode = "422.missing-argument"
	N422NotCompatible                ErrorCode = "422.not-compatible"
	N429RateLimiting                 ErrorCode = "429.rate-limiting"
	N500Database                     ErrorCode = "500.database"
	N500DatabaseInsert               ErrorCode = "500.database-insert"
	N500DatabaseRemove               ErrorCode = "500.database-remove"
	N500DatabaseUpdate               ErrorCode = "500.database-update"
	N500Dev                          ErrorCode = "500.dev"
	N500Email                        ErrorCode = "500.email"
	N500Jobd                         ErrorCode = "500.jobd"
	N500Unknown                      ErrorCode = "500.unknown"
	N503DependencyNotEnabled         ErrorCode = "503.dependency-not-enabled"
	N503NotEnabled                   ErrorCode = "503.not-enabled"
	N503NotReady                     ErrorCode = "503.not-ready"
	N504NotAvailable                 ErrorCode = "504.not-available"
)

Defines values for ErrorCode.

type ErrorEnvelope

type ErrorEnvelope struct {
	Data *map[string]interface{} `json:"data"`

	// Error The Cycle API uses standard HTTP response codes to indicate the success or failure of an API request. Codes in the `2xx` range indicate success. Codes in the `4xx` range indicate a request that failed due to input, and codes in the `5xx` range indicate an error on Cycle's part (rare).
	// There are two types of error response objects. Errors with authentication are formatted to follow the OAuth spec, while all other errors follow the same convention. If you're using one of our API Libraries, they will standardize OAuth errors to fit the general convention.
	Error Error `json:"error"`
}

ErrorEnvelope An error response.

type ErrorStatus

type ErrorStatus int

ErrorStatus The HTTP response code.

const (
	N400 ErrorStatus = 400
	N401 ErrorStatus = 401
	N403 ErrorStatus = 403
	N404 ErrorStatus = 404
	N409 ErrorStatus = 409
	N415 ErrorStatus = 415
	N422 ErrorStatus = 422
	N500 ErrorStatus = 500
	N501 ErrorStatus = 501
	N502 ErrorStatus = 502
	N503 ErrorStatus = 503
	N504 ErrorStatus = 504
)

Defines values for ErrorStatus.

type Event

type Event struct {
	// Labels Additional key-values that can be used for querying in an aggregation pipeline. Often useful for filtering.
	Labels *map[string]string `json:"labels,omitempty"`

	// Metadata Information about this event, such as the type of event, the data it represents, and critical common information such as hub ID and associated cluster.
	Metadata struct {
		// Cluster The cluster associated with this event
		Cluster *string `json:"cluster"`

		// Component The specific resource ID and type associated with this event.
		Component *struct {
			// Id A 24 character hex string used to identify a unique resource.
			Id   ID     `json:"id"`
			Type string `json:"type"`
		} `json:"component"`
		Event EventType `json:"event"`

		// HubId A 24 character hex string used to identify a unique resource.
		HubId *ID `json:"hub_id,omitempty"`

		// Origin The originator of this event.
		Origin string `json:"origin"`

		// Priority Describes how important this event is.
		Priority EventMetadataPriority `json:"priority"`

		// Type The type of event.
		//   - **info**: represents an informational message.
		//   - **warning**: represents a warning message indicating a potential issue.
		//   - **error**: represents an error message indicating a failure or critical issue.
		//   - **success**: represents a success message indicating a successful operation.
		//   - **alert**: represents a critical message indicating a severe issue.
		//   - **notice**: represents a notice message indicating a noteworthy event.
		//   - **audit**: represents a notice message indicating a message that would be needed for audits
		Type EventMetadataType `json:"type"`
	} `json:"metadata"`

	// Tags Additional tags associated with the event.
	Tags *[]string `json:"tags,omitempty"`

	// Text A message describing what happened.
	Text *string  `json:"text,omitempty"`
	Time DateTime `json:"time"`
}

Event A platform-generated event. Describes something happening on the platform at a specific time. Can be informational, security related, or a notice of something important.

type EventMetadataPriority

type EventMetadataPriority string

EventMetadataPriority Describes how important this event is.

const (
	EventMetadataPriorityCritical EventMetadataPriority = "critical"
	EventMetadataPriorityHigh     EventMetadataPriority = "high"
	EventMetadataPriorityLow      EventMetadataPriority = "low"
	EventMetadataPriorityMedium   EventMetadataPriority = "medium"
	EventMetadataPriorityNormal   EventMetadataPriority = "normal"
)

Defines values for EventMetadataPriority.

type EventMetadataType

type EventMetadataType string

EventMetadataType The type of event.

  • **info**: represents an informational message.
  • **warning**: represents a warning message indicating a potential issue.
  • **error**: represents an error message indicating a failure or critical issue.
  • **success**: represents a success message indicating a successful operation.
  • **alert**: represents a critical message indicating a severe issue.
  • **notice**: represents a notice message indicating a noteworthy event.
  • **audit**: represents a notice message indicating a message that would be needed for audits
const (
	EventMetadataTypeAlert   EventMetadataType = "alert"
	EventMetadataTypeAudit   EventMetadataType = "audit"
	EventMetadataTypeError   EventMetadataType = "error"
	EventMetadataTypeInfo    EventMetadataType = "info"
	EventMetadataTypeNotice  EventMetadataType = "notice"
	EventMetadataTypeSuccess EventMetadataType = "success"
	EventMetadataTypeWarning EventMetadataType = "warning"
)

Defines values for EventMetadataType.

type EventType

type EventType string

EventType defines model for EventType.

const (
	ApiSecurityViolation                                 EventType = "api.security_violation"
	ConsoleSosLogin                                      EventType = "console.sos.login"
	ConsoleSosLoginFailed                                EventType = "console.sos.login.failed"
	ConsoleSshLogin                                      EventType = "console.ssh.login"
	ConsoleSshLoginFailed                                EventType = "console.ssh.login.failed"
	ContainerInstanceBackupCompleted                     EventType = "container.instance.backup.completed"
	ContainerInstanceBackupFailed                        EventType = "container.instance.backup.failed"
	ContainerInstanceDeleteFailed                        EventType = "container.instance.delete.failed"
	ContainerInstanceError                               EventType = "container.instance.error"
	ContainerInstanceFunctionMaxRuntime                  EventType = "container.instance.function.max_runtime"
	ContainerInstanceHealthcheckFailed                   EventType = "container.instance.healthcheck.failed"
	ContainerInstanceHealthcheckRecovered                EventType = "container.instance.healthcheck.recovered"
	ContainerInstanceHealthcheckRestarted                EventType = "container.instance.healthcheck.restarted"
	ContainerInstanceMigrationCompleted                  EventType = "container.instance.migration.completed"
	ContainerInstanceMigrationFailed                     EventType = "container.instance.migration.failed"
	ContainerInstanceNetworkInterfacesCreateFailed       EventType = "container.instance.network.interfaces.create.failed"
	ContainerInstanceRestartFailed                       EventType = "container.instance.restart.failed"
	ContainerInstanceRestartMaxRestarts                  EventType = "container.instance.restart.max_restarts"
	ContainerInstanceStartFailed                         EventType = "container.instance.start.failed"
	ContainerInstanceStartPrivileged                     EventType = "container.instance.start.privileged"
	ContainerInstanceStopFailed                          EventType = "container.instance.stop.failed"
	ContainerInstanceVolumeExtendFailed                  EventType = "container.instance.volume.extend.failed"
	ContainerInstancesAutoscaleDown                      EventType = "container.instances.autoscale.down"
	ContainerInstancesAutoscaleUp                        EventType = "container.instances.autoscale.up"
	ContainerReconfiguredPrivileged                      EventType = "container.reconfigured.privileged"
	ContainerVolumesBaseCreateFailed                     EventType = "container.volumes.base.create.failed"
	ContainerVolumesCreateFailed                         EventType = "container.volumes.create.failed"
	EnvironmentServiceAutoUpdate                         EventType = "environment.service.auto_update"
	EnvironmentServiceDiscoveryClientThrottleHit         EventType = "environment.service.discovery.client.throttle.hit"
	EnvironmentServiceGatewayIpsSyncFailed               EventType = "environment.service.gateway.ips.sync.failed"
	EnvironmentServiceLbIpsSyncFailed                    EventType = "environment.service.lb.ips.sync.failed"
	EnvironmentServiceVpnLoginFailed                     EventType = "environment.service.vpn.login.failed"
	InfrastructureClusterResourcesRamFull                EventType = "infrastructure.cluster.resources.ram.full"
	InfrastructureServerAutoscaleUp                      EventType = "infrastructure.server.autoscale.up"
	InfrastructureServerCheckinMissed                    EventType = "infrastructure.server.checkin.missed"
	InfrastructureServerCheckinResumed                   EventType = "infrastructure.server.checkin.resumed"
	InfrastructureServerComputeDied                      EventType = "infrastructure.server.compute.died"
	InfrastructureServerComputeFullRestart               EventType = "infrastructure.server.compute.full_restart"
	InfrastructureServerComputeSharedfsMountsMount       EventType = "infrastructure.server.compute.sharedfs.mounts.mount"
	InfrastructureServerComputeSharedfsMountsMountFailed EventType = "infrastructure.server.compute.sharedfs.mounts.mount.failed"
	InfrastructureServerComputeSoftRestart               EventType = "infrastructure.server.compute.soft_restart"
	InfrastructureServerComputeSpawnerFullRestart        EventType = "infrastructure.server.compute-spawner.full_restart"
	InfrastructureServerComputeStartFailure              EventType = "infrastructure.server.compute.start.failure"
	InfrastructureServerComputeVolumesBaseReconfigured   EventType = "infrastructure.server.compute.volumes.base.reconfigured"
	InfrastructureServerEvacuationCompleted              EventType = "infrastructure.server.evacuation.completed"
	InfrastructureServerEvacuationFailed                 EventType = "infrastructure.server.evacuation.failed"
	InfrastructureServerImageDownloadFailed              EventType = "infrastructure.server.image.download.failed"
	InfrastructureServerInternalApiThrottled             EventType = "infrastructure.server.internal_api.throttled"
	InfrastructureServerManifestSyncFailed               EventType = "infrastructure.server.manifest.sync.failed"
	InfrastructureServerMeshConnectFailed                EventType = "infrastructure.server.mesh.connect.failed"
	InfrastructureServerMonitoringThrottled              EventType = "infrastructure.server.monitoring.throttled"
	InfrastructureServerNeighborIncompatible             EventType = "infrastructure.server.neighbor.incompatible"
	InfrastructureServerNeighborReachable                EventType = "infrastructure.server.neighbor.reachable"
	InfrastructureServerNeighborRebuild                  EventType = "infrastructure.server.neighbor.rebuild"
	InfrastructureServerNeighborUnreachable              EventType = "infrastructure.server.neighbor.unreachable"
	InfrastructureServerNeighborUpgraded                 EventType = "infrastructure.server.neighbor.upgraded"
	InfrastructureServerNeighborsRebuild                 EventType = "infrastructure.server.neighbors.rebuild"
	InfrastructureServerPowerPowerOff                    EventType = "infrastructure.server.power.power_off"
	InfrastructureServerPowerReboot                      EventType = "infrastructure.server.power.reboot"
	InfrastructureServerResourcesLoadHigh                EventType = "infrastructure.server.resources.load.high"
	InfrastructureServerResourcesRamFull                 EventType = "infrastructure.server.resources.ram.full"
	InfrastructureServerResourcesStorageCyclePoolFull    EventType = "infrastructure.server.resources.storage.cycle_pool.full"
	InfrastructureServerResourcesStorageVolumesBaseFull  EventType = "infrastructure.server.resources.storage.volumes.base.full"
	InfrastructureServerSftpLockdown                     EventType = "infrastructure.server.sftp.lockdown"
	InfrastructureServerSftpLogin                        EventType = "infrastructure.server.sftp.login"
	InfrastructureServerSftpLoginFailed                  EventType = "infrastructure.server.sftp.login.failed"
)

Defines values for EventType.

type Events

type Events map[string]DateTime

Events Describes the date and time at which certain events occurred in the lifetime of this resource.

type ExistingSource

type ExistingSource struct {
	// SourceId A 24 character hex string used to identify a unique resource.
	SourceId *ID `json:"source_id,omitempty"`
}

ExistingSource In a stack, specifies an image source ID from which Cycle will derive any values not specified in the stack file. This is useful for avoiding direct placement of credentials in a stack file, for example.

type ExpireInstanceSSHCredentialsResponse

type ExpireInstanceSSHCredentialsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data The number of tokens expired.
		Data struct {
			// Tokens The number of tokens expired.
			Tokens int `json:"tokens"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseExpireInstanceSSHCredentialsResponse

func ParseExpireInstanceSSHCredentialsResponse(rsp *http.Response) (*ExpireInstanceSSHCredentialsResponse, error)

ParseExpireInstanceSSHCredentialsResponse parses an HTTP response from a ExpireInstanceSSHCredentialsWithResponse call

func (ExpireInstanceSSHCredentialsResponse) Status

Status returns HTTPResponse.Status

func (ExpireInstanceSSHCredentialsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ExpireVirtualMachineSosCredentialsResponse

type ExpireVirtualMachineSosCredentialsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data The number of tokens expired.
		Data struct {
			// Tokens The number of tokens expired.
			Tokens int `json:"tokens"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseExpireVirtualMachineSosCredentialsResponse

func ParseExpireVirtualMachineSosCredentialsResponse(rsp *http.Response) (*ExpireVirtualMachineSosCredentialsResponse, error)

ParseExpireVirtualMachineSosCredentialsResponse parses an HTTP response from a ExpireVirtualMachineSosCredentialsWithResponse call

func (ExpireVirtualMachineSosCredentialsResponse) Status

Status returns HTTPResponse.Status

func (ExpireVirtualMachineSosCredentialsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ExportStackJSONBody

type ExportStackJSONBody struct {
	// DeploymentTags Defines which deployment containers to include in the stack export. By default, no containers tagged in a deployment are exported.
	// This option includes all containers with the specific, comma separated deployment tags in the final output in addition to the
	// containers that are not part of any deployment.
	DeploymentTags *[]string `json:"deployment_tags,omitempty"`

	// ResolveOrigins When set to true, Cycle will resolve image origins and inline them into the stack, essentially making this stack portable outside the hub it's currently used in.
	// By default, this is set to false, and the export will just reference existing image sources used by this stack in your hub by ID.
	ResolveOrigins *bool `json:"resolve_origins,omitempty"`
}

ExportStackJSONBody defines parameters for ExportStack.

type ExportStackJSONRequestBody

type ExportStackJSONRequestBody ExportStackJSONBody

ExportStackJSONRequestBody defines body for ExportStack for application/json ContentType.

type ExportStackResponse

type ExportStackResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A Cycle stack file is an "environment as code". This allows an environment to be generated consistently based on a fixed specification.
		// Stack files can describe multiple containers and their configurations, environment service settings, scoped variables, and important metadata.
		Data StackSpec `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseExportStackResponse

func ParseExportStackResponse(rsp *http.Response) (*ExportStackResponse, error)

ParseExportStackResponse parses an HTTP response from a ExportStackWithResponse call

func (ExportStackResponse) Status

func (r ExportStackResponse) Status() string

Status returns HTTPResponse.Status

func (ExportStackResponse) StatusCode

func (r ExportStackResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExternalVolume added in v0.6.5

type ExternalVolume struct {
	// About Additional details about the external volume.
	About ExternalVolumeAbout `json:"about"`

	// Attachment Attachment configuration for an external volume.
	Attachment *ExternalVolumeAttachment `json:"attachment,omitempty"`

	// Cluster A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Cluster Identifier `json:"cluster"`

	// Events Timestamps for events that happen over the lifetime of the attached volume.
	Events ExternalVolumeEvents `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// LocationId A 24 character hex string used to identify a unique resource.
	LocationId ID `json:"location_id"`

	// Meta A list of meta fields that can be applied to an attached volume.
	Meta *ExternalVolumeMeta `json:"meta,omitempty"`

	// Name The name of the external volume.
	Name string `json:"name"`

	// Options Configuration options controlling the behavior of the volume.
	Options   ExternalVolumeOptions `json:"options"`
	ServerIds []ID                  `json:"server_ids"`

	// Size A human-readable data size string. Values are expressed as an integer followed by a unit suffix, without spaces. Supported units:
	//   - b, k, m, g, t, p (bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes)
	//   - An optional "b" suffix may be added (e.g., "mb", "gb").
	// Units are case-insensitive. Example: "512M", "10GB", "1t".
	Size *DataSize `json:"size,omitempty"`

	// Source The source information for this volume.
	Source ExternalVolumeSource `json:"source"`
	State  ExternalVolumeState  `json:"state"`
}

ExternalVolume A persistent storage volume within a cluster. Volumes may be attached to containers or VMs and can originate from different storage sources.

type ExternalVolumeAbout added in v0.6.5

type ExternalVolumeAbout struct {
	// Description Custom details about this external volume.
	Description string `json:"description"`
}

ExternalVolumeAbout Additional details about the external volume.

type ExternalVolumeAttachment added in v0.6.5

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

ExternalVolumeAttachment Attachment configuration for an external volume.

func (ExternalVolumeAttachment) AsExternalVolumeAttachmentBlock added in v0.6.5

func (t ExternalVolumeAttachment) AsExternalVolumeAttachmentBlock() (ExternalVolumeAttachmentBlock, error)

AsExternalVolumeAttachmentBlock returns the union data inside the ExternalVolumeAttachment as a ExternalVolumeAttachmentBlock

func (ExternalVolumeAttachment) AsExternalVolumeAttachmentFileSystem added in v0.6.5

func (t ExternalVolumeAttachment) AsExternalVolumeAttachmentFileSystem() (ExternalVolumeAttachmentFileSystem, error)

AsExternalVolumeAttachmentFileSystem returns the union data inside the ExternalVolumeAttachment as a ExternalVolumeAttachmentFileSystem

func (ExternalVolumeAttachment) Discriminator added in v0.6.5

func (t ExternalVolumeAttachment) Discriminator() (string, error)

func (*ExternalVolumeAttachment) FromExternalVolumeAttachmentBlock added in v0.6.5

func (t *ExternalVolumeAttachment) FromExternalVolumeAttachmentBlock(v ExternalVolumeAttachmentBlock) error

FromExternalVolumeAttachmentBlock overwrites any union data inside the ExternalVolumeAttachment as the provided ExternalVolumeAttachmentBlock

func (*ExternalVolumeAttachment) FromExternalVolumeAttachmentFileSystem added in v0.6.5

func (t *ExternalVolumeAttachment) FromExternalVolumeAttachmentFileSystem(v ExternalVolumeAttachmentFileSystem) error

FromExternalVolumeAttachmentFileSystem overwrites any union data inside the ExternalVolumeAttachment as the provided ExternalVolumeAttachmentFileSystem

func (ExternalVolumeAttachment) MarshalJSON added in v0.6.5

func (t ExternalVolumeAttachment) MarshalJSON() ([]byte, error)

func (*ExternalVolumeAttachment) MergeExternalVolumeAttachmentBlock added in v0.6.5

func (t *ExternalVolumeAttachment) MergeExternalVolumeAttachmentBlock(v ExternalVolumeAttachmentBlock) error

MergeExternalVolumeAttachmentBlock performs a merge with any union data inside the ExternalVolumeAttachment, using the provided ExternalVolumeAttachmentBlock

func (*ExternalVolumeAttachment) MergeExternalVolumeAttachmentFileSystem added in v0.6.5

func (t *ExternalVolumeAttachment) MergeExternalVolumeAttachmentFileSystem(v ExternalVolumeAttachmentFileSystem) error

MergeExternalVolumeAttachmentFileSystem performs a merge with any union data inside the ExternalVolumeAttachment, using the provided ExternalVolumeAttachmentFileSystem

func (*ExternalVolumeAttachment) UnmarshalJSON added in v0.6.5

func (t *ExternalVolumeAttachment) UnmarshalJSON(b []byte) error

func (ExternalVolumeAttachment) ValueByDiscriminator added in v0.6.5

func (t ExternalVolumeAttachment) ValueByDiscriminator() (interface{}, error)

type ExternalVolumeAttachmentBlock added in v0.6.5

type ExternalVolumeAttachmentBlock struct {
	// Details Details for a block attachment. Present when `type` is `block`.
	Details map[string]interface{} `json:"details"`

	// Mode The access mode for the attachment.
	Mode ExternalVolumeAttachmentBlockMode `json:"mode"`
	Type ExternalVolumeAttachmentBlockType `json:"type"`
}

ExternalVolumeAttachmentBlock Configuration for a block volume attachment.

type ExternalVolumeAttachmentBlockMode added in v0.6.5

type ExternalVolumeAttachmentBlockMode string

ExternalVolumeAttachmentBlockMode The access mode for the attachment.

const (
	ExternalVolumeAttachmentBlockModeMultiNodeReadOnly      ExternalVolumeAttachmentBlockMode = "multi-node-read-only"
	ExternalVolumeAttachmentBlockModeMultiNodeWriter        ExternalVolumeAttachmentBlockMode = "multi-node-writer"
	ExternalVolumeAttachmentBlockModeSingleInstanceReadOnly ExternalVolumeAttachmentBlockMode = "single-instance-read-only"
	ExternalVolumeAttachmentBlockModeSingleInstanceWriter   ExternalVolumeAttachmentBlockMode = "single-instance-writer"
	ExternalVolumeAttachmentBlockModeSingleNodeReadOnly     ExternalVolumeAttachmentBlockMode = "single-node-read-only"
	ExternalVolumeAttachmentBlockModeSingleNodeWriter       ExternalVolumeAttachmentBlockMode = "single-node-writer"
)

Defines values for ExternalVolumeAttachmentBlockMode.

type ExternalVolumeAttachmentBlockType added in v0.6.5

type ExternalVolumeAttachmentBlockType string

ExternalVolumeAttachmentBlockType defines model for ExternalVolumeAttachmentBlock.Type.

const (
	Block ExternalVolumeAttachmentBlockType = "block"
)

Defines values for ExternalVolumeAttachmentBlockType.

type ExternalVolumeAttachmentFileSystem added in v0.6.5

type ExternalVolumeAttachmentFileSystem struct {
	// Details Details for a filesystem attachment. Present when `type` is `filesystem`.
	Details map[string]interface{} `json:"details"`

	// Mode The access mode for the attachment.
	Mode ExternalVolumeAttachmentFileSystemMode `json:"mode"`
	Type ExternalVolumeAttachmentFileSystemType `json:"type"`
}

ExternalVolumeAttachmentFileSystem Configuration for a filesystem volume attachment.

type ExternalVolumeAttachmentFileSystemMode added in v0.6.5

type ExternalVolumeAttachmentFileSystemMode string

ExternalVolumeAttachmentFileSystemMode The access mode for the attachment.

const (
	ExternalVolumeAttachmentFileSystemModeMultiNodeReadOnly      ExternalVolumeAttachmentFileSystemMode = "multi-node-read-only"
	ExternalVolumeAttachmentFileSystemModeMultiNodeWriter        ExternalVolumeAttachmentFileSystemMode = "multi-node-writer"
	ExternalVolumeAttachmentFileSystemModeSingleInstanceReadOnly ExternalVolumeAttachmentFileSystemMode = "single-instance-read-only"
	ExternalVolumeAttachmentFileSystemModeSingleInstanceWriter   ExternalVolumeAttachmentFileSystemMode = "single-instance-writer"
	ExternalVolumeAttachmentFileSystemModeSingleNodeReadOnly     ExternalVolumeAttachmentFileSystemMode = "single-node-read-only"
	ExternalVolumeAttachmentFileSystemModeSingleNodeWriter       ExternalVolumeAttachmentFileSystemMode = "single-node-writer"
)

Defines values for ExternalVolumeAttachmentFileSystemMode.

type ExternalVolumeAttachmentFileSystemType added in v0.6.5

type ExternalVolumeAttachmentFileSystemType string

ExternalVolumeAttachmentFileSystemType defines model for ExternalVolumeAttachmentFileSystem.Type.

const (
	Filesystem ExternalVolumeAttachmentFileSystemType = "filesystem"
)

Defines values for ExternalVolumeAttachmentFileSystemType.

type ExternalVolumeAttachmentReconfigureAction added in v0.6.6

type ExternalVolumeAttachmentReconfigureAction struct {
	// Action The name of the action to perform (attachment.reconfigure).
	Action ExternalVolumeAttachmentReconfigureActionAction `json:"action"`

	// Contents Attachment configuration for an external volume.
	Contents *ExternalVolumeAttachment `json:"contents,omitempty"`
}

ExternalVolumeAttachmentReconfigureAction A task to reconfigure the attachment for external volume.

type ExternalVolumeAttachmentReconfigureActionAction added in v0.6.6

type ExternalVolumeAttachmentReconfigureActionAction string

ExternalVolumeAttachmentReconfigureActionAction The name of the action to perform (attachment.reconfigure).

const (
	AttachmentReconfigure ExternalVolumeAttachmentReconfigureActionAction = "attachment.reconfigure"
)

Defines values for ExternalVolumeAttachmentReconfigureActionAction.

type ExternalVolumeEvents added in v0.6.5

type ExternalVolumeEvents struct {
	Created      DateTime  `json:"created"`
	Deleted      DateTime  `json:"deleted"`
	LastSync     *DateTime `json:"last_sync,omitempty"`
	LastVerified *DateTime `json:"last_verified,omitempty"`
	Updated      DateTime  `json:"updated"`
}

ExternalVolumeEvents Timestamps for events that happen over the lifetime of the attached volume.

type ExternalVolumeIncludes added in v0.6.5

type ExternalVolumeIncludes struct {
	Locations *map[string]ProviderLocation `json:"locations,omitempty"`
	Servers   *map[string]Server           `json:"servers,omitempty"`
}

ExternalVolumeIncludes All includable resources linked to the given external volume.

type ExternalVolumeMeta added in v0.6.5

type ExternalVolumeMeta struct {
	Containers *[]ContainerSummary `json:"containers,omitempty"`
}

ExternalVolumeMeta A list of meta fields that can be applied to an attached volume.

type ExternalVolumeOptions added in v0.6.5

type ExternalVolumeOptions struct {
	// Create If the volume doesn't exist, attempt to create it on container start if create struct defined.
	Create *struct {
		// Size A human-readable data size string. Values are expressed as an integer followed by a unit suffix, without spaces. Supported units:
		//   - b, k, m, g, t, p (bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes)
		//   - An optional "b" suffix may be added (e.g., "mb", "gb").
		// Units are case-insensitive. Example: "512M", "10GB", "1t".
		Size DataSize `json:"size"`
	} `json:"create"`
}

ExternalVolumeOptions Configuration options controlling the behavior of the volume.

type ExternalVolumeServersReconfigureAction added in v0.6.5

type ExternalVolumeServersReconfigureAction struct {
	// Action The name of the action to perform (servers.reconfigure).
	Action ExternalVolumeServersReconfigureActionAction `json:"action"`

	// Contents Contents contains an array of server ids to set as mountable destinations for the external volume.
	Contents *[]ID `json:"contents,omitempty"`
}

ExternalVolumeServersReconfigureAction A task to reconfigure mountable destination servers for external volume.

type ExternalVolumeServersReconfigureActionAction added in v0.6.5

type ExternalVolumeServersReconfigureActionAction string

ExternalVolumeServersReconfigureActionAction The name of the action to perform (servers.reconfigure).

const (
	ServersReconfigure ExternalVolumeServersReconfigureActionAction = "servers.reconfigure"
)

Defines values for ExternalVolumeServersReconfigureActionAction.

type ExternalVolumeSource added in v0.6.5

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

ExternalVolumeSource The source information for this volume.

func (ExternalVolumeSource) AsSourceAwsEbs added in v0.6.5

func (t ExternalVolumeSource) AsSourceAwsEbs() (SourceAwsEbs, error)

AsSourceAwsEbs returns the union data inside the ExternalVolumeSource as a SourceAwsEbs

func (ExternalVolumeSource) AsSourceCephRbd added in v0.6.5

func (t ExternalVolumeSource) AsSourceCephRbd() (SourceCephRbd, error)

AsSourceCephRbd returns the union data inside the ExternalVolumeSource as a SourceCephRbd

func (ExternalVolumeSource) AsSourceSanIscsi added in v0.6.5

func (t ExternalVolumeSource) AsSourceSanIscsi() (SourceSanIscsi, error)

AsSourceSanIscsi returns the union data inside the ExternalVolumeSource as a SourceSanIscsi

func (ExternalVolumeSource) Discriminator added in v0.6.5

func (t ExternalVolumeSource) Discriminator() (string, error)

func (*ExternalVolumeSource) FromSourceAwsEbs added in v0.6.5

func (t *ExternalVolumeSource) FromSourceAwsEbs(v SourceAwsEbs) error

FromSourceAwsEbs overwrites any union data inside the ExternalVolumeSource as the provided SourceAwsEbs

func (*ExternalVolumeSource) FromSourceCephRbd added in v0.6.5

func (t *ExternalVolumeSource) FromSourceCephRbd(v SourceCephRbd) error

FromSourceCephRbd overwrites any union data inside the ExternalVolumeSource as the provided SourceCephRbd

func (*ExternalVolumeSource) FromSourceSanIscsi added in v0.6.5

func (t *ExternalVolumeSource) FromSourceSanIscsi(v SourceSanIscsi) error

FromSourceSanIscsi overwrites any union data inside the ExternalVolumeSource as the provided SourceSanIscsi

func (ExternalVolumeSource) MarshalJSON added in v0.6.5

func (t ExternalVolumeSource) MarshalJSON() ([]byte, error)

func (*ExternalVolumeSource) MergeSourceAwsEbs added in v0.6.5

func (t *ExternalVolumeSource) MergeSourceAwsEbs(v SourceAwsEbs) error

MergeSourceAwsEbs performs a merge with any union data inside the ExternalVolumeSource, using the provided SourceAwsEbs

func (*ExternalVolumeSource) MergeSourceCephRbd added in v0.6.5

func (t *ExternalVolumeSource) MergeSourceCephRbd(v SourceCephRbd) error

MergeSourceCephRbd performs a merge with any union data inside the ExternalVolumeSource, using the provided SourceCephRbd

func (*ExternalVolumeSource) MergeSourceSanIscsi added in v0.6.5

func (t *ExternalVolumeSource) MergeSourceSanIscsi(v SourceSanIscsi) error

MergeSourceSanIscsi performs a merge with any union data inside the ExternalVolumeSource, using the provided SourceSanIscsi

func (*ExternalVolumeSource) UnmarshalJSON added in v0.6.5

func (t *ExternalVolumeSource) UnmarshalJSON(b []byte) error

func (ExternalVolumeSource) ValueByDiscriminator added in v0.6.5

func (t ExternalVolumeSource) ValueByDiscriminator() (interface{}, error)

type ExternalVolumeState added in v0.6.5

type ExternalVolumeState struct {
	Changed DateTime `json:"changed"`

	// Current The current lifecycle state of the volume.
	Current ExternalVolumeStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

ExternalVolumeState defines model for ExternalVolumeState.

type ExternalVolumeStateCurrent added in v0.6.5

type ExternalVolumeStateCurrent string

ExternalVolumeStateCurrent The current lifecycle state of the volume.

const (
	ExternalVolumeStateCurrentConfiguring ExternalVolumeStateCurrent = "configuring"
	ExternalVolumeStateCurrentDeleted     ExternalVolumeStateCurrent = "deleted"
	ExternalVolumeStateCurrentDeleting    ExternalVolumeStateCurrent = "deleting"
	ExternalVolumeStateCurrentLive        ExternalVolumeStateCurrent = "live"
	ExternalVolumeStateCurrentNew         ExternalVolumeStateCurrent = "new"
	ExternalVolumeStateCurrentReady       ExternalVolumeStateCurrent = "ready"
)

Defines values for ExternalVolumeStateCurrent.

type ExternalVolumeTask added in v0.6.5

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

ExternalVolumeTask defines model for ExternalVolumeTask.

func (ExternalVolumeTask) AsExternalVolumeAttachmentReconfigureAction added in v0.6.6

func (t ExternalVolumeTask) AsExternalVolumeAttachmentReconfigureAction() (ExternalVolumeAttachmentReconfigureAction, error)

AsExternalVolumeAttachmentReconfigureAction returns the union data inside the ExternalVolumeTask as a ExternalVolumeAttachmentReconfigureAction

func (ExternalVolumeTask) AsExternalVolumeServersReconfigureAction added in v0.6.5

func (t ExternalVolumeTask) AsExternalVolumeServersReconfigureAction() (ExternalVolumeServersReconfigureAction, error)

AsExternalVolumeServersReconfigureAction returns the union data inside the ExternalVolumeTask as a ExternalVolumeServersReconfigureAction

func (ExternalVolumeTask) Discriminator added in v0.6.5

func (t ExternalVolumeTask) Discriminator() (string, error)

func (*ExternalVolumeTask) FromExternalVolumeAttachmentReconfigureAction added in v0.6.6

func (t *ExternalVolumeTask) FromExternalVolumeAttachmentReconfigureAction(v ExternalVolumeAttachmentReconfigureAction) error

FromExternalVolumeAttachmentReconfigureAction overwrites any union data inside the ExternalVolumeTask as the provided ExternalVolumeAttachmentReconfigureAction

func (*ExternalVolumeTask) FromExternalVolumeServersReconfigureAction added in v0.6.5

func (t *ExternalVolumeTask) FromExternalVolumeServersReconfigureAction(v ExternalVolumeServersReconfigureAction) error

FromExternalVolumeServersReconfigureAction overwrites any union data inside the ExternalVolumeTask as the provided ExternalVolumeServersReconfigureAction

func (ExternalVolumeTask) MarshalJSON added in v0.6.5

func (t ExternalVolumeTask) MarshalJSON() ([]byte, error)

func (*ExternalVolumeTask) MergeExternalVolumeAttachmentReconfigureAction added in v0.6.6

func (t *ExternalVolumeTask) MergeExternalVolumeAttachmentReconfigureAction(v ExternalVolumeAttachmentReconfigureAction) error

MergeExternalVolumeAttachmentReconfigureAction performs a merge with any union data inside the ExternalVolumeTask, using the provided ExternalVolumeAttachmentReconfigureAction

func (*ExternalVolumeTask) MergeExternalVolumeServersReconfigureAction added in v0.6.5

func (t *ExternalVolumeTask) MergeExternalVolumeServersReconfigureAction(v ExternalVolumeServersReconfigureAction) error

MergeExternalVolumeServersReconfigureAction performs a merge with any union data inside the ExternalVolumeTask, using the provided ExternalVolumeServersReconfigureAction

func (*ExternalVolumeTask) UnmarshalJSON added in v0.6.5

func (t *ExternalVolumeTask) UnmarshalJSON(b []byte) error

func (ExternalVolumeTask) ValueByDiscriminator added in v0.6.5

func (t ExternalVolumeTask) ValueByDiscriminator() (interface{}, error)

type ExternalVolumesScanAction added in v0.6.6

type ExternalVolumesScanAction struct {
	// Action The action for the external volumes job.
	Action ExternalVolumesScanActionAction `json:"action"`

	// Contents Scan options used by the platform to create the job.
	Contents struct {
		// Cluster A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
		// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
		// have the identifier of `my-container` and is automatically created by the platform.
		//
		// The identifier does not have to be unique.
		Cluster Identifier `json:"cluster"`

		// IntegrationId A 24 character hex string used to identify a unique resource.
		IntegrationId ID `json:"integration_id"`

		// LocationId A 24 character hex string used to identify a unique resource.
		LocationId *ID `json:"location_id,omitempty"`

		// Namespace Optional namespace string to limit the scan scope.
		Namespace *string `json:"namespace"`

		// ServerIds Optional list of server IDs to limit the scan scope.
		ServerIds *[]ID `json:"server_ids"`

		// SourceType Type of external volume system to scan.
		SourceType ExternalVolumesScanActionContentsSourceType `json:"source_type"`
	} `json:"contents"`
}

ExternalVolumesScanAction A task to scan for available external volumes on a given cluster.

type ExternalVolumesScanActionAction added in v0.6.6

type ExternalVolumesScanActionAction string

ExternalVolumesScanActionAction The action for the external volumes job.

const (
	Scan ExternalVolumesScanActionAction = "scan"
)

Defines values for ExternalVolumesScanActionAction.

type ExternalVolumesScanActionContentsSourceType added in v0.6.6

type ExternalVolumesScanActionContentsSourceType string

ExternalVolumesScanActionContentsSourceType Type of external volume system to scan.

const (
	ExternalVolumesScanActionContentsSourceTypeAwsEbs   ExternalVolumesScanActionContentsSourceType = "aws-ebs"
	ExternalVolumesScanActionContentsSourceTypeCephRbd  ExternalVolumesScanActionContentsSourceType = "ceph-rbd"
	ExternalVolumesScanActionContentsSourceTypeSanIscsi ExternalVolumesScanActionContentsSourceType = "san-iscsi"
)

Defines values for ExternalVolumesScanActionContentsSourceType.

type ExternalVolumesTask added in v0.6.6

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

ExternalVolumesTask defines model for ExternalVolumesTask.

func (ExternalVolumesTask) AsExternalVolumesScanAction added in v0.6.6

func (t ExternalVolumesTask) AsExternalVolumesScanAction() (ExternalVolumesScanAction, error)

AsExternalVolumesScanAction returns the union data inside the ExternalVolumesTask as a ExternalVolumesScanAction

func (ExternalVolumesTask) Discriminator added in v0.6.6

func (t ExternalVolumesTask) Discriminator() (string, error)

func (*ExternalVolumesTask) FromExternalVolumesScanAction added in v0.6.6

func (t *ExternalVolumesTask) FromExternalVolumesScanAction(v ExternalVolumesScanAction) error

FromExternalVolumesScanAction overwrites any union data inside the ExternalVolumesTask as the provided ExternalVolumesScanAction

func (ExternalVolumesTask) MarshalJSON added in v0.6.6

func (t ExternalVolumesTask) MarshalJSON() ([]byte, error)

func (*ExternalVolumesTask) MergeExternalVolumesScanAction added in v0.6.6

func (t *ExternalVolumesTask) MergeExternalVolumesScanAction(v ExternalVolumesScanAction) error

MergeExternalVolumesScanAction performs a merge with any union data inside the ExternalVolumesTask, using the provided ExternalVolumesScanAction

func (*ExternalVolumesTask) UnmarshalJSON added in v0.6.6

func (t *ExternalVolumesTask) UnmarshalJSON(b []byte) error

func (ExternalVolumesTask) ValueByDiscriminator added in v0.6.6

func (t ExternalVolumesTask) ValueByDiscriminator() (interface{}, error)

type FeaturesSpec

type FeaturesSpec struct {
	// Extra Provider specific features, allowing for additional, unspecified properties. This is an open map for any key-value pairs, accommodating various types of values.
	Extra *map[string]interface{} `json:"extra"`

	// Hypervisor Indicates if the model supports virtual machines.
	Hypervisor *bool `json:"hypervisor"`

	// Raid The type of RAID supported, if any.
	Raid *string `json:"raid"`
}

FeaturesSpec The spec for server features.

type FilterParam

type FilterParam = map[string]interface{}

FilterParam defines model for FilterParam.

type FluidIdentifier

type FluidIdentifier = string

FluidIdentifier An identifier used in pipelines to refer to different kinds of resources across Cycle.

- `id:<mongo id>`: A raw resource ID - `resource:<a resource identifier>`: A compound identifier pointing to a resource. - `from:<stage/step>`: For referencing a previous pipeline step.

type FunctionRuntimeVariables

type FunctionRuntimeVariables struct {
	// EnvironmentVariables Environment variables to inject into the container.
	EnvironmentVariables *map[string]string `json:"environment_variables"`
}

FunctionRuntimeVariables Variables that affect the runtime of a function container.

type FunctionTask added in v0.6.1

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

FunctionTask defines model for FunctionTask.

func (FunctionTask) AsFunctionTriggerAction added in v0.6.1

func (t FunctionTask) AsFunctionTriggerAction() (FunctionTriggerAction, error)

AsFunctionTriggerAction returns the union data inside the FunctionTask as a FunctionTriggerAction

func (FunctionTask) Discriminator added in v0.6.1

func (t FunctionTask) Discriminator() (string, error)

func (*FunctionTask) FromFunctionTriggerAction added in v0.6.1

func (t *FunctionTask) FromFunctionTriggerAction(v FunctionTriggerAction) error

FromFunctionTriggerAction overwrites any union data inside the FunctionTask as the provided FunctionTriggerAction

func (FunctionTask) MarshalJSON added in v0.6.1

func (t FunctionTask) MarshalJSON() ([]byte, error)

func (*FunctionTask) MergeFunctionTriggerAction added in v0.6.1

func (t *FunctionTask) MergeFunctionTriggerAction(v FunctionTriggerAction) error

MergeFunctionTriggerAction performs a merge with any union data inside the FunctionTask, using the provided FunctionTriggerAction

func (*FunctionTask) UnmarshalJSON added in v0.6.1

func (t *FunctionTask) UnmarshalJSON(b []byte) error

func (FunctionTask) ValueByDiscriminator added in v0.6.1

func (t FunctionTask) ValueByDiscriminator() (interface{}, error)

type FunctionTriggerAction added in v0.6.1

type FunctionTriggerAction struct {
	// Action The name of the action to perform.
	Action   FunctionTriggerActionAction `json:"action"`
	Contents struct {
		// RuntimeVariables Variables that affect the runtime of a function container.
		RuntimeVariables FunctionRuntimeVariables `json:"runtime_variables"`

		// Token A custom token used for identifying and managing a claim. Can be any valid string 5 characters or more.
		Token string `json:"token"`
	} `json:"contents"`
}

FunctionTriggerAction defines model for FunctionTriggerAction.

type FunctionTriggerActionAction added in v0.6.1

type FunctionTriggerActionAction string

FunctionTriggerActionAction The name of the action to perform.

const (
	FunctionTriggerActionActionTrigger FunctionTriggerActionAction = "trigger"
)

Defines values for FunctionTriggerActionAction.

type GPUSpec

type GPUSpec struct {
	// Cores The number of cores.
	Cores *int `json:"cores,omitempty"`

	// Count The number of GPUs.
	Count int `json:"count"`

	// Extra Extra information about the GPU if there is any.
	Extra *map[string]string `json:"extra,omitempty"`

	// Shared A boolean where true represents the GPU is shared.
	Shared *bool `json:"shared,omitempty"`

	// Type The type of the GPU.
	Type string `json:"type"`

	// VramGb The amount of virtaul RAM for the GPU.
	VramGb *int `json:"vram_gb,omitempty"`
}

GPUSpec Information about a given servers GPU resources.

type GatewayEnvironmentService

type GatewayEnvironmentService struct {
	// AutoUpdate A boolean where `true` represents the desire to automatically update the environment gateway service.
	AutoUpdate *bool `json:"auto_update,omitempty"`

	// ContainerId The ID of the gateway service container
	ContainerId string `json:"container_id"`

	// Enable Whether or not the gateway service is enabled.
	Enable bool `json:"enable"`

	// HighAvailability A boolean representing if this service container is set to high availability mode or not.
	HighAvailability bool `json:"high_availability"`
}

GatewayEnvironmentService Information about the environments gateway service(s).

type GenerateAggregatedEventsJSONBody

type GenerateAggregatedEventsJSONBody struct {
	// Criteria The criteria to add to the first match. Cycle will automatically provide the hub ID.
	Criteria *map[string]interface{} `json:"criteria,omitempty"`

	// Pipeline The aggregation pipeline. Supports Mongo-style syntax and operators.
	Pipeline *[]map[string]interface{} `json:"pipeline,omitempty"`
}

GenerateAggregatedEventsJSONBody defines parameters for GenerateAggregatedEvents.

type GenerateAggregatedEventsJSONRequestBody

type GenerateAggregatedEventsJSONRequestBody GenerateAggregatedEventsJSONBody

GenerateAggregatedEventsJSONRequestBody defines body for GenerateAggregatedEvents for application/json ContentType.

type GenerateAggregatedEventsParams

type GenerateAggregatedEventsParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		RangeEnd   *DateTime `json:"range-end,omitempty"`
		RangeStart *DateTime `json:"range-start,omitempty"`
	} `json:"filter,omitempty"`
}

GenerateAggregatedEventsParams defines parameters for GenerateAggregatedEvents.

type GenerateAggregatedEventsResponse

type GenerateAggregatedEventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []map[string]interface{} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGenerateAggregatedEventsResponse

func ParseGenerateAggregatedEventsResponse(rsp *http.Response) (*GenerateAggregatedEventsResponse, error)

ParseGenerateAggregatedEventsResponse parses an HTTP response from a GenerateAggregatedEventsWithResponse call

func (GenerateAggregatedEventsResponse) Status

Status returns HTTPResponse.Status

func (GenerateAggregatedEventsResponse) StatusCode

func (r GenerateAggregatedEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GenerateAggregatedMetricsJSONBody

type GenerateAggregatedMetricsJSONBody struct {
	// Criteria The criteria to add to the first match. Cycle will automatically provide the hub ID.
	Criteria *map[string]interface{} `json:"criteria,omitempty"`

	// Pipeline The aggregation pipeline. Supports Mongo-style syntax and operators.
	Pipeline *[]map[string]interface{} `json:"pipeline,omitempty"`
}

GenerateAggregatedMetricsJSONBody defines parameters for GenerateAggregatedMetrics.

type GenerateAggregatedMetricsJSONRequestBody

type GenerateAggregatedMetricsJSONRequestBody GenerateAggregatedMetricsJSONBody

GenerateAggregatedMetricsJSONRequestBody defines body for GenerateAggregatedMetrics for application/json ContentType.

type GenerateAggregatedMetricsParams

type GenerateAggregatedMetricsParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		RangeEnd   *DateTime `json:"range-end,omitempty"`
		RangeStart *DateTime `json:"range-start,omitempty"`
	} `json:"filter,omitempty"`
}

GenerateAggregatedMetricsParams defines parameters for GenerateAggregatedMetrics.

type GenerateAggregatedMetricsResponse

type GenerateAggregatedMetricsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []map[string]interface{} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGenerateAggregatedMetricsResponse

func ParseGenerateAggregatedMetricsResponse(rsp *http.Response) (*GenerateAggregatedMetricsResponse, error)

ParseGenerateAggregatedMetricsResponse parses an HTTP response from a GenerateAggregatedMetricsWithResponse call

func (GenerateAggregatedMetricsResponse) Status

Status returns HTTPResponse.Status

func (GenerateAggregatedMetricsResponse) StatusCode

func (r GenerateAggregatedMetricsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GenerateInstanceSSHCredentialsResponse

type GenerateInstanceSSHCredentialsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data SSH connection information for a given container instance.
		Data SSHResponse `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGenerateInstanceSSHCredentialsResponse

func ParseGenerateInstanceSSHCredentialsResponse(rsp *http.Response) (*GenerateInstanceSSHCredentialsResponse, error)

ParseGenerateInstanceSSHCredentialsResponse parses an HTTP response from a GenerateInstanceSSHCredentialsWithResponse call

func (GenerateInstanceSSHCredentialsResponse) Status

Status returns HTTPResponse.Status

func (GenerateInstanceSSHCredentialsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GenerateVirtualMachineSosCredentialsResponse

type GenerateVirtualMachineSosCredentialsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Connection details for connecting to a virtual machine using serial-over-SSH.
		Data VirtualMachineSosConnection `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGenerateVirtualMachineSosCredentialsResponse

func ParseGenerateVirtualMachineSosCredentialsResponse(rsp *http.Response) (*GenerateVirtualMachineSosCredentialsResponse, error)

ParseGenerateVirtualMachineSosCredentialsResponse parses an HTTP response from a GenerateVirtualMachineSosCredentialsWithResponse call

func (GenerateVirtualMachineSosCredentialsResponse) Status

Status returns HTTPResponse.Status

func (GenerateVirtualMachineSosCredentialsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetAPIKeyParams

type GetAPIKeyParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetAPIKeyParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetAPIKeyParams defines parameters for GetAPIKey.

type GetAPIKeyParamsInclude

type GetAPIKeyParamsInclude string

GetAPIKeyParamsInclude defines parameters for GetAPIKey.

const (
	GetAPIKeyParamsIncludeRoles GetAPIKeyParamsInclude = "roles"
)

Defines values for GetAPIKeyParamsInclude.

type GetAPIKeyResponse

type GetAPIKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An API key resource
		Data *ApiKey `json:"data,omitempty"`

		// Includes A resource that is associated with an API key.
		Includes *ApiKeyIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetAPIKeyResponse

func ParseGetAPIKeyResponse(rsp *http.Response) (*GetAPIKeyResponse, error)

ParseGetAPIKeyResponse parses an HTTP response from a GetAPIKeyWithResponse call

func (GetAPIKeyResponse) Status

func (r GetAPIKeyResponse) Status() string

Status returns HTTPResponse.Status

func (GetAPIKeyResponse) StatusCode

func (r GetAPIKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAccountInvitesParams

type GetAccountInvitesParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta    *[]GetAccountInvitesParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
	Include *MembershipIncludeParam        `form:"include,omitempty" json:"include,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetAccountInvitesParams defines parameters for GetAccountInvites.

type GetAccountInvitesParamsInclude

type GetAccountInvitesParamsInclude string

GetAccountInvitesParamsInclude defines parameters for GetAccountInvites.

const (
	GetAccountInvitesParamsIncludeHubs    GetAccountInvitesParamsInclude = "hubs"
	GetAccountInvitesParamsIncludeRoles   GetAccountInvitesParamsInclude = "roles"
	GetAccountInvitesParamsIncludeSenders GetAccountInvitesParamsInclude = "senders"
)

Defines values for GetAccountInvitesParamsInclude.

type GetAccountInvitesParamsMeta

type GetAccountInvitesParamsMeta string

GetAccountInvitesParamsMeta defines parameters for GetAccountInvites.

const (
	GetAccountInvitesParamsMetaCapabilities GetAccountInvitesParamsMeta = "capabilities"
)

Defines values for GetAccountInvitesParamsMeta.

type GetAccountInvitesResponse

type GetAccountInvitesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []HubMembership `json:"data"`

		// Includes A resource that is associated with an account's membership.
		Includes *AccountMembershipIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetAccountInvitesResponse

func ParseGetAccountInvitesResponse(rsp *http.Response) (*GetAccountInvitesResponse, error)

ParseGetAccountInvitesResponse parses an HTTP response from a GetAccountInvitesWithResponse call

func (GetAccountInvitesResponse) Status

func (r GetAccountInvitesResponse) Status() string

Status returns HTTPResponse.Status

func (GetAccountInvitesResponse) StatusCode

func (r GetAccountInvitesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAccountLoginsParams

type GetAccountLoginsParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetAccountLoginsParams defines parameters for GetAccountLogins.

type GetAccountLoginsResponse

type GetAccountLoginsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []map[string]interface{} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetAccountLoginsResponse

func ParseGetAccountLoginsResponse(rsp *http.Response) (*GetAccountLoginsResponse, error)

ParseGetAccountLoginsResponse parses an HTTP response from a GetAccountLoginsWithResponse call

func (GetAccountLoginsResponse) Status

func (r GetAccountLoginsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAccountLoginsResponse) StatusCode

func (r GetAccountLoginsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAccountMembershipsParams

type GetAccountMembershipsParams struct {
	Include *MembershipIncludeParam `form:"include,omitempty" json:"include,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetAccountMembershipsParams defines parameters for GetAccountMemberships.

type GetAccountMembershipsParamsInclude

type GetAccountMembershipsParamsInclude string

GetAccountMembershipsParamsInclude defines parameters for GetAccountMemberships.

const (
	GetAccountMembershipsParamsIncludeHubs    GetAccountMembershipsParamsInclude = "hubs"
	GetAccountMembershipsParamsIncludeRoles   GetAccountMembershipsParamsInclude = "roles"
	GetAccountMembershipsParamsIncludeSenders GetAccountMembershipsParamsInclude = "senders"
)

Defines values for GetAccountMembershipsParamsInclude.

type GetAccountMembershipsResponse

type GetAccountMembershipsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []HubMembership `json:"data"`

		// Includes A resource that is associated with a hub membership.
		Includes *HubMembershipIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetAccountMembershipsResponse

func ParseGetAccountMembershipsResponse(rsp *http.Response) (*GetAccountMembershipsResponse, error)

ParseGetAccountMembershipsResponse parses an HTTP response from a GetAccountMembershipsWithResponse call

func (GetAccountMembershipsResponse) Status

Status returns HTTPResponse.Status

func (GetAccountMembershipsResponse) StatusCode

func (r GetAccountMembershipsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAccountResponse

type GetAccountResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An object representing information about the currently logged-in user.
		Data *Account `json:"data,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetAccountResponse

func ParseGetAccountResponse(rsp *http.Response) (*GetAccountResponse, error)

ParseGetAccountResponse parses an HTTP response from a GetAccountWithResponse call

func (GetAccountResponse) Status

func (r GetAccountResponse) Status() string

Status returns HTTPResponse.Status

func (GetAccountResponse) StatusCode

func (r GetAccountResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllPipelineRunsParams added in v0.6.6

type GetAllPipelineRunsParams struct {
	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetAllPipelineRunsParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetAllPipelineRunsParams defines parameters for GetAllPipelineRuns.

type GetAllPipelineRunsParamsInclude added in v0.6.6

type GetAllPipelineRunsParamsInclude string

GetAllPipelineRunsParamsInclude defines parameters for GetAllPipelineRuns.

const (
	GetAllPipelineRunsParamsIncludeCreators  GetAllPipelineRunsParamsInclude = "creators"
	GetAllPipelineRunsParamsIncludeKeys      GetAllPipelineRunsParamsInclude = "keys"
	GetAllPipelineRunsParamsIncludePipelines GetAllPipelineRunsParamsInclude = "pipelines"
)

Defines values for GetAllPipelineRunsParamsInclude.

type GetAllPipelineRunsResponse added in v0.6.6

type GetAllPipelineRunsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []PipelineRun `json:"data"`

		// Includes Resources related to a pipeline run, that can be included on supported endpoints when the matching includes query parameter is passed.
		Includes *PipelineRunIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetAllPipelineRunsResponse added in v0.6.6

func ParseGetAllPipelineRunsResponse(rsp *http.Response) (*GetAllPipelineRunsResponse, error)

ParseGetAllPipelineRunsResponse parses an HTTP response from a GetAllPipelineRunsWithResponse call

func (GetAllPipelineRunsResponse) Status added in v0.6.6

Status returns HTTPResponse.Status

func (GetAllPipelineRunsResponse) StatusCode added in v0.6.6

func (r GetAllPipelineRunsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllStackBuildsParams added in v0.6.6

type GetAllStackBuildsParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetAllStackBuildsParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Search `filter[search]=value` search for a value associated with a field on the given Stack Build(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the Stack Build's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetAllStackBuildsParams defines parameters for GetAllStackBuilds.

type GetAllStackBuildsParamsMeta added in v0.6.6

type GetAllStackBuildsParamsMeta string

GetAllStackBuildsParamsMeta defines parameters for GetAllStackBuilds.

const (
	GetAllStackBuildsParamsMetaContainersCount GetAllStackBuildsParamsMeta = "containers_count"
)

Defines values for GetAllStackBuildsParamsMeta.

type GetAllStackBuildsResponse added in v0.6.6

type GetAllStackBuildsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []StackBuild `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetAllStackBuildsResponse added in v0.6.6

func ParseGetAllStackBuildsResponse(rsp *http.Response) (*GetAllStackBuildsResponse, error)

ParseGetAllStackBuildsResponse parses an HTTP response from a GetAllStackBuildsWithResponse call

func (GetAllStackBuildsResponse) Status added in v0.6.6

func (r GetAllStackBuildsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllStackBuildsResponse) StatusCode added in v0.6.6

func (r GetAllStackBuildsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllTlsCertificatesParams added in v0.6.6

type GetAllTlsCertificatesParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Domain `filter[domain]=value1` filter user certificates by associated domain.
		Domain *string `json:"domain,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow filtering by the current state.
		State *string `json:"state,omitempty"`

		// UserSupplied `filter[user-supplied]=true` List only those certificates that are user supplied.
		// `filter[user-supplied]=false` List only those certificates that are auto generated.
		UserSupplied *string `json:"user-supplied,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetAllTlsCertificatesParams defines parameters for GetAllTlsCertificates.

type GetAllTlsCertificatesResponse added in v0.6.6

type GetAllTlsCertificatesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []TlsCertificate `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetAllTlsCertificatesResponse added in v0.6.6

func ParseGetAllTlsCertificatesResponse(rsp *http.Response) (*GetAllTlsCertificatesResponse, error)

ParseGetAllTlsCertificatesResponse parses an HTTP response from a GetAllTlsCertificatesWithResponse call

func (GetAllTlsCertificatesResponse) Status added in v0.6.6

Status returns HTTPResponse.Status

func (GetAllTlsCertificatesResponse) StatusCode added in v0.6.6

func (r GetAllTlsCertificatesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAnnouncementsParams

type GetAnnouncementsParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Range The start date from when to fetch the Announcements
		Range *GetAnnouncementsParamsFilterRange `json:"range,omitempty"`

		// Resolved Get only Announcements that have been resolved, or only those that have not.
		Resolved *GetAnnouncementsParamsFilterResolved `json:"resolved,omitempty"`
	} `json:"filter,omitempty"`
}

GetAnnouncementsParams defines parameters for GetAnnouncements.

type GetAnnouncementsParamsFilterRange

type GetAnnouncementsParamsFilterRange string

GetAnnouncementsParamsFilterRange defines parameters for GetAnnouncements.

Defines values for GetAnnouncementsParamsFilterRange.

type GetAnnouncementsParamsFilterResolved

type GetAnnouncementsParamsFilterResolved string

GetAnnouncementsParamsFilterResolved defines parameters for GetAnnouncements.

Defines values for GetAnnouncementsParamsFilterResolved.

type GetAnnouncementsResponse

type GetAnnouncementsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Announcement `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetAnnouncementsResponse

func ParseGetAnnouncementsResponse(rsp *http.Response) (*GetAnnouncementsResponse, error)

ParseGetAnnouncementsResponse parses an HTTP response from a GetAnnouncementsWithResponse call

func (GetAnnouncementsResponse) Status

func (r GetAnnouncementsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAnnouncementsResponse) StatusCode

func (r GetAnnouncementsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiKeysParams

type GetApiKeysParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetApiKeysParams defines parameters for GetApiKeys.

type GetApiKeysResponse

type GetApiKeysResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []ApiKey `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetApiKeysResponse

func ParseGetApiKeysResponse(rsp *http.Response) (*GetApiKeysResponse, error)

ParseGetApiKeysResponse parses an HTTP response from a GetApiKeysWithResponse call

func (GetApiKeysResponse) Status

func (r GetApiKeysResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiKeysResponse) StatusCode

func (r GetApiKeysResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAutoScaleGroupParams

type GetAutoScaleGroupParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetAutoScaleGroupParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetAutoScaleGroupParams defines parameters for GetAutoScaleGroup.

type GetAutoScaleGroupParamsInclude

type GetAutoScaleGroupParamsInclude string

GetAutoScaleGroupParamsInclude defines parameters for GetAutoScaleGroup.

const (
	GetAutoScaleGroupParamsIncludeIntegrations GetAutoScaleGroupParamsInclude = "integrations"
	GetAutoScaleGroupParamsIncludeLocations    GetAutoScaleGroupParamsInclude = "locations"
	GetAutoScaleGroupParamsIncludeModels       GetAutoScaleGroupParamsInclude = "models"
)

Defines values for GetAutoScaleGroupParamsInclude.

type GetAutoScaleGroupResponse

type GetAutoScaleGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data AutoScaleGroup `json:"data"`

		// Includes All includable resource linkable to the given auto-scale group.
		Includes *AutoScaleGroupIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetAutoScaleGroupResponse

func ParseGetAutoScaleGroupResponse(rsp *http.Response) (*GetAutoScaleGroupResponse, error)

ParseGetAutoScaleGroupResponse parses an HTTP response from a GetAutoScaleGroupWithResponse call

func (GetAutoScaleGroupResponse) Status

func (r GetAutoScaleGroupResponse) Status() string

Status returns HTTPResponse.Status

func (GetAutoScaleGroupResponse) StatusCode

func (r GetAutoScaleGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAutoScaleGroupsParams

type GetAutoScaleGroupsParams struct {
	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetAutoScaleGroupsParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Cluster `filter[cluster]=value` return a list of auto-scale groups that are associated with the specified cluster.
		Cluster *string `json:"cluster,omitempty"`

		// Identifier `filter[identifier]=value` list only those auto-scale groups matching this identifier. May return multiple results.
		Identifier *string `json:"identifier,omitempty"`

		// Search `filter[search]=value` search for a value associated with a field on the given auto-scale group(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`
}

GetAutoScaleGroupsParams defines parameters for GetAutoScaleGroups.

type GetAutoScaleGroupsParamsInclude

type GetAutoScaleGroupsParamsInclude string

GetAutoScaleGroupsParamsInclude defines parameters for GetAutoScaleGroups.

const (
	GetAutoScaleGroupsParamsIncludeIntegrations GetAutoScaleGroupsParamsInclude = "integrations"
	GetAutoScaleGroupsParamsIncludeLocations    GetAutoScaleGroupsParamsInclude = "locations"
	GetAutoScaleGroupsParamsIncludeModels       GetAutoScaleGroupsParamsInclude = "models"
)

Defines values for GetAutoScaleGroupsParamsInclude.

type GetAutoScaleGroupsResponse

type GetAutoScaleGroupsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []AutoScaleGroup `json:"data"`

		// Includes All includable resource linkable to the given auto-scale group.
		Includes *AutoScaleGroupIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetAutoScaleGroupsResponse

func ParseGetAutoScaleGroupsResponse(rsp *http.Response) (*GetAutoScaleGroupsResponse, error)

ParseGetAutoScaleGroupsResponse parses an HTTP response from a GetAutoScaleGroupsWithResponse call

func (GetAutoScaleGroupsResponse) Status

Status returns HTTPResponse.Status

func (GetAutoScaleGroupsResponse) StatusCode

func (r GetAutoScaleGroupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAvailableIntegrationsResponse

type GetAvailableIntegrationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			Billing                  *[]IntegrationDefinition `json:"billing"`
			ImageBuilders            *[]IntegrationDefinition `json:"image-builders"`
			InfrastructureProvider   *[]IntegrationDefinition `json:"infrastructure-provider"`
			ObjectStorage            *[]IntegrationDefinition `json:"object-storage"`
			TlsCertificateGeneration *[]IntegrationDefinition `json:"tls-certificate-generation"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetAvailableIntegrationsResponse

func ParseGetAvailableIntegrationsResponse(rsp *http.Response) (*GetAvailableIntegrationsResponse, error)

ParseGetAvailableIntegrationsResponse parses an HTTP response from a GetAvailableIntegrationsWithResponse call

func (GetAvailableIntegrationsResponse) Status

Status returns HTTPResponse.Status

func (GetAvailableIntegrationsResponse) StatusCode

func (r GetAvailableIntegrationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAvailableIpsResponse

type GetAvailableIpsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Ip `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetAvailableIpsResponse

func ParseGetAvailableIpsResponse(rsp *http.Response) (*GetAvailableIpsResponse, error)

ParseGetAvailableIpsResponse parses an HTTP response from a GetAvailableIpsWithResponse call

func (GetAvailableIpsResponse) Status

func (r GetAvailableIpsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAvailableIpsResponse) StatusCode

func (r GetAvailableIpsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBillingMethodResponse

type GetBillingMethodResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Information about a billing method, usable to pay invoices.
		Data Method `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetBillingMethodResponse

func ParseGetBillingMethodResponse(rsp *http.Response) (*GetBillingMethodResponse, error)

ParseGetBillingMethodResponse parses an HTTP response from a GetBillingMethodWithResponse call

func (GetBillingMethodResponse) Status

func (r GetBillingMethodResponse) Status() string

Status returns HTTPResponse.Status

func (GetBillingMethodResponse) StatusCode

func (r GetBillingMethodResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBillingMethodsParams

type GetBillingMethodsParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetBillingMethodsParams defines parameters for GetBillingMethods.

type GetBillingMethodsResponse

type GetBillingMethodsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Method `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetBillingMethodsResponse

func ParseGetBillingMethodsResponse(rsp *http.Response) (*GetBillingMethodsResponse, error)

ParseGetBillingMethodsResponse parses an HTTP response from a GetBillingMethodsWithResponse call

func (GetBillingMethodsResponse) Status

func (r GetBillingMethodsResponse) Status() string

Status returns HTTPResponse.Status

func (GetBillingMethodsResponse) StatusCode

func (r GetBillingMethodsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBillingOrderParams

type GetBillingOrderParams struct {
	Meta    *[]GetBillingOrderParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
	Include *OrderIncludeParam           `form:"include,omitempty" json:"include,omitempty"`
}

GetBillingOrderParams defines parameters for GetBillingOrder.

type GetBillingOrderParamsInclude

type GetBillingOrderParamsInclude string

GetBillingOrderParamsInclude defines parameters for GetBillingOrder.

const (
	GetBillingOrderParamsIncludePromoCodes GetBillingOrderParamsInclude = "promo_codes"
)

Defines values for GetBillingOrderParamsInclude.

type GetBillingOrderParamsMeta

type GetBillingOrderParamsMeta string

GetBillingOrderParamsMeta defines parameters for GetBillingOrder.

const (
	GetBillingOrderParamsMetaDue GetBillingOrderParamsMeta = "due"
)

Defines values for GetBillingOrderParamsMeta.

type GetBillingOrderResponse

type GetBillingOrderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An order is a resource that describes a billing order
		Data     Order                 `json:"data"`
		Includes *BillingOrderIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetBillingOrderResponse

func ParseGetBillingOrderResponse(rsp *http.Response) (*GetBillingOrderResponse, error)

ParseGetBillingOrderResponse parses an HTTP response from a GetBillingOrderWithResponse call

func (GetBillingOrderResponse) Status

func (r GetBillingOrderResponse) Status() string

Status returns HTTPResponse.Status

func (GetBillingOrderResponse) StatusCode

func (r GetBillingOrderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBillingOveragesParams

type GetBillingOveragesParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetBillingOveragesParams defines parameters for GetBillingOverages.

type GetBillingOveragesResponse

type GetBillingOveragesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Overage `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetBillingOveragesResponse

func ParseGetBillingOveragesResponse(rsp *http.Response) (*GetBillingOveragesResponse, error)

ParseGetBillingOveragesResponse parses an HTTP response from a GetBillingOveragesWithResponse call

func (GetBillingOveragesResponse) Status

Status returns HTTPResponse.Status

func (GetBillingOveragesResponse) StatusCode

func (r GetBillingOveragesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBillingServiceResponse

type GetBillingServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Information about billing service.
		Data BillingService `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetBillingServiceResponse

func ParseGetBillingServiceResponse(rsp *http.Response) (*GetBillingServiceResponse, error)

ParseGetBillingServiceResponse parses an HTTP response from a GetBillingServiceWithResponse call

func (GetBillingServiceResponse) Status

func (r GetBillingServiceResponse) Status() string

Status returns HTTPResponse.Status

func (GetBillingServiceResponse) StatusCode

func (r GetBillingServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBillingServicesParams

type GetBillingServicesParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetBillingServicesParams defines parameters for GetBillingServices.

type GetBillingServicesResponse

type GetBillingServicesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []BillingService `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetBillingServicesResponse

func ParseGetBillingServicesResponse(rsp *http.Response) (*GetBillingServicesResponse, error)

ParseGetBillingServicesResponse parses an HTTP response from a GetBillingServicesWithResponse call

func (GetBillingServicesResponse) Status

Status returns HTTPResponse.Status

func (GetBillingServicesResponse) StatusCode

func (r GetBillingServicesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBillingStatusResponse added in v0.6.2

type GetBillingStatusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			// Enabled Whether billing is enabled for this core. Generally, this will only be false for dedicated cores.
			Enabled *bool `json:"enabled,omitempty"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetBillingStatusResponse added in v0.6.2

func ParseGetBillingStatusResponse(rsp *http.Response) (*GetBillingStatusResponse, error)

ParseGetBillingStatusResponse parses an HTTP response from a GetBillingStatusWithResponse call

func (GetBillingStatusResponse) Status added in v0.6.2

func (r GetBillingStatusResponse) Status() string

Status returns HTTPResponse.Status

func (GetBillingStatusResponse) StatusCode added in v0.6.2

func (r GetBillingStatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBillingSupportPlansParams

type GetBillingSupportPlansParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetBillingSupportPlansParams defines parameters for GetBillingSupportPlans.

type GetBillingSupportPlansResponse

type GetBillingSupportPlansResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []SupportPlan `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetBillingSupportPlansResponse

func ParseGetBillingSupportPlansResponse(rsp *http.Response) (*GetBillingSupportPlansResponse, error)

ParseGetBillingSupportPlansResponse parses an HTTP response from a GetBillingSupportPlansWithResponse call

func (GetBillingSupportPlansResponse) Status

Status returns HTTPResponse.Status

func (GetBillingSupportPlansResponse) StatusCode

func (r GetBillingSupportPlansResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBillingTiersResponse

type GetBillingTiersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []TierPlan `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetBillingTiersResponse

func ParseGetBillingTiersResponse(rsp *http.Response) (*GetBillingTiersResponse, error)

ParseGetBillingTiersResponse parses an HTTP response from a GetBillingTiersWithResponse call

func (GetBillingTiersResponse) Status

func (r GetBillingTiersResponse) Status() string

Status returns HTTPResponse.Status

func (GetBillingTiersResponse) StatusCode

func (r GetBillingTiersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetChangelogParams added in v0.6.4

type GetChangelogParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetChangelogParams defines parameters for GetChangelog.

type GetChangelogResponse added in v0.6.4

type GetChangelogResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data *[]ChangelogEntry `json:"data,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetChangelogResponse added in v0.6.4

func ParseGetChangelogResponse(rsp *http.Response) (*GetChangelogResponse, error)

ParseGetChangelogResponse parses an HTTP response from a GetChangelogWithResponse call

func (GetChangelogResponse) Status added in v0.6.4

func (r GetChangelogResponse) Status() string

Status returns HTTPResponse.Status

func (GetChangelogResponse) StatusCode added in v0.6.4

func (r GetChangelogResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetClusterMonitoringTiersResponse added in v0.6.3

type GetClusterMonitoringTiersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data map[string]MonitoringTierDetails `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetClusterMonitoringTiersResponse added in v0.6.3

func ParseGetClusterMonitoringTiersResponse(rsp *http.Response) (*GetClusterMonitoringTiersResponse, error)

ParseGetClusterMonitoringTiersResponse parses an HTTP response from a GetClusterMonitoringTiersWithResponse call

func (GetClusterMonitoringTiersResponse) Status added in v0.6.3

Status returns HTTPResponse.Status

func (GetClusterMonitoringTiersResponse) StatusCode added in v0.6.3

func (r GetClusterMonitoringTiersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetClusterResponse

type GetClusterResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Clusters are groups of servers that allow physical separation of resources.
		Data Cluster `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetClusterResponse

func ParseGetClusterResponse(rsp *http.Response) (*GetClusterResponse, error)

ParseGetClusterResponse parses an HTTP response from a GetClusterWithResponse call

func (GetClusterResponse) Status

func (r GetClusterResponse) Status() string

Status returns HTTPResponse.Status

func (GetClusterResponse) StatusCode

func (r GetClusterResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetClustersParams

type GetClustersParams struct {
	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Essential `filter[essential]=true` filter for essential/non-essential clusters.
		Essential *string `json:"essential,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the cluster's current state.
		//        `filter[stack_build]=ID` stack build filtering by ID.  Submit the ID of the stack build you wish to filter for and the return sill be any environments that have the stack build deployed to them.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`
}

GetClustersParams defines parameters for GetClusters.

type GetClustersResponse

type GetClustersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Cluster `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetClustersResponse

func ParseGetClustersResponse(rsp *http.Response) (*GetClustersResponse, error)

ParseGetClustersResponse parses an HTTP response from a GetClustersWithResponse call

func (GetClustersResponse) Status

func (r GetClustersResponse) Status() string

Status returns HTTPResponse.Status

func (GetClustersResponse) StatusCode

func (r GetClustersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCompatibleImagesParams

type GetCompatibleImagesParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetCompatibleImagesParams defines parameters for GetCompatibleImages.

type GetCompatibleImagesResponse

type GetCompatibleImagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Image `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetCompatibleImagesResponse

func ParseGetCompatibleImagesResponse(rsp *http.Response) (*GetCompatibleImagesResponse, error)

ParseGetCompatibleImagesResponse parses an HTTP response from a GetCompatibleImagesWithResponse call

func (GetCompatibleImagesResponse) Status

Status returns HTTPResponse.Status

func (GetCompatibleImagesResponse) StatusCode

func (r GetCompatibleImagesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCompatibleServersParams

type GetCompatibleServersParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetCompatibleServersParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetCompatibleServersParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetCompatibleServersParams defines parameters for GetCompatibleServers.

type GetCompatibleServersParamsInclude

type GetCompatibleServersParamsInclude string

GetCompatibleServersParamsInclude defines parameters for GetCompatibleServers.

const (
	GetCompatibleServersParamsIncludeIntegrations GetCompatibleServersParamsInclude = "integrations"
	GetCompatibleServersParamsIncludeLocation     GetCompatibleServersParamsInclude = "location"
	GetCompatibleServersParamsIncludeModels       GetCompatibleServersParamsInclude = "models"
)

Defines values for GetCompatibleServersParamsInclude.

type GetCompatibleServersParamsMeta

type GetCompatibleServersParamsMeta string

GetCompatibleServersParamsMeta defines parameters for GetCompatibleServers.

const (
	GetCompatibleServersParamsMetaInstancesCount GetCompatibleServersParamsMeta = "instances_count"
	GetCompatibleServersParamsMetaNode           GetCompatibleServersParamsMeta = "node"
)

Defines values for GetCompatibleServersParamsMeta.

type GetCompatibleServersResponse

type GetCompatibleServersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Server `json:"data"`

		// Includes A resource associated with a server.
		Includes *ServerIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetCompatibleServersResponse

func ParseGetCompatibleServersResponse(rsp *http.Response) (*GetCompatibleServersResponse, error)

ParseGetCompatibleServersResponse parses an HTTP response from a GetCompatibleServersWithResponse call

func (GetCompatibleServersResponse) Status

Status returns HTTPResponse.Status

func (GetCompatibleServersResponse) StatusCode

func (r GetCompatibleServersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetContainerBackupLogsResponse

type GetContainerBackupLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []ContainerBackupLogs `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetContainerBackupLogsResponse

func ParseGetContainerBackupLogsResponse(rsp *http.Response) (*GetContainerBackupLogsResponse, error)

ParseGetContainerBackupLogsResponse parses an HTTP response from a GetContainerBackupLogsWithResponse call

func (GetContainerBackupLogsResponse) Status

Status returns HTTPResponse.Status

func (GetContainerBackupLogsResponse) StatusCode

func (r GetContainerBackupLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetContainerBackupParams

type GetContainerBackupParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetContainerBackupParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetContainerBackupParams defines parameters for GetContainerBackup.

type GetContainerBackupParamsInclude

type GetContainerBackupParamsInclude string

GetContainerBackupParamsInclude defines parameters for GetContainerBackup.

const (
	GetContainerBackupParamsIncludeIntegrations GetContainerBackupParamsInclude = "integrations"
)

Defines values for GetContainerBackupParamsInclude.

type GetContainerBackupResponse

type GetContainerBackupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A Container Backup.
		Data ContainerBackup `json:"data"`

		// Includes All includable resources linkable to the given Zone.
		Includes *ContainerBackupIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetContainerBackupResponse

func ParseGetContainerBackupResponse(rsp *http.Response) (*GetContainerBackupResponse, error)

ParseGetContainerBackupResponse parses an HTTP response from a GetContainerBackupWithResponse call

func (GetContainerBackupResponse) Status

Status returns HTTPResponse.Status

func (GetContainerBackupResponse) StatusCode

func (r GetContainerBackupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetContainerBackupsParams

type GetContainerBackupsParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetContainerBackupsParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetContainerBackupsParams defines parameters for GetContainerBackups.

type GetContainerBackupsParamsInclude

type GetContainerBackupsParamsInclude string

GetContainerBackupsParamsInclude defines parameters for GetContainerBackups.

const (
	GetContainerBackupsParamsIncludeIntegrations GetContainerBackupsParamsInclude = "integrations"
)

Defines values for GetContainerBackupsParamsInclude.

type GetContainerBackupsResponse

type GetContainerBackupsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []ContainerBackup `json:"data"`

		// Includes All includable resources linkable to the given Zone.
		Includes *ContainerBackupIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetContainerBackupsResponse

func ParseGetContainerBackupsResponse(rsp *http.Response) (*GetContainerBackupsResponse, error)

ParseGetContainerBackupsResponse parses an HTTP response from a GetContainerBackupsWithResponse call

func (GetContainerBackupsResponse) Status

Status returns HTTPResponse.Status

func (GetContainerBackupsResponse) StatusCode

func (r GetContainerBackupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetContainerParams

type GetContainerParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetContainerParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetContainerParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetContainerParams defines parameters for GetContainer.

type GetContainerParamsInclude

type GetContainerParamsInclude string

GetContainerParamsInclude defines parameters for GetContainer.

const (
	GetContainerParamsIncludeCreators     GetContainerParamsInclude = "creators"
	GetContainerParamsIncludeEnvironments GetContainerParamsInclude = "environments"
	GetContainerParamsIncludeImages       GetContainerParamsInclude = "images"
	GetContainerParamsIncludeStackBuilds  GetContainerParamsInclude = "stack_builds"
	GetContainerParamsIncludeStacks       GetContainerParamsInclude = "stacks"
)

Defines values for GetContainerParamsInclude.

type GetContainerParamsMeta

type GetContainerParamsMeta string

GetContainerParamsMeta defines parameters for GetContainer.

const (
	GetContainerParamsMetaDomains        GetContainerParamsMeta = "domains"
	GetContainerParamsMetaInstancesCount GetContainerParamsMeta = "instances_count"
	GetContainerParamsMetaIps            GetContainerParamsMeta = "ips"
)

Defines values for GetContainerParamsMeta.

type GetContainerResponse

type GetContainerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Containers are a way to package together your application along with it's dependencies, and run in a resource isolated process. They provide consistency across different hosts, efficiency over traditional hosting methods, and facilitate a micro-service based approach, where each logical piece of your application is split into multiple, easily testable parts (such as API, Backend, Frontend, etc).
		Data Container `json:"data"`

		// Includes All includable resources linkable to the given container.
		Includes *ContainerIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetContainerResponse

func ParseGetContainerResponse(rsp *http.Response) (*GetContainerResponse, error)

ParseGetContainerResponse parses an HTTP response from a GetContainerWithResponse call

func (GetContainerResponse) Status

func (r GetContainerResponse) Status() string

Status returns HTTPResponse.Status

func (GetContainerResponse) StatusCode

func (r GetContainerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetContainerServersParams

type GetContainerServersParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetContainerServersParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetContainerServersParams defines parameters for GetContainerServers.

type GetContainerServersParamsMeta

type GetContainerServersParamsMeta string

GetContainerServersParamsMeta defines parameters for GetContainerServers.

const (
	PrimaryIp GetContainerServersParamsMeta = "primary_ip"
)

Defines values for GetContainerServersParamsMeta.

type GetContainerServersResponse

type GetContainerServersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A Server ID and number of Instances of a specific Container it hosts.
		Data ServerInstancesSummary `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetContainerServersResponse

func ParseGetContainerServersResponse(rsp *http.Response) (*GetContainerServersResponse, error)

ParseGetContainerServersResponse parses an HTTP response from a GetContainerServersWithResponse call

func (GetContainerServersResponse) Status

Status returns HTTPResponse.Status

func (GetContainerServersResponse) StatusCode

func (r GetContainerServersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetContainerSummaryResponse

type GetContainerSummaryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Contains useful and relevant data/statistics for a container that would otherwise be several separate API calls.
		Data struct {
			// Id A 24 character hex string used to identify a unique resource.
			Id    ID                 `json:"id"`
			State ContainerState     `json:"state"`
			Stats *StateCountSummary `json:"stats"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetContainerSummaryResponse

func ParseGetContainerSummaryResponse(rsp *http.Response) (*GetContainerSummaryResponse, error)

ParseGetContainerSummaryResponse parses an HTTP response from a GetContainerSummaryWithResponse call

func (GetContainerSummaryResponse) Status

Status returns HTTPResponse.Status

func (GetContainerSummaryResponse) StatusCode

func (r GetContainerSummaryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetContainersParams

type GetContainersParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetContainersParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetContainersParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Creator `filter[creator]=account-ID` filter for containers matching a particular creator, such as `account-ID` or `environment-ID`
		Creator *string `json:"creator,omitempty"`

		// Deployment `filter[deployment]=v1,v2` filter containers by deployment(s).
		Deployment *string `json:"deployment,omitempty"`

		// DeploymentStrategy `filter[deployment_strategy]=strategy` deployment strategy filtering by strategy string.  Submit the deployment strategy (example: "function") of the strategy you wish to filter for and the return will be any containers matching that description.
		DeploymentStrategy *string `json:"deployment_strategy,omitempty"`

		// Deprecated `filter[deprecated]=true` filter for containers that are deprecated.
		Deprecated *string `json:"deprecated,omitempty"`

		// Environment `filter[environment]=ID` environment filtering by ID.  Submit the ID of the environment you wish to filter for and the return will be any containers in that environment.
		Environment *string `json:"environment,omitempty"`

		// Identifier `filter[identifier]=value` List only those containers matching this identifier. May return multiple results.
		Identifier *string `json:"identifier,omitempty"`

		// Image `filter[image]=ID` image filtering by ID.  Submit the ID of the image you wish to filter for and the return will be any containers currently using the image.
		Image *string `json:"image,omitempty"`

		// PublicNetwork `filter[public_network]=value` public network filtering will allow you to filter by the containers network settings: `enabled`, `disabled`, `egress-only`.
		PublicNetwork *string   `json:"public_network,omitempty"`
		RangeEnd      *DateTime `json:"range-end,omitempty"`
		RangeStart    *DateTime `json:"range-start,omitempty"`

		// Search `filter[search]=value` search containers for a value associated with a field on the given container(s).
		Search *string `json:"search,omitempty"`

		// Service `filter[service]=value` service filtering will allow you to filter by service type: `loadbalancer`, `discovery`, `vpn`.
		Service *string `json:"service,omitempty"`

		// Stack `filter[stack]=ID` stack filtering by ID.  Submit the ID of the stack you wish to filter for and the return will be any containers deployed associated with 'containers' from the stack.
		Stack *string `json:"stack,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the container's current state.
		State *string `json:"state,omitempty"`

		// Tags `filter[tags]=tagone,tagtwo,tagthree` container filtering using server tags. If the container has the tags you submit it will be part of the return.
		Tags *string `json:"tags,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetContainersParams defines parameters for GetContainers.

type GetContainersParamsInclude

type GetContainersParamsInclude string

GetContainersParamsInclude defines parameters for GetContainers.

const (
	GetContainersParamsIncludeCreators     GetContainersParamsInclude = "creators"
	GetContainersParamsIncludeEnvironments GetContainersParamsInclude = "environments"
	GetContainersParamsIncludeImages       GetContainersParamsInclude = "images"
	GetContainersParamsIncludeStackBuilds  GetContainersParamsInclude = "stack_builds"
	GetContainersParamsIncludeStacks       GetContainersParamsInclude = "stacks"
)

Defines values for GetContainersParamsInclude.

type GetContainersParamsMeta

type GetContainersParamsMeta string

GetContainersParamsMeta defines parameters for GetContainers.

const (
	GetContainersParamsMetaDomains        GetContainersParamsMeta = "domains"
	GetContainersParamsMetaInstancesCount GetContainersParamsMeta = "instances_count"
	GetContainersParamsMetaIps            GetContainersParamsMeta = "ips"
)

Defines values for GetContainersParamsMeta.

type GetContainersResponse

type GetContainersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Container `json:"data"`

		// Includes All includable resources linkable to the given container.
		Includes *ContainerIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetContainersResponse

func ParseGetContainersResponse(rsp *http.Response) (*GetContainersResponse, error)

ParseGetContainersResponse parses an HTTP response from a GetContainersWithResponse call

func (GetContainersResponse) Status

func (r GetContainersResponse) Status() string

Status returns HTTPResponse.Status

func (GetContainersResponse) StatusCode

func (r GetContainersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCreditResponse

type GetCreditResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Information about a billing credit.
		Data Credit `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetCreditResponse

func ParseGetCreditResponse(rsp *http.Response) (*GetCreditResponse, error)

ParseGetCreditResponse parses an HTTP response from a GetCreditWithResponse call

func (GetCreditResponse) Status

func (r GetCreditResponse) Status() string

Status returns HTTPResponse.Status

func (GetCreditResponse) StatusCode

func (r GetCreditResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCreditsParams

type GetCreditsParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Search Use a text-based search to filter the credits.
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the credit's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetCreditsParams defines parameters for GetCredits.

type GetCreditsResponse

type GetCreditsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Credit `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetCreditsResponse

func ParseGetCreditsResponse(rsp *http.Response) (*GetCreditsResponse, error)

ParseGetCreditsResponse parses an HTTP response from a GetCreditsWithResponse call

func (GetCreditsResponse) Status

func (r GetCreditsResponse) Status() string

Status returns HTTPResponse.Status

func (GetCreditsResponse) StatusCode

func (r GetCreditsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDNSZoneRecordsParams

type GetDNSZoneRecordsParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *RecordIncludeParam `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// State `filter[state]=value1,value2` state filtering will allow you to filter by the DNS record's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetDNSZoneRecordsParams defines parameters for GetDNSZoneRecords.

type GetDNSZoneRecordsParamsInclude

type GetDNSZoneRecordsParamsInclude string

GetDNSZoneRecordsParamsInclude defines parameters for GetDNSZoneRecords.

const (
	GetDNSZoneRecordsParamsIncludeContainers                 GetDNSZoneRecordsParamsInclude = "containers"
	GetDNSZoneRecordsParamsIncludeContainersIdentifiers      GetDNSZoneRecordsParamsInclude = "containers:identifiers"
	GetDNSZoneRecordsParamsIncludeCreators                   GetDNSZoneRecordsParamsInclude = "creators"
	GetDNSZoneRecordsParamsIncludeVirtualMachines            GetDNSZoneRecordsParamsInclude = "virtual-machines"
	GetDNSZoneRecordsParamsIncludeVirtualMachinesIdentifiers GetDNSZoneRecordsParamsInclude = "virtual-machines:identifiers"
)

Defines values for GetDNSZoneRecordsParamsInclude.

type GetDNSZoneRecordsResponse

type GetDNSZoneRecordsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []DnsRecord `json:"data"`

		// Includes All includable resources linkable to the given records.
		Includes *RecordIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetDNSZoneRecordsResponse

func ParseGetDNSZoneRecordsResponse(rsp *http.Response) (*GetDNSZoneRecordsResponse, error)

ParseGetDNSZoneRecordsResponse parses an HTTP response from a GetDNSZoneRecordsWithResponse call

func (GetDNSZoneRecordsResponse) Status

func (r GetDNSZoneRecordsResponse) Status() string

Status returns HTTPResponse.Status

func (GetDNSZoneRecordsResponse) StatusCode

func (r GetDNSZoneRecordsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDNSZoneResponse

type GetDNSZoneResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data DNS (Domain Name System), in short, is a decentralized naming system for computers, services, or other resources connected to the internet or a private network. It is what allows the translation of a URL, such as http://example.com, to an IP address.
		Data DnsZone `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetDNSZoneResponse

func ParseGetDNSZoneResponse(rsp *http.Response) (*GetDNSZoneResponse, error)

ParseGetDNSZoneResponse parses an HTTP response from a GetDNSZoneWithResponse call

func (GetDNSZoneResponse) Status

func (r GetDNSZoneResponse) Status() string

Status returns HTTPResponse.Status

func (GetDNSZoneResponse) StatusCode

func (r GetDNSZoneResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDNSZonesParams

type GetDNSZonesParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetDNSZonesParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// State `filter[state]=value1,value2` state filtering will allow you to filter by the DNS Zone's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetDNSZonesParams defines parameters for GetDNSZones.

type GetDNSZonesParamsInclude

type GetDNSZonesParamsInclude string

GetDNSZonesParamsInclude defines parameters for GetDNSZones.

const (
	GetDNSZonesParamsIncludeCreators GetDNSZonesParamsInclude = "creators"
)

Defines values for GetDNSZonesParamsInclude.

type GetDNSZonesResponse

type GetDNSZonesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []DnsZone `json:"data"`

		// Includes All includable resources linkable to the given Zone.
		Includes *DnsZoneIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetDNSZonesResponse

func ParseGetDNSZonesResponse(rsp *http.Response) (*GetDNSZonesResponse, error)

ParseGetDNSZonesResponse parses an HTTP response from a GetDNSZonesWithResponse call

func (GetDNSZonesResponse) Status

func (r GetDNSZonesResponse) Status() string

Status returns HTTPResponse.Status

func (GetDNSZonesResponse) StatusCode

func (r GetDNSZonesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDefaultHubRolesResponse

type GetDefaultHubRolesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []struct {
			Capabilities struct {
				// All If true, the role has all capabilities.
				All      bool         `json:"all"`
				Specific []Capability `json:"specific"`
			} `json:"capabilities"`

			// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
			// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
			// have the identifier of `my-container` and is automatically created by the platform.
			//
			// The identifier does not have to be unique.
			Identifier Identifier `json:"identifier"`
			Name       string     `json:"name"`

			// Root The role marked as root has full moderation control over all roles.
			Root bool `json:"root"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetDefaultHubRolesResponse

func ParseGetDefaultHubRolesResponse(rsp *http.Response) (*GetDefaultHubRolesResponse, error)

ParseGetDefaultHubRolesResponse parses an HTTP response from a GetDefaultHubRolesWithResponse call

func (GetDefaultHubRolesResponse) Status

Status returns HTTPResponse.Status

func (GetDefaultHubRolesResponse) StatusCode

func (r GetDefaultHubRolesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDeploymentStrategiesResponse

type GetDeploymentStrategiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			// Distributed Information about supported container deployment strategies.
			Distributed *DeploymentStrategy `json:"distributed,omitempty"`

			// Edge Information about supported container deployment strategies.
			Edge *DeploymentStrategy `json:"edge,omitempty"`

			// FirstAvailable Information about supported container deployment strategies.
			FirstAvailable *DeploymentStrategy `json:"first-available,omitempty"`

			// Function Information about supported container deployment strategies.
			Function *DeploymentStrategy `json:"function,omitempty"`

			// HighAvailability Information about supported container deployment strategies.
			HighAvailability *DeploymentStrategy `json:"high-availability,omitempty"`

			// Manual Information about supported container deployment strategies.
			Manual *DeploymentStrategy `json:"manual,omitempty"`

			// Node Information about supported container deployment strategies.
			Node *DeploymentStrategy `json:"node,omitempty"`

			// ResourceDensity Information about supported container deployment strategies.
			ResourceDensity *DeploymentStrategy `json:"resource-density,omitempty"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetDeploymentStrategiesResponse

func ParseGetDeploymentStrategiesResponse(rsp *http.Response) (*GetDeploymentStrategiesResponse, error)

ParseGetDeploymentStrategiesResponse parses an HTTP response from a GetDeploymentStrategiesWithResponse call

func (GetDeploymentStrategiesResponse) Status

Status returns HTTPResponse.Status

func (GetDeploymentStrategiesResponse) StatusCode

func (r GetDeploymentStrategiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEnvironmentDeploymentsResponse

type GetEnvironmentDeploymentsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			// Versions A map where the key is the version property of a deployment.
			Versions map[string]struct {
				// Containers The number of containers utilizing this version of this deployment.
				Containers int `json:"containers"`

				// Tags An array of all tags on this environment that point to this version.
				Tags []Identifier `json:"tags"`
			} `json:"versions"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetEnvironmentDeploymentsResponse

func ParseGetEnvironmentDeploymentsResponse(rsp *http.Response) (*GetEnvironmentDeploymentsResponse, error)

ParseGetEnvironmentDeploymentsResponse parses an HTTP response from a GetEnvironmentDeploymentsWithResponse call

func (GetEnvironmentDeploymentsResponse) Status

Status returns HTTPResponse.Status

func (GetEnvironmentDeploymentsResponse) StatusCode

func (r GetEnvironmentDeploymentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEnvironmentParams

type GetEnvironmentParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetEnvironmentParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetEnvironmentParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetEnvironmentParams defines parameters for GetEnvironment.

type GetEnvironmentParamsInclude

type GetEnvironmentParamsInclude string

GetEnvironmentParamsInclude defines parameters for GetEnvironment.

const (
	GetEnvironmentParamsIncludeClusters GetEnvironmentParamsInclude = "clusters"
	GetEnvironmentParamsIncludeCreators GetEnvironmentParamsInclude = "creators"
	GetEnvironmentParamsIncludeStacks   GetEnvironmentParamsInclude = "stacks"
)

Defines values for GetEnvironmentParamsInclude.

type GetEnvironmentParamsMeta

type GetEnvironmentParamsMeta string

GetEnvironmentParamsMeta defines parameters for GetEnvironment.

const (
	GetEnvironmentParamsMetaContainers      GetEnvironmentParamsMeta = "containers"
	GetEnvironmentParamsMetaContainersCount GetEnvironmentParamsMeta = "containers_count"
	GetEnvironmentParamsMetaInstancesCount  GetEnvironmentParamsMeta = "instances_count"
	GetEnvironmentParamsMetaServiceVersions GetEnvironmentParamsMeta = "service_versions"
)

Defines values for GetEnvironmentParamsMeta.

type GetEnvironmentResponse

type GetEnvironmentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Environments are groups of containers with a private network built between them. For more information on environments, see the [main docs](https://cycle.io/docs/platform/introduction-to-environments).
		Data     Environment `json:"data"`
		Includes *struct {
			// Clusters A resource associated with a cluster.
			Clusters *ClusterIncludes `json:"clusters,omitempty"`

			// Creators An identity that created a resource.
			Creators *CreatorInclude `json:"creators,omitempty"`
		} `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetEnvironmentResponse

func ParseGetEnvironmentResponse(rsp *http.Response) (*GetEnvironmentResponse, error)

ParseGetEnvironmentResponse parses an HTTP response from a GetEnvironmentWithResponse call

func (GetEnvironmentResponse) Status

func (r GetEnvironmentResponse) Status() string

Status returns HTTPResponse.Status

func (GetEnvironmentResponse) StatusCode

func (r GetEnvironmentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEnvironmentSummaryResponse

type GetEnvironmentSummaryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Contains useful and relevant data/statistics for an environment that would otherwise be several separate API calls.
		Data EnvironmentSummary `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetEnvironmentSummaryResponse

func ParseGetEnvironmentSummaryResponse(rsp *http.Response) (*GetEnvironmentSummaryResponse, error)

ParseGetEnvironmentSummaryResponse parses an HTTP response from a GetEnvironmentSummaryWithResponse call

func (GetEnvironmentSummaryResponse) Status

Status returns HTTPResponse.Status

func (GetEnvironmentSummaryResponse) StatusCode

func (r GetEnvironmentSummaryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEnvironmentsParams

type GetEnvironmentsParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetEnvironmentsParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetEnvironmentsParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Creator `filter[creator]=account-ID` filter for environments matching a particular creator, such as `account-ID`.
		Creator *string `json:"creator,omitempty"`

		// Identifier `filter[identifier]=value` List only those environments matching this identifier. May return multiple results.
		Identifier *string `json:"identifier,omitempty"`

		// Search `filter[search]=value` search for a value associated with a field on the given environment(s).
		Search *string `json:"search,omitempty"`

		// StackBuild `filter[stack_build]=ID` stack build filtering by ID.  Submit the ID of the stack build you wish to filter for and the return sill be any environments that have the stack build deployed to them.
		StackBuild *string `json:"stack_build,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the environment's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetEnvironmentsParams defines parameters for GetEnvironments.

type GetEnvironmentsParamsInclude

type GetEnvironmentsParamsInclude string

GetEnvironmentsParamsInclude defines parameters for GetEnvironments.

const (
	GetEnvironmentsParamsIncludeCreators GetEnvironmentsParamsInclude = "creators"
	GetEnvironmentsParamsIncludeStacks   GetEnvironmentsParamsInclude = "stacks"
)

Defines values for GetEnvironmentsParamsInclude.

type GetEnvironmentsParamsMeta

type GetEnvironmentsParamsMeta string

GetEnvironmentsParamsMeta defines parameters for GetEnvironments.

const (
	GetEnvironmentsParamsMetaContainers      GetEnvironmentsParamsMeta = "containers"
	GetEnvironmentsParamsMetaContainersCount GetEnvironmentsParamsMeta = "containers_count"
	GetEnvironmentsParamsMetaInstancesCount  GetEnvironmentsParamsMeta = "instances_count"
	GetEnvironmentsParamsMetaServiceVersions GetEnvironmentsParamsMeta = "service_versions"
)

Defines values for GetEnvironmentsParamsMeta.

type GetEnvironmentsResponse

type GetEnvironmentsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data     []Environment `json:"data"`
		Includes *struct {
			// Creators An identity that created a resource.
			Creators *CreatorInclude `json:"creators,omitempty"`
		} `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetEnvironmentsResponse

func ParseGetEnvironmentsResponse(rsp *http.Response) (*GetEnvironmentsResponse, error)

ParseGetEnvironmentsResponse parses an HTTP response from a GetEnvironmentsWithResponse call

func (GetEnvironmentsResponse) Status

func (r GetEnvironmentsResponse) Status() string

Status returns HTTPResponse.Status

func (GetEnvironmentsResponse) StatusCode

func (r GetEnvironmentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEventsParams

type GetEventsParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	//
	// To search via labels, use `label:<label key>` as the filter. For example in URL parameters, `filter[label:test]=abc`.
	Filter *GetEventsParams_Filter `json:"filter,omitempty"`
}

GetEventsParams defines parameters for GetEvents.

type GetEventsParamsFilterType

type GetEventsParamsFilterType string

GetEventsParamsFilterType defines parameters for GetEvents.

const (
	GetEventsParamsFilterTypeAlert   GetEventsParamsFilterType = "alert"
	GetEventsParamsFilterTypeAudit   GetEventsParamsFilterType = "audit"
	GetEventsParamsFilterTypeError   GetEventsParamsFilterType = "error"
	GetEventsParamsFilterTypeInfo    GetEventsParamsFilterType = "info"
	GetEventsParamsFilterTypeNotice  GetEventsParamsFilterType = "notice"
	GetEventsParamsFilterTypeSuccess GetEventsParamsFilterType = "success"
	GetEventsParamsFilterTypeWarning GetEventsParamsFilterType = "warning"
)

Defines values for GetEventsParamsFilterType.

type GetEventsParams_Filter

type GetEventsParams_Filter struct {
	// Cluster Specify the cluster associated with the events.
	Cluster *string `json:"cluster,omitempty"`

	// Container A 24 character hex string used to identify a unique resource.
	Container *ID `json:"container,omitempty"`

	// Environment A 24 character hex string used to identify a unique resource.
	Environment *ID        `json:"environment,omitempty"`
	Event       *EventType `json:"event,omitempty"`

	// Pipeline A 24 character hex string used to identify a unique resource.
	Pipeline   *ID       `json:"pipeline,omitempty"`
	RangeEnd   *DateTime `json:"range-end,omitempty"`
	RangeStart *DateTime `json:"range-start,omitempty"`

	// Stack A 24 character hex string used to identify a unique resource.
	Stack *ID `json:"stack,omitempty"`

	// Tags Filter by tags associated with the events.
	Tags *string `json:"tags,omitempty"`

	// Type Filter by the type of event.
	Type                 *GetEventsParamsFilterType `json:"type,omitempty"`
	AdditionalProperties map[string]interface{}     `json:"-"`
}

GetEventsParams_Filter defines parameters for GetEvents.

func (GetEventsParams_Filter) Get

func (a GetEventsParams_Filter) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for GetEventsParams_Filter. Returns the specified element and whether it was found

func (GetEventsParams_Filter) MarshalJSON

func (a GetEventsParams_Filter) MarshalJSON() ([]byte, error)

Override default JSON handling for GetEventsParams_Filter to handle AdditionalProperties

func (*GetEventsParams_Filter) Set

func (a *GetEventsParams_Filter) Set(fieldName string, value interface{})

Setter for additional properties for GetEventsParams_Filter

func (*GetEventsParams_Filter) UnmarshalJSON

func (a *GetEventsParams_Filter) UnmarshalJSON(b []byte) error

Override default JSON handling for GetEventsParams_Filter to handle AdditionalProperties

type GetEventsResponse

type GetEventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Event `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetEventsResponse

func ParseGetEventsResponse(rsp *http.Response) (*GetEventsResponse, error)

ParseGetEventsResponse parses an HTTP response from a GetEventsWithResponse call

func (GetEventsResponse) Status

func (r GetEventsResponse) Status() string

Status returns HTTPResponse.Status

func (GetEventsResponse) StatusCode

func (r GetEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetExternalVolumeParams added in v0.6.5

type GetExternalVolumeParams struct {
	// Meta A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
	// In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
	// In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetExternalVolumeParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]GetExternalVolumeParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetExternalVolumeParams defines parameters for GetExternalVolume.

type GetExternalVolumeParamsInclude added in v0.6.5

type GetExternalVolumeParamsInclude string

GetExternalVolumeParamsInclude defines parameters for GetExternalVolume.

const (
	GetExternalVolumeParamsIncludeLocations GetExternalVolumeParamsInclude = "locations"
	GetExternalVolumeParamsIncludeServers   GetExternalVolumeParamsInclude = "servers"
)

Defines values for GetExternalVolumeParamsInclude.

type GetExternalVolumeParamsMeta added in v0.6.5

type GetExternalVolumeParamsMeta string

GetExternalVolumeParamsMeta defines parameters for GetExternalVolume.

const (
	GetExternalVolumeParamsMetaContainers GetExternalVolumeParamsMeta = "containers"
)

Defines values for GetExternalVolumeParamsMeta.

type GetExternalVolumeResponse added in v0.6.5

type GetExternalVolumeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A persistent storage volume within a cluster. Volumes may be attached to containers or VMs and can originate from different storage sources.
		Data ExternalVolume `json:"data"`

		// Includes All includable resources linked to the given external volume.
		Includes *ExternalVolumeIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetExternalVolumeResponse added in v0.6.5

func ParseGetExternalVolumeResponse(rsp *http.Response) (*GetExternalVolumeResponse, error)

ParseGetExternalVolumeResponse parses an HTTP response from a GetExternalVolumeWithResponse call

func (GetExternalVolumeResponse) Status added in v0.6.5

func (r GetExternalVolumeResponse) Status() string

Status returns HTTPResponse.Status

func (GetExternalVolumeResponse) StatusCode added in v0.6.5

func (r GetExternalVolumeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetExternalVolumeSourcesResponse added in v0.6.5

type GetExternalVolumeSourcesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data map[string]struct {
			// Capabilities Map where keys are attachment types and values are arrays of supported modes.
			Capabilities map[string][]string `json:"capabilities"`

			// Creatable Whether volumes of this source type can be created via the API.
			Creatable bool `json:"creatable"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetExternalVolumeSourcesResponse added in v0.6.5

func ParseGetExternalVolumeSourcesResponse(rsp *http.Response) (*GetExternalVolumeSourcesResponse, error)

ParseGetExternalVolumeSourcesResponse parses an HTTP response from a GetExternalVolumeSourcesWithResponse call

func (GetExternalVolumeSourcesResponse) Status added in v0.6.5

Status returns HTTPResponse.Status

func (GetExternalVolumeSourcesResponse) StatusCode added in v0.6.5

func (r GetExternalVolumeSourcesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetExternalVolumesParams added in v0.6.5

type GetExternalVolumesParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetExternalVolumesParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]GetExternalVolumesParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Cluster `filter[search]=value` List only those attached volumes within the specified cluster.
		Cluster *string `json:"cluster,omitempty"`

		// Location `filter[location]=value` List only those attached volumes available at the specified location.
		Location *string `json:"location,omitempty"`

		// Server `filter[server-id]=value` List only those attached volumes attached to the specified server.
		Server *string `json:"server,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the attached volume's current state.
		State *string `json:"state,omitempty"`

		// Unused `filter[unused]=true` List only those external volumes that are unused (not attached).
		Unused *string `json:"unused,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetExternalVolumesParams defines parameters for GetExternalVolumes.

type GetExternalVolumesParamsInclude added in v0.6.5

type GetExternalVolumesParamsInclude string

GetExternalVolumesParamsInclude defines parameters for GetExternalVolumes.

const (
	GetExternalVolumesParamsIncludeLocations GetExternalVolumesParamsInclude = "locations"
	GetExternalVolumesParamsIncludeServers   GetExternalVolumesParamsInclude = "servers"
)

Defines values for GetExternalVolumesParamsInclude.

type GetExternalVolumesParamsMeta added in v0.6.5

type GetExternalVolumesParamsMeta string

GetExternalVolumesParamsMeta defines parameters for GetExternalVolumes.

const (
	GetExternalVolumesParamsMetaContainers GetExternalVolumesParamsMeta = "containers"
)

Defines values for GetExternalVolumesParamsMeta.

type GetExternalVolumesResponse added in v0.6.5

type GetExternalVolumesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []ExternalVolume `json:"data"`

		// Includes All includable resources linked to the given external volume.
		Includes *ExternalVolumeIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetExternalVolumesResponse added in v0.6.5

func ParseGetExternalVolumesResponse(rsp *http.Response) (*GetExternalVolumesResponse, error)

ParseGetExternalVolumesResponse parses an HTTP response from a GetExternalVolumesWithResponse call

func (GetExternalVolumesResponse) Status added in v0.6.5

Status returns HTTPResponse.Status

func (GetExternalVolumesResponse) StatusCode added in v0.6.5

func (r GetExternalVolumesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHubActivityParams

type GetHubActivityParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetHubActivityParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Container `filter[container]=ID` container filtering by ID. Submit the ID of the container you wish to filter for and the return will be any activity from that container.
		Container *string `json:"container,omitempty"`

		// Environment `filter[environment]=ID` environment filtering by ID. Submit the ID of the environment you wish to filter for and the return will be any activity from that environment.
		Environment *string `json:"environment,omitempty"`

		// Events `filter[events]=value` filter by event names.
		Events *string `json:"events,omitempty"`

		// Instance `filter[instance]=ID` instance filtering by ID. Submit the ID of the instance you wish to filter for and the return will be any activity from that instance.
		Instance *string `json:"instance,omitempty"`

		// Search `filter[search]=value` search activities for a value associated with a field on the given activity(s).
		Search *string `json:"search,omitempty"`

		// Server `filter[server]=ID` server filtering by ID. Submit the ID of the server you wish to filter for and the return will be any activity from that server.
		Server *string `json:"server,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the activity's current state.
		State *string `json:"state,omitempty"`

		// User `filter[user]=ID` user filtering by ID. Submit the ID of the user you wish to filter for and the return will be any activity from that user.
		User *string `json:"user,omitempty"`

		// Verbosity `filter[verbosity]=integer` filter the activity return by verbosity. The verbosity can be:
		//   `0` - Activity that users would find useful.
		//   `1` - Activity that can be useful when tracking down how something happened.
		//   `2` - Full activity, can be useful in debugging problems.
		Verbosity *int `json:"verbosity,omitempty"`

		// VirtualMachine `filter[virtual-machine]=ID` virtual machine filtering by ID. Submit the ID of the virtual machine you wish to filter for and the return will be any activity from that virtual machine.
		VirtualMachine *string `json:"virtual-machine,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetHubActivityParams defines parameters for GetHubActivity.

type GetHubActivityParamsInclude

type GetHubActivityParamsInclude string

GetHubActivityParamsInclude defines parameters for GetHubActivity.

const (
	GetHubActivityParamsIncludeComponents   GetHubActivityParamsInclude = "components"
	GetHubActivityParamsIncludeCreators     GetHubActivityParamsInclude = "creators"
	GetHubActivityParamsIncludeEnvironments GetHubActivityParamsInclude = "environments"
	GetHubActivityParamsIncludeImages       GetHubActivityParamsInclude = "images"
	GetHubActivityParamsIncludeStackBuilds  GetHubActivityParamsInclude = "stack_builds"
	GetHubActivityParamsIncludeStacks       GetHubActivityParamsInclude = "stacks"
	GetHubActivityParamsIncludeUsers        GetHubActivityParamsInclude = "users"
)

Defines values for GetHubActivityParamsInclude.

type GetHubActivityResponse

type GetHubActivityResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Activity `json:"data"`

		// Includes All includable resources linkable to the given records.
		Includes *ActivityIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubActivityResponse

func ParseGetHubActivityResponse(rsp *http.Response) (*GetHubActivityResponse, error)

ParseGetHubActivityResponse parses an HTTP response from a GetHubActivityWithResponse call

func (GetHubActivityResponse) Status

func (r GetHubActivityResponse) Status() string

Status returns HTTPResponse.Status

func (GetHubActivityResponse) StatusCode

func (r GetHubActivityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHubCapabilitiesResponse

type GetHubCapabilitiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Capability `json:"data"`
		Meta struct {
			// Captions Human-readable captions keyed by the platform level capability it describes.
			Captions map[string]string `json:"captions"`
		} `json:"meta"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubCapabilitiesResponse

func ParseGetHubCapabilitiesResponse(rsp *http.Response) (*GetHubCapabilitiesResponse, error)

ParseGetHubCapabilitiesResponse parses an HTTP response from a GetHubCapabilitiesWithResponse call

func (GetHubCapabilitiesResponse) Status

Status returns HTTPResponse.Status

func (GetHubCapabilitiesResponse) StatusCode

func (r GetHubCapabilitiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHubInvitesParams

type GetHubInvitesParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetHubInvitesParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetHubInvitesParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetHubInvitesParams defines parameters for GetHubInvites.

type GetHubInvitesParamsInclude

type GetHubInvitesParamsInclude string

GetHubInvitesParamsInclude defines parameters for GetHubInvites.

const (
	GetHubInvitesParamsIncludeRoles   GetHubInvitesParamsInclude = "roles"
	GetHubInvitesParamsIncludeSenders GetHubInvitesParamsInclude = "senders"
)

Defines values for GetHubInvitesParamsInclude.

type GetHubInvitesParamsMeta

type GetHubInvitesParamsMeta string

GetHubInvitesParamsMeta defines parameters for GetHubInvites.

const (
	GetHubInvitesParamsMetaCapabilities GetHubInvitesParamsMeta = "capabilities"
)

Defines values for GetHubInvitesParamsMeta.

type GetHubInvitesResponse

type GetHubInvitesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []HubMembership `json:"data"`

		// Includes All includable resources for invites.
		Includes *HubInviteIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubInvitesResponse

func ParseGetHubInvitesResponse(rsp *http.Response) (*GetHubInvitesResponse, error)

ParseGetHubInvitesResponse parses an HTTP response from a GetHubInvitesWithResponse call

func (GetHubInvitesResponse) Status

func (r GetHubInvitesResponse) Status() string

Status returns HTTPResponse.Status

func (GetHubInvitesResponse) StatusCode

func (r GetHubInvitesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHubMemberAccountParams

type GetHubMemberAccountParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetHubMemberAccountParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetHubMemberAccountParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetHubMemberAccountParams defines parameters for GetHubMemberAccount.

type GetHubMemberAccountParamsInclude

type GetHubMemberAccountParamsInclude string

GetHubMemberAccountParamsInclude defines parameters for GetHubMemberAccount.

const (
	GetHubMemberAccountParamsIncludeAccounts GetHubMemberAccountParamsInclude = "accounts"
	GetHubMemberAccountParamsIncludeRoles    GetHubMemberAccountParamsInclude = "roles"
)

Defines values for GetHubMemberAccountParamsInclude.

type GetHubMemberAccountParamsMeta

type GetHubMemberAccountParamsMeta string

GetHubMemberAccountParamsMeta defines parameters for GetHubMemberAccount.

const (
	Capabilities GetHubMemberAccountParamsMeta = "capabilities"
)

Defines values for GetHubMemberAccountParamsMeta.

type GetHubMemberAccountResponse

type GetHubMemberAccountResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A membership resource that is scoped to an individual hub.
		Data HubMembership `json:"data"`

		// Includes All includable resources for hub memberships.
		Includes *HubMembershipIncludes2 `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubMemberAccountResponse

func ParseGetHubMemberAccountResponse(rsp *http.Response) (*GetHubMemberAccountResponse, error)

ParseGetHubMemberAccountResponse parses an HTTP response from a GetHubMemberAccountWithResponse call

func (GetHubMemberAccountResponse) Status

Status returns HTTPResponse.Status

func (GetHubMemberAccountResponse) StatusCode

func (r GetHubMemberAccountResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHubMemberParams

type GetHubMemberParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetHubMemberParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetHubMemberParams defines parameters for GetHubMember.

type GetHubMemberParamsInclude

type GetHubMemberParamsInclude string

GetHubMemberParamsInclude defines parameters for GetHubMember.

const (
	GetHubMemberParamsIncludeAccounts GetHubMemberParamsInclude = "accounts"
	GetHubMemberParamsIncludeRoles    GetHubMemberParamsInclude = "roles"
)

Defines values for GetHubMemberParamsInclude.

type GetHubMemberResponse

type GetHubMemberResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A membership resource that is scoped to an individual hub.
		Data HubMembership `json:"data"`

		// Includes All includable resources for hub memberships.
		Includes *HubMembershipIncludes2 `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubMemberResponse

func ParseGetHubMemberResponse(rsp *http.Response) (*GetHubMemberResponse, error)

ParseGetHubMemberResponse parses an HTTP response from a GetHubMemberWithResponse call

func (GetHubMemberResponse) Status

func (r GetHubMemberResponse) Status() string

Status returns HTTPResponse.Status

func (GetHubMemberResponse) StatusCode

func (r GetHubMemberResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHubMembersParams

type GetHubMembersParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetHubMembersParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetHubMembersParams defines parameters for GetHubMembers.

type GetHubMembersParamsInclude

type GetHubMembersParamsInclude string

GetHubMembersParamsInclude defines parameters for GetHubMembers.

const (
	GetHubMembersParamsIncludeAccounts GetHubMembersParamsInclude = "accounts"
	GetHubMembersParamsIncludeRoles    GetHubMembersParamsInclude = "roles"
)

Defines values for GetHubMembersParamsInclude.

type GetHubMembersResponse

type GetHubMembersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []HubMembership `json:"data"`

		// Includes All includable resources for hub memberships.
		Includes *HubMembershipIncludes2 `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubMembersResponse

func ParseGetHubMembersResponse(rsp *http.Response) (*GetHubMembersResponse, error)

ParseGetHubMembersResponse parses an HTTP response from a GetHubMembersWithResponse call

func (GetHubMembersResponse) Status

func (r GetHubMembersResponse) Status() string

Status returns HTTPResponse.Status

func (GetHubMembersResponse) StatusCode

func (r GetHubMembersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHubMembershipParams

type GetHubMembershipParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetHubMembershipParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetHubMembershipParams defines parameters for GetHubMembership.

type GetHubMembershipParamsInclude

type GetHubMembershipParamsInclude string

GetHubMembershipParamsInclude defines parameters for GetHubMembership.

const (
	Accounts GetHubMembershipParamsInclude = "accounts"
	Roles    GetHubMembershipParamsInclude = "roles"
)

Defines values for GetHubMembershipParamsInclude.

type GetHubMembershipResponse

type GetHubMembershipResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A membership resource that is scoped to an individual hub.
		Data HubMembership `json:"data"`

		// Includes All includable resources for hub memberships.
		Includes *HubMembershipIncludes2 `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubMembershipResponse

func ParseGetHubMembershipResponse(rsp *http.Response) (*GetHubMembershipResponse, error)

ParseGetHubMembershipResponse parses an HTTP response from a GetHubMembershipWithResponse call

func (GetHubMembershipResponse) Status

func (r GetHubMembershipResponse) Status() string

Status returns HTTPResponse.Status

func (GetHubMembershipResponse) StatusCode

func (r GetHubMembershipResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHubNotificationSocketAuthResponse

type GetHubNotificationSocketAuthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			// Token A token used for connecting to the Hub notification pipeline websocket API.
			Token string `json:"token"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubNotificationSocketAuthResponse

func ParseGetHubNotificationSocketAuthResponse(rsp *http.Response) (*GetHubNotificationSocketAuthResponse, error)

ParseGetHubNotificationSocketAuthResponse parses an HTTP response from a GetHubNotificationSocketAuthWithResponse call

func (GetHubNotificationSocketAuthResponse) Status

Status returns HTTPResponse.Status

func (GetHubNotificationSocketAuthResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetHubParams

type GetHubParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetHubParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
}

GetHubParams defines parameters for GetHub.

type GetHubParamsMeta

type GetHubParamsMeta string

GetHubParamsMeta defines parameters for GetHub.

const (
	Memberships GetHubParamsMeta = "memberships"
)

Defines values for GetHubParamsMeta.

type GetHubResponse

type GetHubResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A hub resource.
		Data *Hub `json:"data,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubResponse

func ParseGetHubResponse(rsp *http.Response) (*GetHubResponse, error)

ParseGetHubResponse parses an HTTP response from a GetHubWithResponse call

func (GetHubResponse) Status

func (r GetHubResponse) Status() string

Status returns HTTPResponse.Status

func (GetHubResponse) StatusCode

func (r GetHubResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHubUsageParams

type GetHubUsageParams struct {
	Filter *FilterParam `json:"filter,omitempty"`
}

GetHubUsageParams defines parameters for GetHubUsage.

type GetHubUsageResponse

type GetHubUsageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []HubUsageDatum `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubUsageResponse

func ParseGetHubUsageResponse(rsp *http.Response) (*GetHubUsageResponse, error)

ParseGetHubUsageResponse parses an HTTP response from a GetHubUsageWithResponse call

func (GetHubUsageResponse) Status

func (r GetHubUsageResponse) Status() string

Status returns HTTPResponse.Status

func (GetHubUsageResponse) StatusCode

func (r GetHubUsageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHubsParams

type GetHubsParams struct {
	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Identifier `filter[identifier]=value` List only those environments matching this identifier. May return multiple results.
		Identifier *string `json:"identifier,omitempty"`

		// Search `filter[search]=value` search hubs for a value associated with a field on the given Hub(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the Hub's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`
}

GetHubsParams defines parameters for GetHubs.

type GetHubsResponse

type GetHubsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Hub `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetHubsResponse

func ParseGetHubsResponse(rsp *http.Response) (*GetHubsResponse, error)

ParseGetHubsResponse parses an HTTP response from a GetHubsWithResponse call

func (GetHubsResponse) Status

func (r GetHubsResponse) Status() string

Status returns HTTPResponse.Status

func (GetHubsResponse) StatusCode

func (r GetHubsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIPPoolParams

type GetIPPoolParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetIPPoolParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetIPPoolParams defines parameters for GetIPPool.

type GetIPPoolParamsInclude

type GetIPPoolParamsInclude string

GetIPPoolParamsInclude defines parameters for GetIPPool.

const (
	GetIPPoolParamsIncludeIntegrations GetIPPoolParamsInclude = "integrations"
	GetIPPoolParamsIncludeLocations    GetIPPoolParamsInclude = "locations"
	GetIPPoolParamsIncludeServers      GetIPPoolParamsInclude = "servers"
)

Defines values for GetIPPoolParamsInclude.

type GetIPPoolResponse

type GetIPPoolResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An IP Pool
		Data IpPool `json:"data"`

		// Includes Resources associated with an IP Pool.
		Includes *IpPoolIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetIPPoolResponse

func ParseGetIPPoolResponse(rsp *http.Response) (*GetIPPoolResponse, error)

ParseGetIPPoolResponse parses an HTTP response from a GetIPPoolWithResponse call

func (GetIPPoolResponse) Status

func (r GetIPPoolResponse) Status() string

Status returns HTTPResponse.Status

func (GetIPPoolResponse) StatusCode

func (r GetIPPoolResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetImageBuildLogResponse

type GetImageBuildLogResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A build log for a given image.
		Data BuildLog `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetImageBuildLogResponse

func ParseGetImageBuildLogResponse(rsp *http.Response) (*GetImageBuildLogResponse, error)

ParseGetImageBuildLogResponse parses an HTTP response from a GetImageBuildLogWithResponse call

func (GetImageBuildLogResponse) Status

func (r GetImageBuildLogResponse) Status() string

Status returns HTTPResponse.Status

func (GetImageBuildLogResponse) StatusCode

func (r GetImageBuildLogResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetImageParams

type GetImageParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetImageParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetImageParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetImageParams defines parameters for GetImage.

type GetImageParamsInclude

type GetImageParamsInclude string

GetImageParamsInclude defines parameters for GetImage.

const (
	GetImageParamsIncludeCreators     GetImageParamsInclude = "creators"
	GetImageParamsIncludeIntegrations GetImageParamsInclude = "integrations"
	GetImageParamsIncludeSources      GetImageParamsInclude = "sources"
	GetImageParamsIncludeStackBuilds  GetImageParamsInclude = "stack_builds"
	GetImageParamsIncludeStacks       GetImageParamsInclude = "stacks"
)

Defines values for GetImageParamsInclude.

type GetImageParamsMeta

type GetImageParamsMeta string

GetImageParamsMeta defines parameters for GetImage.

const (
	GetImageParamsMetaContainersCount GetImageParamsMeta = "containers_count"
)

Defines values for GetImageParamsMeta.

type GetImageResponse

type GetImageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An image is a point in time build on a given image source, and what is distributed by Cycle to run containers.
		Data Image `json:"data"`

		// Includes All includable resources linkable to the given image.
		Includes *ImageIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetImageResponse

func ParseGetImageResponse(rsp *http.Response) (*GetImageResponse, error)

ParseGetImageResponse parses an HTTP response from a GetImageWithResponse call

func (GetImageResponse) Status

func (r GetImageResponse) Status() string

Status returns HTTPResponse.Status

func (GetImageResponse) StatusCode

func (r GetImageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetImageSourceParams

type GetImageSourceParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetImageSourceParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetImageSourceParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetImageSourceParams defines parameters for GetImageSource.

type GetImageSourceParamsInclude

type GetImageSourceParamsInclude string

GetImageSourceParamsInclude defines parameters for GetImageSource.

const (
	GetImageSourceParamsIncludeCreators     GetImageSourceParamsInclude = "creators"
	GetImageSourceParamsIncludeIntegrations GetImageSourceParamsInclude = "integrations"
)

Defines values for GetImageSourceParamsInclude.

type GetImageSourceParamsMeta

type GetImageSourceParamsMeta string

GetImageSourceParamsMeta defines parameters for GetImageSource.

const (
	GetImageSourceParamsMetaImagesCount GetImageSourceParamsMeta = "images_count"
)

Defines values for GetImageSourceParamsMeta.

type GetImageSourceResponse

type GetImageSourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An image source is a set of resources that direct the platform on where it can find the resources needed to build an image resource.
		Data ImageSource `json:"data"`

		// Includes A resource associate with an image source.
		Includes *SourceIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetImageSourceResponse

func ParseGetImageSourceResponse(rsp *http.Response) (*GetImageSourceResponse, error)

ParseGetImageSourceResponse parses an HTTP response from a GetImageSourceWithResponse call

func (GetImageSourceResponse) Status

func (r GetImageSourceResponse) Status() string

Status returns HTTPResponse.Status

func (GetImageSourceResponse) StatusCode

func (r GetImageSourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetImageSourcesParams

type GetImageSourcesParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetImageSourcesParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetImageSourcesParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Identifier `filter[identifier]=value` List only those image sources matching this identifier. May return multiple results.
		Identifier *string `json:"identifier,omitempty"`

		// Search `filter[search]=value` search for a value associated with a field on the given Image Source(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the Image Source's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetImageSourcesParams defines parameters for GetImageSources.

type GetImageSourcesParamsInclude

type GetImageSourcesParamsInclude string

GetImageSourcesParamsInclude defines parameters for GetImageSources.

const (
	GetImageSourcesParamsIncludeCreators     GetImageSourcesParamsInclude = "creators"
	GetImageSourcesParamsIncludeIntegrations GetImageSourcesParamsInclude = "integrations"
)

Defines values for GetImageSourcesParamsInclude.

type GetImageSourcesParamsMeta

type GetImageSourcesParamsMeta string

GetImageSourcesParamsMeta defines parameters for GetImageSources.

const (
	GetImageSourcesParamsMetaImagesCount GetImageSourcesParamsMeta = "images_count"
)

Defines values for GetImageSourcesParamsMeta.

type GetImageSourcesResponse

type GetImageSourcesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []ImageSource `json:"data"`

		// Includes A resource associate with an image source.
		Includes *SourceIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetImageSourcesResponse

func ParseGetImageSourcesResponse(rsp *http.Response) (*GetImageSourcesResponse, error)

ParseGetImageSourcesResponse parses an HTTP response from a GetImageSourcesWithResponse call

func (GetImageSourcesResponse) Status

func (r GetImageSourcesResponse) Status() string

Status returns HTTPResponse.Status

func (GetImageSourcesResponse) StatusCode

func (r GetImageSourcesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetImagesParams

type GetImagesParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetImagesParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetImagesParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Identifier `filter[identifier]=value` List only those images matching this identifier. May return multiple results.
		Identifier *string `json:"identifier,omitempty"`

		// Search `filter[search]=value` search for a value associated with a field on the given Image(s).
		Search *string `json:"search,omitempty"`

		// SourceId `filter[source_id]=ID` Image filtering by source ID.  Submit the ID of the Image source you wish to filter for and the return will be any Images created from that source.
		SourceId *string `json:"source_id,omitempty"`

		// SourceType `filter[source_type]=value` filter images by the Image source's type.  Can be: `direct`, `stack-build`, or `bucket`
		SourceType *string `json:"source_type,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the Image's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetImagesParams defines parameters for GetImages.

type GetImagesParamsInclude

type GetImagesParamsInclude string

GetImagesParamsInclude defines parameters for GetImages.

const (
	GetImagesParamsIncludeCreators     GetImagesParamsInclude = "creators"
	GetImagesParamsIncludeIntegrations GetImagesParamsInclude = "integrations"
	GetImagesParamsIncludeSources      GetImagesParamsInclude = "sources"
	GetImagesParamsIncludeStackBuilds  GetImagesParamsInclude = "stack_builds"
	GetImagesParamsIncludeStacks       GetImagesParamsInclude = "stacks"
)

Defines values for GetImagesParamsInclude.

type GetImagesParamsMeta

type GetImagesParamsMeta string

GetImagesParamsMeta defines parameters for GetImages.

const (
	GetImagesParamsMetaContainersCount GetImagesParamsMeta = "containers_count"
)

Defines values for GetImagesParamsMeta.

type GetImagesResponse

type GetImagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Image `json:"data"`

		// Includes All includable resources linkable to the given image.
		Includes *ImageIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetImagesResponse

func ParseGetImagesResponse(rsp *http.Response) (*GetImagesResponse, error)

ParseGetImagesResponse parses an HTTP response from a GetImagesWithResponse call

func (GetImagesResponse) Status

func (r GetImagesResponse) Status() string

Status returns HTTPResponse.Status

func (GetImagesResponse) StatusCode

func (r GetImagesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInfrastructureSummaryParams

type GetInfrastructureSummaryParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Cluster `filter[cluster]=value` return an infrastructure summary only for the specified cluster.
		Cluster *string `json:"cluster,omitempty"`
	} `json:"filter,omitempty"`
}

GetInfrastructureSummaryParams defines parameters for GetInfrastructureSummary.

type GetInfrastructureSummaryResponse

type GetInfrastructureSummaryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An infrastructure summary resource.
		Data InfrastructureSummary `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetInfrastructureSummaryResponse

func ParseGetInfrastructureSummaryResponse(rsp *http.Response) (*GetInfrastructureSummaryResponse, error)

ParseGetInfrastructureSummaryResponse parses an HTTP response from a GetInfrastructureSummaryWithResponse call

func (GetInfrastructureSummaryResponse) Status

Status returns HTTPResponse.Status

func (GetInfrastructureSummaryResponse) StatusCode

func (r GetInfrastructureSummaryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInstanceConsoleStreamAuthResponse

type GetInstanceConsoleStreamAuthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			// Address The protocol and url for connecting to the Instance console.
			Address string `json:"address"`

			// Token A token used for connecting to the Instance console.
			Token string `json:"token"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetInstanceConsoleStreamAuthResponse

func ParseGetInstanceConsoleStreamAuthResponse(rsp *http.Response) (*GetInstanceConsoleStreamAuthResponse, error)

ParseGetInstanceConsoleStreamAuthResponse parses an HTTP response from a GetInstanceConsoleStreamAuthWithResponse call

func (GetInstanceConsoleStreamAuthResponse) Status

Status returns HTTPResponse.Status

func (GetInstanceConsoleStreamAuthResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetInstanceParams

type GetInstanceParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetInstanceParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetInstanceParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetInstanceParams defines parameters for GetInstance.

type GetInstanceParamsInclude

type GetInstanceParamsInclude string

GetInstanceParamsInclude defines parameters for GetInstance.

const (
	GetInstanceParamsIncludeContainers   GetInstanceParamsInclude = "containers"
	GetInstanceParamsIncludeCreators     GetInstanceParamsInclude = "creators"
	GetInstanceParamsIncludeEnvironments GetInstanceParamsInclude = "environments"
	GetInstanceParamsIncludeIntegrations GetInstanceParamsInclude = "integrations"
	GetInstanceParamsIncludeLocations    GetInstanceParamsInclude = "locations"
	GetInstanceParamsIncludeServers      GetInstanceParamsInclude = "servers"
)

Defines values for GetInstanceParamsInclude.

type GetInstanceParamsMeta added in v0.6.3

type GetInstanceParamsMeta string

GetInstanceParamsMeta defines parameters for GetInstance.

const (
	GetInstanceParamsMetaNode       GetInstanceParamsMeta = "node"
	GetInstanceParamsMetaSdnPoolIps GetInstanceParamsMeta = "sdn_pool_ips"
)

Defines values for GetInstanceParamsMeta.

type GetInstanceResponse

type GetInstanceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An instance of a Container.
		Data Instance `json:"data"`

		// Includes A resource associated with an instance.
		Includes *InstanceIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetInstanceResponse

func ParseGetInstanceResponse(rsp *http.Response) (*GetInstanceResponse, error)

ParseGetInstanceResponse parses an HTTP response from a GetInstanceWithResponse call

func (GetInstanceResponse) Status

func (r GetInstanceResponse) Status() string

Status returns HTTPResponse.Status

func (GetInstanceResponse) StatusCode

func (r GetInstanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInstanceTelemetryReportParams

type GetInstanceTelemetryReportParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		RangeEnd   *DateTime `json:"range-end,omitempty"`
		RangeStart *DateTime `json:"range-start,omitempty"`
	} `json:"filter,omitempty"`
}

GetInstanceTelemetryReportParams defines parameters for GetInstanceTelemetryReport.

type GetInstanceTelemetryReportResponse

type GetInstanceTelemetryReportResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An Instance telemetry report.
		Data InstanceTelemetryReport `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetInstanceTelemetryReportResponse

func ParseGetInstanceTelemetryReportResponse(rsp *http.Response) (*GetInstanceTelemetryReportResponse, error)

ParseGetInstanceTelemetryReportResponse parses an HTTP response from a GetInstanceTelemetryReportWithResponse call

func (GetInstanceTelemetryReportResponse) Status

Status returns HTTPResponse.Status

func (GetInstanceTelemetryReportResponse) StatusCode

func (r GetInstanceTelemetryReportResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInstanceTelemetryStreamAuthResponse

type GetInstanceTelemetryStreamAuthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Credentials for connecting to the instance telemetry stream on compute.
		Data struct {
			// Address The URL address to open a websocket to for streaming instance telemetry data.
			Address string `json:"address"`

			// Token The authentication token passed into the address as a URL parameter (?token).
			Token string `json:"token"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetInstanceTelemetryStreamAuthResponse

func ParseGetInstanceTelemetryStreamAuthResponse(rsp *http.Response) (*GetInstanceTelemetryStreamAuthResponse, error)

ParseGetInstanceTelemetryStreamAuthResponse parses an HTTP response from a GetInstanceTelemetryStreamAuthWithResponse call

func (GetInstanceTelemetryStreamAuthResponse) Status

Status returns HTTPResponse.Status

func (GetInstanceTelemetryStreamAuthResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetInstanceVolumesParams

type GetInstanceVolumesParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetInstanceVolumesParams defines parameters for GetInstanceVolumes.

type GetInstanceVolumesResponse

type GetInstanceVolumesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []InstanceVolume `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetInstanceVolumesResponse

func ParseGetInstanceVolumesResponse(rsp *http.Response) (*GetInstanceVolumesResponse, error)

ParseGetInstanceVolumesResponse parses an HTTP response from a GetInstanceVolumesWithResponse call

func (GetInstanceVolumesResponse) Status

Status returns HTTPResponse.Status

func (GetInstanceVolumesResponse) StatusCode

func (r GetInstanceVolumesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInstancesParams

type GetInstancesParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetInstancesParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetInstancesParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		RangeEnd   *DateTime `json:"range-end,omitempty"`
		RangeStart *DateTime `json:"range-start,omitempty"`

		// Search `filter[search]=value` search instances for a value associated with a field on the given instance(s).
		Search *string `json:"search,omitempty"`

		// Server `filter[server]=ID` server filtering by ID. Submit the ID of the server you wish to filter for and the return will be any instances of the container currently deployed to the given server.
		Server *string `json:"server,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the instance's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetInstancesParams defines parameters for GetInstances.

type GetInstancesParamsInclude

type GetInstancesParamsInclude string

GetInstancesParamsInclude defines parameters for GetInstances.

const (
	GetInstancesParamsIncludeContainers   GetInstancesParamsInclude = "containers"
	GetInstancesParamsIncludeCreators     GetInstancesParamsInclude = "creators"
	GetInstancesParamsIncludeEnvironments GetInstancesParamsInclude = "environments"
	GetInstancesParamsIncludeIntegrations GetInstancesParamsInclude = "integrations"
	GetInstancesParamsIncludeLocations    GetInstancesParamsInclude = "locations"
	GetInstancesParamsIncludeServers      GetInstancesParamsInclude = "servers"
)

Defines values for GetInstancesParamsInclude.

type GetInstancesParamsMeta added in v0.6.3

type GetInstancesParamsMeta string

GetInstancesParamsMeta defines parameters for GetInstances.

const (
	GetInstancesParamsMetaNode       GetInstancesParamsMeta = "node"
	GetInstancesParamsMetaSdnPoolIps GetInstancesParamsMeta = "sdn_pool_ips"
)

Defines values for GetInstancesParamsMeta.

type GetInstancesResponse

type GetInstancesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Instance `json:"data"`

		// Includes A resource associated with an instance.
		Includes *InstanceIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetInstancesResponse

func ParseGetInstancesResponse(rsp *http.Response) (*GetInstancesResponse, error)

ParseGetInstancesResponse parses an HTTP response from a GetInstancesWithResponse call

func (GetInstancesResponse) Status

func (r GetInstancesResponse) Status() string

Status returns HTTPResponse.Status

func (GetInstancesResponse) StatusCode

func (r GetInstancesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIntegrationParams

type GetIntegrationParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetIntegrationParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
}

GetIntegrationParams defines parameters for GetIntegration.

type GetIntegrationParamsMeta

type GetIntegrationParamsMeta string

GetIntegrationParamsMeta defines parameters for GetIntegration.

const (
	GetIntegrationParamsMetaDefinition GetIntegrationParamsMeta = "definition"
)

Defines values for GetIntegrationParamsMeta.

type GetIntegrationResponse

type GetIntegrationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data Integration `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetIntegrationResponse

func ParseGetIntegrationResponse(rsp *http.Response) (*GetIntegrationResponse, error)

ParseGetIntegrationResponse parses an HTTP response from a GetIntegrationWithResponse call

func (GetIntegrationResponse) Status

func (r GetIntegrationResponse) Status() string

Status returns HTTPResponse.Status

func (GetIntegrationResponse) StatusCode

func (r GetIntegrationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIntegrationsParams

type GetIntegrationsParams struct {
	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetIntegrationsParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for. Supports filtering by state and a text search.
	Filter *struct {
		// Category `filter[category]=value` Filters integrations by their category. For example, `filter[category]=infrastructure-provider` would return only integrations that are capable of provisioning infrastructure.
		Category *string `json:"category,omitempty"`

		// Search `filter[search]=value` Performs a text search across relevant fields of the integrations. For example, `filter[search]=example` would return integrations that have "example" in any of the searchable fields
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value` Filters integrations by their current state. For example, `filter[state]=active` would return only integrations in an active state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`
}

GetIntegrationsParams defines parameters for GetIntegrations.

type GetIntegrationsParamsMeta

type GetIntegrationsParamsMeta string

GetIntegrationsParamsMeta defines parameters for GetIntegrations.

const (
	GetIntegrationsParamsMetaDefinition GetIntegrationsParamsMeta = "definition"
)

Defines values for GetIntegrationsParamsMeta.

type GetIntegrationsResponse

type GetIntegrationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Integration `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetIntegrationsResponse

func ParseGetIntegrationsResponse(rsp *http.Response) (*GetIntegrationsResponse, error)

ParseGetIntegrationsResponse parses an HTTP response from a GetIntegrationsWithResponse call

func (GetIntegrationsResponse) Status

func (r GetIntegrationsResponse) Status() string

Status returns HTTPResponse.Status

func (GetIntegrationsResponse) StatusCode

func (r GetIntegrationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInvoiceParams

type GetInvoiceParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetInvoiceParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Token Token can be optionally provided for authentication outside of the hub context.
	Token *string `form:"token,omitempty" json:"token,omitempty"`
}

GetInvoiceParams defines parameters for GetInvoice.

type GetInvoiceParamsMeta

type GetInvoiceParamsMeta string

GetInvoiceParamsMeta defines parameters for GetInvoice.

const (
	GetInvoiceParamsMetaDue GetInvoiceParamsMeta = "due"
	GetInvoiceParamsMetaHub GetInvoiceParamsMeta = "hub"
)

Defines values for GetInvoiceParamsMeta.

type GetInvoiceResponse

type GetInvoiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Information about a billing invoice.
		Data Invoice `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetInvoiceResponse

func ParseGetInvoiceResponse(rsp *http.Response) (*GetInvoiceResponse, error)

ParseGetInvoiceResponse parses an HTTP response from a GetInvoiceWithResponse call

func (GetInvoiceResponse) Status

func (r GetInvoiceResponse) Status() string

Status returns HTTPResponse.Status

func (GetInvoiceResponse) StatusCode

func (r GetInvoiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInvoicesParams

type GetInvoicesParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetInvoicesParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		RangeEnd   *DateTime `json:"range-end,omitempty"`
		RangeStart *DateTime `json:"range-start,omitempty"`

		// Search `filter[search]=value` search for the specified text on supported fields.
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the invoice's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`
}

GetInvoicesParams defines parameters for GetInvoices.

type GetInvoicesParamsMeta

type GetInvoicesParamsMeta string

GetInvoicesParamsMeta defines parameters for GetInvoices.

const (
	GetInvoicesParamsMetaDue GetInvoicesParamsMeta = "due"
)

Defines values for GetInvoicesParamsMeta.

type GetInvoicesResponse

type GetInvoicesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Invoice `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetInvoicesResponse

func ParseGetInvoicesResponse(rsp *http.Response) (*GetInvoicesResponse, error)

ParseGetInvoicesResponse parses an HTTP response from a GetInvoicesWithResponse call

func (GetInvoicesResponse) Status

func (r GetInvoicesResponse) Status() string

Status returns HTTPResponse.Status

func (GetInvoicesResponse) StatusCode

func (r GetInvoicesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIpPoolsParams added in v0.6.3

type GetIpPoolsParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetIpPoolsParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Available `filter[available]=true` filter for IPs that are available for use.
		Available *string `json:"available,omitempty"`

		// Location `filter[location]=ID` location filtering by ID. Submit the ID of the location you wish to filter by.
		Location *string `json:"location,omitempty"`

		// Server `filter[server]=ID` server filtering by ID. Submit the ID of the server you wish to filter for and the return will be any IP pool associated with that server.
		Server *string `json:"server,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the IP's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetIpPoolsParams defines parameters for GetIpPools.

type GetIpPoolsParamsInclude added in v0.6.3

type GetIpPoolsParamsInclude string

GetIpPoolsParamsInclude defines parameters for GetIpPools.

const (
	GetIpPoolsParamsIncludeIntegrations GetIpPoolsParamsInclude = "integrations"
	GetIpPoolsParamsIncludeLocations    GetIpPoolsParamsInclude = "locations"
	GetIpPoolsParamsIncludeServers      GetIpPoolsParamsInclude = "servers"
)

Defines values for GetIpPoolsParamsInclude.

type GetIpPoolsResponse added in v0.6.3

type GetIpPoolsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []IpPool `json:"data"`

		// Includes Resources associated with an IP Pool.
		Includes *IpPoolIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetIpPoolsResponse added in v0.6.3

func ParseGetIpPoolsResponse(rsp *http.Response) (*GetIpPoolsResponse, error)

ParseGetIpPoolsResponse parses an HTTP response from a GetIpPoolsWithResponse call

func (GetIpPoolsResponse) Status added in v0.6.3

func (r GetIpPoolsResponse) Status() string

Status returns HTTPResponse.Status

func (GetIpPoolsResponse) StatusCode added in v0.6.3

func (r GetIpPoolsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetJobResponse

type GetJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A job resource.
		Data Job `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetJobResponse

func ParseGetJobResponse(rsp *http.Response) (*GetJobResponse, error)

ParseGetJobResponse parses an HTTP response from a GetJobWithResponse call

func (GetJobResponse) Status

func (r GetJobResponse) Status() string

Status returns HTTPResponse.Status

func (GetJobResponse) StatusCode

func (r GetJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetJobsParams

type GetJobsParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetJobsParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		RangeEnd   *DateTime `json:"range-end,omitempty"`
		RangeStart *DateTime `json:"range-start,omitempty"`

		// Search `filter[search]=value` search jobs for a value associated with a field on the given job(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the job's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetJobsParams defines parameters for GetJobs.

type GetJobsParamsInclude

type GetJobsParamsInclude string

GetJobsParamsInclude defines parameters for GetJobs.

const (
	GetJobsParamsIncludeCreators GetJobsParamsInclude = "creators"
)

Defines values for GetJobsParamsInclude.

type GetJobsResponse

type GetJobsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data     []Job        `json:"data"`
		Includes *JobIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetJobsResponse

func ParseGetJobsResponse(rsp *http.Response) (*GetJobsResponse, error)

ParseGetJobsResponse parses an HTTP response from a GetJobsWithResponse call

func (GetJobsResponse) Status

func (r GetJobsResponse) Status() string

Status returns HTTPResponse.Status

func (GetJobsResponse) StatusCode

func (r GetJobsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLatestJobsResponse

type GetLatestJobsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Job `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetLatestJobsResponse

func ParseGetLatestJobsResponse(rsp *http.Response) (*GetLatestJobsResponse, error)

ParseGetLatestJobsResponse parses an HTTP response from a GetLatestJobsWithResponse call

func (GetLatestJobsResponse) Status

func (r GetLatestJobsResponse) Status() string

Status returns HTTPResponse.Status

func (GetLatestJobsResponse) StatusCode

func (r GetLatestJobsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLoadBalancerLatestTelemetryReportParams

type GetLoadBalancerLatestTelemetryReportParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	// On this endpoint, you MUST pass filter[controller].
	Filter struct {
		// Controller `filter[controller]=port-123` filter for a specific controller to load telemetry for. THIS FILTER IS REQUIRED.
		Controller *string `json:"controller,omitempty"`
	} `json:"filter"`
}

GetLoadBalancerLatestTelemetryReportParams defines parameters for GetLoadBalancerLatestTelemetryReport.

type GetLoadBalancerLatestTelemetryReportResponse

type GetLoadBalancerLatestTelemetryReportResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Snapshots of the latest load balancer telemetry
		Data LoadBalancerLatestTelemetry `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetLoadBalancerLatestTelemetryReportResponse

func ParseGetLoadBalancerLatestTelemetryReportResponse(rsp *http.Response) (*GetLoadBalancerLatestTelemetryReportResponse, error)

ParseGetLoadBalancerLatestTelemetryReportResponse parses an HTTP response from a GetLoadBalancerLatestTelemetryReportWithResponse call

func (GetLoadBalancerLatestTelemetryReportResponse) Status

Status returns HTTPResponse.Status

func (GetLoadBalancerLatestTelemetryReportResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetLoadBalancerServiceResponse

type GetLoadBalancerServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Information about an environments load balancer configuration, state, and availability settings.
		Data LoadBalancerInfo `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetLoadBalancerServiceResponse

func ParseGetLoadBalancerServiceResponse(rsp *http.Response) (*GetLoadBalancerServiceResponse, error)

ParseGetLoadBalancerServiceResponse parses an HTTP response from a GetLoadBalancerServiceWithResponse call

func (GetLoadBalancerServiceResponse) Status

Status returns HTTPResponse.Status

func (GetLoadBalancerServiceResponse) StatusCode

func (r GetLoadBalancerServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLoadBalancerTelemetryLatestControllersParams

type GetLoadBalancerTelemetryLatestControllersParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetLoadBalancerTelemetryLatestControllersParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetLoadBalancerTelemetryLatestControllersParams defines parameters for GetLoadBalancerTelemetryLatestControllers.

type GetLoadBalancerTelemetryLatestControllersParamsInclude

type GetLoadBalancerTelemetryLatestControllersParamsInclude string

GetLoadBalancerTelemetryLatestControllersParamsInclude defines parameters for GetLoadBalancerTelemetryLatestControllers.

const (
	GetLoadBalancerTelemetryLatestControllersParamsIncludeContainers GetLoadBalancerTelemetryLatestControllersParamsInclude = "containers"
	GetLoadBalancerTelemetryLatestControllersParamsIncludeInstances  GetLoadBalancerTelemetryLatestControllersParamsInclude = "instances"
	GetLoadBalancerTelemetryLatestControllersParamsIncludeServers    GetLoadBalancerTelemetryLatestControllersParamsInclude = "servers"
)

Defines values for GetLoadBalancerTelemetryLatestControllersParamsInclude.

type GetLoadBalancerTelemetryLatestControllersResponse

type GetLoadBalancerTelemetryLatestControllersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Information about the latest controllers that generated traffic.
		Data LoadBalancerLatestControllers `json:"data"`

		// Includes Optionally included resources for load balancer controllers
		Includes *Controllers `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetLoadBalancerTelemetryLatestControllersResponse

func ParseGetLoadBalancerTelemetryLatestControllersResponse(rsp *http.Response) (*GetLoadBalancerTelemetryLatestControllersResponse, error)

ParseGetLoadBalancerTelemetryLatestControllersResponse parses an HTTP response from a GetLoadBalancerTelemetryLatestControllersWithResponse call

func (GetLoadBalancerTelemetryLatestControllersResponse) Status

Status returns HTTPResponse.Status

func (GetLoadBalancerTelemetryLatestControllersResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetLoadBalancerTelemetryReportParams

type GetLoadBalancerTelemetryReportParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter struct {
		Controller DateTime  `json:"controller"`
		RangeEnd   *DateTime `json:"range-end,omitempty"`
		RangeStart *DateTime `json:"range-start,omitempty"`
	} `json:"filter"`
}

GetLoadBalancerTelemetryReportParams defines parameters for GetLoadBalancerTelemetryReport.

type GetLoadBalancerTelemetryReportResponse

type GetLoadBalancerTelemetryReportResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Aggregated load balancer telemetry across all instances for a given range.
		Data LoadBalancerTelemetryReport `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetLoadBalancerTelemetryReportResponse

func ParseGetLoadBalancerTelemetryReportResponse(rsp *http.Response) (*GetLoadBalancerTelemetryReportResponse, error)

ParseGetLoadBalancerTelemetryReportResponse parses an HTTP response from a GetLoadBalancerTelemetryReportWithResponse call

func (GetLoadBalancerTelemetryReportResponse) Status

Status returns HTTPResponse.Status

func (GetLoadBalancerTelemetryReportResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetMetricsParams

type GetMetricsParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	//
	// To search via labels, use `label:<label key>` as the filter. For example in URL parameters, `filter[label:test]=abc`.
	Filter *GetMetricsParams_Filter `json:"filter,omitempty"`
}

GetMetricsParams defines parameters for GetMetrics.

type GetMetricsParamsFilterType

type GetMetricsParamsFilterType string

GetMetricsParamsFilterType defines parameters for GetMetrics.

const (
	GetMetricsParamsFilterTypeCount        GetMetricsParamsFilterType = "count"
	GetMetricsParamsFilterTypeCounter      GetMetricsParamsFilterType = "counter"
	GetMetricsParamsFilterTypeDistribution GetMetricsParamsFilterType = "distribution"
	GetMetricsParamsFilterTypeGauge        GetMetricsParamsFilterType = "gauge"
	GetMetricsParamsFilterTypeHistogram    GetMetricsParamsFilterType = "histogram"
	GetMetricsParamsFilterTypeRate         GetMetricsParamsFilterType = "rate"
	GetMetricsParamsFilterTypeSet          GetMetricsParamsFilterType = "set"
)

Defines values for GetMetricsParamsFilterType.

type GetMetricsParams_Filter

type GetMetricsParams_Filter struct {
	// Cluster Specify the cluster associated with the metrics.
	Cluster *string `json:"cluster,omitempty"`

	// Container Specify the container associated with the metrics.
	Container *string `json:"container,omitempty"`

	// Environment A 24 character hex string used to identify a unique resource.
	Environment *ID `json:"environment,omitempty"`

	// Metric Specify the metric to filter by.
	Metric *string `json:"metric,omitempty"`

	// Pipeline A 24 character hex string used to identify a unique resource.
	Pipeline   *ID       `json:"pipeline,omitempty"`
	RangeEnd   *DateTime `json:"range-end,omitempty"`
	RangeStart *DateTime `json:"range-start,omitempty"`

	// Stack A 24 character hex string used to identify a unique resource.
	Stack *ID `json:"stack,omitempty"`

	// Tags Filter by tags associated with the metrics
	Tags *string `json:"tags,omitempty"`

	// Type Filter by the type of metric.
	Type                 *GetMetricsParamsFilterType `json:"type,omitempty"`
	AdditionalProperties map[string]interface{}      `json:"-"`
}

GetMetricsParams_Filter defines parameters for GetMetrics.

func (GetMetricsParams_Filter) Get

func (a GetMetricsParams_Filter) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for GetMetricsParams_Filter. Returns the specified element and whether it was found

func (GetMetricsParams_Filter) MarshalJSON

func (a GetMetricsParams_Filter) MarshalJSON() ([]byte, error)

Override default JSON handling for GetMetricsParams_Filter to handle AdditionalProperties

func (*GetMetricsParams_Filter) Set

func (a *GetMetricsParams_Filter) Set(fieldName string, value interface{})

Setter for additional properties for GetMetricsParams_Filter

func (*GetMetricsParams_Filter) UnmarshalJSON

func (a *GetMetricsParams_Filter) UnmarshalJSON(b []byte) error

Override default JSON handling for GetMetricsParams_Filter to handle AdditionalProperties

type GetMetricsResponse

type GetMetricsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Metric `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetMetricsResponse

func ParseGetMetricsResponse(rsp *http.Response) (*GetMetricsResponse, error)

ParseGetMetricsResponse parses an HTTP response from a GetMetricsWithResponse call

func (GetMetricsResponse) Status

func (r GetMetricsResponse) Status() string

Status returns HTTPResponse.Status

func (GetMetricsResponse) StatusCode

func (r GetMetricsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMonitoringMonitorsResponse

type GetMonitoringMonitorsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Monitor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetMonitoringMonitorsResponse

func ParseGetMonitoringMonitorsResponse(rsp *http.Response) (*GetMonitoringMonitorsResponse, error)

ParseGetMonitoringMonitorsResponse parses an HTTP response from a GetMonitoringMonitorsWithResponse call

func (GetMonitoringMonitorsResponse) Status

Status returns HTTPResponse.Status

func (GetMonitoringMonitorsResponse) StatusCode

func (r GetMonitoringMonitorsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNetworkParams

type GetNetworkParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetNetworkParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetNetworkParams defines parameters for GetNetwork.

type GetNetworkParamsInclude

type GetNetworkParamsInclude string

GetNetworkParamsInclude defines parameters for GetNetwork.

const (
	GetNetworkParamsIncludeCreators     GetNetworkParamsInclude = "creators"
	GetNetworkParamsIncludeEnvironments GetNetworkParamsInclude = "environments"
)

Defines values for GetNetworkParamsInclude.

type GetNetworkResponse

type GetNetworkResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data SDN Network resource.
		Data Network `json:"data"`

		// Includes All includable resource linkable to the given network.
		Includes *NetworkIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetNetworkResponse

func ParseGetNetworkResponse(rsp *http.Response) (*GetNetworkResponse, error)

ParseGetNetworkResponse parses an HTTP response from a GetNetworkWithResponse call

func (GetNetworkResponse) Status

func (r GetNetworkResponse) Status() string

Status returns HTTPResponse.Status

func (GetNetworkResponse) StatusCode

func (r GetNetworkResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNetworksParams

type GetNetworksParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetNetworksParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Environment `filter[environment]=ID` Filter networks based on linked environment. Submit the ID of the environment you wish to filter for.
		Environment *string `json:"environment,omitempty"`

		// Search `filter[search]=value` search for a value associated with a field on the given Network(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the network's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetNetworksParams defines parameters for GetNetworks.

type GetNetworksParamsInclude

type GetNetworksParamsInclude string

GetNetworksParamsInclude defines parameters for GetNetworks.

const (
	GetNetworksParamsIncludeCreators     GetNetworksParamsInclude = "creators"
	GetNetworksParamsIncludeEnvironments GetNetworksParamsInclude = "environments"
)

Defines values for GetNetworksParamsInclude.

type GetNetworksResponse

type GetNetworksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Network `json:"data"`

		// Includes All includable resource linkable to the given network.
		Includes *NetworkIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetNetworksResponse

func ParseGetNetworksResponse(rsp *http.Response) (*GetNetworksResponse, error)

ParseGetNetworksResponse parses an HTTP response from a GetNetworksWithResponse call

func (GetNetworksResponse) Status

func (r GetNetworksResponse) Status() string

Status returns HTTPResponse.Status

func (GetNetworksResponse) StatusCode

func (r GetNetworksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrdersParams

type GetOrdersParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page    *PageParam             `json:"page,omitempty"`
	Meta    *[]GetOrdersParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
	Include *OrderIncludeParam     `form:"include,omitempty" json:"include,omitempty"`
}

GetOrdersParams defines parameters for GetOrders.

type GetOrdersParamsInclude

type GetOrdersParamsInclude string

GetOrdersParamsInclude defines parameters for GetOrders.

const (
	GetOrdersParamsIncludePromoCodes GetOrdersParamsInclude = "promo_codes"
)

Defines values for GetOrdersParamsInclude.

type GetOrdersParamsMeta

type GetOrdersParamsMeta string

GetOrdersParamsMeta defines parameters for GetOrders.

const (
	GetOrdersParamsMetaDue GetOrdersParamsMeta = "due"
)

Defines values for GetOrdersParamsMeta.

type GetOrdersResponse

type GetOrdersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data     []Order               `json:"data"`
		Includes *BillingOrderIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetOrdersResponse

func ParseGetOrdersResponse(rsp *http.Response) (*GetOrdersResponse, error)

ParseGetOrdersResponse parses an HTTP response from a GetOrdersWithResponse call

func (GetOrdersResponse) Status

func (r GetOrdersResponse) Status() string

Status returns HTTPResponse.Status

func (GetOrdersResponse) StatusCode

func (r GetOrdersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPipelineParams

type GetPipelineParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetPipelineParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetPipelineParams defines parameters for GetPipeline.

type GetPipelineParamsInclude

type GetPipelineParamsInclude string

GetPipelineParamsInclude defines parameters for GetPipeline.

const (
	GetPipelineParamsIncludeComponents GetPipelineParamsInclude = "components"
	GetPipelineParamsIncludeCreators   GetPipelineParamsInclude = "creators"
	GetPipelineParamsIncludeName       GetPipelineParamsInclude = "name"
)

Defines values for GetPipelineParamsInclude.

type GetPipelineResponse

type GetPipelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A pipeline resource.
		Data Pipeline `json:"data"`

		// Includes All includable resources linkable to the given pipeline.
		Includes *PipelineIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetPipelineResponse

func ParseGetPipelineResponse(rsp *http.Response) (*GetPipelineResponse, error)

ParseGetPipelineResponse parses an HTTP response from a GetPipelineWithResponse call

func (GetPipelineResponse) Status

func (r GetPipelineResponse) Status() string

Status returns HTTPResponse.Status

func (GetPipelineResponse) StatusCode

func (r GetPipelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPipelineRunParams

type GetPipelineRunParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetPipelineRunParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetPipelineRunParams defines parameters for GetPipelineRun.

type GetPipelineRunParamsInclude

type GetPipelineRunParamsInclude string

GetPipelineRunParamsInclude defines parameters for GetPipelineRun.

const (
	GetPipelineRunParamsIncludeCreators GetPipelineRunParamsInclude = "creators"
)

Defines values for GetPipelineRunParamsInclude.

type GetPipelineRunResponse

type GetPipelineRunResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A pipeline run resource.
		Data     PipelineRun `json:"data"`
		Includes *struct {
			// Creators An identity that created a resource.
			Creators *CreatorInclude `json:"creators,omitempty"`
		} `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetPipelineRunResponse

func ParseGetPipelineRunResponse(rsp *http.Response) (*GetPipelineRunResponse, error)

ParseGetPipelineRunResponse parses an HTTP response from a GetPipelineRunWithResponse call

func (GetPipelineRunResponse) Status

func (r GetPipelineRunResponse) Status() string

Status returns HTTPResponse.Status

func (GetPipelineRunResponse) StatusCode

func (r GetPipelineRunResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPipelineRunsParams

type GetPipelineRunsParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetPipelineRunsParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetPipelineRunsParams defines parameters for GetPipelineRuns.

type GetPipelineRunsParamsInclude

type GetPipelineRunsParamsInclude string

GetPipelineRunsParamsInclude defines parameters for GetPipelineRuns.

const (
	GetPipelineRunsParamsIncludeCreators GetPipelineRunsParamsInclude = "creators"
)

Defines values for GetPipelineRunsParamsInclude.

type GetPipelineRunsResponse

type GetPipelineRunsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data     []PipelineRun `json:"data"`
		Includes *struct {
			// Creators An identity that created a resource.
			Creators *CreatorInclude `json:"creators,omitempty"`
		} `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetPipelineRunsResponse

func ParseGetPipelineRunsResponse(rsp *http.Response) (*GetPipelineRunsResponse, error)

ParseGetPipelineRunsResponse parses an HTTP response from a GetPipelineRunsWithResponse call

func (GetPipelineRunsResponse) Status

func (r GetPipelineRunsResponse) Status() string

Status returns HTTPResponse.Status

func (GetPipelineRunsResponse) StatusCode

func (r GetPipelineRunsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPipelineTriggerKeyResponse

type GetPipelineTriggerKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A pipeline trigger key resource.
		Data *TriggerKey `json:"data,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetPipelineTriggerKeyResponse

func ParseGetPipelineTriggerKeyResponse(rsp *http.Response) (*GetPipelineTriggerKeyResponse, error)

ParseGetPipelineTriggerKeyResponse parses an HTTP response from a GetPipelineTriggerKeyWithResponse call

func (GetPipelineTriggerKeyResponse) Status

Status returns HTTPResponse.Status

func (GetPipelineTriggerKeyResponse) StatusCode

func (r GetPipelineTriggerKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPipelineTriggerKeysParams

type GetPipelineTriggerKeysParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Search `filter[search]=value` search for a value associated with a field on the given Trigger Key(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the Trigger Key's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetPipelineTriggerKeysParams defines parameters for GetPipelineTriggerKeys.

type GetPipelineTriggerKeysResponse

type GetPipelineTriggerKeysResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []TriggerKey `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetPipelineTriggerKeysResponse

func ParseGetPipelineTriggerKeysResponse(rsp *http.Response) (*GetPipelineTriggerKeysResponse, error)

ParseGetPipelineTriggerKeysResponse parses an HTTP response from a GetPipelineTriggerKeysWithResponse call

func (GetPipelineTriggerKeysResponse) Status

Status returns HTTPResponse.Status

func (GetPipelineTriggerKeysResponse) StatusCode

func (r GetPipelineTriggerKeysResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPipelinesParams

type GetPipelinesParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetPipelinesParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Identifier `filter[identifier]=value` List only those pipelines matching this identifier. May return multiple results.
		Identifier *string `json:"identifier,omitempty"`

		// Search `filter[search]=value` search for a value associated with a field on the given pipelines(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the Pipeline's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetPipelinesParams defines parameters for GetPipelines.

type GetPipelinesParamsInclude

type GetPipelinesParamsInclude string

GetPipelinesParamsInclude defines parameters for GetPipelines.

const (
	GetPipelinesParamsIncludeComponents GetPipelinesParamsInclude = "components"
	GetPipelinesParamsIncludeCreators   GetPipelinesParamsInclude = "creators"
	GetPipelinesParamsIncludeName       GetPipelinesParamsInclude = "name"
)

Defines values for GetPipelinesParamsInclude.

type GetPipelinesResponse

type GetPipelinesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Pipeline `json:"data"`

		// Includes All includable resources linkable to the given pipeline.
		Includes *PipelineIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetPipelinesResponse

func ParseGetPipelinesResponse(rsp *http.Response) (*GetPipelinesResponse, error)

ParseGetPipelinesResponse parses an HTTP response from a GetPipelinesWithResponse call

func (GetPipelinesResponse) Status

func (r GetPipelinesResponse) Status() string

Status returns HTTPResponse.Status

func (GetPipelinesResponse) StatusCode

func (r GetPipelinesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPoolIPsResponse

type GetPoolIPsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Ip `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetPoolIPsResponse

func ParseGetPoolIPsResponse(rsp *http.Response) (*GetPoolIPsResponse, error)

ParseGetPoolIPsResponse parses an HTTP response from a GetPoolIPsWithResponse call

func (GetPoolIPsResponse) Status

func (r GetPoolIPsResponse) Status() string

Status returns HTTPResponse.Status

func (GetPoolIPsResponse) StatusCode

func (r GetPoolIPsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetProviderLocationsParams

type GetProviderLocationsParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetProviderLocationsParams defines parameters for GetProviderLocations.

type GetProviderLocationsResponse

type GetProviderLocationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []ProviderLocation `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetProviderLocationsResponse

func ParseGetProviderLocationsResponse(rsp *http.Response) (*GetProviderLocationsResponse, error)

ParseGetProviderLocationsResponse parses an HTTP response from a GetProviderLocationsWithResponse call

func (GetProviderLocationsResponse) Status

Status returns HTTPResponse.Status

func (GetProviderLocationsResponse) StatusCode

func (r GetProviderLocationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetProviderServerModelsParams added in v0.6.6

type GetProviderServerModelsParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// LocationIds `filter[location_ids]=value` List only those provider servers matching this location. May return multiple results.
		LocationIds *string `json:"location_ids,omitempty"`
	} `json:"filter,omitempty"`
}

GetProviderServerModelsParams defines parameters for GetProviderServerModels.

type GetProviderServerModelsResponse added in v0.6.6

type GetProviderServerModelsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []ProviderServerModel `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetProviderServerModelsResponse added in v0.6.6

func ParseGetProviderServerModelsResponse(rsp *http.Response) (*GetProviderServerModelsResponse, error)

ParseGetProviderServerModelsResponse parses an HTTP response from a GetProviderServerModelsWithResponse call

func (GetProviderServerModelsResponse) Status added in v0.6.6

Status returns HTTPResponse.Status

func (GetProviderServerModelsResponse) StatusCode added in v0.6.6

func (r GetProviderServerModelsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRoleParams

type GetRoleParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetRoleParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
}

GetRoleParams defines parameters for GetRole.

type GetRoleParamsMeta

type GetRoleParamsMeta string

GetRoleParamsMeta defines parameters for GetRole.

const (
	GetRoleParamsMetaCounts GetRoleParamsMeta = "counts"
)

Defines values for GetRoleParamsMeta.

type GetRoleResponse

type GetRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A Role is a custom combination of platform-level capabilities, allowing for fully customizable role-based access controls across the platform.
		Data *Role `json:"data,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetRoleResponse

func ParseGetRoleResponse(rsp *http.Response) (*GetRoleResponse, error)

ParseGetRoleResponse parses an HTTP response from a GetRoleWithResponse call

func (GetRoleResponse) Status

func (r GetRoleResponse) Status() string

Status returns HTTPResponse.Status

func (GetRoleResponse) StatusCode

func (r GetRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRolesParams

type GetRolesParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort   *SortParam   `form:"sort,omitempty" json:"sort,omitempty"`
	Filter *FilterParam `json:"filter,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetRolesParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
}

GetRolesParams defines parameters for GetRoles.

type GetRolesParamsMeta

type GetRolesParamsMeta string

GetRolesParamsMeta defines parameters for GetRoles.

const (
	GetRolesParamsMetaCounts GetRolesParamsMeta = "counts"
)

Defines values for GetRolesParamsMeta.

type GetRolesResponse

type GetRolesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Role `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetRolesResponse

func ParseGetRolesResponse(rsp *http.Response) (*GetRolesResponse, error)

ParseGetRolesResponse parses an HTTP response from a GetRolesWithResponse call

func (GetRolesResponse) Status

func (r GetRolesResponse) Status() string

Status returns HTTPResponse.Status

func (GetRolesResponse) StatusCode

func (r GetRolesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetScopedVariableResponse

type GetScopedVariableResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Scoped variables are a way for users to dynamically allocate runtime specific environment variables across any number of containers in an environment.
		Data ScopedVariable `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetScopedVariableResponse

func ParseGetScopedVariableResponse(rsp *http.Response) (*GetScopedVariableResponse, error)

ParseGetScopedVariableResponse parses an HTTP response from a GetScopedVariableWithResponse call

func (GetScopedVariableResponse) Status

func (r GetScopedVariableResponse) Status() string

Status returns HTTPResponse.Status

func (GetScopedVariableResponse) StatusCode

func (r GetScopedVariableResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetScopedVariablesParams

type GetScopedVariablesParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Container `filter[container]=value` List only those scoped variables assigned to the specified container ID.
		Container *string `json:"container,omitempty"`

		// Identifier `filter[identifier]=value` List only those scoped variables matching this identifier. May return multiple results.
		Identifier *string `json:"identifier,omitempty"`

		// Search `filter[search]=value` search for a value associated with a field on the given scoped variable(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the scoped variable's current state.
		State *string `json:"state,omitempty"`
	} `form:"filter,omitempty" json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetScopedVariablesParams defines parameters for GetScopedVariables.

type GetScopedVariablesResponse

type GetScopedVariablesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []ScopedVariable `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetScopedVariablesResponse

func ParseGetScopedVariablesResponse(rsp *http.Response) (*GetScopedVariablesResponse, error)

ParseGetScopedVariablesResponse parses an HTTP response from a GetScopedVariablesWithResponse call

func (GetScopedVariablesResponse) Status

Status returns HTTPResponse.Status

func (GetScopedVariablesResponse) StatusCode

func (r GetScopedVariablesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSearchIndexResponse

type GetSearchIndexResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An index that enables search in the portal
		Data Index `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetSearchIndexResponse

func ParseGetSearchIndexResponse(rsp *http.Response) (*GetSearchIndexResponse, error)

ParseGetSearchIndexResponse parses an HTTP response from a GetSearchIndexWithResponse call

func (GetSearchIndexResponse) Status

func (r GetSearchIndexResponse) Status() string

Status returns HTTPResponse.Status

func (GetSearchIndexResponse) StatusCode

func (r GetSearchIndexResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServerConsoleResponse

type GetServerConsoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			// Address The websocket target URL.
			Address string `json:"address"`

			// Token The authentication token for the console socket. It should be appended as the URL parameter "token" to the address.
			Token string `json:"token"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetServerConsoleResponse

func ParseGetServerConsoleResponse(rsp *http.Response) (*GetServerConsoleResponse, error)

ParseGetServerConsoleResponse parses an HTTP response from a GetServerConsoleWithResponse call

func (GetServerConsoleResponse) Status

func (r GetServerConsoleResponse) Status() string

Status returns HTTPResponse.Status

func (GetServerConsoleResponse) StatusCode

func (r GetServerConsoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServerInstancesParams

type GetServerInstancesParams struct {
	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetServerInstancesParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetServerInstancesParams defines parameters for GetServerInstances.

type GetServerInstancesParamsInclude

type GetServerInstancesParamsInclude string

GetServerInstancesParamsInclude defines parameters for GetServerInstances.

const (
	GetServerInstancesParamsIncludeContainers   GetServerInstancesParamsInclude = "containers"
	GetServerInstancesParamsIncludeCreator      GetServerInstancesParamsInclude = "creator"
	GetServerInstancesParamsIncludeEnvironments GetServerInstancesParamsInclude = "environments"
	GetServerInstancesParamsIncludeIntegrations GetServerInstancesParamsInclude = "integrations"
	GetServerInstancesParamsIncludeLocations    GetServerInstancesParamsInclude = "locations"
	GetServerInstancesParamsIncludeServers      GetServerInstancesParamsInclude = "servers"
)

Defines values for GetServerInstancesParamsInclude.

type GetServerInstancesResponse

type GetServerInstancesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Instance `json:"data"`

		// Includes A resource associated with an instance.
		Includes *InstanceIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetServerInstancesResponse

func ParseGetServerInstancesResponse(rsp *http.Response) (*GetServerInstancesResponse, error)

ParseGetServerInstancesResponse parses an HTTP response from a GetServerInstancesWithResponse call

func (GetServerInstancesResponse) Status

Status returns HTTPResponse.Status

func (GetServerInstancesResponse) StatusCode

func (r GetServerInstancesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServerParams

type GetServerParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetServerParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetServerParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
}

GetServerParams defines parameters for GetServer.

type GetServerParamsInclude

type GetServerParamsInclude string

GetServerParamsInclude defines parameters for GetServer.

const (
	GetServerParamsIncludeClusters     GetServerParamsInclude = "clusters"
	GetServerParamsIncludeIntegrations GetServerParamsInclude = "integrations"
	GetServerParamsIncludeLocations    GetServerParamsInclude = "locations"
	GetServerParamsIncludeModels       GetServerParamsInclude = "models"
)

Defines values for GetServerParamsInclude.

type GetServerParamsMeta

type GetServerParamsMeta string

GetServerParamsMeta defines parameters for GetServer.

const (
	GetServerParamsMetaAllocations    GetServerParamsMeta = "allocations"
	GetServerParamsMetaInstancesCount GetServerParamsMeta = "instances_count"
	GetServerParamsMetaNode           GetServerParamsMeta = "node"
)

Defines values for GetServerParamsMeta.

type GetServerResponse

type GetServerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data The server resource, referring to servers that have been deployed to a Cycle hub.
		Data Server `json:"data"`

		// Includes A resource associated with a server.
		Includes *ServerIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetServerResponse

func ParseGetServerResponse(rsp *http.Response) (*GetServerResponse, error)

ParseGetServerResponse parses an HTTP response from a GetServerWithResponse call

func (GetServerResponse) Status

func (r GetServerResponse) Status() string

Status returns HTTPResponse.Status

func (GetServerResponse) StatusCode

func (r GetServerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServerTagsParams

type GetServerTagsParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Cluster `filter[cluster]=clusterone,clustertwo` filtering by cluster.  Enter one or more clusters (commas separated) and the return will include tags from servers that match any cluster(s) in the list.
		Cluster *string `json:"cluster,omitempty"`
	} `json:"filter,omitempty"`
}

GetServerTagsParams defines parameters for GetServerTags.

type GetServerTagsResponse

type GetServerTagsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ServerTags
	JSONDefault  *DefaultError
}

func ParseGetServerTagsResponse

func ParseGetServerTagsResponse(rsp *http.Response) (*GetServerTagsResponse, error)

ParseGetServerTagsResponse parses an HTTP response from a GetServerTagsWithResponse call

func (GetServerTagsResponse) Status

func (r GetServerTagsResponse) Status() string

Status returns HTTPResponse.Status

func (GetServerTagsResponse) StatusCode

func (r GetServerTagsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServerTelemetryParams

type GetServerTelemetryParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		RangeEnd   *DateTime `json:"range-end,omitempty"`
		RangeStart *DateTime `json:"range-start,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetServerTelemetryParams defines parameters for GetServerTelemetry.

type GetServerTelemetryResponse

type GetServerTelemetryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []ServerStatsTelemetry `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetServerTelemetryResponse

func ParseGetServerTelemetryResponse(rsp *http.Response) (*GetServerTelemetryResponse, error)

ParseGetServerTelemetryResponse parses an HTTP response from a GetServerTelemetryWithResponse call

func (GetServerTelemetryResponse) Status

Status returns HTTPResponse.Status

func (GetServerTelemetryResponse) StatusCode

func (r GetServerTelemetryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServerUsageResponse

type GetServerUsageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Server usage data.
		Data UsageDatum `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetServerUsageResponse

func ParseGetServerUsageResponse(rsp *http.Response) (*GetServerUsageResponse, error)

ParseGetServerUsageResponse parses an HTTP response from a GetServerUsageWithResponse call

func (GetServerUsageResponse) Status

func (r GetServerUsageResponse) Status() string

Status returns HTTPResponse.Status

func (GetServerUsageResponse) StatusCode

func (r GetServerUsageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServersParams

type GetServersParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetServersParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetServersParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Cluster `filter[cluster]=clusterIdentifier` filtering by cluster.  Enter the cluster identifier and the return will include servers belonging to the specified cluster.
		Cluster *string `json:"cluster,omitempty"`

		// Location `filter[location]=location` filtering by location.  Enter the location id and the return will include servers belonging to the specified location.
		Location *string `json:"location,omitempty"`

		// Providers `filter[providers]=providerone,providertwo` filtering by provider.  Enter one or more providers (commas separated) and the return will include servers that match any providers in the list.
		Providers *string `json:"providers,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state.
		State *string `json:"state,omitempty"`

		// Tags `filter[tags]=tagone,tagtwo,tagthree` filtering by Server tag.  Enter one or more tags (comma separated) and the return will include servers that match any tags in the list.
		Tags *string `json:"tags,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetServersParams defines parameters for GetServers.

type GetServersParamsInclude

type GetServersParamsInclude string

GetServersParamsInclude defines parameters for GetServers.

const (
	GetServersParamsIncludeClusters     GetServersParamsInclude = "clusters"
	GetServersParamsIncludeIntegrations GetServersParamsInclude = "integrations"
	GetServersParamsIncludeLocations    GetServersParamsInclude = "locations"
	GetServersParamsIncludeModels       GetServersParamsInclude = "models"
)

Defines values for GetServersParamsInclude.

type GetServersParamsMeta

type GetServersParamsMeta string

GetServersParamsMeta defines parameters for GetServers.

const (
	GetServersParamsMetaInstancesCount GetServersParamsMeta = "instances_count"
	GetServersParamsMetaNode           GetServersParamsMeta = "node"
)

Defines values for GetServersParamsMeta.

type GetServersResponse

type GetServersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Server `json:"data"`

		// Includes A resource associated with a server.
		Includes *ServerIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetServersResponse

func ParseGetServersResponse(rsp *http.Response) (*GetServersResponse, error)

ParseGetServersResponse parses an HTTP response from a GetServersWithResponse call

func (GetServersResponse) Status

func (r GetServersResponse) Status() string

Status returns HTTPResponse.Status

func (GetServersResponse) StatusCode

func (r GetServersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStackBuildLogResponse

type GetStackBuildLogResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A build log for a given stack build.
		Data StackBuildLog `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetStackBuildLogResponse

func ParseGetStackBuildLogResponse(rsp *http.Response) (*GetStackBuildLogResponse, error)

ParseGetStackBuildLogResponse parses an HTTP response from a GetStackBuildLogWithResponse call

func (GetStackBuildLogResponse) Status

func (r GetStackBuildLogResponse) Status() string

Status returns HTTPResponse.Status

func (GetStackBuildLogResponse) StatusCode

func (r GetStackBuildLogResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStackBuildResponse

type GetStackBuildResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A stack build resource.
		Data StackBuild `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetStackBuildResponse

func ParseGetStackBuildResponse(rsp *http.Response) (*GetStackBuildResponse, error)

ParseGetStackBuildResponse parses an HTTP response from a GetStackBuildWithResponse call

func (GetStackBuildResponse) Status

func (r GetStackBuildResponse) Status() string

Status returns HTTPResponse.Status

func (GetStackBuildResponse) StatusCode

func (r GetStackBuildResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStackBuildsParams

type GetStackBuildsParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetStackBuildsParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Search `filter[search]=value` search for a value associated with a field on the given Stack Build(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the Stack Build's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetStackBuildsParams defines parameters for GetStackBuilds.

type GetStackBuildsParamsMeta

type GetStackBuildsParamsMeta string

GetStackBuildsParamsMeta defines parameters for GetStackBuilds.

const (
	ContainersCount GetStackBuildsParamsMeta = "containers_count"
)

Defines values for GetStackBuildsParamsMeta.

type GetStackBuildsResponse

type GetStackBuildsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []StackBuild `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetStackBuildsResponse

func ParseGetStackBuildsResponse(rsp *http.Response) (*GetStackBuildsResponse, error)

ParseGetStackBuildsResponse parses an HTTP response from a GetStackBuildsWithResponse call

func (GetStackBuildsResponse) Status

func (r GetStackBuildsResponse) Status() string

Status returns HTTPResponse.Status

func (GetStackBuildsResponse) StatusCode

func (r GetStackBuildsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStackResponse

type GetStackResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Stacks are a way to orchestrate multiple containers atomically and automatically.
		Data Stack `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetStackResponse

func ParseGetStackResponse(rsp *http.Response) (*GetStackResponse, error)

ParseGetStackResponse parses an HTTP response from a GetStackWithResponse call

func (GetStackResponse) Status

func (r GetStackResponse) Status() string

Status returns HTTPResponse.Status

func (GetStackResponse) StatusCode

func (r GetStackResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStacksParams

type GetStacksParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetStacksParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetStacksParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Identifier `filter[identifier]=value` List only those stacks matching this identifier. May return multiple results.
		Identifier *string `json:"identifier,omitempty"`

		// Search `filter[search]=value` search for a value associated with a field on the given Stack(s).
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow you to filter by the Stack's current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetStacksParams defines parameters for GetStacks.

type GetStacksParamsInclude

type GetStacksParamsInclude string

GetStacksParamsInclude defines parameters for GetStacks.

const (
	GetStacksParamsIncludeCreators GetStacksParamsInclude = "creators"
)

Defines values for GetStacksParamsInclude.

type GetStacksParamsMeta

type GetStacksParamsMeta string

GetStacksParamsMeta defines parameters for GetStacks.

const (
	GetStacksParamsMetaBuildsCount     GetStacksParamsMeta = "builds_count"
	GetStacksParamsMetaContainersCount GetStacksParamsMeta = "containers_count"
)

Defines values for GetStacksParamsMeta.

type GetStacksResponse

type GetStacksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Stack `json:"data"`

		// Includes All includable resources linkable to the given stack.
		Includes *StackInclude `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetStacksResponse

func ParseGetStacksResponse(rsp *http.Response) (*GetStacksResponse, error)

ParseGetStacksResponse parses an HTTP response from a GetStacksWithResponse call

func (GetStacksResponse) Status

func (r GetStacksResponse) Status() string

Status returns HTTPResponse.Status

func (GetStacksResponse) StatusCode

func (r GetStacksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTLSGenerationAttemptsParams

type GetTLSGenerationAttemptsParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Domain `filter[domain]=value` filter the return for TLS attempts by domain.
		Domain *string `json:"domain,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetTLSGenerationAttemptsParams defines parameters for GetTLSGenerationAttempts.

type GetTLSGenerationAttemptsResponse

type GetTLSGenerationAttemptsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []Attempt `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetTLSGenerationAttemptsResponse

func ParseGetTLSGenerationAttemptsResponse(rsp *http.Response) (*GetTLSGenerationAttemptsResponse, error)

ParseGetTLSGenerationAttemptsResponse parses an HTTP response from a GetTLSGenerationAttemptsWithResponse call

func (GetTLSGenerationAttemptsResponse) Status

Status returns HTTPResponse.Status

func (GetTLSGenerationAttemptsResponse) StatusCode

func (r GetTLSGenerationAttemptsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTwoFactorAuthSetupResponse

type GetTwoFactorAuthSetupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data *TwoFactorAuthSetup `json:"data,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetTwoFactorAuthSetupResponse

func ParseGetTwoFactorAuthSetupResponse(rsp *http.Response) (*GetTwoFactorAuthSetupResponse, error)

ParseGetTwoFactorAuthSetupResponse parses an HTTP response from a GetTwoFactorAuthSetupWithResponse call

func (GetTwoFactorAuthSetupResponse) Status

Status returns HTTPResponse.Status

func (GetTwoFactorAuthSetupResponse) StatusCode

func (r GetTwoFactorAuthSetupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUserSuppliedCertificateResponse

type GetUserSuppliedCertificateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A TLS certificate.
		Data TlsCertificate `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetUserSuppliedCertificateResponse

func ParseGetUserSuppliedCertificateResponse(rsp *http.Response) (*GetUserSuppliedCertificateResponse, error)

ParseGetUserSuppliedCertificateResponse parses an HTTP response from a GetUserSuppliedCertificateWithResponse call

func (GetUserSuppliedCertificateResponse) Status

Status returns HTTPResponse.Status

func (GetUserSuppliedCertificateResponse) StatusCode

func (r GetUserSuppliedCertificateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUserSuppliedCertificatesParams

type GetUserSuppliedCertificatesParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Domain `filter[domain]=value1` filter user certificates by associated domain.
		Domain *string `json:"domain,omitempty"`

		// State `filter[state]=value1,value2` state filtering will allow filtering by the current state.
		State *string `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetUserSuppliedCertificatesParams defines parameters for GetUserSuppliedCertificates.

type GetUserSuppliedCertificatesResponse

type GetUserSuppliedCertificatesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []TlsCertificate `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetUserSuppliedCertificatesResponse

func ParseGetUserSuppliedCertificatesResponse(rsp *http.Response) (*GetUserSuppliedCertificatesResponse, error)

ParseGetUserSuppliedCertificatesResponse parses an HTTP response from a GetUserSuppliedCertificatesWithResponse call

func (GetUserSuppliedCertificatesResponse) Status

Status returns HTTPResponse.Status

func (GetUserSuppliedCertificatesResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetVPNLoginsParams

type GetVPNLoginsParams struct {
	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetVPNLoginsParams defines parameters for GetVPNLogins.

type GetVPNLoginsResponse

type GetVPNLoginsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []VPNLogin `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetVPNLoginsResponse

func ParseGetVPNLoginsResponse(rsp *http.Response) (*GetVPNLoginsResponse, error)

ParseGetVPNLoginsResponse parses an HTTP response from a GetVPNLoginsWithResponse call

func (GetVPNLoginsResponse) Status

func (r GetVPNLoginsResponse) Status() string

Status returns HTTPResponse.Status

func (GetVPNLoginsResponse) StatusCode

func (r GetVPNLoginsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVPNServiceResponse

type GetVPNServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A summary of a VPN service for a given environment.
		Data VPNInfoReturn `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetVPNServiceResponse

func ParseGetVPNServiceResponse(rsp *http.Response) (*GetVPNServiceResponse, error)

ParseGetVPNServiceResponse parses an HTTP response from a GetVPNServiceWithResponse call

func (GetVPNServiceResponse) Status

func (r GetVPNServiceResponse) Status() string

Status returns HTTPResponse.Status

func (GetVPNServiceResponse) StatusCode

func (r GetVPNServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVPNUsersResponse

type GetVPNUsersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []VPNUsers `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetVPNUsersResponse

func ParseGetVPNUsersResponse(rsp *http.Response) (*GetVPNUsersResponse, error)

ParseGetVPNUsersResponse parses an HTTP response from a GetVPNUsersWithResponse call

func (GetVPNUsersResponse) Status

func (r GetVPNUsersResponse) Status() string

Status returns HTTPResponse.Status

func (GetVPNUsersResponse) StatusCode

func (r GetVPNUsersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVirtualMachineBaseImagesResponse

type GetVirtualMachineBaseImagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data map[string]VirtualMachineBaseImage `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetVirtualMachineBaseImagesResponse

func ParseGetVirtualMachineBaseImagesResponse(rsp *http.Response) (*GetVirtualMachineBaseImagesResponse, error)

ParseGetVirtualMachineBaseImagesResponse parses an HTTP response from a GetVirtualMachineBaseImagesWithResponse call

func (GetVirtualMachineBaseImagesResponse) Status

Status returns HTTPResponse.Status

func (GetVirtualMachineBaseImagesResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetVirtualMachineParams

type GetVirtualMachineParams struct {
	// Meta A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
	// In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
	// In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetVirtualMachineParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]GetVirtualMachineParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetVirtualMachineParams defines parameters for GetVirtualMachine.

type GetVirtualMachineParamsInclude

type GetVirtualMachineParamsInclude string

GetVirtualMachineParamsInclude defines parameters for GetVirtualMachine.

const (
	Clusters     GetVirtualMachineParamsInclude = "clusters"
	Containers   GetVirtualMachineParamsInclude = "containers"
	Creators     GetVirtualMachineParamsInclude = "creators"
	Environments GetVirtualMachineParamsInclude = "environments"
)

Defines values for GetVirtualMachineParamsInclude.

type GetVirtualMachineParamsMeta

type GetVirtualMachineParamsMeta string

GetVirtualMachineParamsMeta defines parameters for GetVirtualMachine.

const (
	GetVirtualMachineParamsMetaDomains       GetVirtualMachineParamsMeta = "domains"
	GetVirtualMachineParamsMetaHypervisorIps GetVirtualMachineParamsMeta = "hypervisor_ips"
	GetVirtualMachineParamsMetaIps           GetVirtualMachineParamsMeta = "ips"
	GetVirtualMachineParamsMetaServer        GetVirtualMachineParamsMeta = "server"
)

Defines values for GetVirtualMachineParamsMeta.

type GetVirtualMachineResponse

type GetVirtualMachineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Describes a virtual machine running on the Cycle Platform.
		Data VirtualMachine `json:"data"`

		// Includes All includable resources linkable to the given virtual machine.
		Includes *VirtualMachineIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetVirtualMachineResponse

func ParseGetVirtualMachineResponse(rsp *http.Response) (*GetVirtualMachineResponse, error)

ParseGetVirtualMachineResponse parses an HTTP response from a GetVirtualMachineWithResponse call

func (GetVirtualMachineResponse) Status

func (r GetVirtualMachineResponse) Status() string

Status returns HTTPResponse.Status

func (GetVirtualMachineResponse) StatusCode

func (r GetVirtualMachineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVirtualMachineSshKeyParams

type GetVirtualMachineSshKeyParams struct {
	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]GetVirtualMachineSshKeyParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetVirtualMachineSshKeyParams defines parameters for GetVirtualMachineSshKey.

type GetVirtualMachineSshKeyParamsInclude

type GetVirtualMachineSshKeyParamsInclude string

GetVirtualMachineSshKeyParamsInclude defines parameters for GetVirtualMachineSshKey.

const (
	GetVirtualMachineSshKeyParamsIncludeCreators     GetVirtualMachineSshKeyParamsInclude = "creators"
	GetVirtualMachineSshKeyParamsIncludeEnvironments GetVirtualMachineSshKeyParamsInclude = "environments"
)

Defines values for GetVirtualMachineSshKeyParamsInclude.

type GetVirtualMachineSshKeyResponse

type GetVirtualMachineSshKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Describes an SSH key used to access a virtual machine.
		Data VirtualMachineSshKey `json:"data"`

		// Includes All includable resources linkable to the given virtual machine SSH key.
		Includes *VirtualMachineSshIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetVirtualMachineSshKeyResponse

func ParseGetVirtualMachineSshKeyResponse(rsp *http.Response) (*GetVirtualMachineSshKeyResponse, error)

ParseGetVirtualMachineSshKeyResponse parses an HTTP response from a GetVirtualMachineSshKeyWithResponse call

func (GetVirtualMachineSshKeyResponse) Status

Status returns HTTPResponse.Status

func (GetVirtualMachineSshKeyResponse) StatusCode

func (r GetVirtualMachineSshKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVirtualMachineSshKeysParams

type GetVirtualMachineSshKeysParams struct {
	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Creator `filter[creator]=account-ID` Filter for SSH keys matching a particular creator, such as `account-<ID>` or `environment-<ID>`.
		Creator *string `json:"creator,omitempty"`

		// Environment `filter[environment]=ID` Filter SSH keys by environment ID. Submit the ID of the environment you wish to filter for.
		Environment *string `json:"environment,omitempty"`

		// Identifier `filter[identifier]=value` List only those SSH keys matching this identifier. May return multiple results.
		Identifier *string   `json:"identifier,omitempty"`
		RangeEnd   *DateTime `json:"range-end,omitempty"`
		RangeStart *DateTime `json:"range-start,omitempty"`

		// Search `filter[search]=value` Search SSH keys for a value associated with a field.
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value` Filter virtual machines by their current state.
		State *GetVirtualMachineSshKeysParamsFilterState `json:"state,omitempty"`
	} `json:"filter,omitempty"`

	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]GetVirtualMachineSshKeysParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetVirtualMachineSshKeysParams defines parameters for GetVirtualMachineSshKeys.

type GetVirtualMachineSshKeysParamsFilterState

type GetVirtualMachineSshKeysParamsFilterState string

GetVirtualMachineSshKeysParamsFilterState defines parameters for GetVirtualMachineSshKeys.

const (
	GetVirtualMachineSshKeysParamsFilterStateDeleted  GetVirtualMachineSshKeysParamsFilterState = "deleted"
	GetVirtualMachineSshKeysParamsFilterStateDeleting GetVirtualMachineSshKeysParamsFilterState = "deleting"
	GetVirtualMachineSshKeysParamsFilterStateLive     GetVirtualMachineSshKeysParamsFilterState = "live"
)

Defines values for GetVirtualMachineSshKeysParamsFilterState.

type GetVirtualMachineSshKeysParamsInclude

type GetVirtualMachineSshKeysParamsInclude string

GetVirtualMachineSshKeysParamsInclude defines parameters for GetVirtualMachineSshKeys.

const (
	GetVirtualMachineSshKeysParamsIncludeCreators     GetVirtualMachineSshKeysParamsInclude = "creators"
	GetVirtualMachineSshKeysParamsIncludeEnvironments GetVirtualMachineSshKeysParamsInclude = "environments"
)

Defines values for GetVirtualMachineSshKeysParamsInclude.

type GetVirtualMachineSshKeysResponse

type GetVirtualMachineSshKeysResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []VirtualMachineSshKey `json:"data"`

		// Includes All includable resources linkable to the given virtual machine SSH key.
		Includes *VirtualMachineSshIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetVirtualMachineSshKeysResponse

func ParseGetVirtualMachineSshKeysResponse(rsp *http.Response) (*GetVirtualMachineSshKeysResponse, error)

ParseGetVirtualMachineSshKeysResponse parses an HTTP response from a GetVirtualMachineSshKeysWithResponse call

func (GetVirtualMachineSshKeysResponse) Status

Status returns HTTPResponse.Status

func (GetVirtualMachineSshKeysResponse) StatusCode

func (r GetVirtualMachineSshKeysResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVirtualMachinesParams

type GetVirtualMachinesParams struct {
	// Meta A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
	// In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
	// In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]GetVirtualMachinesParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]GetVirtualMachinesParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Filter The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	Filter *struct {
		// Creator `filter[creator]=account-ID` Filter for virtual machines matching a particular creator, such as `account-<ID>` or `environment-<ID>`.
		Creator *string `json:"creator,omitempty"`

		// Environment `filter[environment]=ID` Filter virtual machines by environment ID. Submit the ID of the environment you wish to filter for.
		Environment *string `json:"environment,omitempty"`

		// Identifier `filter[identifier]=value` List only those virtual machines matching this identifier. May return multiple results.
		Identifier *string `json:"identifier,omitempty"`

		// PublicNetwork `filter[public_network]=value` Filter virtual machines by their public network status.
		PublicNetwork *GetVirtualMachinesParamsFilterPublicNetwork `json:"public_network,omitempty"`
		RangeEnd      *DateTime                                    `json:"range-end,omitempty"`
		RangeStart    *DateTime                                    `json:"range-start,omitempty"`

		// Search `filter[search]=value` Search virtual machines for a value associated with a field.
		Search *string `json:"search,omitempty"`

		// State `filter[state]=value` Filter virtual machines by their current state.
		State *GetVirtualMachinesParamsFilterState `json:"state,omitempty"`

		// Tags `filter[tags]=value` Filter virtual machines by their tags.
		Tags *string `json:"tags,omitempty"`
	} `json:"filter,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`
}

GetVirtualMachinesParams defines parameters for GetVirtualMachines.

type GetVirtualMachinesParamsFilterPublicNetwork

type GetVirtualMachinesParamsFilterPublicNetwork string

GetVirtualMachinesParamsFilterPublicNetwork defines parameters for GetVirtualMachines.

Defines values for GetVirtualMachinesParamsFilterPublicNetwork.

type GetVirtualMachinesParamsFilterState

type GetVirtualMachinesParamsFilterState string

GetVirtualMachinesParamsFilterState defines parameters for GetVirtualMachines.

const (
	GetVirtualMachinesParamsFilterStateDeleted  GetVirtualMachinesParamsFilterState = "deleted"
	GetVirtualMachinesParamsFilterStateDeleting GetVirtualMachinesParamsFilterState = "deleting"
	GetVirtualMachinesParamsFilterStateNew      GetVirtualMachinesParamsFilterState = "new"
	GetVirtualMachinesParamsFilterStateRunning  GetVirtualMachinesParamsFilterState = "running"
	GetVirtualMachinesParamsFilterStateStarting GetVirtualMachinesParamsFilterState = "starting"
	GetVirtualMachinesParamsFilterStateStopped  GetVirtualMachinesParamsFilterState = "stopped"
	GetVirtualMachinesParamsFilterStateStopping GetVirtualMachinesParamsFilterState = "stopping"
)

Defines values for GetVirtualMachinesParamsFilterState.

type GetVirtualMachinesParamsInclude

type GetVirtualMachinesParamsInclude string

GetVirtualMachinesParamsInclude defines parameters for GetVirtualMachines.

const (
	GetVirtualMachinesParamsIncludeClusters     GetVirtualMachinesParamsInclude = "clusters"
	GetVirtualMachinesParamsIncludeContainers   GetVirtualMachinesParamsInclude = "containers"
	GetVirtualMachinesParamsIncludeCreators     GetVirtualMachinesParamsInclude = "creators"
	GetVirtualMachinesParamsIncludeEnvironments GetVirtualMachinesParamsInclude = "environments"
)

Defines values for GetVirtualMachinesParamsInclude.

type GetVirtualMachinesParamsMeta

type GetVirtualMachinesParamsMeta string

GetVirtualMachinesParamsMeta defines parameters for GetVirtualMachines.

const (
	GetVirtualMachinesParamsMetaDomains       GetVirtualMachinesParamsMeta = "domains"
	GetVirtualMachinesParamsMetaHypervisorIps GetVirtualMachinesParamsMeta = "hypervisor_ips"
	GetVirtualMachinesParamsMetaIps           GetVirtualMachinesParamsMeta = "ips"
	GetVirtualMachinesParamsMetaServer        GetVirtualMachinesParamsMeta = "server"
)

Defines values for GetVirtualMachinesParamsMeta.

type GetVirtualMachinesResponse

type GetVirtualMachinesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []VirtualMachine `json:"data"`

		// Includes All includable resources linkable to the given virtual machine.
		Includes *VirtualMachineIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetVirtualMachinesResponse

func ParseGetVirtualMachinesResponse(rsp *http.Response) (*GetVirtualMachinesResponse, error)

ParseGetVirtualMachinesResponse parses an HTTP response from a GetVirtualMachinesWithResponse call

func (GetVirtualMachinesResponse) Status

Status returns HTTPResponse.Status

func (GetVirtualMachinesResponse) StatusCode

func (r GetVirtualMachinesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVirtualProviderIsoDownloadUrlResponse added in v0.6.3

type GetVirtualProviderIsoDownloadUrlResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		Data struct {
			Url string `json:"url"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseGetVirtualProviderIsoDownloadUrlResponse added in v0.6.3

func ParseGetVirtualProviderIsoDownloadUrlResponse(rsp *http.Response) (*GetVirtualProviderIsoDownloadUrlResponse, error)

ParseGetVirtualProviderIsoDownloadUrlResponse parses an HTTP response from a GetVirtualProviderIsoDownloadUrlWithResponse call

func (GetVirtualProviderIsoDownloadUrlResponse) Status added in v0.6.3

Status returns HTTPResponse.Status

func (GetVirtualProviderIsoDownloadUrlResponse) StatusCode added in v0.6.3

StatusCode returns HTTPResponse.StatusCode

type GetVirtualProviderIsoParams added in v0.6.3

type GetVirtualProviderIsoParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetVirtualProviderIsoParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetVirtualProviderIsoParams defines parameters for GetVirtualProviderIso.

type GetVirtualProviderIsoParamsInclude added in v0.6.3

type GetVirtualProviderIsoParamsInclude string

GetVirtualProviderIsoParamsInclude defines parameters for GetVirtualProviderIso.

const (
	GetVirtualProviderIsoParamsIncludeIntegrations GetVirtualProviderIsoParamsInclude = "integrations"
)

Defines values for GetVirtualProviderIsoParamsInclude.

type GetVirtualProviderIsoResponse added in v0.6.3

type GetVirtualProviderIsoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data The ISO image for a virtual provider.
		Data VirtualProviderIso `json:"data"`

		// Includes A resource that is associated with an ISO.
		Includes *VirtualProviderIsoIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseGetVirtualProviderIsoResponse added in v0.6.3

func ParseGetVirtualProviderIsoResponse(rsp *http.Response) (*GetVirtualProviderIsoResponse, error)

ParseGetVirtualProviderIsoResponse parses an HTTP response from a GetVirtualProviderIsoWithResponse call

func (GetVirtualProviderIsoResponse) Status added in v0.6.3

Status returns HTTPResponse.Status

func (GetVirtualProviderIsoResponse) StatusCode added in v0.6.3

func (r GetVirtualProviderIsoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVirtualProviderIsosParams added in v0.6.3

type GetVirtualProviderIsosParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]GetVirtualProviderIsosParamsInclude `form:"include,omitempty" json:"include,omitempty"`

	// Page In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
	Page *PageParam `json:"page,omitempty"`

	// Sort An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	Sort *SortParam `form:"sort,omitempty" json:"sort,omitempty"`
}

GetVirtualProviderIsosParams defines parameters for GetVirtualProviderIsos.

type GetVirtualProviderIsosParamsInclude added in v0.6.3

type GetVirtualProviderIsosParamsInclude string

GetVirtualProviderIsosParamsInclude defines parameters for GetVirtualProviderIsos.

const (
	GetVirtualProviderIsosParamsIncludeIntegrations GetVirtualProviderIsosParamsInclude = "integrations"
)

Defines values for GetVirtualProviderIsosParamsInclude.

type GetVirtualProviderIsosResponse added in v0.6.3

type GetVirtualProviderIsosResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []VirtualProviderIso `json:"data"`

		// Includes A resource that is associated with an ISO.
		Includes *VirtualProviderIsoIncludes `json:"includes,omitempty"`
	}
}

func ParseGetVirtualProviderIsosResponse added in v0.6.3

func ParseGetVirtualProviderIsosResponse(rsp *http.Response) (*GetVirtualProviderIsosResponse, error)

ParseGetVirtualProviderIsosResponse parses an HTTP response from a GetVirtualProviderIsosWithResponse call

func (GetVirtualProviderIsosResponse) Status added in v0.6.3

Status returns HTTPResponse.Status

func (GetVirtualProviderIsosResponse) StatusCode added in v0.6.3

func (r GetVirtualProviderIsosResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HaProxyConfig

type HaProxyConfig struct {
	Default HaProxyConfigSet `json:"default"`

	// Ports An object that defines how HAProxy will act on a specific port. The key is a custom port, and the value is the same settings object found under `default` above.
	Ports map[string]HaProxyConfigSet `json:"ports"`
}

HaProxyConfig Describes settings that are passed to HAProxy within the load balancer.

type HaProxyConfigSet

type HaProxyConfigSet struct {
	// Backend Settings related to how the load balancer routes connections to container instances.
	Backend struct {
		// Balance How connections are balanced across your container instances. Can be one of the following:
		//  - `roundrobin`: Each container instance is used in turns.
		//  - `static-rr`: Each container instance is used in turns, but is faster than Round Robin at the expense of being less dynamic.
		//  - `leastconn`: Routes traffic to the instance with the least number of active connections.
		//  - `first`: Routes traffic to the first available instance.
		//  - `source`: The same client IP always reaches the same container instance as long as no instance goes down or up.
		Balance HaProxyConfigSetBackendBalance `json:"balance"`

		// Timeouts Various options for handling timeouts when communicating with a container instance behind the load balancer.
		Timeouts *struct {
			// ConnectMs The number of milliseconds the load balancer will wait for a successful connection to a container instance. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4-timeout%20connect) for more information.
			ConnectMs *int `json:"connect_ms"`

			// QueueMs The number of milliseconds the load balancer will hold connections in a queue when the maximum number of connections has been reached. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4-timeout%20queue) for more information.
			QueueMs *int `json:"queue_ms"`

			// ServerFinMs The number of milliseconds the load balancer will wait for the server to send data when one direction is already closed. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4-timeout%20server-fin) for more information.
			ServerFinMs *int `json:"server_fin_ms"`

			// ServerSecs The number of seconds the load balancer will wait for a response from the container instance. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4.2-timeout%20server) for more information.
			ServerSecs *int `json:"server_secs"`

			// TunnelSecs The number of milliseconds the load balancer will allow for inactivity on a bidirectional tunnel. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4-timeout%20tunnel) for more information.
			TunnelSecs *int `json:"tunnel_secs"`
		} `json:"timeouts"`
	} `json:"backend"`

	// Frontend Settings that describe how incoming traffic to the load balancer is handled.
	Frontend struct {
		// MaxConnections The number of simultaneous connections that can be processed at a time.
		MaxConnections *int `json:"max_connections"`

		// Mode The type of traffic expected by the load balancer for this port. Can be either:
		//  - tcp: Traffic is forwarded without any parsing or additional manipulation.
		//  - http: Traffic is treated as web traffic. If a LINKED record is configured for a container exposing this port, the domain will be parsed and it will be forwarded to the proper container. This allows multiple services to run on port 80 in the same environment.
		Mode HaProxyConfigSetFrontendMode `json:"mode"`

		// Timeouts Various options for handling timeouts when communicating with the client.
		Timeouts *struct {
			// ClientFinMs The number of milliseconds the load balancer will wait for a client to send it data when one direction is already closed. This is particularly useful to avoid keeping connections in a waiting state for too long when clients do not disconnect cleanly.
			ClientFinMs *int `json:"client_fin_ms"`

			// ClientSecs The number of seconds the load balancer will wait for a response from a client before disconnecting.
			ClientSecs *int `json:"client_secs"`

			// HttpKeepAliveMs The number of milliseconds the load balancer will wait for a new HTTP request to start coming after a response was set. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4.2-timeout%20http-request) for more information. (`http` mode only)
			HttpKeepAliveMs *int `json:"http_keep_alive_ms"`

			// HttpRequestMs The number of milliseconds the load balancer will wait for a complete HTTP request. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4.2-timeout%20http-request) for more information. (`http` mode only)
			HttpRequestMs *int `json:"http_request_ms"`
		} `json:"timeouts"`
	} `json:"frontend"`
}

HaProxyConfigSet defines model for HaProxyConfigSet.

type HaProxyConfigSetBackendBalance

type HaProxyConfigSetBackendBalance string

HaProxyConfigSetBackendBalance How connections are balanced across your container instances. Can be one of the following:

  • `roundrobin`: Each container instance is used in turns.
  • `static-rr`: Each container instance is used in turns, but is faster than Round Robin at the expense of being less dynamic.
  • `leastconn`: Routes traffic to the instance with the least number of active connections.
  • `first`: Routes traffic to the first available instance.
  • `source`: The same client IP always reaches the same container instance as long as no instance goes down or up.
const (
	First      HaProxyConfigSetBackendBalance = "first"
	Leastconn  HaProxyConfigSetBackendBalance = "leastconn"
	Roundrobin HaProxyConfigSetBackendBalance = "roundrobin"
	Source     HaProxyConfigSetBackendBalance = "source"
	StaticRr   HaProxyConfigSetBackendBalance = "static-rr"
)

Defines values for HaProxyConfigSetBackendBalance.

type HaProxyConfigSetFrontendMode

type HaProxyConfigSetFrontendMode string

HaProxyConfigSetFrontendMode The type of traffic expected by the load balancer for this port. Can be either:

  • tcp: Traffic is forwarded without any parsing or additional manipulation.
  • http: Traffic is treated as web traffic. If a LINKED record is configured for a container exposing this port, the domain will be parsed and it will be forwarded to the proper container. This allows multiple services to run on port 80 in the same environment.
const (
	HaProxyConfigSetFrontendModeHttp HaProxyConfigSetFrontendMode = "http"
	HaProxyConfigSetFrontendModeTcp  HaProxyConfigSetFrontendMode = "tcp"
)

Defines values for HaProxyConfigSetFrontendMode.

type HaProxyLbType

type HaProxyLbType struct {
	Details *HaProxyConfig `json:"details"`

	// Ipv4 Allow / disallow traffic to be routed via IPv4.
	Ipv4 bool `json:"ipv4"`

	// Ipv6 Allow / disallow traffic to be routed via IPv6.
	Ipv6 bool              `json:"ipv6"`
	Type HaProxyLbTypeType `json:"type"`
}

HaProxyLbType defines model for HaProxyLbType.

type HaProxyLbTypeType

type HaProxyLbTypeType string

HaProxyLbTypeType defines model for HaProxyLbType.Type.

const (
	HaProxyLbTypeTypeHaproxy HaProxyLbTypeType = "haproxy"
)

Defines values for HaProxyLbTypeType.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type HttpRouterConfig

type HttpRouterConfig struct {
	Details struct {
		Caching *struct {
			Files *[]struct {
				// Match Regex string that describes the files to cache.
				Match string `json:"match"`

				// Ttl A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
				Ttl Duration `json:"ttl"`
			} `json:"files"`
		} `json:"caching"`
		Forward *struct {
			// ContentMod Allows the load balancer to modify content before it reaches the user.
			ContentMod *struct {
				// Replace An array that describes a list of replacement match/value pairs.
				Replace *[]struct {
					// Match String that will be replaced.
					Match string `json:"match"`

					// Value Replacement value.
					Value string `json:"value"`
				} `json:"replace"`
			} `json:"content_mod"`
			Scheme *string `json:"scheme"`

			// Url The URL to forward the request to.
			//
			// Given a path match of `^/example/(.*)$`, a route such as `/example/wow.jpg` would be forwarded as /wow.jpg.
			Url *string `json:"url"`
		} `json:"forward"`
		Proxy *struct {
			// ContentMod Allows the load balancer to modify content before it reaches the user.
			ContentMod *struct {
				// Replace An array that describes a list of replacement match/value pairs.
				Replace *[]struct {
					// Match String that will be replaced.
					Match string `json:"match"`

					// Value Replacement value.
					Value string `json:"value"`
				} `json:"replace"`
			} `json:"content_mod"`

			// Domain The domain that this router will proxy.
			Domain *string `json:"domain"`

			// Url The full URL that this router will proxy.
			Url *string `json:"url"`
		} `json:"proxy"`

		// Redirect Defines a built-in redirect for HTTP mode routers
		Redirect *struct {
			// AutoHttpsRedirect If enabled and a sibling controller exists for port 443, requests will be auto redirected to it. Essentially sets up automatic TLS redirection for this router.
			AutoHttpsRedirect bool `json:"auto_https_redirect"`

			// Port The port to redirect traffic to.
			Port *int `json:"port"`

			// RemoveWww If true, any request comes in with "www" prefix will be permanently redirected to the same path without www.
			RemoveWww bool `json:"remove_www"`

			// Scheme The scheme to redirect to. (i.e. `https`)
			Scheme *string `json:"scheme"`

			// Url A specific URL to redirect to.
			Url *string `json:"url"`
		} `json:"redirect"`
	} `json:"details"`
	Type HttpRouterConfigType `json:"type"`
}

HttpRouterConfig Additional configuration options for HTTP mode routers.

type HttpRouterConfigType

type HttpRouterConfigType string

HttpRouterConfigType defines model for HttpRouterConfig.Type.

const (
	HttpRouterConfigTypeHttp HttpRouterConfigType = "http"
)

Defines values for HttpRouterConfigType.

type HttpTransportConfig

type HttpTransportConfig struct {
	Details struct {
		// Connections Defines extra configuration options connections to the load balancer
		Connections struct {
			// MaxIdleConnsPerConnection Maximum number of simultaneous connections (via http/2) per connection.
			MaxIdleConnsPerConnection *int `json:"max_idle_conns_per_connection"`
		} `json:"connections"`

		// Telemetry Configuration options for how telemetry is handled.
		Telemetry struct {
			// IgnorePaths An array of paths to exclude from tracking.
			IgnorePaths *[]string `json:"ignore_paths"`

			// MaxTrackableUrls Determines how many URLs the load balancer will track at one time. Defaults to 150.
			MaxTrackableUrls *int `json:"max_trackable_urls"`

			// TrackInvalidRequests Whether or not to track invalid requests. An invalid request is a request that came in that no router existed for. Usually this means bot requests. Defaults to false.
			TrackInvalidRequests *bool `json:"track_invalid_requests"`
		} `json:"telemetry"`
	} `json:"details"`
	Type HttpTransportConfigType `json:"type"`
}

HttpTransportConfig Additional configuration options for the HTTP transport mode.

type HttpTransportConfigType

type HttpTransportConfigType string

HttpTransportConfigType defines model for HttpTransportConfig.Type.

const (
	HttpTransportConfigTypeHttp HttpTransportConfigType = "http"
)

Defines values for HttpTransportConfigType.

type Hub

type Hub struct {
	Billing *HubBillingProfile `json:"billing"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the hub's lifetime.
	Events HubEvents `json:"events"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Meta A list of meta fields that can be applied to a hub.
	Meta *HubMeta `json:"meta,omitempty"`

	// Name A name for the hub.
	Name string `json:"name"`

	// Security Security options for a hub.
	Security HubSecurity `json:"security"`
	State    HubState    `json:"state"`

	// Webhooks Hub related webhooks. When supplied, the given webhook will be called with a payload any time one of these events occurs.
	Webhooks HubWebhooks `json:"webhooks"`
}

Hub A hub resource.

type HubBillingContact

type HubBillingContact struct {
	// LegalBusinessName The legal business name of the billing contact.
	LegalBusinessName string `json:"legal_business_name"`

	// Name The name of the billing contact.
	Name string `json:"name"`

	// TaxId The legal tax ID of the billing contact, if applicable.
	TaxId string `json:"tax_id"`
}

HubBillingContact The contact to whom invoices are billed.

type HubBillingProfile

type HubBillingProfile struct {
	// AllowDirectPayments When true, this hub is allowed to create 'direct' payment methods.
	AllowDirectPayments *bool `json:"allow_direct_payments,omitempty"`

	// AllowPrepaid A boolean where true represents this account being approved to use a prepaid card for billing transactions.
	AllowPrepaid *bool `json:"allow_prepaid,omitempty"`

	// Contact The contact to whom invoices are billed.
	Contact *HubBillingContact `json:"contact,omitempty"`

	// Disable A boolean where true means this billing is disabled on this hub.
	Disable *bool `json:"disable,omitempty"`

	// Emails An array of email addresses to whom the billing invoices will be sent to. If left empty, they will be sent to the owner of this hub.
	Emails *[]string `json:"emails"`

	// PauseInvoices A boolean where true represents invoices have been paused on this hub for one reason or another.
	PauseInvoices bool `json:"pause_invoices"`

	// Plans Information about the plan associated with this hub.
	Plans struct {
		// SupportId An ID referencing the support plan applied to this hub.
		SupportId *string `json:"support_id"`

		// TierId An ID referencing the pricing tier applied to this hub.
		TierId *string `json:"tier_id"`
	} `json:"plans"`

	// Term Information about a billing term.
	Term Term `json:"term"`
}

HubBillingProfile A billing profile for a given hub.

type HubEvents

type HubEvents struct {
	Converted        *DateTime `json:"converted,omitempty"`
	Created          DateTime  `json:"created"`
	Deleted          DateTime  `json:"deleted"`
	FirstContainer   *DateTime `json:"first_container,omitempty"`
	FirstEnvironment *DateTime `json:"first_environment,omitempty"`
	FirstImage       *DateTime `json:"first_image,omitempty"`
	FirstOrder       *DateTime `json:"first_order,omitempty"`
	FirstProvider    *DateTime `json:"first_provider,omitempty"`
	FirstServer      *DateTime `json:"first_server,omitempty"`
	Updated          DateTime  `json:"updated"`
}

HubEvents A collection of timestamps for each event in the hub's lifetime.

type HubID

type HubID = string

HubID The unique ID of the Hub this resource was created in.

type HubInviteIncludes

type HubInviteIncludes struct {
	// Roles A map of roles relevant to this hub membership, keyed by the Role ID.
	Roles *map[string]Role `json:"roles,omitempty"`

	// RolesIdentifiers A map of roles relevant to this hub membership, keyed by the role ID.
	RolesIdentifiers *map[string]ID `json:"roles:identifiers,omitempty"`

	// Senders A record with an ID mapped to a public account for the account that sent this memberships initial invite.
	Senders *struct {
		// Accounts A record with an ID mapped to a public account.
		Accounts *map[string]PublicAccount `json:"accounts,omitempty"`
	} `json:"senders,omitempty"`
}

HubInviteIncludes All includable resources for invites.

type HubMembership

type HubMembership struct {
	// AccountId An ID for the account associated with the given membership.
	AccountId *string `json:"account_id,omitempty"`

	// Cycle If this member is a Cycle employee, their employee ID will be listed here. Cycle employee accounts do not consume a "membership" for a given hub.
	Cycle *struct {
		// EmployeeId The ID of the employee this membership is associated with.
		EmployeeId string `json:"employee_id"`
	} `json:"cycle,omitempty"`

	// Events A collection of timestamps for each event in the membership's lifetime.
	Events struct {
		Created *DateTime `json:"created,omitempty"`
		Deleted *DateTime `json:"deleted,omitempty"`
		Joined  DateTime  `json:"joined"`
		Updated *DateTime `json:"updated,omitempty"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Invitation Information about a hub membership invitation.
	Invitation Invitation `json:"invitation"`

	// Preferences Preference information set by the user for the membership.
	Preferences *struct {
		Email struct {
			Notificaitons *struct {
				Server struct {
					New     *bool `json:"new"`
					Offline *bool `json:"offline"`
				} `json:"server"`
			} `json:"notificaitons,omitempty"`
		} `json:"email"`
		Portal struct {
			Notifications struct {
				Jobs struct {
					ApikeyAlerts bool `json:"apikey_alerts"`
				} `json:"jobs"`
			} `json:"notifications"`
		} `json:"portal"`
	} `json:"preferences,omitempty"`

	// RoleId A 24 character hex string used to identify a unique resource.
	RoleId ID              `json:"role_id"`
	State  MembershipState `json:"state"`
}

HubMembership A membership resource that is scoped to an individual hub.

type HubMembershipIncludes

type HubMembershipIncludes struct {
	// Accounts A record with an ID mapped to a public account.
	Accounts *map[string]PublicAccount `json:"accounts,omitempty"`

	// Hubs A record with an ID mapped to a hub resource.
	Hubs *map[string]Hub `json:"hubs,omitempty"`

	// Roles A map of Roles relevant to this Hub Membership, keyed by the Role ID.
	Roles *map[string]Role `json:"roles,omitempty"`

	// RolesIdentifiers A map of Roles relevant to this Hub Membership, keyed by the Role ID.
	RolesIdentifiers *map[string]ID `json:"roles:identifiers,omitempty"`

	// Senders A record with an ID mapped to a public account for the account that sent this memberships initial invite.
	Senders *struct {
		// Accounts A record with an ID mapped to a public account.
		Accounts *map[string]PublicAccount `json:"accounts,omitempty"`
	} `json:"senders,omitempty"`
}

HubMembershipIncludes A resource that is associated with a hub membership.

type HubMembershipIncludes2

type HubMembershipIncludes2 struct {
	// Accounts A record with an ID mapped to a public account.
	Accounts *map[string]PublicAccount `json:"accounts,omitempty"`

	// Roles A map of roles relevant to this hub membership, keyed by the Role ID.
	Roles *map[string]Role `json:"roles,omitempty"`

	// RolesIdentifiers A map of roles relevant to this hub membership, keyed by the role ID.
	RolesIdentifiers *map[string]ID `json:"roles:identifiers,omitempty"`
}

HubMembershipIncludes2 All includable resources for hub memberships.

type HubMeta

type HubMeta struct {
	// Membership A membership resource that is scoped to an individual hub.
	Membership *HubMembership `json:"membership,omitempty"`
}

HubMeta A list of meta fields that can be applied to a hub.

type HubSecurity

type HubSecurity struct {
	// Force2fa When true, any API call for this hub from an account that does not have two-factor auth enabled will fail with a 403 error.
	Force2fa bool `json:"force_2fa"`
}

HubSecurity Security options for a hub.

type HubState

type HubState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the hub.
	Current HubStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

HubState defines model for HubState.

type HubStateCurrent

type HubStateCurrent string

HubStateCurrent The current state of the hub.

const (
	HubStateCurrentConfiguring HubStateCurrent = "configuring"
	HubStateCurrentDeleted     HubStateCurrent = "deleted"
	HubStateCurrentDeleting    HubStateCurrent = "deleting"
	HubStateCurrentInactive    HubStateCurrent = "inactive"
	HubStateCurrentLive        HubStateCurrent = "live"
	HubStateCurrentNew         HubStateCurrent = "new"
)

Defines values for HubStateCurrent.

type HubUsageDatum

type HubUsageDatum struct {
	Containers   float32 `json:"containers"`
	Environments float32 `json:"environments"`
	Members      float32 `json:"members"`
	Servers      float32 `json:"servers"`
	Time         string  `json:"time"`
}

HubUsageDatum A hub usage data point

type HubWebhooks

type HubWebhooks struct {
	// ServerDeleted A webhook that is called any time a server in this hub is deleted. The payload will be a `Server` object.
	ServerDeleted *string `json:"server_deleted"`

	// ServerDeployed A webhook that is called any time a server is deployed to this hub. The payload will be a `Server` object.
	ServerDeployed *string `json:"server_deployed"`
}

HubWebhooks Hub related webhooks. When supplied, the given webhook will be called with a payload any time one of these events occurs.

type HugeTLB

type HugeTLB struct {
	// FailCount The number of times the hugeTLB memory limit has been exceeded by this instance.
	FailCount *int `json:"fail_count,omitempty"`

	// Max The maximum number of bytes allowed to be used for huge pages for this instance.
	Max *int `json:"max,omitempty"`

	// Usage The number of bytes being consumed by huge pages of all sizes.
	Usage *int `json:"usage,omitempty"`
}

HugeTLB HugeTLB data.

type HybridIdentifier

type HybridIdentifier = string

HybridIdentifier Either a resource ID (objectid - i.e. 651586fca6078e98982dbd90) or a resource Identifier (human-readable)

type ID

type ID = string

ID A 24 character hex string used to identify a unique resource.

type IPNet

type IPNet struct {
	// Cidr The CIDR notation, describing the range of IP addresses.
	Cidr string `json:"cidr"`

	// Ip The IP address.
	Ip string `json:"ip"`
}

IPNet defines model for IPNet.

type Identifier

type Identifier = string

Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient. The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will have the identifier of `my-container` and is automatically created by the platform.

The identifier does not have to be unique.

type IdentifierIncludes

type IdentifierIncludes map[string][]ID

IdentifierIncludes A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.

type Image

type Image struct {
	// About An object that holds information about the image.
	About *struct {
		// Description A description of the image.
		Description *string `json:"description"`
	} `json:"about,omitempty"`

	// Backend Describes where the image is hosted.
	Backend struct {
		// FileId A file id for the image, used by the platform.
		FileId string `json:"file_id"`

		// FileName A file name for the image, used by the platform.
		FileName string `json:"file_name"`

		// Provider The provider where this image is hosted.
		Provider string `json:"provider"`

		// Size The size of the image in bytes.
		Size int `json:"size"`
	} `json:"backend"`

	// Build Any additional build details for this image
	Build *struct {
		// Args Arguments to pass to the builder during a build of this image.
		Args *map[string]string `json:"args,omitempty"`

		// UseDisk If true, will skip using /dev/shm when building an image on factory. Allows for building much larger images.
		UseDisk *bool `json:"use_disk,omitempty"`
	} `json:"build"`

	// Builder Configuration options regarding the builder used to create/import this Image.
	Builder *struct {
		// IntegrationId A 24 character hex string used to identify a unique resource.
		IntegrationId ID `json:"integration_id"`
	} `json:"builder"`

	// Config Configuration settings for the image.
	Config struct {
		// Command The CMD array used to start the container.
		Command []string `json:"command"`

		// Entrypoint An entrypoint command.
		Entrypoint []string `json:"entrypoint"`

		// Env Image defined environment variables for the image.
		Env map[string]string `json:"env"`

		// Labels Image labels.
		Labels map[string]string `json:"labels"`

		// Ports The port settings for the image.
		Ports []struct {
			Container float32 `json:"container"`

			// Host Host Port
			Host float32 `json:"host"`
			Type string  `json:"type"`
		} `json:"ports"`

		// SignalStop A set command to be run if a signal is called.
		SignalStop string `json:"signal_stop"`

		// User The linux user this image runs its processes as.
		User string `json:"user"`

		// Volumes Volumes information for the given image.
		Volumes []struct {
			// Mode Permission settings for the volume.
			Mode *ImageConfigVolumesMode `json:"mode,omitempty"`

			// Path The path where the volume is mounted.
			Path *string `json:"path,omitempty"`
		} `json:"volumes"`

		// Workdir The working directory for the image.
		Workdir string `json:"workdir"`
	} `json:"config"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator *CreatorScope `json:"creator,omitempty"`

	// Events A collection of timestamps for each event in the image's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// Factory Information about the Factory service that built/imported the Image into Cycle.
	Factory *struct {
		Acknowledged DateTime `json:"acknowledged"`
		Cached       DateTime `json:"cached"`

		// NodeId The node holding the factory service that was responsible for building the image.
		NodeId string `json:"node_id"`
	} `json:"factory"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Meta A list of meta fields that can be applied to the image.
	Meta *ImageMeta `json:"meta,omitempty"`

	// Name A user defined name for the image.
	Name string `json:"name"`

	// Requires Any restrictions or requirements needed to run this image as a container.
	Requires struct {
		NvidiaGpu *bool `json:"nvidia_gpu,omitempty"`
	} `json:"requires"`

	// Size The image size in bytes.
	Size   int           `json:"size"`
	Source *Image_Source `json:"source,omitempty"`
	State  ImageState    `json:"state"`
}

Image An image is a point in time build on a given image source, and what is distributed by Cycle to run containers.

type ImageConfigVolumesMode

type ImageConfigVolumesMode string

ImageConfigVolumesMode Permission settings for the volume.

const (
	Ro ImageConfigVolumesMode = "ro"
	Rw ImageConfigVolumesMode = "rw"
)

Defines values for ImageConfigVolumesMode.

type ImageCreateImportStep

type ImageCreateImportStep struct {
	// Action The action that the step takes.
	Action  ImageCreateImportStepAction `json:"action"`
	Details struct {
		// Build Optional build-time options for when this image is built on pipeline run.
		Build *struct {
			// Args Build args passed into the container image build process during pipeline run.
			Args *map[string]string `json:"args"`
		} `json:"build,omitempty"`
		Name *string `json:"name"`

		// Override An override object to be used for a single image create request.
		Override *struct {
			// Target For image sources with `docker-hub` or `docker-registry` origin types. A target to be used for overridding the default target - should include an image and a tag.
			Target *string `json:"target"`

			// TargzUrl For image sources with `docker-file` origin types. A URL pointing to a .tar.gz file of a repo with a Dockerfile in it - can be used instead of linking Cycle directly to a repository.
			TargzUrl *string `json:"targz_url"`
		} `json:"override"`

		// Source An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Source FluidIdentifier `json:"source"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ImageCreateImportStep A pipeline step for creating and importing an image in one go.

type ImageCreateImportStepAction

type ImageCreateImportStepAction string

ImageCreateImportStepAction The action that the step takes.

const (
	ImageCreateImport ImageCreateImportStepAction = "image.create-import"
)

Defines values for ImageCreateImportStepAction.

type ImageCreateStep

type ImageCreateStep struct {
	// Action The action that the step takes.
	Action  ImageCreateStepAction `json:"action"`
	Details struct {
		// Build Optional build-time options for when this image is built on pipeline run.
		Build *struct {
			// Args Build args passed into the container image build process during pipeline run.
			Args *map[string]string `json:"args"`
		} `json:"build,omitempty"`
		Name *string `json:"name"`

		// Override An override object to be used for a single image create request.
		Override *struct {
			// Target For image sources with `docker-hub` or `docker-registry` origin types. A target to be used for overridding the default target - should include an image and a tag.
			Target *string `json:"target"`

			// TargzUrl For image sources with `docker-file` origin types. A URL pointing to a .tar.gz file of a repo with a Dockerfile in it - can be used instead of linking Cycle directly to a repository.
			TargzUrl *string `json:"targz_url"`
		} `json:"override"`

		// Source An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Source FluidIdentifier `json:"source"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ImageCreateStep Settings for the image create step for a pipeline.

type ImageCreateStepAction

type ImageCreateStepAction string

ImageCreateStepAction The action that the step takes.

const (
	ImageCreate ImageCreateStepAction = "image.create"
)

Defines values for ImageCreateStepAction.

type ImageImportStep

type ImageImportStep struct {
	// Action The action that the step takes.
	Action  ImageImportStepAction `json:"action"`
	Details struct {
		// Image An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Image FluidIdentifier `json:"image"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ImageImportStep Settings for the image import step for a pipeline.

type ImageImportStepAction

type ImageImportStepAction string

ImageImportStepAction The action that the step takes.

const (
	ImageImport ImageImportStepAction = "image.import"
)

Defines values for ImageImportStepAction.

type ImageIncludes

type ImageIncludes struct {
	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`

	// Integrations A resource that is associated with an integration.
	Integrations *IntegrationsIncludes `json:"integrations,omitempty"`

	// IntegrationsIdentifiers A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.
	IntegrationsIdentifiers *IdentifierIncludes `json:"integrations:identifiers,omitempty"`

	// Sources A resource associated with an image source.
	Sources *ImageSourceIncludes `json:"sources,omitempty"`

	// SourcesIdentifiers A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.
	SourcesIdentifiers *IdentifierIncludes `json:"sources:identifiers,omitempty"`

	// StackBuilds A resource that is associated with a stack build.
	StackBuilds *StackBuildIncludes `json:"stack_builds,omitempty"`

	// Stacks A resource associated with a stack.
	Stacks *StackIncludes `json:"stacks,omitempty"`

	// StacksIdentifiers A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.
	StacksIdentifiers *IdentifierIncludes `json:"stacks:identifiers,omitempty"`
}

ImageIncludes All includable resources linkable to the given image.

type ImageMeta

type ImageMeta struct {
	// ContainersCount A summary of resources by state
	ContainersCount *StateCountSummary `json:"containers_count,omitempty"`
}

ImageMeta A list of meta fields that can be applied to the image.

type ImageOrigin

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

ImageOrigin The origin of the image.

func (ImageOrigin) AsCycleSourceOrigin

func (t ImageOrigin) AsCycleSourceOrigin() (CycleSourceOrigin, error)

AsCycleSourceOrigin returns the union data inside the ImageOrigin as a CycleSourceOrigin

func (ImageOrigin) AsCycleUploadOrigin

func (t ImageOrigin) AsCycleUploadOrigin() (CycleUploadOrigin, error)

AsCycleUploadOrigin returns the union data inside the ImageOrigin as a CycleUploadOrigin

func (ImageOrigin) AsDockerFileOrigin

func (t ImageOrigin) AsDockerFileOrigin() (DockerFileOrigin, error)

AsDockerFileOrigin returns the union data inside the ImageOrigin as a DockerFileOrigin

func (ImageOrigin) AsDockerHubOrigin

func (t ImageOrigin) AsDockerHubOrigin() (DockerHubOrigin, error)

AsDockerHubOrigin returns the union data inside the ImageOrigin as a DockerHubOrigin

func (ImageOrigin) AsDockerRegistryOrigin

func (t ImageOrigin) AsDockerRegistryOrigin() (DockerRegistryOrigin, error)

AsDockerRegistryOrigin returns the union data inside the ImageOrigin as a DockerRegistryOrigin

func (ImageOrigin) AsNoneOrigin

func (t ImageOrigin) AsNoneOrigin() (NoneOrigin, error)

AsNoneOrigin returns the union data inside the ImageOrigin as a NoneOrigin

func (ImageOrigin) AsOciRegistryOrigin

func (t ImageOrigin) AsOciRegistryOrigin() (OciRegistryOrigin, error)

AsOciRegistryOrigin returns the union data inside the ImageOrigin as a OciRegistryOrigin

func (ImageOrigin) Discriminator

func (t ImageOrigin) Discriminator() (string, error)

func (*ImageOrigin) FromCycleSourceOrigin

func (t *ImageOrigin) FromCycleSourceOrigin(v CycleSourceOrigin) error

FromCycleSourceOrigin overwrites any union data inside the ImageOrigin as the provided CycleSourceOrigin

func (*ImageOrigin) FromCycleUploadOrigin

func (t *ImageOrigin) FromCycleUploadOrigin(v CycleUploadOrigin) error

FromCycleUploadOrigin overwrites any union data inside the ImageOrigin as the provided CycleUploadOrigin

func (*ImageOrigin) FromDockerFileOrigin

func (t *ImageOrigin) FromDockerFileOrigin(v DockerFileOrigin) error

FromDockerFileOrigin overwrites any union data inside the ImageOrigin as the provided DockerFileOrigin

func (*ImageOrigin) FromDockerHubOrigin

func (t *ImageOrigin) FromDockerHubOrigin(v DockerHubOrigin) error

FromDockerHubOrigin overwrites any union data inside the ImageOrigin as the provided DockerHubOrigin

func (*ImageOrigin) FromDockerRegistryOrigin

func (t *ImageOrigin) FromDockerRegistryOrigin(v DockerRegistryOrigin) error

FromDockerRegistryOrigin overwrites any union data inside the ImageOrigin as the provided DockerRegistryOrigin

func (*ImageOrigin) FromNoneOrigin

func (t *ImageOrigin) FromNoneOrigin(v NoneOrigin) error

FromNoneOrigin overwrites any union data inside the ImageOrigin as the provided NoneOrigin

func (*ImageOrigin) FromOciRegistryOrigin

func (t *ImageOrigin) FromOciRegistryOrigin(v OciRegistryOrigin) error

FromOciRegistryOrigin overwrites any union data inside the ImageOrigin as the provided OciRegistryOrigin

func (ImageOrigin) MarshalJSON

func (t ImageOrigin) MarshalJSON() ([]byte, error)

func (*ImageOrigin) MergeCycleSourceOrigin

func (t *ImageOrigin) MergeCycleSourceOrigin(v CycleSourceOrigin) error

MergeCycleSourceOrigin performs a merge with any union data inside the ImageOrigin, using the provided CycleSourceOrigin

func (*ImageOrigin) MergeCycleUploadOrigin

func (t *ImageOrigin) MergeCycleUploadOrigin(v CycleUploadOrigin) error

MergeCycleUploadOrigin performs a merge with any union data inside the ImageOrigin, using the provided CycleUploadOrigin

func (*ImageOrigin) MergeDockerFileOrigin

func (t *ImageOrigin) MergeDockerFileOrigin(v DockerFileOrigin) error

MergeDockerFileOrigin performs a merge with any union data inside the ImageOrigin, using the provided DockerFileOrigin

func (*ImageOrigin) MergeDockerHubOrigin

func (t *ImageOrigin) MergeDockerHubOrigin(v DockerHubOrigin) error

MergeDockerHubOrigin performs a merge with any union data inside the ImageOrigin, using the provided DockerHubOrigin

func (*ImageOrigin) MergeDockerRegistryOrigin

func (t *ImageOrigin) MergeDockerRegistryOrigin(v DockerRegistryOrigin) error

MergeDockerRegistryOrigin performs a merge with any union data inside the ImageOrigin, using the provided DockerRegistryOrigin

func (*ImageOrigin) MergeNoneOrigin

func (t *ImageOrigin) MergeNoneOrigin(v NoneOrigin) error

MergeNoneOrigin performs a merge with any union data inside the ImageOrigin, using the provided NoneOrigin

func (*ImageOrigin) MergeOciRegistryOrigin

func (t *ImageOrigin) MergeOciRegistryOrigin(v OciRegistryOrigin) error

MergeOciRegistryOrigin performs a merge with any union data inside the ImageOrigin, using the provided OciRegistryOrigin

func (*ImageOrigin) UnmarshalJSON

func (t *ImageOrigin) UnmarshalJSON(b []byte) error

func (ImageOrigin) ValueByDiscriminator

func (t ImageOrigin) ValueByDiscriminator() (interface{}, error)

type ImageSource

type ImageSource struct {
	// About Information about the image source resource.
	About *ImageSourceAbout `json:"about,omitempty"`
	Acl   *ACL              `json:"acl"`

	// Builder Configuration options regarding the builder used to create/import Images using this Image Source.
	Builder *struct {
		// IntegrationId The ID or Identifier of the Integration used to do the build.
		IntegrationId *HybridIdentifier `json:"integration_id"`
	} `json:"builder"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the image source's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Meta A list of meta fields that can be applied to this environment.
	Meta *ImageSourceMeta `json:"meta,omitempty"`

	// Name A name for the image source resource.
	Name string `json:"name"`

	// Origin The origin of the image.
	Origin ImageOrigin      `json:"origin"`
	State  ImageSourceState `json:"state"`

	// Type The type of images in this source.
	Type ImageSourceType `json:"type"`
}

ImageSource An image source is a set of resources that direct the platform on where it can find the resources needed to build an image resource.

type ImageSourceAbout

type ImageSourceAbout struct {
	// Description Some information about the image source resource.
	Description *string `json:"description"`
}

ImageSourceAbout Information about the image source resource.

type ImageSourceIncludes

type ImageSourceIncludes map[string]ImageSource

ImageSourceIncludes A resource associated with an image source.

type ImageSourceMeta

type ImageSourceMeta struct {
	ImagesCount *struct {
		State struct {
			// Building Number of images in this source with state building
			Building float32 `json:"building"`

			// Deleting Number of images in this source with state deleting
			Deleting float32 `json:"deleting"`

			// Downloading Number of images in this source with state downloading
			Downloading float32 `json:"downloading"`

			// Live Number of images in this source with state live
			Live float32 `json:"live"`

			// New Number of images in this source with state new
			New float32 `json:"new"`

			// Saving Number of images in this source with state saving
			Saving float32 `json:"saving"`

			// Verifying Number of images in this source with state verifying
			Verifying float32 `json:"verifying"`
		} `json:"state"`

		// Total Number of image sources
		Total float32 `json:"total"`
	} `json:"images_count,omitempty"`
}

ImageSourceMeta A list of meta fields that can be applied to this environment.

type ImageSourceState

type ImageSourceState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the image source.
	Current ImageSourceStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

ImageSourceState defines model for ImageSourceState.

type ImageSourceStateCurrent

type ImageSourceStateCurrent string

ImageSourceStateCurrent The current state of the image source.

const (
	ImageSourceStateCurrentDeleted  ImageSourceStateCurrent = "deleted"
	ImageSourceStateCurrentDeleting ImageSourceStateCurrent = "deleting"
	ImageSourceStateCurrentLive     ImageSourceStateCurrent = "live"
)

Defines values for ImageSourceStateCurrent.

type ImageSourceType

type ImageSourceType string

ImageSourceType The type of images in this source.

const (
	ImageSourceTypeBucket     ImageSourceType = "bucket"
	ImageSourceTypeDirect     ImageSourceType = "direct"
	ImageSourceTypeStackBuild ImageSourceType = "stack-build"
)

Defines values for ImageSourceType.

type ImageState

type ImageState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the image.
	Current ImageStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

ImageState defines model for ImageState.

type ImageStateCurrent

type ImageStateCurrent string

ImageStateCurrent The current state of the image.

const (
	ImageStateCurrentBuilding    ImageStateCurrent = "building"
	ImageStateCurrentDeleted     ImageStateCurrent = "deleted"
	ImageStateCurrentDeleting    ImageStateCurrent = "deleting"
	ImageStateCurrentDownloading ImageStateCurrent = "downloading"
	ImageStateCurrentLive        ImageStateCurrent = "live"
	ImageStateCurrentNew         ImageStateCurrent = "new"
	ImageStateCurrentSaving      ImageStateCurrent = "saving"
	ImageStateCurrentUploading   ImageStateCurrent = "uploading"
	ImageStateCurrentVerifying   ImageStateCurrent = "verifying"
)

Defines values for ImageStateCurrent.

type ImageSummary

type ImageSummary struct {
	Extension *ContainerExtension `json:"extension"`
	Id        *ID                 `json:"id"`

	// Service If a service container, the identifier specifying which service it is.
	Service *ServiceContainerIdentifier `json:"service"`
}

ImageSummary A summary of the image this container was created from.

type Image_Source

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

Image_Source defines model for Image.Source.

func (Image_Source) AsBucketImageSourceType

func (t Image_Source) AsBucketImageSourceType() (BucketImageSourceType, error)

AsBucketImageSourceType returns the union data inside the Image_Source as a BucketImageSourceType

func (Image_Source) AsDirectImageSourceType

func (t Image_Source) AsDirectImageSourceType() (DirectImageSourceType, error)

AsDirectImageSourceType returns the union data inside the Image_Source as a DirectImageSourceType

func (Image_Source) AsStackImageSourceType

func (t Image_Source) AsStackImageSourceType() (StackImageSourceType, error)

AsStackImageSourceType returns the union data inside the Image_Source as a StackImageSourceType

func (Image_Source) Discriminator

func (t Image_Source) Discriminator() (string, error)

func (*Image_Source) FromBucketImageSourceType

func (t *Image_Source) FromBucketImageSourceType(v BucketImageSourceType) error

FromBucketImageSourceType overwrites any union data inside the Image_Source as the provided BucketImageSourceType

func (*Image_Source) FromDirectImageSourceType

func (t *Image_Source) FromDirectImageSourceType(v DirectImageSourceType) error

FromDirectImageSourceType overwrites any union data inside the Image_Source as the provided DirectImageSourceType

func (*Image_Source) FromStackImageSourceType

func (t *Image_Source) FromStackImageSourceType(v StackImageSourceType) error

FromStackImageSourceType overwrites any union data inside the Image_Source as the provided StackImageSourceType

func (Image_Source) MarshalJSON

func (t Image_Source) MarshalJSON() ([]byte, error)

func (*Image_Source) MergeBucketImageSourceType

func (t *Image_Source) MergeBucketImageSourceType(v BucketImageSourceType) error

MergeBucketImageSourceType performs a merge with any union data inside the Image_Source, using the provided BucketImageSourceType

func (*Image_Source) MergeDirectImageSourceType

func (t *Image_Source) MergeDirectImageSourceType(v DirectImageSourceType) error

MergeDirectImageSourceType performs a merge with any union data inside the Image_Source, using the provided DirectImageSourceType

func (*Image_Source) MergeStackImageSourceType

func (t *Image_Source) MergeStackImageSourceType(v StackImageSourceType) error

MergeStackImageSourceType performs a merge with any union data inside the Image_Source, using the provided StackImageSourceType

func (*Image_Source) UnmarshalJSON

func (t *Image_Source) UnmarshalJSON(b []byte) error

func (Image_Source) ValueByDiscriminator

func (t Image_Source) ValueByDiscriminator() (interface{}, error)

type ImagesIncludes

type ImagesIncludes map[string]Image

ImagesIncludes A resource associated with an image.

type ImagesPruneStep

type ImagesPruneStep struct {
	// Action The action that the step takes.
	Action  ImagesPruneStepAction `json:"action"`
	Details struct {
		SourceIds []ID `json:"source_ids"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

ImagesPruneStep Settings for the images prune step for a pipeline.

type ImagesPruneStepAction

type ImagesPruneStepAction string

ImagesPruneStepAction The action that the step takes.

const (
	ImagesPrune ImagesPruneStepAction = "images.prune"
)

Defines values for ImagesPruneStepAction.

type IncludedPipelines added in v0.6.6

type IncludedPipelines map[string]Pipeline

IncludedPipelines A map of pipelines, keyed by ID, included on endpoints that support it when passing the matching includes query parameter.

type IncludedTriggerKeys added in v0.6.6

type IncludedTriggerKeys map[string]TriggerKey

IncludedTriggerKeys A map of trigger keys, keyed by ID, included on endpoints that support it when passing the matching includes query parameter.

type Index

type Index struct {
	Containers   map[string]Component `json:"containers"`
	DnsZones     map[string]Component `json:"dns_zones"`
	Environments map[string]Component `json:"environments"`
	Generated    DateTime             `json:"generated"`

	// HubId Id describing the Hub
	HubId           string               `json:"hub_id"`
	ImageSources    map[string]Component `json:"image_sources"`
	Instances       map[string]Component `json:"instances"`
	Pipelines       map[string]Component `json:"pipelines"`
	Servers         map[string]Component `json:"servers"`
	Stacks          map[string]Component `json:"stacks"`
	VirtualMachines map[string]Component `json:"virtual_machines"`
}

Index An index that enables search in the portal

type InfrastructureResourceSummary

type InfrastructureResourceSummary struct {
	// Cpu Information about CPU resources.
	Cpu struct {
		// Cores The number of CPU cores.
		Cores int `json:"cores"`

		// ShareRatio The ratio of shares allocated to total shares.
		ShareRatio *int `json:"share_ratio,omitempty"`

		// Shares Information about CPU shares.
		Shares struct {
			// Allocated The number of shares allocated.
			Allocated int `json:"allocated"`

			// Total The total number of shares available.
			Total int `json:"total"`
		} `json:"shares"`
	} `json:"cpu"`

	// Ram Information about RAM Resources.
	Ram struct {
		// AllocatedMb The total amount of allocated RAM in MBs.
		AllocatedMb int `json:"allocated_mb"`

		// ProvisionedMb The total amount of provisioned RAM in MBs.
		ProvisionedMb *int `json:"provisioned_mb,omitempty"`

		// TotalMb The total amount of RAM in MBsr.
		TotalMb int `json:"total_mb"`

		// UsedMb The total amount of used RAM in MBs.
		UsedMb int `json:"used_mb"`
	} `json:"ram"`
}

InfrastructureResourceSummary A summary of resource utilization/availability.

type InfrastructureSummary

type InfrastructureSummary struct {
	// Clusters Records pointing to information about clusters that make up this hubs infrastructure.
	Clusters map[string]struct {
		// Healthy Whether Cycle has determined this cluster to be healthy or not.
		Healthy bool `json:"healthy"`

		// Instances A summary of resources by state
		Instances StateCountSummary `json:"instances"`

		// Name The name of the cluster
		Name string `json:"name"`

		// Resources A summary of resource utilization/availability.
		Resources InfrastructureResourceSummary `json:"resources"`
		Servers   struct {
			Count     float32 `json:"count"`
			Providers map[string]struct {
				Count     float32         `json:"count"`
				Locations *map[string]int `json:"locations"`
				Models    *map[string]int `json:"models"`

				// Resources A summary of resource utilization/availability.
				Resources *InfrastructureResourceSummary `json:"resources,omitempty"`
			} `json:"providers"`

			// ServerIds IDs of all servers in this cluster.
			ServerIds *[]ID `json:"server_ids,omitempty"`
		} `json:"servers"`

		// Versions A count of servers in a cluster with the given version of Cycle software
		Versions ClusterVersionServerCount `json:"versions"`
	} `json:"clusters"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Images Statistics about image usage.
	Images struct {
		// Tier Image tier information.
		Tier struct {
			// AllocatedMb A value in MB representing the amount of allocated space for images.
			AllocatedMb int `json:"allocated_mb"`

			// TotalMb A value in MB representing the total MB of space on the infrastructure available for images.
			TotalMb int `json:"total_mb"`

			// UsedMb A value in MB representing the total MB of space images are taking up out of the total megabytes available.
			UsedMb int `json:"used_mb"`
		} `json:"tier"`
	} `json:"images"`

	// Servers The number of servers on the cluster
	Servers float32  `json:"servers"`
	Updated DateTime `json:"updated"`
}

InfrastructureSummary An infrastructure summary resource.

type Instance

type Instance struct {
	Autoscale *InstanceAutoScale `json:"autoscale"`

	// ContainerId A container identifier for the container that is associated with this instance.
	ContainerId string `json:"container_id"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator    CreatorScope `json:"creator"`
	Deployment *Deployment  `json:"deployment"`

	// Environment Details about the environment network this instance is a member of.
	Environment EnvironmentNetworkSummary `json:"environment"`

	// Events A collection of timestamps for each event in the instance's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`
	Extension *ContainerExtension `json:"extension"`

	// Function If the instance is a function, additional details relating to its function properties
	Function *struct {
		// Seed The seed used for this function.
		Seed int `json:"seed"`
	} `json:"function,omitempty"`

	// Hostname The hostname of the instance.
	Hostname string `json:"hostname"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// LocationId A location identifier that's associated with the server this instance is deployed to.
	LocationId string             `json:"location_id"`
	Meta       *InstanceMeta      `json:"meta"`
	Migration  *InstanceMigration `json:"migration"`
	Provider   InstanceProvider   `json:"provider"`

	// PurgeTime The timestamp of when the instance was purged.
	PurgeTime *DateTime `json:"purge_time"`

	// ReadyState The state as it relates to the following. * `active` - instance can be started or stopped. * `purge` - instance should be deleted. * `hibernate` - instance is active but not allowed to run. * `configuring` - this instance is not allowed to start yet
	ReadyState InstanceReadyState `json:"ready_state"`

	// ServerId A 24 character hex string used to identify a unique resource.
	ServerId ID `json:"server_id"`

	// Service Identifier of a service Container within an Environment.
	Service *ServiceContainerIdentifier `json:"service,omitempty"`

	// State Information about the state of an instance.
	State InstanceState `json:"state"`

	// Stateful If the instance is stateful, additional details relating to its stateful properties.
	Stateful *struct {
		// BaseHostname The base hostname for the given instance.
		BaseHostname string `json:"base_hostname"`

		// Id A 24 character hex string used to identify a unique resource.
		Id ID `json:"id"`
	} `json:"stateful"`
	TrafficDrain *InstanceTrafficDrain `json:"traffic_drain"`
}

Instance An instance of a Container.

type InstanceAutoScale

type InstanceAutoScale struct {
	MinTtl DateTime `json:"min_ttl"`
}

InstanceAutoScale Auto-scale details for instances created by auto-scale events.

type InstanceExtendVolumeAction added in v0.6.1

type InstanceExtendVolumeAction struct {
	// Action The name of the action to perform.
	Action   InstanceExtendVolumeActionAction `json:"action"`
	Contents struct {
		// ExtendSize A human-readable data size string. Values are expressed as an integer followed by a unit suffix, without spaces. Supported units:
		//   - b, k, m, g, t, p (bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes)
		//   - An optional "b" suffix may be added (e.g., "mb", "gb").
		// Units are case-insensitive. Example: "512M", "10GB", "1t".
		ExtendSize DataSize `json:"extend_size"`

		// VolumeId The ID of the volume that will be extended through this task.
		VolumeId string `json:"volume_id"`
	} `json:"contents"`
}

InstanceExtendVolumeAction defines model for InstanceExtendVolumeAction.

type InstanceExtendVolumeActionAction added in v0.6.1

type InstanceExtendVolumeActionAction string

InstanceExtendVolumeActionAction The name of the action to perform.

const (
	VolumeExtend InstanceExtendVolumeActionAction = "volume.extend"
)

Defines values for InstanceExtendVolumeActionAction.

type InstanceIncludes

type InstanceIncludes struct {
	// Containers A resource that is associated with a container.
	Containers *ContainersIncludes `json:"containers,omitempty"`

	// ContainersIdentifiers A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.
	ContainersIdentifiers *IdentifierIncludes `json:"containers:identifiers,omitempty"`

	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`

	// Environments An identity that is associated with an environment.
	Environments *EnvironmentIncludes `json:"environments,omitempty"`

	// EnvironmentsIdentifiers A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.
	EnvironmentsIdentifiers *IdentifierIncludes `json:"environments:identifiers,omitempty"`

	// Integrations A resource that is associated with an integration.
	Integrations *IntegrationsIncludes `json:"integrations,omitempty"`

	// IntegrationsIdentifiers A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.
	IntegrationsIdentifiers *IdentifierIncludes `json:"integrations:identifiers,omitempty"`

	// Locations A resource that is associated with a provider location.
	Locations *LocationsIncludes `json:"locations,omitempty"`

	// Servers A resource that is associated with a server.
	Servers *ServersIncludes `json:"servers,omitempty"`
}

InstanceIncludes A resource associated with an instance.

type InstanceMeta added in v0.6.3

type InstanceMeta struct {
	Node *struct {
		Healthy     *bool      `json:"healthy,omitempty"`
		LastCheckin *DateTime  `json:"last_checkin,omitempty"`
		Online      *bool      `json:"online,omitempty"`
		State       *NodeState `json:"state,omitempty"`
	} `json:"node,omitempty"`
	SdnPoolIps *[]Ip `json:"sdn_pool_ips,omitempty"`
}

InstanceMeta A list of meta fields that can be applied to an instance.

type InstanceMigrateAction added in v0.6.1

type InstanceMigrateAction struct {
	// Action The name of the action to perform.
	Action   InstanceMigrateActionAction `json:"action"`
	Contents struct {
		// DestinationServerId The ID of the server being migrated to.
		DestinationServerId string `json:"destination_server_id"`

		// Stateful Information about additonal configuration settings used when migrating a stateful instance.
		Stateful *struct {
			// CopyVolumes A boolean where true represents the desire to copy the contents of the volume for a given stateful instance with the migration.
			CopyVolumes bool `json:"copy_volumes"`
		} `json:"stateful,omitempty"`
	} `json:"contents"`
}

InstanceMigrateAction defines model for InstanceMigrateAction.

type InstanceMigrateActionAction added in v0.6.1

type InstanceMigrateActionAction string

InstanceMigrateActionAction The name of the action to perform.

const (
	MigrationStart InstanceMigrateActionAction = "migration.start"
)

Defines values for InstanceMigrateActionAction.

type InstanceMigration

type InstanceMigration struct {
	Completed *DateTime `json:"completed,omitempty"`

	// CopyVolumes A boolean where true represents the volumes for the instance should be copied to the new server as well.
	CopyVolumes bool               `json:"copy_volumes"`
	From        *MigrationInstance `json:"from"`

	// Key A key used by the platform to verify the migration.
	Key     string             `json:"key"`
	Started *DateTime          `json:"started,omitempty"`
	To      *MigrationInstance `json:"to"`
}

InstanceMigration Information regarding the migration of an instance, such as the server that the instance came from or the server that the instance was moved to.

type InstanceProvider

type InstanceProvider struct {
	// IntegrationId A 24 character hex string used to identify a unique resource.
	IntegrationId ID `json:"integration_id"`

	// Location The identifier of the location related to the server this instance runs on.
	Location string `json:"location"`

	// Vendor The vendor of the hub provider integration related to the server this instance runs on.
	Vendor string `json:"vendor"`
}

InstanceProvider defines model for InstanceProvider.

type InstanceReadyState

type InstanceReadyState string

InstanceReadyState The state as it relates to the following. * `active` - instance can be started or stopped. * `purge` - instance should be deleted. * `hibernate` - instance is active but not allowed to run. * `configuring` - this instance is not allowed to start yet

const (
	InstanceReadyStateActive      InstanceReadyState = "active"
	InstanceReadyStateConfiguring InstanceReadyState = "configuring"
	InstanceReadyStateHibernate   InstanceReadyState = "hibernate"
	InstanceReadyStatePurge       InstanceReadyState = "purge"
)

Defines values for InstanceReadyState.

type InstanceRevertMigrationAction added in v0.6.1

type InstanceRevertMigrationAction struct {
	// Action The name of the action to perform.
	Action InstanceRevertMigrationActionAction `json:"action"`
}

InstanceRevertMigrationAction defines model for InstanceRevertMigrationAction.

type InstanceRevertMigrationActionAction added in v0.6.1

type InstanceRevertMigrationActionAction string

InstanceRevertMigrationActionAction The name of the action to perform.

const (
	MigrationRevert InstanceRevertMigrationActionAction = "migration.revert"
)

Defines values for InstanceRevertMigrationActionAction.

type InstanceState

type InstanceState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the instance.
	Current InstanceStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`

	// Health information about the health of the instance.
	Health *struct {
		// Healthy Describes the healthiness of the instance. Health checks can be configured at the container level.
		// - `true`: The instance is considered healthy.
		// - `false`: The instance is considered unhealthy.
		// - `null`: The instance has not yet reported its health, or a health check has not yet been performed.
		Healthy *bool    `json:"healthy"`
		Updated DateTime `json:"updated"`
	} `json:"health"`

	// Readiness information about the readiness of the instance.
	Readiness *struct {
		// Ready Describes the readiness of the instance.
		// - `true`: The instance is ready.
		// - `false`: The instance is not ready.
		// - `null`: The instance has not yet reported its readiness, or a readiness check has not yet been performed.
		Ready   *bool    `json:"ready"`
		Updated DateTime `json:"updated"`
	} `json:"readiness"`
}

InstanceState defines model for InstanceState.

type InstanceStateCurrent

type InstanceStateCurrent string

InstanceStateCurrent The current state of the instance.

const (
	InstanceStateCurrentDeleted   InstanceStateCurrent = "deleted"
	InstanceStateCurrentDeleting  InstanceStateCurrent = "deleting"
	InstanceStateCurrentFailed    InstanceStateCurrent = "failed"
	InstanceStateCurrentMigrating InstanceStateCurrent = "migrating"
	InstanceStateCurrentNew       InstanceStateCurrent = "new"
	InstanceStateCurrentRunning   InstanceStateCurrent = "running"
	InstanceStateCurrentStarting  InstanceStateCurrent = "starting"
	InstanceStateCurrentStopped   InstanceStateCurrent = "stopped"
	InstanceStateCurrentStopping  InstanceStateCurrent = "stopping"
)

Defines values for InstanceStateCurrent.

type InstanceTask added in v0.6.1

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

InstanceTask defines model for InstanceTask.

func (InstanceTask) AsInstanceExtendVolumeAction added in v0.6.1

func (t InstanceTask) AsInstanceExtendVolumeAction() (InstanceExtendVolumeAction, error)

AsInstanceExtendVolumeAction returns the union data inside the InstanceTask as a InstanceExtendVolumeAction

func (InstanceTask) AsInstanceMigrateAction added in v0.6.1

func (t InstanceTask) AsInstanceMigrateAction() (InstanceMigrateAction, error)

AsInstanceMigrateAction returns the union data inside the InstanceTask as a InstanceMigrateAction

func (InstanceTask) AsInstanceRevertMigrationAction added in v0.6.1

func (t InstanceTask) AsInstanceRevertMigrationAction() (InstanceRevertMigrationAction, error)

AsInstanceRevertMigrationAction returns the union data inside the InstanceTask as a InstanceRevertMigrationAction

func (InstanceTask) AsInstanceTrafficDrainReconfigure added in v0.6.3

func (t InstanceTask) AsInstanceTrafficDrainReconfigure() (InstanceTrafficDrainReconfigure, error)

AsInstanceTrafficDrainReconfigure returns the union data inside the InstanceTask as a InstanceTrafficDrainReconfigure

func (InstanceTask) Discriminator added in v0.6.1

func (t InstanceTask) Discriminator() (string, error)

func (*InstanceTask) FromInstanceExtendVolumeAction added in v0.6.1

func (t *InstanceTask) FromInstanceExtendVolumeAction(v InstanceExtendVolumeAction) error

FromInstanceExtendVolumeAction overwrites any union data inside the InstanceTask as the provided InstanceExtendVolumeAction

func (*InstanceTask) FromInstanceMigrateAction added in v0.6.1

func (t *InstanceTask) FromInstanceMigrateAction(v InstanceMigrateAction) error

FromInstanceMigrateAction overwrites any union data inside the InstanceTask as the provided InstanceMigrateAction

func (*InstanceTask) FromInstanceRevertMigrationAction added in v0.6.1

func (t *InstanceTask) FromInstanceRevertMigrationAction(v InstanceRevertMigrationAction) error

FromInstanceRevertMigrationAction overwrites any union data inside the InstanceTask as the provided InstanceRevertMigrationAction

func (*InstanceTask) FromInstanceTrafficDrainReconfigure added in v0.6.3

func (t *InstanceTask) FromInstanceTrafficDrainReconfigure(v InstanceTrafficDrainReconfigure) error

FromInstanceTrafficDrainReconfigure overwrites any union data inside the InstanceTask as the provided InstanceTrafficDrainReconfigure

func (InstanceTask) MarshalJSON added in v0.6.1

func (t InstanceTask) MarshalJSON() ([]byte, error)

func (*InstanceTask) MergeInstanceExtendVolumeAction added in v0.6.1

func (t *InstanceTask) MergeInstanceExtendVolumeAction(v InstanceExtendVolumeAction) error

MergeInstanceExtendVolumeAction performs a merge with any union data inside the InstanceTask, using the provided InstanceExtendVolumeAction

func (*InstanceTask) MergeInstanceMigrateAction added in v0.6.1

func (t *InstanceTask) MergeInstanceMigrateAction(v InstanceMigrateAction) error

MergeInstanceMigrateAction performs a merge with any union data inside the InstanceTask, using the provided InstanceMigrateAction

func (*InstanceTask) MergeInstanceRevertMigrationAction added in v0.6.1

func (t *InstanceTask) MergeInstanceRevertMigrationAction(v InstanceRevertMigrationAction) error

MergeInstanceRevertMigrationAction performs a merge with any union data inside the InstanceTask, using the provided InstanceRevertMigrationAction

func (*InstanceTask) MergeInstanceTrafficDrainReconfigure added in v0.6.3

func (t *InstanceTask) MergeInstanceTrafficDrainReconfigure(v InstanceTrafficDrainReconfigure) error

MergeInstanceTrafficDrainReconfigure performs a merge with any union data inside the InstanceTask, using the provided InstanceTrafficDrainReconfigure

func (*InstanceTask) UnmarshalJSON added in v0.6.1

func (t *InstanceTask) UnmarshalJSON(b []byte) error

func (InstanceTask) ValueByDiscriminator added in v0.6.1

func (t InstanceTask) ValueByDiscriminator() (interface{}, error)

type InstanceTelemetryReport

type InstanceTelemetryReport struct {
	// Request A summary of report requests and when they occured.
	Request TelemetryReportRequest `json:"request"`

	// Snapshots An array of telemetry snapshots.
	Snapshots []ResourceSnapshot `json:"snapshots"`
}

InstanceTelemetryReport An Instance telemetry report.

type InstanceTrafficDrain added in v0.6.3

type InstanceTrafficDrain struct {
	Started DateTime `json:"started"`
}

InstanceTrafficDrain Traffic drain details for instance.

type InstanceTrafficDrainReconfigure added in v0.6.3

type InstanceTrafficDrainReconfigure struct {
	// Action The name of the action to perform.
	Action   InstanceTrafficDrainReconfigureAction `json:"action"`
	Contents struct {
		// Enable Enable or disable traffic drain for the instance.
		Enable bool `json:"enable"`
	} `json:"contents"`
}

InstanceTrafficDrainReconfigure defines model for InstanceTrafficDrainReconfigure.

type InstanceTrafficDrainReconfigureAction added in v0.6.3

type InstanceTrafficDrainReconfigureAction string

InstanceTrafficDrainReconfigureAction The name of the action to perform.

const (
	TrafficDrainReconfigure InstanceTrafficDrainReconfigureAction = "traffic-drain.reconfigure"
)

Defines values for InstanceTrafficDrainReconfigureAction.

type InstanceVolume

type InstanceVolume struct {
	// Config Configuration settings for container volumes.
	Config ContainerVolume `json:"config"`

	// Deployed A deployed volume resource.
	Deployed *DeployedVolume `json:"deployed,omitempty"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Sftp Information about connecting to a instance volume over SFTP.
	Sftp *SFTP `json:"sftp,omitempty"`
}

InstanceVolume A container instance volume resource.

type Integration

type Integration struct {
	// Auth Authentication information for the integration, can be null.
	Auth *IntegrationAuth `json:"auth"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the integration's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// Extra Updated key-value pairs associated with the integration.
	Extra *map[string]string `json:"extra"`

	// HubId A 24 character hex string used to identify a unique resource.
	HubId ID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier       `json:"identifier"`
	Meta       *IntegrationMeta `json:"meta"`

	// Name Name of the integration.
	Name  string           `json:"name"`
	State IntegrationState `json:"state"`

	// Vendor Which vendor this integration is associated with.
	Vendor string `json:"vendor"`
}

Integration defines model for Integration.

type IntegrationAdvancedOptionBoolean

type IntegrationAdvancedOptionBoolean struct {
	Default *bool                                `json:"default"`
	Key     string                               `json:"key"`
	Title   string                               `json:"title"`
	Type    IntegrationAdvancedOptionBooleanType `json:"type"`
}

IntegrationAdvancedOptionBoolean defines model for IntegrationAdvancedOptionBoolean.

type IntegrationAdvancedOptionBooleanType

type IntegrationAdvancedOptionBooleanType string

IntegrationAdvancedOptionBooleanType defines model for IntegrationAdvancedOptionBoolean.Type.

const (
	Bool IntegrationAdvancedOptionBooleanType = "bool"
)

Defines values for IntegrationAdvancedOptionBooleanType.

type IntegrationAdvancedOptionInt

type IntegrationAdvancedOptionInt struct {
	Default *int                             `json:"default"`
	Key     string                           `json:"key"`
	Title   string                           `json:"title"`
	Type    IntegrationAdvancedOptionIntType `json:"type"`
}

IntegrationAdvancedOptionInt defines model for IntegrationAdvancedOptionInt.

type IntegrationAdvancedOptionIntType

type IntegrationAdvancedOptionIntType string

IntegrationAdvancedOptionIntType defines model for IntegrationAdvancedOptionInt.Type.

const (
	IntegrationAdvancedOptionIntTypeInt IntegrationAdvancedOptionIntType = "int"
)

Defines values for IntegrationAdvancedOptionIntType.

type IntegrationAdvancedOptionString

type IntegrationAdvancedOptionString struct {
	Default *string                             `json:"default"`
	Key     string                              `json:"key"`
	Title   string                              `json:"title"`
	Type    IntegrationAdvancedOptionStringType `json:"type"`
}

IntegrationAdvancedOptionString defines model for IntegrationAdvancedOptionString.

type IntegrationAdvancedOptionStringType

type IntegrationAdvancedOptionStringType string

IntegrationAdvancedOptionStringType defines model for IntegrationAdvancedOptionString.Type.

const (
	String IntegrationAdvancedOptionStringType = "string"
)

Defines values for IntegrationAdvancedOptionStringType.

type IntegrationAuth

type IntegrationAuth struct {
	// ApiKey API key for accessing the Integration.
	ApiKey *string `json:"api_key"`

	// Base64Config Base64 encoded configuration for the Integration.
	Base64Config *string `json:"base64_config"`

	// ClientId Client ID for the Integration.
	ClientId *string `json:"client_id"`

	// KeyId Key ID for accessing the Integration.
	KeyId *string `json:"key_id"`

	// Namespace The namespace associated with the Integration.
	Namespace *string `json:"namespace"`

	// Region The region associated with the Integration.
	Region *string `json:"region"`

	// Secret Secret for accessing the Integration.
	Secret *string `json:"secret"`

	// SubscriptionId Subscription ID for the Integration.
	SubscriptionId *string `json:"subscription_id"`
}

IntegrationAuth defines model for IntegrationAuth.

type IntegrationDefinition

type IntegrationDefinition struct {
	// Deprecated If true, this integration is no longer being supported and may be removed in the future. New instances of this integration will not be able to be created.
	Deprecated *bool `json:"deprecated,omitempty"`

	// Editable If true, the integration can be edited. Otherwise, to make a change it will need to be deleted and recreated.
	Editable bool `json:"editable"`

	// ExtendedConfiguration Additional configuration options that are available when using this integration. These describe additional functionality that Cycle may utilize.
	ExtendedConfiguration *struct {
		Options *[]IntegrationDefinition_ExtendedConfiguration_Options_Item `json:"options"`
	} `json:"extended_configuration"`

	// Extends A list of functionality that this integration extends. i.e. ["backups"]
	Extends *[]string `json:"extends"`

	// Features A list of additional features supported by this integration.
	Features *[]string `json:"features"`
	Fields   *struct {
		Auth  *map[string]IntegrationDefinitionField `json:"auth"`
		Extra *map[string]IntegrationDefinitionField `json:"extra"`
	} `json:"fields,omitempty"`
	Name                 string `json:"name"`
	Public               bool   `json:"public"`
	SupportsMultiple     bool   `json:"supports_multiple"`
	SupportsVerification bool   `json:"supports_verification"`
	Url                  string `json:"url"`

	// Usable Whether or not this integration can be used at this time.
	Usable bool   `json:"usable"`
	Vendor string `json:"vendor"`
}

IntegrationDefinition Describes an integration for a Cycle hub that can be enabled by the hub owner.

type IntegrationDefinitionField added in v0.6.3

type IntegrationDefinitionField struct {
	Description *string                         `json:"description,omitempty"`
	Name        string                          `json:"name"`
	Options     *[]string                       `json:"options"`
	Regex       *string                         `json:"regex"`
	Required    bool                            `json:"required"`
	Type        *IntegrationDefinitionFieldType `json:"type,omitempty"`
}

IntegrationDefinitionField defines model for IntegrationDefinitionField.

type IntegrationDefinitionFieldType added in v0.6.3

type IntegrationDefinitionFieldType string

IntegrationDefinitionFieldType defines model for IntegrationDefinitionField.Type.

const (
	IntegrationDefinitionFieldTypeBlob   IntegrationDefinitionFieldType = "blob"
	IntegrationDefinitionFieldTypeInt    IntegrationDefinitionFieldType = "int"
	IntegrationDefinitionFieldTypeSelect IntegrationDefinitionFieldType = "select"
	IntegrationDefinitionFieldTypeString IntegrationDefinitionFieldType = "string"
)

Defines values for IntegrationDefinitionFieldType.

type IntegrationDefinition_ExtendedConfiguration_Options_Item

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

IntegrationDefinition_ExtendedConfiguration_Options_Item defines model for IntegrationDefinition.ExtendedConfiguration.Options.Item.

func (IntegrationDefinition_ExtendedConfiguration_Options_Item) AsIntegrationAdvancedOptionBoolean

AsIntegrationAdvancedOptionBoolean returns the union data inside the IntegrationDefinition_ExtendedConfiguration_Options_Item as a IntegrationAdvancedOptionBoolean

func (IntegrationDefinition_ExtendedConfiguration_Options_Item) AsIntegrationAdvancedOptionInt

AsIntegrationAdvancedOptionInt returns the union data inside the IntegrationDefinition_ExtendedConfiguration_Options_Item as a IntegrationAdvancedOptionInt

func (IntegrationDefinition_ExtendedConfiguration_Options_Item) AsIntegrationAdvancedOptionString

AsIntegrationAdvancedOptionString returns the union data inside the IntegrationDefinition_ExtendedConfiguration_Options_Item as a IntegrationAdvancedOptionString

func (IntegrationDefinition_ExtendedConfiguration_Options_Item) Discriminator

func (*IntegrationDefinition_ExtendedConfiguration_Options_Item) FromIntegrationAdvancedOptionBoolean

FromIntegrationAdvancedOptionBoolean overwrites any union data inside the IntegrationDefinition_ExtendedConfiguration_Options_Item as the provided IntegrationAdvancedOptionBoolean

func (*IntegrationDefinition_ExtendedConfiguration_Options_Item) FromIntegrationAdvancedOptionInt

FromIntegrationAdvancedOptionInt overwrites any union data inside the IntegrationDefinition_ExtendedConfiguration_Options_Item as the provided IntegrationAdvancedOptionInt

func (*IntegrationDefinition_ExtendedConfiguration_Options_Item) FromIntegrationAdvancedOptionString

FromIntegrationAdvancedOptionString overwrites any union data inside the IntegrationDefinition_ExtendedConfiguration_Options_Item as the provided IntegrationAdvancedOptionString

func (IntegrationDefinition_ExtendedConfiguration_Options_Item) MarshalJSON

func (*IntegrationDefinition_ExtendedConfiguration_Options_Item) MergeIntegrationAdvancedOptionBoolean

MergeIntegrationAdvancedOptionBoolean performs a merge with any union data inside the IntegrationDefinition_ExtendedConfiguration_Options_Item, using the provided IntegrationAdvancedOptionBoolean

func (*IntegrationDefinition_ExtendedConfiguration_Options_Item) MergeIntegrationAdvancedOptionInt

MergeIntegrationAdvancedOptionInt performs a merge with any union data inside the IntegrationDefinition_ExtendedConfiguration_Options_Item, using the provided IntegrationAdvancedOptionInt

func (*IntegrationDefinition_ExtendedConfiguration_Options_Item) MergeIntegrationAdvancedOptionString

MergeIntegrationAdvancedOptionString performs a merge with any union data inside the IntegrationDefinition_ExtendedConfiguration_Options_Item, using the provided IntegrationAdvancedOptionString

func (*IntegrationDefinition_ExtendedConfiguration_Options_Item) UnmarshalJSON

func (IntegrationDefinition_ExtendedConfiguration_Options_Item) ValueByDiscriminator

func (t IntegrationDefinition_ExtendedConfiguration_Options_Item) ValueByDiscriminator() (interface{}, error)

type IntegrationMeta

type IntegrationMeta struct {
	// Definition Describes an integration for a Cycle hub that can be enabled by the hub owner.
	Definition *IntegrationDefinition `json:"definition,omitempty"`
}

IntegrationMeta Additional fields that can be requested for an Integration on fetch.

type IntegrationState

type IntegrationState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the integration.
	Current IntegrationStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

IntegrationState defines model for IntegrationState.

type IntegrationStateCurrent

type IntegrationStateCurrent string

IntegrationStateCurrent The current state of the integration.

const (
	IntegrationStateCurrentDeleted   IntegrationStateCurrent = "deleted"
	IntegrationStateCurrentDeleting  IntegrationStateCurrent = "deleting"
	IntegrationStateCurrentLive      IntegrationStateCurrent = "live"
	IntegrationStateCurrentNew       IntegrationStateCurrent = "new"
	IntegrationStateCurrentVerifying IntegrationStateCurrent = "verifying"
)

Defines values for IntegrationStateCurrent.

type IntegrationsIncludes

type IntegrationsIncludes map[string]Integration

IntegrationsIncludes A resource that is associated with an integration.

type Invitation

type Invitation struct {
	// Events A collection of timestamps for each event in the invitation's lifetime.
	Events struct {
		Accepted DateTime `json:"accepted"`
		Created  DateTime `json:"created"`
		Declined DateTime `json:"declined"`
		Deleted  DateTime `json:"deleted"`
		Revoked  DateTime `json:"revoked"`
		Updated  DateTime `json:"updated"`
	} `json:"events"`

	// Recipient The email address for the invitations recipient.
	Recipient string `json:"recipient"`

	// Sender Information about the origin account of the invitation.
	Sender struct {
		// Id A 24 character hex string used to identify a unique resource.
		Id ID `json:"id"`

		// Type The account type.
		Type string `json:"type"`
	} `json:"sender"`
}

Invitation Information about a hub membership invitation.

type Invoice

type Invoice struct {
	// Approved A boolean where true represents the invoice is approved for collection.
	Approved bool `json:"approved"`

	// BillingContact The contact to whom invoices are billed.
	BillingContact *HubBillingContact `json:"billing_contact,omitempty"`

	// Charges The amount in charges generated through the licesnse agreement + overages for the billing period covered by the invoice.
	Charges int              `json:"charges"`
	Credits *[]InvoiceCredit `json:"credits"`
	Due     *DateTime        `json:"due,omitempty"`

	// Events A collection of timestamps for each event in the billing order's lifetime.
	Events struct {
		Billed         DateTime  `json:"billed"`
		Created        DateTime  `json:"created"`
		Credited       DateTime  `json:"credited"`
		Deleted        DateTime  `json:"deleted"`
		Paid           DateTime  `json:"paid"`
		PaymentAttempt *DateTime `json:"payment_attempt,omitempty"`
		Updated        DateTime  `json:"updated"`
		Voided         DateTime  `json:"voided"`
	} `json:"events"`

	// FailedPaymentAttempts The number of failed payment attempts for the invoice.
	FailedPaymentAttempts int `json:"failed_payment_attempts"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id       ID         `json:"id"`
	LateFees *[]LateFee `json:"late_fees"`

	// Meta A list of meta fields that can be applied to a invoice.
	Meta     *InvoiceMeta      `json:"meta,omitempty"`
	Overdue  *DateTime         `json:"overdue,omitempty"`
	Payments *[]Payment        `json:"payments"`
	Services *[]BillingSummary `json:"services"`
	State    InvoiceState      `json:"state"`
}

Invoice Information about a billing invoice.

type InvoiceCredit

type InvoiceCredit struct {
	// Amount The amount of credit for the invoice.
	Amount int `json:"amount"`

	// AssociatedCredit Credit associated with an invoice.
	AssociatedCredit struct {
		// Amount The amount of the credit.
		Amount int `json:"amount"`

		// Id A 24 character hex string used to identify a unique resource.
		Id ID `json:"id"`
	} `json:"associated_credit"`

	// Description A description of the invoice credit.
	Description string `json:"description"`

	// Id A 24 character hex string used to identify a unique resource.
	Id   ID       `json:"id"`
	Time DateTime `json:"time"`
}

InvoiceCredit A billing credit for a specific invoice.

type InvoiceMeta

type InvoiceMeta struct {
	// Due The amount due for a given invoice.
	Due *int `json:"due,omitempty"`

	// Hub A hub resource.
	Hub *Hub `json:"hub,omitempty"`
}

InvoiceMeta A list of meta fields that can be applied to a invoice.

type InvoiceState

type InvoiceState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the invoice.
	Current InvoiceStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

InvoiceState defines model for InvoiceState.

type InvoiceStateCurrent

type InvoiceStateCurrent string

InvoiceStateCurrent The current state of the invoice.

const (
	InvoiceStateCurrentAwaitingFunds InvoiceStateCurrent = "awaiting-funds"
	InvoiceStateCurrentBilled        InvoiceStateCurrent = "billed"
	InvoiceStateCurrentBilling       InvoiceStateCurrent = "billing"
	InvoiceStateCurrentCredited      InvoiceStateCurrent = "credited"
	InvoiceStateCurrentCrediting     InvoiceStateCurrent = "crediting"
	InvoiceStateCurrentNew           InvoiceStateCurrent = "new"
	InvoiceStateCurrentPaid          InvoiceStateCurrent = "paid"
	InvoiceStateCurrentPartiallyPaid InvoiceStateCurrent = "partially-paid"
	InvoiceStateCurrentProcessing    InvoiceStateCurrent = "processing"
	InvoiceStateCurrentRefunded      InvoiceStateCurrent = "refunded"
	InvoiceStateCurrentRefunding     InvoiceStateCurrent = "refunding"
	InvoiceStateCurrentUncollectible InvoiceStateCurrent = "uncollectible"
	InvoiceStateCurrentVoided        InvoiceStateCurrent = "voided"
	InvoiceStateCurrentVoiding       InvoiceStateCurrent = "voiding"
)

Defines values for InvoiceStateCurrent.

type Ip

type Ip struct {
	// Address The IP address.
	Address string `json:"address"`

	// Assignment Information about the assignment of this IP.
	Assignment *struct {
		// ContainerId A 24 character hex string used to identify a unique resource.
		ContainerId ID `json:"container_id"`

		// EnvironmentId A 24 character hex string used to identify a unique resource.
		EnvironmentId ID `json:"environment_id"`

		// InstanceId A 24 character hex string used to identify a unique resource.
		InstanceId ID `json:"instance_id"`

		// VirtualMachine Details about the virtual machine this IP is assigned to.
		VirtualMachine *struct {
			// Id A 24 character hex string used to identify a unique resource.
			Id ID `json:"id"`
		} `json:"virtual_machine,omitempty"`
	} `json:"assignment"`

	// Cidr The CIDR for the IP.
	Cidr string `json:"cidr"`

	// Gateway The IP gateway.
	Gateway string `json:"gateway"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Ip An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.
	Ip IpAddress `json:"ip"`

	// Kind The type of IP protocol this IP is.
	Kind IpKind `json:"kind"`

	// Network A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix.
	// It combines an IP address with a suffix that indicates how many bits are fixed for routing.
	Network *Cidr `json:"network,omitempty"`

	// NetworkId A 24 character hex string used to identify a unique resource.
	NetworkId ID `json:"network_id"`

	// Options Options for an IP.
	Options *IpOptions `json:"options,omitempty"`

	// PoolId A 24 character hex string used to identify a unique resource.
	PoolId ID      `json:"pool_id"`
	State  IpState `json:"state"`
}

Ip Details about an IP.

type IpAddress added in v0.6.3

type IpAddress = string

IpAddress An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.

type IpKind

type IpKind string

IpKind The type of IP protocol this IP is.

const (
	IpKindIpv4 IpKind = "ipv4"
	IpKindIpv6 IpKind = "ipv6"
)

Defines values for IpKind.

type IpOptions added in v0.6.4

type IpOptions struct {
	// ProxyArp If enabled, allows pool to respond to ARP requests, on behalf of a container / virtual machine, at the host level.
	ProxyArp *bool `json:"proxy_arp"`
}

IpOptions Options for an IP.

type IpPool added in v0.6.3

type IpPool struct {
	// Block Network information about the pool.
	Block struct {
		// Cidr A cidr for the pool.
		Cidr string `json:"cidr"`

		// Gateway A gateway for the pool.
		Gateway string `json:"gateway"`

		// Network A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix.
		// It combines an IP address with a suffix that indicates how many bits are fixed for routing.
		Network *Cidr `json:"network,omitempty"`
	} `json:"block"`

	// Floating A boolean where true represents the pool as a floating IP pool.
	Floating bool `json:"floating"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Ips Data about IPs in the pool.
	Ips struct {
		// Available Of the total number of IP's how many are available to be assigned.
		Available int `json:"available"`

		// Total The total number of IPs in the pool.
		Total int `json:"total"`
	} `json:"ips"`

	// Kind The type of IP pool.
	Kind IpPoolKind `json:"kind"`

	// LocationId An ID associated with a location resource.
	LocationId string `json:"location_id"`

	// Options Options for an IP.
	Options *IpOptions `json:"options,omitempty"`

	// Provider A IP Pool provider.
	Provider IpPoolProvider `json:"provider"`

	// ServerId An ID associated with a server resource.
	ServerId string      `json:"server_id"`
	State    IpPoolState `json:"state"`
}

IpPool An IP Pool

type IpPoolIncludes added in v0.6.3

type IpPoolIncludes struct {
	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`

	// Integrations A resource that is associated with an integration.
	Integrations *IntegrationsIncludes `json:"integrations,omitempty"`

	// Locations A resource that is associated with a provider location.
	Locations *LocationsIncludes `json:"locations,omitempty"`

	// Servers A resource that is associated with a server.
	Servers *ServersIncludes `json:"servers,omitempty"`
}

IpPoolIncludes Resources associated with an IP Pool.

type IpPoolInitializeAction added in v0.6.4

type IpPoolInitializeAction struct {
	// Action The action to take.
	Action IpPoolInitializeActionAction `json:"action"`
}

IpPoolInitializeAction defines model for IpPoolInitializeAction.

type IpPoolInitializeActionAction added in v0.6.4

type IpPoolInitializeActionAction string

IpPoolInitializeActionAction The action to take.

const (
	IpPoolInitializeActionActionInitialize IpPoolInitializeActionAction = "initialize"
)

Defines values for IpPoolInitializeActionAction.

type IpPoolKind added in v0.6.3

type IpPoolKind string

IpPoolKind The type of IP pool.

const (
	IpPoolKindIpv4 IpPoolKind = "ipv4"
	IpPoolKindIpv6 IpPoolKind = "ipv6"
)

Defines values for IpPoolKind.

type IpPoolProvider added in v0.6.3

type IpPoolProvider struct {
	// IntegrationId A 24 character hex string used to identify a unique resource.
	IntegrationId ID `json:"integration_id"`

	// Location Information about the location of the provider this pool is associated with.
	Location string `json:"location"`

	// Reservation A reservation identifier associated with the pool reservation.
	Reservation string `json:"reservation"`

	// Server A server identifier associated with the pool.
	Server string `json:"server"`

	// ServerAssignment An identifier linked to the server assingment of the IP pool.
	ServerAssignment string `json:"server_assignment"`

	// Vendor A vendor for a provider.
	Vendor string `json:"vendor"`
}

IpPoolProvider A IP Pool provider.

type IpPoolReconfigureOptionsAction added in v0.6.4

type IpPoolReconfigureOptionsAction struct {
	// Action The action to take.
	Action IpPoolReconfigureOptionsActionAction `json:"action"`

	// Contents Options for an IP.
	Contents *IpOptions `json:"contents,omitempty"`
}

IpPoolReconfigureOptionsAction defines model for IpPoolReconfigureOptionsAction.

type IpPoolReconfigureOptionsActionAction added in v0.6.4

type IpPoolReconfigureOptionsActionAction string

IpPoolReconfigureOptionsActionAction The action to take.

const (
	OptionsReconfigure IpPoolReconfigureOptionsActionAction = "options.reconfigure"
)

Defines values for IpPoolReconfigureOptionsActionAction.

type IpPoolState added in v0.6.3

type IpPoolState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the pool.
	Current IpPoolStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

IpPoolState defines model for IpPoolState.

type IpPoolStateCurrent added in v0.6.3

type IpPoolStateCurrent string

IpPoolStateCurrent The current state of the pool.

const (
	IpPoolStateCurrentLive      IpPoolStateCurrent = "live"
	IpPoolStateCurrentReleased  IpPoolStateCurrent = "released"
	IpPoolStateCurrentReleasing IpPoolStateCurrent = "releasing"
)

Defines values for IpPoolStateCurrent.

type IpPoolTask added in v0.6.4

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

IpPoolTask defines model for IpPoolTask.

func (IpPoolTask) AsIpPoolInitializeAction added in v0.6.4

func (t IpPoolTask) AsIpPoolInitializeAction() (IpPoolInitializeAction, error)

AsIpPoolInitializeAction returns the union data inside the IpPoolTask as a IpPoolInitializeAction

func (IpPoolTask) AsIpPoolReconfigureOptionsAction added in v0.6.4

func (t IpPoolTask) AsIpPoolReconfigureOptionsAction() (IpPoolReconfigureOptionsAction, error)

AsIpPoolReconfigureOptionsAction returns the union data inside the IpPoolTask as a IpPoolReconfigureOptionsAction

func (IpPoolTask) Discriminator added in v0.6.4

func (t IpPoolTask) Discriminator() (string, error)

func (*IpPoolTask) FromIpPoolInitializeAction added in v0.6.4

func (t *IpPoolTask) FromIpPoolInitializeAction(v IpPoolInitializeAction) error

FromIpPoolInitializeAction overwrites any union data inside the IpPoolTask as the provided IpPoolInitializeAction

func (*IpPoolTask) FromIpPoolReconfigureOptionsAction added in v0.6.4

func (t *IpPoolTask) FromIpPoolReconfigureOptionsAction(v IpPoolReconfigureOptionsAction) error

FromIpPoolReconfigureOptionsAction overwrites any union data inside the IpPoolTask as the provided IpPoolReconfigureOptionsAction

func (IpPoolTask) MarshalJSON added in v0.6.4

func (t IpPoolTask) MarshalJSON() ([]byte, error)

func (*IpPoolTask) MergeIpPoolInitializeAction added in v0.6.4

func (t *IpPoolTask) MergeIpPoolInitializeAction(v IpPoolInitializeAction) error

MergeIpPoolInitializeAction performs a merge with any union data inside the IpPoolTask, using the provided IpPoolInitializeAction

func (*IpPoolTask) MergeIpPoolReconfigureOptionsAction added in v0.6.4

func (t *IpPoolTask) MergeIpPoolReconfigureOptionsAction(v IpPoolReconfigureOptionsAction) error

MergeIpPoolReconfigureOptionsAction performs a merge with any union data inside the IpPoolTask, using the provided IpPoolReconfigureOptionsAction

func (*IpPoolTask) UnmarshalJSON added in v0.6.4

func (t *IpPoolTask) UnmarshalJSON(b []byte) error

func (IpPoolTask) ValueByDiscriminator added in v0.6.4

func (t IpPoolTask) ValueByDiscriminator() (interface{}, error)

type IpState

type IpState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the IP.
	Current IpStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

IpState defines model for IpState.

type IpStateCurrent

type IpStateCurrent string

IpStateCurrent The current state of the IP.

const (
	IpStateCurrentAssigned  IpStateCurrent = "assigned"
	IpStateCurrentAssigning IpStateCurrent = "assigning"
	IpStateCurrentAvailable IpStateCurrent = "available"
	IpStateCurrentReleasing IpStateCurrent = "releasing"
)

Defines values for IpStateCurrent.

type Job

type Job struct {
	// Caption A short description of the job.
	Caption string `json:"caption"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the job's lifetime.
	Events struct {
		Completed DateTime `json:"completed"`
		Queued    DateTime `json:"queued"`
		Started   DateTime `json:"started"`
	} `json:"events"`
	Expires DateTime `json:"expires"`

	// Hash A combination of the individual task details and job details.
	Hash string `json:"hash"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// LimitDuplicates A boolean where true represents the job is set to prevent duplicates of itself quickly after creation.
	LimitDuplicates bool `json:"limit_duplicates"`

	// Queue A dash separated string showing the environment_id where the job is taking place.
	Queue    string   `json:"queue"`
	Schedule DateTime `json:"schedule"`
	State    JobState `json:"state"`

	// Tasks An array of job tasks.
	Tasks []JobTask `json:"tasks"`
}

Job A job resource.

type JobDescriptor

type JobDescriptor struct {
	// Action The action that was taken.
	Action string `json:"action"`

	// Job Contains some basic information about the job associated with this task.
	Job *struct {
		// Accepted Describes if the job has been accepted
		Accepted bool `json:"accepted"`

		// Id The ID of the job
		Id       string `json:"id"`
		Parallel struct {
			SubQueue *string `json:"sub_queue"`
			Tasks    bool    `json:"tasks"`
		} `json:"parallel"`

		// Queue Describes the queue this job is a part of.
		Queue    string   `json:"queue"`
		Schedule DateTime `json:"schedule"`
		Tasks    *[]struct {
			// Caption A short description of the task.
			Caption string `json:"caption"`

			// Header The API function called.
			Header string `json:"header"`

			// Input Input information used for the job tasks.
			Input map[string]interface{} `json:"input"`

			// Steps An array of job task steps.
			Steps *[]TaskStep `json:"steps"`
		} `json:"tasks"`
	} `json:"job,omitempty"`
}

JobDescriptor A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.

type JobIncludes

type JobIncludes struct {
	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`
}

JobIncludes defines model for JobIncludes.

type JobState

type JobState struct {
	Changed *DateTime `json:"changed,omitempty"`

	// Current The current state of the job.
	Current JobStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this job.
	Error *struct {
		// Message Details about the error that has occurred.
		Message string `json:"message"`
	} `json:"error"`
}

JobState defines model for JobState.

type JobStateCurrent

type JobStateCurrent string

JobStateCurrent The current state of the job.

const (
	JobStateCurrentCompleted JobStateCurrent = "completed"
	JobStateCurrentError     JobStateCurrent = "error"
	JobStateCurrentExpired   JobStateCurrent = "expired"
	JobStateCurrentNew       JobStateCurrent = "new"
	JobStateCurrentQueued    JobStateCurrent = "queued"
	JobStateCurrentRunning   JobStateCurrent = "running"
	JobStateCurrentScheduled JobStateCurrent = "scheduled"
)

Defines values for JobStateCurrent.

type JobTask

type JobTask struct {
	// Caption A short description of the task.
	Caption string `json:"caption"`

	// Error An error object describing issues with the job.
	Error *struct {
		// Message An error message
		Message string `json:"message"`
	} `json:"error"`

	// Events A collection of timestamps for each event in the job's lifetime.
	Events struct {
		Completed DateTime `json:"completed"`
		Queued    DateTime `json:"queued"`
		Started   DateTime `json:"started"`
	} `json:"events"`

	// Header The API function called.
	Header string `json:"header"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Input Input information used for the job tasks.
	Input map[string]interface{} `json:"input"`

	// Output Output informaiton used for the job tasks.
	Output *map[string]string `json:"output"`
	State  TaskState          `json:"state"`

	// Steps An array of job task steps.
	Steps *[]TaskStep `json:"steps"`
}

JobTask Information about a job task.

type L2Domain added in v0.6.3

type L2Domain string

L2Domain A standardized name for different layer-2 networks that can be configured on virtual provider hosts.

Containers will utilize this name to determine which network to attach to on the host, if set in the config.
const (
	L2DomainPrivate L2Domain = "private"
	L2DomainPublic  L2Domain = "public"
	L2DomainShared  L2Domain = "shared"
)

Defines values for L2Domain.

type LateFee

type LateFee struct {
	// Amount 1/10th of a cent.
	Amount int `json:"amount"`

	// Description A description of the late fee.
	Description string `json:"description"`

	// Id A 24 character hex string used to identify a unique resource.
	Id   ID       `json:"id"`
	Time DateTime `json:"time"`
}

LateFee A late fee, applied to an invoice.

type LegacyNetwork

type LegacyNetwork struct {
	// Ipv4 IPv4 information available from environments using legacy networking.
	Ipv4 *IPNet `json:"ipv4"`

	// Subnet The IPv4 subnet id.
	Subnet int `json:"subnet"`
}

LegacyNetwork Legacy network information for an environment.

type LoadBalancerConfig

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

LoadBalancerConfig The config object for the loadbalancer service.

func (LoadBalancerConfig) AsDefaultLbType

func (t LoadBalancerConfig) AsDefaultLbType() (DefaultLbType, error)

AsDefaultLbType returns the union data inside the LoadBalancerConfig as a DefaultLbType

func (LoadBalancerConfig) AsHaProxyLbType

func (t LoadBalancerConfig) AsHaProxyLbType() (HaProxyLbType, error)

AsHaProxyLbType returns the union data inside the LoadBalancerConfig as a HaProxyLbType

func (LoadBalancerConfig) AsV1LbType

func (t LoadBalancerConfig) AsV1LbType() (V1LbType, error)

AsV1LbType returns the union data inside the LoadBalancerConfig as a V1LbType

func (LoadBalancerConfig) Discriminator

func (t LoadBalancerConfig) Discriminator() (string, error)

func (*LoadBalancerConfig) FromDefaultLbType

func (t *LoadBalancerConfig) FromDefaultLbType(v DefaultLbType) error

FromDefaultLbType overwrites any union data inside the LoadBalancerConfig as the provided DefaultLbType

func (*LoadBalancerConfig) FromHaProxyLbType

func (t *LoadBalancerConfig) FromHaProxyLbType(v HaProxyLbType) error

FromHaProxyLbType overwrites any union data inside the LoadBalancerConfig as the provided HaProxyLbType

func (*LoadBalancerConfig) FromV1LbType

func (t *LoadBalancerConfig) FromV1LbType(v V1LbType) error

FromV1LbType overwrites any union data inside the LoadBalancerConfig as the provided V1LbType

func (LoadBalancerConfig) MarshalJSON

func (t LoadBalancerConfig) MarshalJSON() ([]byte, error)

func (*LoadBalancerConfig) MergeDefaultLbType

func (t *LoadBalancerConfig) MergeDefaultLbType(v DefaultLbType) error

MergeDefaultLbType performs a merge with any union data inside the LoadBalancerConfig, using the provided DefaultLbType

func (*LoadBalancerConfig) MergeHaProxyLbType

func (t *LoadBalancerConfig) MergeHaProxyLbType(v HaProxyLbType) error

MergeHaProxyLbType performs a merge with any union data inside the LoadBalancerConfig, using the provided HaProxyLbType

func (*LoadBalancerConfig) MergeV1LbType

func (t *LoadBalancerConfig) MergeV1LbType(v V1LbType) error

MergeV1LbType performs a merge with any union data inside the LoadBalancerConfig, using the provided V1LbType

func (*LoadBalancerConfig) UnmarshalJSON

func (t *LoadBalancerConfig) UnmarshalJSON(b []byte) error

func (LoadBalancerConfig) ValueByDiscriminator

func (t LoadBalancerConfig) ValueByDiscriminator() (interface{}, error)

type LoadBalancerEnvironmentService

type LoadBalancerEnvironmentService struct {
	// AutoUpdate A boolean representing if this service container is set to autoupdate or not
	AutoUpdate *bool               `json:"auto_update,omitempty"`
	Config     *LoadBalancerConfig `json:"config"`

	// ContainerId The ID of the loadbalancer service container
	ContainerId *string `json:"container_id"`

	// Enable Whether or not the loadbalancer service is enabled.
	Enable bool `json:"enable"`

	// HighAvailability A boolean representing if this service container is set to high availability mode or not.
	HighAvailability bool `json:"high_availability"`
}

LoadBalancerEnvironmentService Information about the environments loadbalancer service(s).

type LoadBalancerInfo added in v0.6.6

type LoadBalancerInfo struct {
	BaseConfigs *struct {
		// Haproxy Describes settings that are passed to HAProxy within the load balancer.
		Haproxy HaProxyConfig `json:"haproxy"`
		V1      V1LbConfig    `json:"v1"`
	} `json:"base_configs,omitempty"`
	CurrentType LoadBalancerInfoCurrentType `json:"current_type"`

	// DefaultConfig The config object for the loadbalancer service.
	DefaultConfig LoadBalancerConfig              `json:"default_config"`
	DefaultType   LoadBalancerInfoDefaultType     `json:"default_type"`
	Service       *LoadBalancerEnvironmentService `json:"service"`
}

LoadBalancerInfo Information about an environments load balancer configuration, state, and availability settings.

type LoadBalancerInfoCurrentType added in v0.6.6

type LoadBalancerInfoCurrentType string

LoadBalancerInfoCurrentType defines model for LoadBalancerInfo.CurrentType.

const (
	LoadBalancerInfoCurrentTypeHaproxy LoadBalancerInfoCurrentType = "haproxy"
	LoadBalancerInfoCurrentTypeV1      LoadBalancerInfoCurrentType = "v1"
)

Defines values for LoadBalancerInfoCurrentType.

type LoadBalancerInfoDefaultType added in v0.6.6

type LoadBalancerInfoDefaultType string

LoadBalancerInfoDefaultType defines model for LoadBalancerInfo.DefaultType.

const (
	LoadBalancerInfoDefaultTypeHaproxy LoadBalancerInfoDefaultType = "haproxy"
	LoadBalancerInfoDefaultTypeV1      LoadBalancerInfoDefaultType = "v1"
)

Defines values for LoadBalancerInfoDefaultType.

type LoadBalancerLatestControllers

type LoadBalancerLatestControllers struct {
	Controllers *[]LoadBalancerLatestTelemetryController `json:"controllers"`
	Created     DateTime                                 `json:"created"`
}

LoadBalancerLatestControllers Information about the latest controllers that generated traffic.

type LoadBalancerLatestTelemetry

type LoadBalancerLatestTelemetry struct {
	Controllers *[]LoadBalancerLatestTelemetryController `json:"controllers"`
	Created     DateTime                                 `json:"created"`
}

LoadBalancerLatestTelemetry Snapshots of the latest load balancer telemetry

type LoadBalancerLatestTelemetryController

type LoadBalancerLatestTelemetryController struct {
	// Controller A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Controller Identifier                             `json:"controller"`
	Instances  *[]LoadBalancerLatestTelemetryInstance `json:"instances"`
	Time       DateTime                               `json:"time"`
}

LoadBalancerLatestTelemetryController defines model for LoadBalancerLatestTelemetryController.

type LoadBalancerLatestTelemetryInstance

type LoadBalancerLatestTelemetryInstance struct {
	// Cluster A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Cluster Identifier `json:"cluster"`

	// ContainerId A 24 character hex string used to identify a unique resource.
	ContainerId ID `json:"container_id"`

	// Controller A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Controller Identifier `json:"controller"`

	// EnvironmentId A 24 character hex string used to identify a unique resource.
	EnvironmentId ID `json:"environment_id"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// InstanceId A 24 character hex string used to identify a unique resource.
	InstanceId ID                             `json:"instance_id"`
	Latest     *LoadBalancerTelemetrySnapshot `json:"latest"`

	// ServerId A 24 character hex string used to identify a unique resource.
	ServerId  ID                               `json:"server_id"`
	Snapshots *[]LoadBalancerTelemetrySnapshot `json:"snapshots"`
	Time      DateTime                         `json:"time"`
}

LoadBalancerLatestTelemetryInstance Detailed telemetry for a load balancer instance at a point in time.

type LoadBalancerTelemetryControllerMetrics

type LoadBalancerTelemetryControllerMetrics struct {
	BytesReceived    int `json:"bytes_received"`
	BytesTransmitted int `json:"bytes_transmitted"`
	Connections      int `json:"connections"`
	Disconnects      struct {
		DestinationUnavailable int `json:"destination_unavailable"`
		NoError                int `json:"no_error"`
		RequestInvalid         int `json:"request_invalid"`
		RouterNomatch          int `json:"router_nomatch"`
		RouterNone             int `json:"router_none"`
		TimeoutIdle            int `json:"timeout_idle"`
		UnknownError           int `json:"unknown_error"`
	} `json:"disconnects"`
	Requests int `json:"requests"`
}

LoadBalancerTelemetryControllerMetrics defines model for LoadBalancerTelemetryControllerMetrics.

type LoadBalancerTelemetryReport

type LoadBalancerTelemetryReport struct {
	Created DateTime `json:"created"`

	// Range A start and end date-time pair indicating a range of time
	Range     Range `json:"range"`
	Snapshots *[]struct {
		// Controller A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
		// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
		// have the identifier of `my-container` and is automatically created by the platform.
		//
		// The identifier does not have to be unique.
		Controller Identifier                             `json:"controller"`
		Metrics    LoadBalancerTelemetryControllerMetrics `json:"metrics"`
		Time       DateTime                               `json:"time"`
	} `json:"snapshots"`
}

LoadBalancerTelemetryReport Aggregated load balancer telemetry across all instances for a given range.

type LoadBalancerTelemetryRouterMetrics

type LoadBalancerTelemetryRouterMetrics struct {
	Destinations map[string]struct {
		Connections *struct {
			BytesReceived    *int            `json:"bytes_received,omitempty"`
			BytesTransmitted *int            `json:"bytes_transmitted,omitempty"`
			Errors           *map[string]int `json:"errors,omitempty"`
			Success          int             `json:"success"`
			Unavailable      int             `json:"unavailable"`
		} `json:"connections"`
		ContainerId string `json:"container_id"`
		InstanceId  string `json:"instance_id"`
		LatencyMs   *[]int `json:"latency_ms,omitempty"`
		Requests    *struct {
			Errors    *map[string]int `json:"errors,omitempty"`
			Responses *map[string]int `json:"responses,omitempty"`
			Total     int             `json:"total"`
		} `json:"requests"`
	} `json:"destinations"`
}

LoadBalancerTelemetryRouterMetrics defines model for LoadBalancerTelemetryRouterMetrics.

type LoadBalancerTelemetrySnapshot

type LoadBalancerTelemetrySnapshot struct {
	Cumulative struct {
		Metrics LoadBalancerTelemetryControllerMetrics `json:"metrics"`
		Router  *LoadBalancerTelemetryRouterMetrics    `json:"router"`
		Urls    *LoadBalancerTelemetryUrlMetrics       `json:"urls"`
	} `json:"cumulative"`
	Current struct {
		Metrics LoadBalancerTelemetryControllerMetrics `json:"metrics"`
		Router  *LoadBalancerTelemetryRouterMetrics    `json:"router"`
		Urls    *LoadBalancerTelemetryUrlMetrics       `json:"urls"`
	} `json:"current"`
	DatasetId int      `json:"dataset_id"`
	Started   DateTime `json:"started"`
	Time      DateTime `json:"time"`
	Version   *string  `json:"version,omitempty"`
}

LoadBalancerTelemetrySnapshot defines model for LoadBalancerTelemetrySnapshot.

type LoadBalancerTelemetryUrlMetrics

type LoadBalancerTelemetryUrlMetrics struct {
	Destinations map[string]struct {
		Requests *struct {
			// Errors An object where the key is the error type and the value is the number of hits with that error.
			Errors *map[string]int `json:"errors,omitempty"`

			// Handlers An object describing the relative breakdown of proxy, cache, forward, and redirect URL responses.
			Handlers struct {
				Cache    LoadBalancerTelemetryUrlRequestHandler `json:"cache"`
				Forward  LoadBalancerTelemetryUrlRequestHandler `json:"forward"`
				Proxy    LoadBalancerTelemetryUrlRequestHandler `json:"proxy"`
				Redirect LoadBalancerTelemetryUrlRequestHandler `json:"redirect"`
			} `json:"handlers"`

			// Host The host name of the URL request.
			Host    string   `json:"host"`
			LastHit DateTime `json:"last_hit"`

			// Method The HTTP method of the URL request.
			Method string `json:"method"`

			// Path The path portion of the inbound URL request.
			Path string `json:"path"`

			// Responses An object where the key is the response type and the value is the number of hits with that response.
			Responses *map[string]int `json:"responses,omitempty"`

			// Total The number of requests to a this URL.
			Total int `json:"total"`
		} `json:"requests"`
	} `json:"destinations"`
}

LoadBalancerTelemetryUrlMetrics defines model for LoadBalancerTelemetryUrlMetrics.

type LoadBalancerTelemetryUrlRequestHandler

type LoadBalancerTelemetryUrlRequestHandler struct {
	// Hits The number of hits to a specific URL handler.
	Hits int `json:"hits"`

	// TimingMs The cumulative ms of response time across all hits.
	TimingMs int `json:"timing_ms"`
}

LoadBalancerTelemetryUrlRequestHandler defines model for LoadBalancerTelemetryUrlRequestHandler.

type LocationsIncludes

type LocationsIncludes map[string]ProviderLocation

LocationsIncludes A resource that is associated with a provider location.

type LogFormat added in v0.6.3

type LogFormat string

LogFormat defines model for LogFormat.

const (
	NdjsonHeaders LogFormat = "ndjson-headers"
	NdjsonRaw     LogFormat = "ndjson-raw"
)

Defines values for LogFormat.

type LogLine

type LogLine struct {
	// ContextWindow A randomly generated ID that is assigned to all lines in the same context window.
	// The first line with a specific ID is the log line that matches the query, and the following
	// log lines are included due to the the set context window in the aggregate.
	ContextWindow *string `json:"context_window,omitempty"`

	// InstanceId The container instance that the log line originated from.
	InstanceId *string `json:"instance_id"`

	// Message The message associated with the log line.
	Message string `json:"message"`

	// Source The source that generated the log line.
	Source string   `json:"source"`
	Time   DateTime `json:"time"`
}

LogLine A log line is point in time data output from a container instance.

type LookupComponentsJSONBody

type LookupComponentsJSONBody struct {
	Components []struct {
		Id   string       `json:"id"`
		Type ResourceType `json:"type"`
	} `json:"components"`
}

LookupComponentsJSONBody defines parameters for LookupComponents.

type LookupComponentsJSONRequestBody

type LookupComponentsJSONRequestBody LookupComponentsJSONBody

LookupComponentsJSONRequestBody defines body for LookupComponents for application/json ContentType.

type LookupComponentsResponse

type LookupComponentsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A resource that is associated with activity.
		Data ComponentsIncludes `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseLookupComponentsResponse

func ParseLookupComponentsResponse(rsp *http.Response) (*LookupComponentsResponse, error)

ParseLookupComponentsResponse parses an HTTP response from a LookupComponentsWithResponse call

func (LookupComponentsResponse) Status

func (r LookupComponentsResponse) Status() string

Status returns HTTPResponse.Status

func (LookupComponentsResponse) StatusCode

func (r LookupComponentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LookupIdentifierParams

type LookupIdentifierParams struct {
	// Identifier A base64 encoded resource identifier string.
	Identifier string `form:"identifier" json:"identifier"`

	// DesiredComponent The type of resource to lookup from the identifier string.
	DesiredComponent LookupIdentifierParamsDesiredComponent `form:"desired-component" json:"desired-component"`
}

LookupIdentifierParams defines parameters for LookupIdentifier.

type LookupIdentifierParamsDesiredComponent

type LookupIdentifierParamsDesiredComponent string

LookupIdentifierParamsDesiredComponent defines parameters for LookupIdentifier.

const (
	LookupIdentifierParamsDesiredComponentCluster     LookupIdentifierParamsDesiredComponent = "cluster"
	LookupIdentifierParamsDesiredComponentContainer   LookupIdentifierParamsDesiredComponent = "container"
	LookupIdentifierParamsDesiredComponentEnvironment LookupIdentifierParamsDesiredComponent = "environment"
	LookupIdentifierParamsDesiredComponentImageSource LookupIdentifierParamsDesiredComponent = "image-source"
	LookupIdentifierParamsDesiredComponentServer      LookupIdentifierParamsDesiredComponent = "server"
	LookupIdentifierParamsDesiredComponentStack       LookupIdentifierParamsDesiredComponent = "stack"
)

Defines values for LookupIdentifierParamsDesiredComponent.

type LookupIdentifierResponse

type LookupIdentifierResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			Id string `json:"id"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseLookupIdentifierResponse

func ParseLookupIdentifierResponse(rsp *http.Response) (*LookupIdentifierResponse, error)

ParseLookupIdentifierResponse parses an HTTP response from a LookupIdentifierWithResponse call

func (LookupIdentifierResponse) Status

func (r LookupIdentifierResponse) Status() string

Status returns HTTPResponse.Status

func (LookupIdentifierResponse) StatusCode

func (r LookupIdentifierResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LookupStackBuildResponse

type LookupStackBuildResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A stack build resource.
		Data StackBuild `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseLookupStackBuildResponse

func ParseLookupStackBuildResponse(rsp *http.Response) (*LookupStackBuildResponse, error)

ParseLookupStackBuildResponse parses an HTTP response from a LookupStackBuildWithResponse call

func (LookupStackBuildResponse) Status

func (r LookupStackBuildResponse) Status() string

Status returns HTTPResponse.Status

func (LookupStackBuildResponse) StatusCode

func (r LookupStackBuildResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LookupTLSCertificate200DataStateCurrent added in v0.6.5

type LookupTLSCertificate200DataStateCurrent string

type LookupTLSCertificateParams

type LookupTLSCertificateParams struct {
	// Domain The domain to lookup.
	Domain string `form:"domain" json:"domain"`

	// Private If true, will include the private key, bundle, and/or CSR for this certificate. Requires the `dns-certs-view` capability.
	Private *bool `form:"private,omitempty" json:"private,omitempty"`
}

LookupTLSCertificateParams defines parameters for LookupTLSCertificate.

type LookupTLSCertificateResponse

type LookupTLSCertificateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			Bundle *string `json:"bundle,omitempty"`
			Csr    *string `json:"csr,omitempty"`

			// Domains A list of domains associated with the certificate.
			Domains []string `json:"domains"`

			// Events A collection of timestamps for each event in the TLS certificate's lifetime.
			Events struct {
				Created   DateTime `json:"created"`
				Deleted   DateTime `json:"deleted"`
				Generated DateTime `json:"generated"`
				Updated   DateTime `json:"updated"`
			} `json:"events"`
			Expires DateTime `json:"expires"`
			HubId   *ID      `json:"hub_id"`

			// Id A 24 character hex string used to identify a unique resource.
			Id         ID      `json:"id"`
			PrivateKey *string `json:"private_key,omitempty"`
			State      struct {
				Changed DateTime `json:"changed"`

				// Current The current state of the TLS certificate.
				Current LookupTLSCertificate200DataStateCurrent `json:"current"`

				// Error An error, if any, that has occurred for this resource.
				Error *struct {
					// Message Details about the error that has occurred.
					Message *string   `json:"message,omitempty"`
					Time    *DateTime `json:"time,omitempty"`
				} `json:"error,omitempty"`
			} `json:"state"`

			// UserSupplied Whether or not this certificate was uploaded instead of generated by the platform.
			UserSupplied bool `json:"user_supplied"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseLookupTLSCertificateResponse

func ParseLookupTLSCertificateResponse(rsp *http.Response) (*LookupTLSCertificateResponse, error)

ParseLookupTLSCertificateResponse parses an HTTP response from a LookupTLSCertificateWithResponse call

func (LookupTLSCertificateResponse) Status

Status returns HTTPResponse.Status

func (LookupTLSCertificateResponse) StatusCode

func (r LookupTLSCertificateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Mandate

type Mandate struct {
	Accepted DateTime `json:"accepted"`

	// Email The email associated with the account that accepted the mandate
	Email string `json:"email"`

	// Ip The IP address at the time the mandate was accepted.
	Ip string `json:"ip"`

	// UserAgent The user agent of the browser when the mandate was accepted.
	UserAgent string `json:"user_agent"`
}

Mandate Information about the creator of a payment method for compliance purposes.

type MembershipIncludeParam

type MembershipIncludeParam = []string

MembershipIncludeParam defines model for MembershipIncludeParam.

type MembershipState

type MembershipState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the membership.
	Current MembershipStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

MembershipState defines model for MembershipState.

type MembershipStateCurrent

type MembershipStateCurrent string

MembershipStateCurrent The current state of the membership.

const (
	MembershipStateCurrentAccepted MembershipStateCurrent = "accepted"
	MembershipStateCurrentDeclined MembershipStateCurrent = "declined"
	MembershipStateCurrentDeleted  MembershipStateCurrent = "deleted"
	MembershipStateCurrentPending  MembershipStateCurrent = "pending"
	MembershipStateCurrentRevoked  MembershipStateCurrent = "revoked"
)

Defines values for MembershipStateCurrent.

type MemoryData

type MemoryData struct {
	// FailCount The number of times the memory liimit was exceeded for the instance.
	FailCount *float32 `json:"fail_count,omitempty"`

	// Limit The maximum number of bytes of memory this instance has acess to.
	Limit *float32 `json:"limit,omitempty"`

	// MaxUsage The highest amoun tof memory usage since the last restart.
	MaxUsage *float32 `json:"max_usage,omitempty"`

	// Usage The number in bytes of memory being used by the instance at the time of the snapshot.
	Usage *float32 `json:"usage,omitempty"`
}

MemoryData defines model for MemoryData.

type MemorySnapshot

type MemorySnapshot struct {
	// Cache The number of bytes of page cache memory being used by this instance.
	Cache          *float32    `json:"cache,omitempty"`
	KernelTcpUsage *MemoryData `json:"kernel_tcp_usage,omitempty"`
	KernelUsage    *MemoryData `json:"kernel_usage,omitempty"`
	SwapUsage      *MemoryData `json:"swap_usage,omitempty"`
	Usage          *MemoryData `json:"usage,omitempty"`
}

MemorySnapshot A snapshot of memory usage statistics.

type MemorySpec

type MemorySpec struct {
	// Extra Extra inforamtion about the memory resources.
	Extra map[string]string `json:"extra"`

	// SizeGb A number that represents the memory resources in GB.
	SizeGb int `json:"size_gb"`

	// Type The type of the memory resources.
	Type string `json:"type"`
}

MemorySpec Information about the memory resources of a given server.

type Method

type Method struct {
	// Address Address information for a given billing method.
	Address Address `json:"address"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the credit card's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Mandate Information about the creator of a payment method for compliance purposes.
	Mandate *Mandate `json:"mandate,omitempty"`

	// Name A name for the billing method.
	Name string `json:"name"`

	// Primary A boolean where true represents this billing method is set to primary for a given hub.
	Primary bool `json:"primary"`

	// Source The underlying source (credit card, bank account, etc) used by a payment method.
	Source MethodSource `json:"source"`
	State  struct {
		Changed DateTime `json:"changed"`

		// Current The current state of the method.
		Current MethodStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`
}

Method Information about a billing method, usable to pay invoices.

type MethodSource

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

MethodSource The underlying source (credit card, bank account, etc) used by a payment method.

func (MethodSource) AsDirectPayment added in v0.6.3

func (t MethodSource) AsDirectPayment() (DirectPayment, error)

AsDirectPayment returns the union data inside the MethodSource as a DirectPayment

func (MethodSource) AsStripeCreditCard

func (t MethodSource) AsStripeCreditCard() (StripeCreditCard, error)

AsStripeCreditCard returns the union data inside the MethodSource as a StripeCreditCard

func (MethodSource) AsStripeUsBankAcct

func (t MethodSource) AsStripeUsBankAcct() (StripeUsBankAcct, error)

AsStripeUsBankAcct returns the union data inside the MethodSource as a StripeUsBankAcct

func (MethodSource) Discriminator

func (t MethodSource) Discriminator() (string, error)

func (*MethodSource) FromDirectPayment added in v0.6.3

func (t *MethodSource) FromDirectPayment(v DirectPayment) error

FromDirectPayment overwrites any union data inside the MethodSource as the provided DirectPayment

func (*MethodSource) FromStripeCreditCard

func (t *MethodSource) FromStripeCreditCard(v StripeCreditCard) error

FromStripeCreditCard overwrites any union data inside the MethodSource as the provided StripeCreditCard

func (*MethodSource) FromStripeUsBankAcct

func (t *MethodSource) FromStripeUsBankAcct(v StripeUsBankAcct) error

FromStripeUsBankAcct overwrites any union data inside the MethodSource as the provided StripeUsBankAcct

func (MethodSource) MarshalJSON

func (t MethodSource) MarshalJSON() ([]byte, error)

func (*MethodSource) MergeDirectPayment added in v0.6.3

func (t *MethodSource) MergeDirectPayment(v DirectPayment) error

MergeDirectPayment performs a merge with any union data inside the MethodSource, using the provided DirectPayment

func (*MethodSource) MergeStripeCreditCard

func (t *MethodSource) MergeStripeCreditCard(v StripeCreditCard) error

MergeStripeCreditCard performs a merge with any union data inside the MethodSource, using the provided StripeCreditCard

func (*MethodSource) MergeStripeUsBankAcct

func (t *MethodSource) MergeStripeUsBankAcct(v StripeUsBankAcct) error

MergeStripeUsBankAcct performs a merge with any union data inside the MethodSource, using the provided StripeUsBankAcct

func (*MethodSource) UnmarshalJSON

func (t *MethodSource) UnmarshalJSON(b []byte) error

func (MethodSource) ValueByDiscriminator

func (t MethodSource) ValueByDiscriminator() (interface{}, error)

type MethodStateCurrent

type MethodStateCurrent string

MethodStateCurrent The current state of the method.

const (
	MethodStateCurrentDeleted             MethodStateCurrent = "deleted"
	MethodStateCurrentDeleting            MethodStateCurrent = "deleting"
	MethodStateCurrentLive                MethodStateCurrent = "live"
	MethodStateCurrentPendingVerification MethodStateCurrent = "pending-verification"
)

Defines values for MethodStateCurrent.

type Metric

type Metric struct {
	// Labels Additional key-values that can be used for querying in an aggregation pipeline. Often useful for filtering.
	Labels *map[string]string `json:"labels,omitempty"`

	// Metadata Information about this metric, such as the type of metric, the data it represents, and critical common information such as hub ID and associated cluster.
	Metadata struct {
		// Cluster The cluster associated with this metric
		Cluster *string `json:"cluster"`

		// Component The specific resource ID and type associated with this metric.
		Component *struct {
			// Id A 24 character hex string used to identify a unique resource.
			Id   ID     `json:"id"`
			Type string `json:"type"`
		} `json:"component"`

		// HubId A 24 character hex string used to identify a unique resource.
		HubId *ID `json:"hub_id,omitempty"`

		// Metric The data this metric represents. Cycle provides several built-in metrics, and, tier allowing, hubs can submit custom metrics as well.
		//
		// Here is a non-exhaustive list of some of the metrics provided by the platform automatically:
		//   - container.instances.num
		//   - discovery.resolutions.cache_hits
		//   - discovery.resolutions.lookups
		//   - discovery.resolutions.not-founds
		//   - environment.containers.num
		//   - environment.instances.num
		//   - environments.num
		//   - images.num
		//   - images.storage_kb
		//   - infrastructure.resources.cpu.cores
		//   - infrastructure.resources.cpu.usage.idle
		//   - infrastructure.resources.cpu.usage.iowait
		//   - infrastructure.resources.cpu.usage.nice
		//   - infrastructure.resources.cpu.usage.soft_irq
		//   - infrastructure.resources.cpu.usage.steal
		//   - infrastructure.resources.cpu.usage.system
		//   - infrastructure.resources.cpu.usage.user
		//   - infrastructure.resources.ram.available_kb
		//   - infrastructure.resources.ram.free_kb
		//   - infrastructure.resources.ram.total_kb
		//   - infrastructure.servers.num
		//   - lb.controller.connections
		//   - lb.controller.disconnects.destination_unavailable
		//   - lb.controller.disconnects.no_error
		//   - lb.controller.disconnects.timeout_idle
		//   - lb.controller.disconnects.timeout_init
		//   - lb.controller.disconnects.total
		//   - lb.controller.disconnects.unknown_error
		//   - lb.controller.received_kb
		//   - lb.controller.requests
		//   - lb.controller.requests.total
		//   - lb.controller.requests.url.handlers.forward.hits
		//   - lb.controller.requests.url.handlers.forward.timing_ms
		//   - lb.controller.requests.url.handlers.redirect.hits
		//   - lb.controller.requests.url.handlers.redirect.timing_ms
		//   - lb.controller.router.destinations.connections.invalid
		//   - lb.controller.router.destinations.connections.received_kb
		//   - lb.controller.router.destinations.connections.success
		//   - lb.controller.router.destinations.connections.transmitted_kb
		//   - lb.controller.router.destinations.connections.unavailable
		//   - lb.controller.router.destinations.latency
		//   - lb.controller.router.destinations.requests.total
		//   - lb.controller.transmitted_kb
		//   - memberships.num
		//   - pipeline.runs.num
		//   - stack.builds.num
		Metric string `json:"metric"`

		// Origin The originator of this metric.
		Origin string `json:"origin"`

		// Type The type of data represented by the metric.
		//   - **gauge**: represents a single numerical value that can arbitrarily go up and down.
		//   - **count**: represents a counter that resets periodically.
		//   - **counter**: represents a counter that only increases.
		//   - **rate**: represents the rate of change of a counter per second.
		//   - **histogram**: tracks the statistical distribution of a set of values.
		//   - **distribution**: aggregates data across multiple hosts and applications.
		//   - **set**: tracks the number of unique elements in a group.
		Type MetricMetadataType `json:"type"`
	} `json:"metadata"`

	// Points An array of recorded data points for this metric.
	Points [][]Metric_Points_Item `json:"points"`

	// Tags Additional tags associated with the metric.
	Tags *[]string `json:"tags,omitempty"`
	Time DateTime  `json:"time"`
}

Metric A granular point-in-time measurement of a value, and its associated metadata. Metrics may contain multiple data points collected between submission to the platform.

type MetricMetadataType

type MetricMetadataType string

MetricMetadataType The type of data represented by the metric.

  • **gauge**: represents a single numerical value that can arbitrarily go up and down.
  • **count**: represents a counter that resets periodically.
  • **counter**: represents a counter that only increases.
  • **rate**: represents the rate of change of a counter per second.
  • **histogram**: tracks the statistical distribution of a set of values.
  • **distribution**: aggregates data across multiple hosts and applications.
  • **set**: tracks the number of unique elements in a group.
const (
	MetricMetadataTypeCount        MetricMetadataType = "count"
	MetricMetadataTypeCounter      MetricMetadataType = "counter"
	MetricMetadataTypeDistribution MetricMetadataType = "distribution"
	MetricMetadataTypeGauge        MetricMetadataType = "gauge"
	MetricMetadataTypeHistogram    MetricMetadataType = "histogram"
	MetricMetadataTypeRate         MetricMetadataType = "rate"
	MetricMetadataTypeSet          MetricMetadataType = "set"
)

Defines values for MetricMetadataType.

type MetricPoints1

type MetricPoints1 = int

MetricPoints1 defines model for .

type Metric_Points_Item

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

Metric_Points_Item defines model for Metric.points.Item.

func (Metric_Points_Item) AsDateTime

func (t Metric_Points_Item) AsDateTime() (DateTime, error)

AsDateTime returns the union data inside the Metric_Points_Item as a DateTime

func (Metric_Points_Item) AsMetricPoints1

func (t Metric_Points_Item) AsMetricPoints1() (MetricPoints1, error)

AsMetricPoints1 returns the union data inside the Metric_Points_Item as a MetricPoints1

func (*Metric_Points_Item) FromDateTime

func (t *Metric_Points_Item) FromDateTime(v DateTime) error

FromDateTime overwrites any union data inside the Metric_Points_Item as the provided DateTime

func (*Metric_Points_Item) FromMetricPoints1

func (t *Metric_Points_Item) FromMetricPoints1(v MetricPoints1) error

FromMetricPoints1 overwrites any union data inside the Metric_Points_Item as the provided MetricPoints1

func (Metric_Points_Item) MarshalJSON

func (t Metric_Points_Item) MarshalJSON() ([]byte, error)

func (*Metric_Points_Item) MergeDateTime

func (t *Metric_Points_Item) MergeDateTime(v DateTime) error

MergeDateTime performs a merge with any union data inside the Metric_Points_Item, using the provided DateTime

func (*Metric_Points_Item) MergeMetricPoints1

func (t *Metric_Points_Item) MergeMetricPoints1(v MetricPoints1) error

MergeMetricPoints1 performs a merge with any union data inside the Metric_Points_Item, using the provided MetricPoints1

func (*Metric_Points_Item) UnmarshalJSON

func (t *Metric_Points_Item) UnmarshalJSON(b []byte) error

type MigrationInstance

type MigrationInstance struct {
	// InstanceId The ID of the instance.
	InstanceId string `json:"instance_id"`

	// ServerId The ID of the server.
	ServerId string `json:"server_id"`
}

MigrationInstance Information about a migrated instance.

type Monitor

type Monitor struct {
	// City The name of the city where this monitor is located.
	City string `json:"city"`

	// Country The full name of the country where this monitor is located.
	Country string `json:"country"`

	// CountryShort The country code of where this monitor is located.
	CountryShort string `json:"country_short"`

	// Latitude The latitude where this monitor is located.
	Latitude float32 `json:"latitude"`

	// Longitude The longitude where this monitor is located.
	Longitude float32 `json:"longitude"`

	// NodeId The ID of the node this monitor is running on.
	NodeId string `json:"node_id"`

	// Region The name of the region (state, province, prefecture, etc.) where this monitor is located.
	Region string `json:"region"`
}

Monitor A monitor used to determine latency between the public internet and a load balancer on Cycle. These monitors are automatically created and managed by the platform. Information about specific monitors is provided for determining the regional latencies for an environment.

type MonitoringTier added in v0.6.1

type MonitoringTier string

MonitoringTier The tier of monitoring, that determines the frequency that metrics are aggregated by the platform, on a per-environment basis.

const (
	MonitoringTierPlus     MonitoringTier = "plus"
	MonitoringTierPremium  MonitoringTier = "premium"
	MonitoringTierScale    MonitoringTier = "scale"
	MonitoringTierStandard MonitoringTier = "standard"
)

Defines values for MonitoringTier.

type MonitoringTierDetails

type MonitoringTierDetails struct {
	// Description A hamanized description of the monitoring tier.
	Description string `json:"description"`

	// Enabled Whether or not this tier is a selectable monitoring tier for an environment. A disabled tier may be either one coming in the future, or a legacy tier that is no longer available, but saved for historical reasons.
	Enabled bool `json:"enabled"`

	// Events Details on how events are handled for this tier.
	Events struct {
		// Custom Whether or not custom user-submitted events are supported on this tier.
		Custom bool `json:"custom"`

		// RetentionPeriod A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		RetentionPeriod Duration        `json:"retention_period"`
		Usage           MonitoringUsage `json:"usage"`
	} `json:"events"`
	Features struct {
		PublicPingMonitor bool `json:"public_ping_monitor"`
	} `json:"features"`
	Forwarding struct {
		Bandwidth MonitoringUsage `json:"bandwidth"`

		// Supported Indicates if metric forwarding is supported on this tier.
		Supported bool `json:"supported"`
	} `json:"forwarding"`

	// Logs Details on how logs are handled for this tier.
	Logs struct {
		// Analysis Details on log analysis features for this tier.
		Analysis struct {
			// RetentionPeriod A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
			RetentionPeriod Duration `json:"retention_period"`
			Rules           int      `json:"rules"`

			// Supported Indicates if log analysis is supported on this tier.
			Supported bool            `json:"supported"`
			Usage     MonitoringUsage `json:"usage"`
		} `json:"analysis"`

		// Collection Details on log collection features for this tier.
		Collection struct {
			Cold *MonitoringTierDetailsLogsCollectionTier `json:"cold,omitempty"`
			Hot  *MonitoringTierDetailsLogsCollectionTier `json:"hot,omitempty"`

			// Supported Indicates if log collection is supported on this tier.
			Supported bool `json:"supported"`
		} `json:"collection"`
	} `json:"logs"`

	// Metrics Details on how metrics are handled for this tier.
	Metrics struct {
		// ContainerTelemetryGranularity A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		ContainerTelemetryGranularity Duration `json:"container_telemetry_granularity"`

		// Custom Whether or not custom user-submitted metrics are supported on this tier.
		Custom bool `json:"custom"`

		// DownsamplePeriod A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		DownsamplePeriod Duration `json:"downsample_period"`

		// RetentionPeriod A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		RetentionPeriod Duration `json:"retention_period"`

		// ServiceGranularity A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		ServiceGranularity Duration        `json:"service_granularity"`
		Usage              MonitoringUsage `json:"usage"`
	} `json:"metrics"`

	// Price An object holding information about term and amount that relates to a specific billing component.
	Price BillingAmount `json:"price"`
}

MonitoringTierDetails Detailed information about a monitoring tier's features.

type MonitoringTierDetailsLogsCollectionTier added in v0.6.3

type MonitoringTierDetailsLogsCollectionTier struct {
	Bandwidth MonitoringUsage `json:"bandwidth"`

	// RetentionPeriod A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
	RetentionPeriod Duration        `json:"retention_period"`
	Storage         MonitoringUsage `json:"storage"`
}

MonitoringTierDetailsLogsCollectionTier defines model for MonitoringTierDetailsLogsCollectionTier.

type MonitoringUsage added in v0.6.3

type MonitoringUsage struct {
	// Additional An object describing the additonal cost of monitoring exceeding the included usage.
	Additional *struct {
		// Price An object holding information about term and amount that relates to a specific billing component.
		Price BillingAmount `json:"price"`
		Size  int           `json:"size"`
	} `json:"additional"`

	// HardCap A boolean indicating if there is hard usage limit on the tier.
	HardCap bool `json:"hard_cap"`

	// Included Number that, when used in conjunction with unit, describes the included usage.
	Included int `json:"included"`

	// Unit A string describing the metric unit.
	Unit string `json:"unit"`
}

MonitoringUsage defines model for MonitoringUsage.

type Network

type Network struct {
	Acl *ACL `json:"acl"`

	// Cluster The infrastructure cluster the environments belonging to this network belong to.
	Cluster string `json:"cluster"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Environments An array of environments and timestamps.
	Environments *[]struct {
		Added DateTime `json:"added"`

		// Id A 24 character hex string used to identify a unique resource.
		Id ID `json:"id"`
	} `json:"environments"`

	// Events A collection of timestamps for each event in the network's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A network identifier used to construct http calls that specifically use this network over another.
	Identifier string     `json:"identifier"`
	L2         *NetworkL2 `json:"l2"`

	// Name The name of the network.
	Name           string                  `json:"name"`
	PrivateNetwork *NetworkPrivacySettings `json:"private_network"`
	State          NetworkState            `json:"state"`
}

Network SDN Network resource.

type NetworkIncludes

type NetworkIncludes struct {
	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`

	// Environments An identity that is associated with an environment.
	Environments *EnvironmentIncludes `json:"environments,omitempty"`
}

NetworkIncludes All includable resource linkable to the given network.

type NetworkL2 added in v0.6.3

type NetworkL2 struct {
	Domain        *L2Domain     `json:"domain"`
	HostInterface *string       `json:"host_interface"`
	Ips           NetworkL2_Ips `json:"ips"`
	LocationIds   []ID          `json:"location_ids"`

	// Routes An array of L2 routes that are added to this SDN
	Routes *[]struct {
		// Gateway An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.
		Gateway *IpAddress `json:"gateway,omitempty"`

		// Network A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix.
		// It combines an IP address with a suffix that indicates how many bits are fixed for routing.
		Network Cidr `json:"network"`
	} `json:"routes,omitempty"`
	Vid *int `json:"vid"`
}

NetworkL2 Layer 2 network information for a Cycle SDN.

type NetworkL2DhcpDetails added in v0.6.3

type NetworkL2DhcpDetails struct {
	Details *map[string]interface{}    `json:"details,omitempty"`
	Method  NetworkL2DhcpDetailsMethod `json:"method"`
}

NetworkL2DhcpDetails defines model for NetworkL2DhcpDetails.

type NetworkL2DhcpDetailsMethod added in v0.6.3

type NetworkL2DhcpDetailsMethod string

NetworkL2DhcpDetailsMethod defines model for NetworkL2DhcpDetails.Method.

const (
	Dhcp NetworkL2DhcpDetailsMethod = "dhcp"
)

Defines values for NetworkL2DhcpDetailsMethod.

type NetworkL2StaticDetails added in v0.6.3

type NetworkL2StaticDetails struct {
	Details struct {
		Ipv4 *struct {
			// Gateway The IP of the gateway
			Gateway *string `json:"gateway"`

			// Network The CIDR for the network.
			Network string `json:"network"`

			// Usable The usable CIDR.
			Usable string `json:"usable"`
		} `json:"ipv4"`
		Ipv6 *struct {
			// Gateway The IP of the gateway
			Gateway *string `json:"gateway"`

			// Network The CIDR for the network.
			Network string `json:"network"`

			// Usable The usable CIDR.
			Usable string `json:"usable"`
		} `json:"ipv6"`
	} `json:"details"`
	Method NetworkL2StaticDetailsMethod `json:"method"`
}

NetworkL2StaticDetails defines model for NetworkL2StaticDetails.

type NetworkL2StaticDetailsMethod added in v0.6.3

type NetworkL2StaticDetailsMethod string

NetworkL2StaticDetailsMethod defines model for NetworkL2StaticDetails.Method.

const (
	NetworkL2StaticDetailsMethodStatic NetworkL2StaticDetailsMethod = "static"
)

Defines values for NetworkL2StaticDetailsMethod.

type NetworkL2_Ips added in v0.6.3

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

NetworkL2_Ips defines model for NetworkL2.Ips.

func (NetworkL2_Ips) AsNetworkL2DhcpDetails added in v0.6.3

func (t NetworkL2_Ips) AsNetworkL2DhcpDetails() (NetworkL2DhcpDetails, error)

AsNetworkL2DhcpDetails returns the union data inside the NetworkL2_Ips as a NetworkL2DhcpDetails

func (NetworkL2_Ips) AsNetworkL2StaticDetails added in v0.6.3

func (t NetworkL2_Ips) AsNetworkL2StaticDetails() (NetworkL2StaticDetails, error)

AsNetworkL2StaticDetails returns the union data inside the NetworkL2_Ips as a NetworkL2StaticDetails

func (NetworkL2_Ips) Discriminator added in v0.6.3

func (t NetworkL2_Ips) Discriminator() (string, error)

func (*NetworkL2_Ips) FromNetworkL2DhcpDetails added in v0.6.3

func (t *NetworkL2_Ips) FromNetworkL2DhcpDetails(v NetworkL2DhcpDetails) error

FromNetworkL2DhcpDetails overwrites any union data inside the NetworkL2_Ips as the provided NetworkL2DhcpDetails

func (*NetworkL2_Ips) FromNetworkL2StaticDetails added in v0.6.3

func (t *NetworkL2_Ips) FromNetworkL2StaticDetails(v NetworkL2StaticDetails) error

FromNetworkL2StaticDetails overwrites any union data inside the NetworkL2_Ips as the provided NetworkL2StaticDetails

func (NetworkL2_Ips) MarshalJSON added in v0.6.3

func (t NetworkL2_Ips) MarshalJSON() ([]byte, error)

func (*NetworkL2_Ips) MergeNetworkL2DhcpDetails added in v0.6.3

func (t *NetworkL2_Ips) MergeNetworkL2DhcpDetails(v NetworkL2DhcpDetails) error

MergeNetworkL2DhcpDetails performs a merge with any union data inside the NetworkL2_Ips, using the provided NetworkL2DhcpDetails

func (*NetworkL2_Ips) MergeNetworkL2StaticDetails added in v0.6.3

func (t *NetworkL2_Ips) MergeNetworkL2StaticDetails(v NetworkL2StaticDetails) error

MergeNetworkL2StaticDetails performs a merge with any union data inside the NetworkL2_Ips, using the provided NetworkL2StaticDetails

func (*NetworkL2_Ips) UnmarshalJSON added in v0.6.3

func (t *NetworkL2_Ips) UnmarshalJSON(b []byte) error

func (NetworkL2_Ips) ValueByDiscriminator added in v0.6.3

func (t NetworkL2_Ips) ValueByDiscriminator() (interface{}, error)

type NetworkPrivacySettings

type NetworkPrivacySettings struct {
	// Ipv6 IPv6 infromation for the network.
	Ipv6 struct {
		// Cidr The private network CIDR.
		Cidr string `json:"cidr"`

		// Ip The networks IPv6 base.
		Ip string `json:"ip"`
	} `json:"ipv6"`

	// MacAddrSuffix A number used to ensure a MAC address exists for each network.
	MacAddrSuffix int `json:"mac_addr_suffix"`

	// Subnet The subnet of the private network.
	Subnet string `json:"subnet"`

	// VxlanTag A tag used to ensure proper routing.
	VxlanTag int `json:"vxlan_tag"`
}

NetworkPrivacySettings Private network information for a Cycle SDN.

type NetworkSnapshot

type NetworkSnapshot struct {
	// Interfaces An array of network interfaces attached to this instance.
	Interfaces []struct {
		Name    string `json:"name"`
		RxBytes int    `json:"rx_bytes"`
		TxBytes int    `json:"tx_bytes"`
	} `json:"interfaces"`
}

NetworkSnapshot A snapshot of network usage statistics.

type NetworkSpec

type NetworkSpec struct {
	// Count The number of network resources for a given server.
	Count int `json:"count"`

	// Scope The scope of the interfaces.
	Scope NetworkSpecScope `json:"scope"`

	// Throughput The network throughput in MB(per second).
	Throughput int `json:"throughput"`

	// Type The type of the NIC.
	Type string `json:"type"`
}

NetworkSpec Information about the network resources for a given server.

type NetworkSpecScope

type NetworkSpecScope string

NetworkSpecScope The scope of the interfaces.

const (
	NetworkSpecScopePrivate NetworkSpecScope = "private"
	NetworkSpecScopePublic  NetworkSpecScope = "public"
	NetworkSpecScopeShared  NetworkSpecScope = "shared"
)

Defines values for NetworkSpecScope.

type NetworkState

type NetworkState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the network.
	Current NetworkStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

NetworkState defines model for NetworkState.

type NetworkStateCurrent

type NetworkStateCurrent string

NetworkStateCurrent The current state of the network.

const (
	NetworkStateCurrentDeleted  NetworkStateCurrent = "deleted"
	NetworkStateCurrentDeleting NetworkStateCurrent = "deleting"
	NetworkStateCurrentLive     NetworkStateCurrent = "live"
)

Defines values for NetworkStateCurrent.

type NodeMetaStats

type NodeMetaStats struct {
	// Cpu Statistics about the CPU resources on a server.
	Cpu ServerStatsCpu `json:"cpu"`

	// Load Statistics about the current load on the server.
	Load ServerStatsLoad `json:"load"`

	// Network Statistics about the networks on a given server.
	Network ServerStatsNetwork `json:"network"`

	// Os Statistics about the operating system installed on the server (CycleOS).
	Os ServerStatsOS `json:"os"`

	// Ram Statistics about the RAM on a given server.
	Ram ServerStatsRam `json:"ram"`

	// Storage Statistics about storage for a given server.
	Storage ServerStatsStorage `json:"storage"`

	// Uptime Statistics describing the uptime of a given server.
	Uptime ServerStatsUptime `json:"uptime"`

	// Vendor Details about the vendors for the server.
	Vendor ServerStatsVendor `json:"vendor"`

	// Versions Information about the versions of Cycle services on a given server.
	Versions ServerStatsVersions `json:"versions"`
}

NodeMetaStats Statistics that pertain to a specific node.

type NodeState

type NodeState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the node.
	Current NodeStateCurrent  `json:"current"`
	Desired *NodeStateDesired `json:"desired"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

NodeState defines model for NodeState.

type NodeStateCurrent

type NodeStateCurrent string

NodeStateCurrent The current state of the node.

const (
	NodeStateCurrentAuthorizing    NodeStateCurrent = "authorizing"
	NodeStateCurrentDecommissioned NodeStateCurrent = "decommissioned"
	NodeStateCurrentDeleted        NodeStateCurrent = "deleted"
	NodeStateCurrentNew            NodeStateCurrent = "new"
	NodeStateCurrentOffline        NodeStateCurrent = "offline"
	NodeStateCurrentOnline         NodeStateCurrent = "online"
)

Defines values for NodeStateCurrent.

type NodeStateDesired added in v0.6.3

type NodeStateDesired string

NodeStateDesired defines model for NodeState.Desired.

const (
	NodeStateDesiredAuthorizing    NodeStateDesired = "authorizing"
	NodeStateDesiredDecommissioned NodeStateDesired = "decommissioned"
	NodeStateDesiredDeleted        NodeStateDesired = "deleted"
	NodeStateDesiredNew            NodeStateDesired = "new"
	NodeStateDesiredOffline        NodeStateDesired = "offline"
	NodeStateDesiredOnline         NodeStateDesired = "online"
)

Defines values for NodeStateDesired.

type NoneOrigin

type NoneOrigin struct {
	Type NoneOriginType `json:"type"`
}

NoneOrigin An empty origin. No details are provided for this image.

type NoneOriginType

type NoneOriginType string

NoneOriginType defines model for NoneOrigin.Type.

const (
	NoneOriginTypeNone NoneOriginType = "none"
)

Defines values for NoneOriginType.

type OciRegistryOrigin

type OciRegistryOrigin struct {
	Details struct {
		// Auth Authentication details for a third party image registry/source.
		Auth *RegistryAuth `json:"auth,omitempty"`

		// Existing In a stack, specifies an image source ID from which Cycle will derive any values not specified in the stack file. This is useful for avoiding direct placement of credentials in a stack file, for example.
		Existing *ExistingSource `json:"existing,omitempty"`

		// Target The image name on the registry.
		Target string `json:"target"`

		// Url The url of the remote registry.
		Url string `json:"url"`
	} `json:"details"`
	Type OciRegistryOriginType `json:"type"`
}

OciRegistryOrigin An image origin that pulls images fro an OCI-compatible registry. Also used for provider-native registries, such as AWS ECR.

type OciRegistryOriginType

type OciRegistryOriginType string

OciRegistryOriginType defines model for OciRegistryOrigin.Type.

const (
	OciRegistry OciRegistryOriginType = "oci-registry"
)

Defines values for OciRegistryOriginType.

type Order

type Order struct {
	Approved bool `json:"approved"`

	// Creator A type of creator and a matching identifier.
	Creator UserScope `json:"creator"`

	// Events A collection of timestamps for each event in the orders lifetime.
	Events struct {
		Expires DateTime `json:"expires"`
	} `json:"events"`
	HubId       string      `json:"hub_id"`
	Items       []OrderItem `json:"items"`
	PromoCodeId *string     `json:"promo_code_id"`
	State       OrderState  `json:"state"`

	// Term Information about a billing term.
	Term       Term    `json:"term"`
	TotalPrice float32 `json:"total_price"`
}

Order An order is a resource that describes a billing order

type OrderIncludeParam

type OrderIncludeParam = []string

OrderIncludeParam defines model for OrderIncludeParam.

type OrderItem

type OrderItem struct {
	Description string `json:"description"`
	Discount    *struct {
		// Amount An object holding information about term and amount that relates to a specific billing component.
		Amount  BillingAmount `json:"amount"`
		Expires DateTime      `json:"expires"`
		Id      string        `json:"id"`
	} `json:"discount,omitempty"`
	Id       string  `json:"id"`
	NetPrice float32 `json:"net_price"`

	// Price An object holding information about term and amount that relates to a specific billing component.
	Price BillingAmount `json:"price"`

	// Service Information for an item's plan.
	Service ServiceItem `json:"service"`
}

OrderItem Describes a billing item

type OrderState

type OrderState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the zone.
	Current OrderStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

OrderState defines model for OrderState.

type OrderStateCurrent

type OrderStateCurrent string

OrderStateCurrent The current state of the zone.

const (
	OrderStateCurrentDeleted   OrderStateCurrent = "deleted"
	OrderStateCurrentDeleting  OrderStateCurrent = "deleting"
	OrderStateCurrentNew       OrderStateCurrent = "new"
	OrderStateCurrentProcessed OrderStateCurrent = "processed"
)

Defines values for OrderStateCurrent.

type Overage

type Overage struct {
	// DnsLinkedRecords Overage related to DNS linked records usage.
	DnsLinkedRecords *struct {
		// Cost The total cost of the DNS linked record overage in mills.
		Cost int `json:"cost"`

		// Hours The number of DNS linked record hours exceeding the included amount.
		Hours int `json:"hours"`
	} `json:"dns_linked_records,omitempty"`

	// DnsZones Overage related to DNS zone usage.
	DnsZones *struct {
		// Cost The total cost of the DNS zone overage in mills.
		Cost int `json:"cost"`

		// Hours The number of DNS zone hours exceeding the included amount.
		Hours int `json:"hours"`
	} `json:"dns_zones,omitempty"`

	// ImageStorage Overage related to container or image storage usage.
	ImageStorage *struct {
		// Cost The total cost of the image storage overage in mills.
		Cost int `json:"cost"`

		// Gbs The number of gigabytes of image storage overage.
		Gbs int `json:"gbs"`
	} `json:"image_storage,omitempty"`

	// Members Overage related to member usage.
	Members *struct {
		// Cost The total cost of the member overage in mills.
		Cost int `json:"cost"`

		// Hours The number of member hours exceeding the included amount.
		Hours int `json:"hours"`
	} `json:"members,omitempty"`

	// Ram (GEN 1) Overage related to RAM usage.
	Ram *struct {
		// Cost The total cost of the RAM overage in mills.
		Cost int `json:"cost"`

		// GbHours The number of RAM GB-hours exceeding the included amount.
		GbHours int `json:"gb_hours"`
	} `json:"ram,omitempty"`

	// Servers Overage related to server runtime.
	Servers *struct {
		// Cost The total cost of the server overage in mills.
		Cost int `json:"cost"`

		// Hours The number of server hours exceeding the included amount.
		Hours int `json:"hours"`
	} `json:"servers,omitempty"`

	// Term Information about a billing term.
	Term Term `json:"term"`
}

Overage Detailed information about resource overages incurred beyond included billing tier limits.

type PageParam

type PageParam struct {
	// Number The page to jump to
	Number *float32 `json:"number,omitempty"`

	// Size The number of resources returned per page.
	Size *float32 `json:"size,omitempty"`
}

PageParam defines model for PageParam.

type Payment

type Payment struct {
	// Amount 1/10th of a cent.
	Amount int `json:"amount"`

	// AmountRefunded 1/10th of a cent.
	AmountRefunded int `json:"amount_refunded"`

	// Description Some information about the payment.
	Description string `json:"description"`

	// Gateway The type of payment gateway used.
	Gateway PaymentGateway `json:"gateway"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// MethodId The ID associated with the billing method used.
	MethodId *string  `json:"method_id,omitempty"`
	Refunds  []Refund `json:"refunds"`

	// Result A billing payment result.
	Result PaymentResult `json:"result"`
	Time   DateTime      `json:"time"`
}

Payment A billing payment.

type PaymentGateway

type PaymentGateway string

PaymentGateway The type of payment gateway used.

const (
	Stripe PaymentGateway = "stripe"
)

Defines values for PaymentGateway.

type PaymentResult

type PaymentResult struct {
	// Error A description of the error that took place when processing the payment.
	Error string `json:"error"`

	// Status The status of a payment.
	Status PaymentResultStatus `json:"status"`
}

PaymentResult A billing payment result.

type PaymentResultStatus

type PaymentResultStatus string

PaymentResultStatus The status of a payment.

const (
	PaymentResultStatusAwaitingDirectPayment PaymentResultStatus = "awaiting-direct-payment"
	PaymentResultStatusCancelled             PaymentResultStatus = "cancelled"
	PaymentResultStatusError                 PaymentResultStatus = "error"
	PaymentResultStatusProcessing            PaymentResultStatus = "processing"
	PaymentResultStatusSuccess               PaymentResultStatus = "success"
)

Defines values for PaymentResultStatus.

type Permissions

type Permissions struct {
	// AllEnvironments A boolean, where true represents this API key is authorized to make requests that involve all of a hubs environments
	AllEnvironments bool `json:"all_environments"`

	// Environments An environment ID and a boolean representing management configuration for an API key
	Environments []struct {
		// Id A 24 character hex string used to identify a unique resource.
		Id ID `json:"id"`

		// Manage A boolean, where true represents the API keys ability to make changes to the environment components
		Manage bool `json:"manage"`
	} `json:"environments"`
}

Permissions Permissions information for an API Key

type Pipeline

type Pipeline struct {
	Acl *ACL `json:"acl"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Disable A boolean where true signifies the pipeline is disabled.
	Disable bool `json:"disable"`

	// Dynamic Setting to true enables variable and other advanced logic support on this pipeline. This is a one-way toggle. Once set to true, it cannot be set back to false.
	Dynamic bool `json:"dynamic"`

	// Events A collection of timestamps for each event in the pipeline's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		LastRun DateTime `json:"last_run"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Name A name for the pipeline.
	Name string `json:"name"`

	// Stages An array of stages.
	Stages *[]PipelineStage `json:"stages,omitempty"`
	State  PipelineState    `json:"state"`
}

Pipeline A pipeline resource.

type PipelineIncludes

type PipelineIncludes struct {
	// Components A record of resources that can be associated with the pipeline.
	Components *map[string]map[string]interface{} `json:"components,omitempty"`

	// ComponentsIdentifiers A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.
	ComponentsIdentifiers *IdentifierIncludes `json:"components:identifiers,omitempty"`

	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`

	// Name A name value.
	Name *string `json:"name,omitempty"`
}

PipelineIncludes All includable resources linkable to the given pipeline.

type PipelineRerunAction added in v0.6.1

type PipelineRerunAction struct {
	// Action The requested action to perform.
	Action   PipelineRerunActionAction `json:"action"`
	Contents *struct {
		// RunId A 24 character hex string used to identify a unique resource.
		RunId *ID `json:"run_id,omitempty"`
	} `json:"contents,omitempty"`
}

PipelineRerunAction defines model for PipelineRerunAction.

type PipelineRerunActionAction added in v0.6.1

type PipelineRerunActionAction string

PipelineRerunActionAction The requested action to perform.

const (
	Rerun PipelineRerunActionAction = "rerun"
)

Defines values for PipelineRerunActionAction.

type PipelineRun

type PipelineRun struct {
	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the pipeline run's lifetime.
	Events PipelineRunEvents `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// PipelineId The ID for the pipeline this run belongs to.
	PipelineId string `json:"pipeline_id"`

	// SkipLocks Describes if a skip lock was defined during pipeline trigger.
	SkipLocks *bool `json:"skip_locks,omitempty"`

	// Stages An array of pipeline stages.
	Stages []struct {
		// Events A collection of timestamps for each event in the pipeline run's lifetime.
		Events struct {
			Finished DateTime `json:"finished"`
			Started  DateTime `json:"started"`
		} `json:"events"`

		// Identifier A stage identifier.
		Identifier string            `json:"identifier"`
		Steps      []PipelineRunStep `json:"steps"`
	} `json:"stages"`
	State RunState `json:"state"`

	// SubQueue Describes the sub queue defined during pipeline trigger, if present.
	SubQueue *string `json:"sub_queue"`

	// Variables A map of variable values used during pipeline run.
	Variables *map[string]string `json:"variables,omitempty"`
}

PipelineRun A pipeline run resource.

type PipelineRunEvents

type PipelineRunEvents struct {
	Finished DateTime `json:"finished"`
	Queued   DateTime `json:"queued"`
	Started  DateTime `json:"started"`
}

PipelineRunEvents A collection of timestamps for each event in the pipeline run's lifetime.

type PipelineRunIncludes added in v0.6.6

type PipelineRunIncludes struct {
	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`

	// Keys A map of trigger keys, keyed by ID, included on endpoints that support it when passing the matching includes query parameter.
	Keys *IncludedTriggerKeys `json:"keys,omitempty"`

	// Pipelines A map of pipelines, keyed by ID, included on endpoints that support it when passing the matching includes query parameter.
	Pipelines *IncludedPipelines `json:"pipelines,omitempty"`
}

PipelineRunIncludes Resources related to a pipeline run, that can be included on supported endpoints when the matching includes query parameter is passed.

type PipelineRunStep

type PipelineRunStep struct {
	Action     PipelineRunStepAction `json:"action"`
	Components *[]struct {
		Id   string       `json:"id"`
		Type ResourceType `json:"type"`
	} `json:"components"`

	// Error An error, if any, that has occurred for this step.
	Error *struct {
		// Message Details about the error that has occurred.
		Message string `json:"message"`
	} `json:"error"`

	// Events A collection of timestamps for each event in the pipeline run's lifetime.
	Events struct {
		Finished DateTime `json:"finished"`
		Started  DateTime `json:"started"`
	} `json:"events"`
	Identifier string `json:"identifier"`
	Success    bool   `json:"success"`
}

PipelineRunStep defines model for PipelineRunStep.

type PipelineRunStepAction

type PipelineRunStepAction string

PipelineRunStepAction defines model for PipelineRunStep.Action.

const (
	PipelineRunStepActionContainerCreate                   PipelineRunStepAction = "container.create"
	PipelineRunStepActionContainerDelete                   PipelineRunStepAction = "container.delete"
	PipelineRunStepActionContainerDeprecate                PipelineRunStepAction = "container.deprecate"
	PipelineRunStepActionContainerFunctionTrigger          PipelineRunStepAction = "container.function.trigger"
	PipelineRunStepActionContainerReimage                  PipelineRunStepAction = "container.reimage"
	PipelineRunStepActionContainerRestart                  PipelineRunStepAction = "container.restart"
	PipelineRunStepActionContainerStart                    PipelineRunStepAction = "container.start"
	PipelineRunStepActionContainerStop                     PipelineRunStepAction = "container.stop"
	PipelineRunStepActionEnvironmentCreate                 PipelineRunStepAction = "environment.create"
	PipelineRunStepActionEnvironmentDelete                 PipelineRunStepAction = "environment.delete"
	PipelineRunStepActionEnvironmentDeploymentHealthyWatch PipelineRunStepAction = "environment.deployment.healthy.watch"
	PipelineRunStepActionEnvironmentDeploymentStart        PipelineRunStepAction = "environment.deployment.start"
	PipelineRunStepActionEnvironmentDeploymentStop         PipelineRunStepAction = "environment.deployment.stop"
	PipelineRunStepActionEnvironmentDeploymentsPrune       PipelineRunStepAction = "environment.deployments.prune"
	PipelineRunStepActionEnvironmentDeploymentsTag         PipelineRunStepAction = "environment.deployments.tag"
	PipelineRunStepActionEnvironmentStart                  PipelineRunStepAction = "environment.start"
	PipelineRunStepActionEnvironmentStop                   PipelineRunStepAction = "environment.stop"
	PipelineRunStepActionImageCreate                       PipelineRunStepAction = "image.create"
	PipelineRunStepActionImageCreateImport                 PipelineRunStepAction = "image.create-import"
	PipelineRunStepActionImageImport                       PipelineRunStepAction = "image.import"
	PipelineRunStepActionImagesPrune                       PipelineRunStepAction = "images.prune"
	PipelineRunStepActionSleep                             PipelineRunStepAction = "sleep"
	PipelineRunStepActionStackBuildCreate                  PipelineRunStepAction = "stack.build.create"
	PipelineRunStepActionStackBuildDeploy                  PipelineRunStepAction = "stack.build.deploy"
	PipelineRunStepActionStackBuildGenerate                PipelineRunStepAction = "stack.build.generate"
	PipelineRunStepActionStackPrune                        PipelineRunStepAction = "stack.prune"
	PipelineRunStepActionWebhookGet                        PipelineRunStepAction = "webhook.get"
	PipelineRunStepActionWebhookPost                       PipelineRunStepAction = "webhook.post"
)

Defines values for PipelineRunStepAction.

type PipelineStage

type PipelineStage struct {
	// Identifier A stage identifier.
	Identifier string `json:"identifier"`

	// Options Additonal options for the stage.
	Options *struct {
		// Skip A boolean where true indicates the given stage should be skipped when the pipeline is run.
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`

	// Steps An array of steps for the stage.
	Steps []PipelineSteps `json:"steps"`
}

PipelineStage A stage for a given pipeline.

type PipelineState

type PipelineState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the pipeline.
	Current PipelineStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

PipelineState defines model for PipelineState.

type PipelineStateCurrent

type PipelineStateCurrent string

PipelineStateCurrent The current state of the pipeline.

const (
	PipelineStateCurrentAcquiring PipelineStateCurrent = "acquiring"
	PipelineStateCurrentDeleted   PipelineStateCurrent = "deleted"
	PipelineStateCurrentDeleting  PipelineStateCurrent = "deleting"
	PipelineStateCurrentLive      PipelineStateCurrent = "live"
)

Defines values for PipelineStateCurrent.

type PipelineSteps

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

PipelineSteps A step for a pipeline stage.

func (PipelineSteps) AsContainerCreateStep

func (t PipelineSteps) AsContainerCreateStep() (ContainerCreateStep, error)

AsContainerCreateStep returns the union data inside the PipelineSteps as a ContainerCreateStep

func (PipelineSteps) AsContainerDeleteStep

func (t PipelineSteps) AsContainerDeleteStep() (ContainerDeleteStep, error)

AsContainerDeleteStep returns the union data inside the PipelineSteps as a ContainerDeleteStep

func (PipelineSteps) AsContainerFunctionTriggerStep

func (t PipelineSteps) AsContainerFunctionTriggerStep() (ContainerFunctionTriggerStep, error)

AsContainerFunctionTriggerStep returns the union data inside the PipelineSteps as a ContainerFunctionTriggerStep

func (PipelineSteps) AsContainerReimageStep

func (t PipelineSteps) AsContainerReimageStep() (ContainerReimageStep, error)

AsContainerReimageStep returns the union data inside the PipelineSteps as a ContainerReimageStep

func (PipelineSteps) AsContainerRestartStep

func (t PipelineSteps) AsContainerRestartStep() (ContainerRestartStep, error)

AsContainerRestartStep returns the union data inside the PipelineSteps as a ContainerRestartStep

func (PipelineSteps) AsContainerStartStep

func (t PipelineSteps) AsContainerStartStep() (ContainerStartStep, error)

AsContainerStartStep returns the union data inside the PipelineSteps as a ContainerStartStep

func (PipelineSteps) AsContainerStopStep

func (t PipelineSteps) AsContainerStopStep() (ContainerStopStep, error)

AsContainerStopStep returns the union data inside the PipelineSteps as a ContainerStopStep

func (PipelineSteps) AsEnvironmentCreateStep

func (t PipelineSteps) AsEnvironmentCreateStep() (EnvironmentCreateStep, error)

AsEnvironmentCreateStep returns the union data inside the PipelineSteps as a EnvironmentCreateStep

func (PipelineSteps) AsEnvironmentDeleteStep

func (t PipelineSteps) AsEnvironmentDeleteStep() (EnvironmentDeleteStep, error)

AsEnvironmentDeleteStep returns the union data inside the PipelineSteps as a EnvironmentDeleteStep

func (PipelineSteps) AsEnvironmentDeploymentHealthyWatchStep

func (t PipelineSteps) AsEnvironmentDeploymentHealthyWatchStep() (EnvironmentDeploymentHealthyWatchStep, error)

AsEnvironmentDeploymentHealthyWatchStep returns the union data inside the PipelineSteps as a EnvironmentDeploymentHealthyWatchStep

func (PipelineSteps) AsEnvironmentDeploymentStartStep

func (t PipelineSteps) AsEnvironmentDeploymentStartStep() (EnvironmentDeploymentStartStep, error)

AsEnvironmentDeploymentStartStep returns the union data inside the PipelineSteps as a EnvironmentDeploymentStartStep

func (PipelineSteps) AsEnvironmentDeploymentStopStep

func (t PipelineSteps) AsEnvironmentDeploymentStopStep() (EnvironmentDeploymentStopStep, error)

AsEnvironmentDeploymentStopStep returns the union data inside the PipelineSteps as a EnvironmentDeploymentStopStep

func (PipelineSteps) AsEnvironmentDeploymentsPruneStep

func (t PipelineSteps) AsEnvironmentDeploymentsPruneStep() (EnvironmentDeploymentsPruneStep, error)

AsEnvironmentDeploymentsPruneStep returns the union data inside the PipelineSteps as a EnvironmentDeploymentsPruneStep

func (PipelineSteps) AsEnvironmentDeploymentsTagStep

func (t PipelineSteps) AsEnvironmentDeploymentsTagStep() (EnvironmentDeploymentsTagStep, error)

AsEnvironmentDeploymentsTagStep returns the union data inside the PipelineSteps as a EnvironmentDeploymentsTagStep

func (PipelineSteps) AsEnvironmentStartStep

func (t PipelineSteps) AsEnvironmentStartStep() (EnvironmentStartStep, error)

AsEnvironmentStartStep returns the union data inside the PipelineSteps as a EnvironmentStartStep

func (PipelineSteps) AsEnvironmentStopStep

func (t PipelineSteps) AsEnvironmentStopStep() (EnvironmentStopStep, error)

AsEnvironmentStopStep returns the union data inside the PipelineSteps as a EnvironmentStopStep

func (PipelineSteps) AsImageCreateImportStep

func (t PipelineSteps) AsImageCreateImportStep() (ImageCreateImportStep, error)

AsImageCreateImportStep returns the union data inside the PipelineSteps as a ImageCreateImportStep

func (PipelineSteps) AsImageCreateStep

func (t PipelineSteps) AsImageCreateStep() (ImageCreateStep, error)

AsImageCreateStep returns the union data inside the PipelineSteps as a ImageCreateStep

func (PipelineSteps) AsImageImportStep

func (t PipelineSteps) AsImageImportStep() (ImageImportStep, error)

AsImageImportStep returns the union data inside the PipelineSteps as a ImageImportStep

func (PipelineSteps) AsImagesPruneStep

func (t PipelineSteps) AsImagesPruneStep() (ImagesPruneStep, error)

AsImagesPruneStep returns the union data inside the PipelineSteps as a ImagesPruneStep

func (PipelineSteps) AsSleepStep

func (t PipelineSteps) AsSleepStep() (SleepStep, error)

AsSleepStep returns the union data inside the PipelineSteps as a SleepStep

func (PipelineSteps) AsStackBuildCreateStep

func (t PipelineSteps) AsStackBuildCreateStep() (StackBuildCreateStep, error)

AsStackBuildCreateStep returns the union data inside the PipelineSteps as a StackBuildCreateStep

func (PipelineSteps) AsStackBuildDeployStep

func (t PipelineSteps) AsStackBuildDeployStep() (StackBuildDeployStep, error)

AsStackBuildDeployStep returns the union data inside the PipelineSteps as a StackBuildDeployStep

func (PipelineSteps) AsStackBuildGenerateStep

func (t PipelineSteps) AsStackBuildGenerateStep() (StackBuildGenerateStep, error)

AsStackBuildGenerateStep returns the union data inside the PipelineSteps as a StackBuildGenerateStep

func (PipelineSteps) AsStackPruneStep

func (t PipelineSteps) AsStackPruneStep() (StackPruneStep, error)

AsStackPruneStep returns the union data inside the PipelineSteps as a StackPruneStep

func (PipelineSteps) AsWebhookGetStep

func (t PipelineSteps) AsWebhookGetStep() (WebhookGetStep, error)

AsWebhookGetStep returns the union data inside the PipelineSteps as a WebhookGetStep

func (PipelineSteps) AsWebhookPostStep

func (t PipelineSteps) AsWebhookPostStep() (WebhookPostStep, error)

AsWebhookPostStep returns the union data inside the PipelineSteps as a WebhookPostStep

func (PipelineSteps) Discriminator

func (t PipelineSteps) Discriminator() (string, error)

func (*PipelineSteps) FromContainerCreateStep

func (t *PipelineSteps) FromContainerCreateStep(v ContainerCreateStep) error

FromContainerCreateStep overwrites any union data inside the PipelineSteps as the provided ContainerCreateStep

func (*PipelineSteps) FromContainerDeleteStep

func (t *PipelineSteps) FromContainerDeleteStep(v ContainerDeleteStep) error

FromContainerDeleteStep overwrites any union data inside the PipelineSteps as the provided ContainerDeleteStep

func (*PipelineSteps) FromContainerFunctionTriggerStep

func (t *PipelineSteps) FromContainerFunctionTriggerStep(v ContainerFunctionTriggerStep) error

FromContainerFunctionTriggerStep overwrites any union data inside the PipelineSteps as the provided ContainerFunctionTriggerStep

func (*PipelineSteps) FromContainerReimageStep

func (t *PipelineSteps) FromContainerReimageStep(v ContainerReimageStep) error

FromContainerReimageStep overwrites any union data inside the PipelineSteps as the provided ContainerReimageStep

func (*PipelineSteps) FromContainerRestartStep

func (t *PipelineSteps) FromContainerRestartStep(v ContainerRestartStep) error

FromContainerRestartStep overwrites any union data inside the PipelineSteps as the provided ContainerRestartStep

func (*PipelineSteps) FromContainerStartStep

func (t *PipelineSteps) FromContainerStartStep(v ContainerStartStep) error

FromContainerStartStep overwrites any union data inside the PipelineSteps as the provided ContainerStartStep

func (*PipelineSteps) FromContainerStopStep

func (t *PipelineSteps) FromContainerStopStep(v ContainerStopStep) error

FromContainerStopStep overwrites any union data inside the PipelineSteps as the provided ContainerStopStep

func (*PipelineSteps) FromEnvironmentCreateStep

func (t *PipelineSteps) FromEnvironmentCreateStep(v EnvironmentCreateStep) error

FromEnvironmentCreateStep overwrites any union data inside the PipelineSteps as the provided EnvironmentCreateStep

func (*PipelineSteps) FromEnvironmentDeleteStep

func (t *PipelineSteps) FromEnvironmentDeleteStep(v EnvironmentDeleteStep) error

FromEnvironmentDeleteStep overwrites any union data inside the PipelineSteps as the provided EnvironmentDeleteStep

func (*PipelineSteps) FromEnvironmentDeploymentHealthyWatchStep

func (t *PipelineSteps) FromEnvironmentDeploymentHealthyWatchStep(v EnvironmentDeploymentHealthyWatchStep) error

FromEnvironmentDeploymentHealthyWatchStep overwrites any union data inside the PipelineSteps as the provided EnvironmentDeploymentHealthyWatchStep

func (*PipelineSteps) FromEnvironmentDeploymentStartStep

func (t *PipelineSteps) FromEnvironmentDeploymentStartStep(v EnvironmentDeploymentStartStep) error

FromEnvironmentDeploymentStartStep overwrites any union data inside the PipelineSteps as the provided EnvironmentDeploymentStartStep

func (*PipelineSteps) FromEnvironmentDeploymentStopStep

func (t *PipelineSteps) FromEnvironmentDeploymentStopStep(v EnvironmentDeploymentStopStep) error

FromEnvironmentDeploymentStopStep overwrites any union data inside the PipelineSteps as the provided EnvironmentDeploymentStopStep

func (*PipelineSteps) FromEnvironmentDeploymentsPruneStep

func (t *PipelineSteps) FromEnvironmentDeploymentsPruneStep(v EnvironmentDeploymentsPruneStep) error

FromEnvironmentDeploymentsPruneStep overwrites any union data inside the PipelineSteps as the provided EnvironmentDeploymentsPruneStep

func (*PipelineSteps) FromEnvironmentDeploymentsTagStep

func (t *PipelineSteps) FromEnvironmentDeploymentsTagStep(v EnvironmentDeploymentsTagStep) error

FromEnvironmentDeploymentsTagStep overwrites any union data inside the PipelineSteps as the provided EnvironmentDeploymentsTagStep

func (*PipelineSteps) FromEnvironmentStartStep

func (t *PipelineSteps) FromEnvironmentStartStep(v EnvironmentStartStep) error

FromEnvironmentStartStep overwrites any union data inside the PipelineSteps as the provided EnvironmentStartStep

func (*PipelineSteps) FromEnvironmentStopStep

func (t *PipelineSteps) FromEnvironmentStopStep(v EnvironmentStopStep) error

FromEnvironmentStopStep overwrites any union data inside the PipelineSteps as the provided EnvironmentStopStep

func (*PipelineSteps) FromImageCreateImportStep

func (t *PipelineSteps) FromImageCreateImportStep(v ImageCreateImportStep) error

FromImageCreateImportStep overwrites any union data inside the PipelineSteps as the provided ImageCreateImportStep

func (*PipelineSteps) FromImageCreateStep

func (t *PipelineSteps) FromImageCreateStep(v ImageCreateStep) error

FromImageCreateStep overwrites any union data inside the PipelineSteps as the provided ImageCreateStep

func (*PipelineSteps) FromImageImportStep

func (t *PipelineSteps) FromImageImportStep(v ImageImportStep) error

FromImageImportStep overwrites any union data inside the PipelineSteps as the provided ImageImportStep

func (*PipelineSteps) FromImagesPruneStep

func (t *PipelineSteps) FromImagesPruneStep(v ImagesPruneStep) error

FromImagesPruneStep overwrites any union data inside the PipelineSteps as the provided ImagesPruneStep

func (*PipelineSteps) FromSleepStep

func (t *PipelineSteps) FromSleepStep(v SleepStep) error

FromSleepStep overwrites any union data inside the PipelineSteps as the provided SleepStep

func (*PipelineSteps) FromStackBuildCreateStep

func (t *PipelineSteps) FromStackBuildCreateStep(v StackBuildCreateStep) error

FromStackBuildCreateStep overwrites any union data inside the PipelineSteps as the provided StackBuildCreateStep

func (*PipelineSteps) FromStackBuildDeployStep

func (t *PipelineSteps) FromStackBuildDeployStep(v StackBuildDeployStep) error

FromStackBuildDeployStep overwrites any union data inside the PipelineSteps as the provided StackBuildDeployStep

func (*PipelineSteps) FromStackBuildGenerateStep

func (t *PipelineSteps) FromStackBuildGenerateStep(v StackBuildGenerateStep) error

FromStackBuildGenerateStep overwrites any union data inside the PipelineSteps as the provided StackBuildGenerateStep

func (*PipelineSteps) FromStackPruneStep

func (t *PipelineSteps) FromStackPruneStep(v StackPruneStep) error

FromStackPruneStep overwrites any union data inside the PipelineSteps as the provided StackPruneStep

func (*PipelineSteps) FromWebhookGetStep

func (t *PipelineSteps) FromWebhookGetStep(v WebhookGetStep) error

FromWebhookGetStep overwrites any union data inside the PipelineSteps as the provided WebhookGetStep

func (*PipelineSteps) FromWebhookPostStep

func (t *PipelineSteps) FromWebhookPostStep(v WebhookPostStep) error

FromWebhookPostStep overwrites any union data inside the PipelineSteps as the provided WebhookPostStep

func (PipelineSteps) MarshalJSON

func (t PipelineSteps) MarshalJSON() ([]byte, error)

func (*PipelineSteps) MergeContainerCreateStep

func (t *PipelineSteps) MergeContainerCreateStep(v ContainerCreateStep) error

MergeContainerCreateStep performs a merge with any union data inside the PipelineSteps, using the provided ContainerCreateStep

func (*PipelineSteps) MergeContainerDeleteStep

func (t *PipelineSteps) MergeContainerDeleteStep(v ContainerDeleteStep) error

MergeContainerDeleteStep performs a merge with any union data inside the PipelineSteps, using the provided ContainerDeleteStep

func (*PipelineSteps) MergeContainerFunctionTriggerStep

func (t *PipelineSteps) MergeContainerFunctionTriggerStep(v ContainerFunctionTriggerStep) error

MergeContainerFunctionTriggerStep performs a merge with any union data inside the PipelineSteps, using the provided ContainerFunctionTriggerStep

func (*PipelineSteps) MergeContainerReimageStep

func (t *PipelineSteps) MergeContainerReimageStep(v ContainerReimageStep) error

MergeContainerReimageStep performs a merge with any union data inside the PipelineSteps, using the provided ContainerReimageStep

func (*PipelineSteps) MergeContainerRestartStep

func (t *PipelineSteps) MergeContainerRestartStep(v ContainerRestartStep) error

MergeContainerRestartStep performs a merge with any union data inside the PipelineSteps, using the provided ContainerRestartStep

func (*PipelineSteps) MergeContainerStartStep

func (t *PipelineSteps) MergeContainerStartStep(v ContainerStartStep) error

MergeContainerStartStep performs a merge with any union data inside the PipelineSteps, using the provided ContainerStartStep

func (*PipelineSteps) MergeContainerStopStep

func (t *PipelineSteps) MergeContainerStopStep(v ContainerStopStep) error

MergeContainerStopStep performs a merge with any union data inside the PipelineSteps, using the provided ContainerStopStep

func (*PipelineSteps) MergeEnvironmentCreateStep

func (t *PipelineSteps) MergeEnvironmentCreateStep(v EnvironmentCreateStep) error

MergeEnvironmentCreateStep performs a merge with any union data inside the PipelineSteps, using the provided EnvironmentCreateStep

func (*PipelineSteps) MergeEnvironmentDeleteStep

func (t *PipelineSteps) MergeEnvironmentDeleteStep(v EnvironmentDeleteStep) error

MergeEnvironmentDeleteStep performs a merge with any union data inside the PipelineSteps, using the provided EnvironmentDeleteStep

func (*PipelineSteps) MergeEnvironmentDeploymentHealthyWatchStep

func (t *PipelineSteps) MergeEnvironmentDeploymentHealthyWatchStep(v EnvironmentDeploymentHealthyWatchStep) error

MergeEnvironmentDeploymentHealthyWatchStep performs a merge with any union data inside the PipelineSteps, using the provided EnvironmentDeploymentHealthyWatchStep

func (*PipelineSteps) MergeEnvironmentDeploymentStartStep

func (t *PipelineSteps) MergeEnvironmentDeploymentStartStep(v EnvironmentDeploymentStartStep) error

MergeEnvironmentDeploymentStartStep performs a merge with any union data inside the PipelineSteps, using the provided EnvironmentDeploymentStartStep

func (*PipelineSteps) MergeEnvironmentDeploymentStopStep

func (t *PipelineSteps) MergeEnvironmentDeploymentStopStep(v EnvironmentDeploymentStopStep) error

MergeEnvironmentDeploymentStopStep performs a merge with any union data inside the PipelineSteps, using the provided EnvironmentDeploymentStopStep

func (*PipelineSteps) MergeEnvironmentDeploymentsPruneStep

func (t *PipelineSteps) MergeEnvironmentDeploymentsPruneStep(v EnvironmentDeploymentsPruneStep) error

MergeEnvironmentDeploymentsPruneStep performs a merge with any union data inside the PipelineSteps, using the provided EnvironmentDeploymentsPruneStep

func (*PipelineSteps) MergeEnvironmentDeploymentsTagStep

func (t *PipelineSteps) MergeEnvironmentDeploymentsTagStep(v EnvironmentDeploymentsTagStep) error

MergeEnvironmentDeploymentsTagStep performs a merge with any union data inside the PipelineSteps, using the provided EnvironmentDeploymentsTagStep

func (*PipelineSteps) MergeEnvironmentStartStep

func (t *PipelineSteps) MergeEnvironmentStartStep(v EnvironmentStartStep) error

MergeEnvironmentStartStep performs a merge with any union data inside the PipelineSteps, using the provided EnvironmentStartStep

func (*PipelineSteps) MergeEnvironmentStopStep

func (t *PipelineSteps) MergeEnvironmentStopStep(v EnvironmentStopStep) error

MergeEnvironmentStopStep performs a merge with any union data inside the PipelineSteps, using the provided EnvironmentStopStep

func (*PipelineSteps) MergeImageCreateImportStep

func (t *PipelineSteps) MergeImageCreateImportStep(v ImageCreateImportStep) error

MergeImageCreateImportStep performs a merge with any union data inside the PipelineSteps, using the provided ImageCreateImportStep

func (*PipelineSteps) MergeImageCreateStep

func (t *PipelineSteps) MergeImageCreateStep(v ImageCreateStep) error

MergeImageCreateStep performs a merge with any union data inside the PipelineSteps, using the provided ImageCreateStep

func (*PipelineSteps) MergeImageImportStep

func (t *PipelineSteps) MergeImageImportStep(v ImageImportStep) error

MergeImageImportStep performs a merge with any union data inside the PipelineSteps, using the provided ImageImportStep

func (*PipelineSteps) MergeImagesPruneStep

func (t *PipelineSteps) MergeImagesPruneStep(v ImagesPruneStep) error

MergeImagesPruneStep performs a merge with any union data inside the PipelineSteps, using the provided ImagesPruneStep

func (*PipelineSteps) MergeSleepStep

func (t *PipelineSteps) MergeSleepStep(v SleepStep) error

MergeSleepStep performs a merge with any union data inside the PipelineSteps, using the provided SleepStep

func (*PipelineSteps) MergeStackBuildCreateStep

func (t *PipelineSteps) MergeStackBuildCreateStep(v StackBuildCreateStep) error

MergeStackBuildCreateStep performs a merge with any union data inside the PipelineSteps, using the provided StackBuildCreateStep

func (*PipelineSteps) MergeStackBuildDeployStep

func (t *PipelineSteps) MergeStackBuildDeployStep(v StackBuildDeployStep) error

MergeStackBuildDeployStep performs a merge with any union data inside the PipelineSteps, using the provided StackBuildDeployStep

func (*PipelineSteps) MergeStackBuildGenerateStep

func (t *PipelineSteps) MergeStackBuildGenerateStep(v StackBuildGenerateStep) error

MergeStackBuildGenerateStep performs a merge with any union data inside the PipelineSteps, using the provided StackBuildGenerateStep

func (*PipelineSteps) MergeStackPruneStep

func (t *PipelineSteps) MergeStackPruneStep(v StackPruneStep) error

MergeStackPruneStep performs a merge with any union data inside the PipelineSteps, using the provided StackPruneStep

func (*PipelineSteps) MergeWebhookGetStep

func (t *PipelineSteps) MergeWebhookGetStep(v WebhookGetStep) error

MergeWebhookGetStep performs a merge with any union data inside the PipelineSteps, using the provided WebhookGetStep

func (*PipelineSteps) MergeWebhookPostStep

func (t *PipelineSteps) MergeWebhookPostStep(v WebhookPostStep) error

MergeWebhookPostStep performs a merge with any union data inside the PipelineSteps, using the provided WebhookPostStep

func (*PipelineSteps) UnmarshalJSON

func (t *PipelineSteps) UnmarshalJSON(b []byte) error

func (PipelineSteps) ValueByDiscriminator

func (t PipelineSteps) ValueByDiscriminator() (interface{}, error)

type PipelineTask added in v0.6.1

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

PipelineTask defines model for PipelineTask.

func (PipelineTask) AsPipelineRerunAction added in v0.6.1

func (t PipelineTask) AsPipelineRerunAction() (PipelineRerunAction, error)

AsPipelineRerunAction returns the union data inside the PipelineTask as a PipelineRerunAction

func (PipelineTask) AsPipelineTriggerAction added in v0.6.1

func (t PipelineTask) AsPipelineTriggerAction() (PipelineTriggerAction, error)

AsPipelineTriggerAction returns the union data inside the PipelineTask as a PipelineTriggerAction

func (PipelineTask) Discriminator added in v0.6.1

func (t PipelineTask) Discriminator() (string, error)

func (*PipelineTask) FromPipelineRerunAction added in v0.6.1

func (t *PipelineTask) FromPipelineRerunAction(v PipelineRerunAction) error

FromPipelineRerunAction overwrites any union data inside the PipelineTask as the provided PipelineRerunAction

func (*PipelineTask) FromPipelineTriggerAction added in v0.6.1

func (t *PipelineTask) FromPipelineTriggerAction(v PipelineTriggerAction) error

FromPipelineTriggerAction overwrites any union data inside the PipelineTask as the provided PipelineTriggerAction

func (PipelineTask) MarshalJSON added in v0.6.1

func (t PipelineTask) MarshalJSON() ([]byte, error)

func (*PipelineTask) MergePipelineRerunAction added in v0.6.1

func (t *PipelineTask) MergePipelineRerunAction(v PipelineRerunAction) error

MergePipelineRerunAction performs a merge with any union data inside the PipelineTask, using the provided PipelineRerunAction

func (*PipelineTask) MergePipelineTriggerAction added in v0.6.1

func (t *PipelineTask) MergePipelineTriggerAction(v PipelineTriggerAction) error

MergePipelineTriggerAction performs a merge with any union data inside the PipelineTask, using the provided PipelineTriggerAction

func (*PipelineTask) UnmarshalJSON added in v0.6.1

func (t *PipelineTask) UnmarshalJSON(b []byte) error

func (PipelineTask) ValueByDiscriminator added in v0.6.1

func (t PipelineTask) ValueByDiscriminator() (interface{}, error)

type PipelineTriggerAction added in v0.6.1

type PipelineTriggerAction struct {
	// Action The requested action to perform.
	Action   PipelineTriggerActionAction `json:"action"`
	Contents *struct {
		Advanced *struct {
			// SkipLocks To enable skip locks, pass the current UNIX timestamp. Must be accurate within 10 minutes of the current UTC time.
			// This will skip lock checks when running a pipeline - the user takes all risk of ensuring two pipeline runs won't make conflicting changes.
			SkipLocks *int `json:"skip_locks"`

			// SubQueue Sub queue allows multiple concurrent pipeline runs.
			SubQueue *string `json:"sub_queue"`
		} `json:"advanced,omitempty"`

		// Variables A map of variables to pass into the pipeline when it runs.
		Variables *map[string]string `json:"variables,omitempty"`
	} `json:"contents,omitempty"`
}

PipelineTriggerAction defines model for PipelineTriggerAction.

type PipelineTriggerActionAction added in v0.6.1

type PipelineTriggerActionAction string

PipelineTriggerActionAction The requested action to perform.

const (
	PipelineTriggerActionActionTrigger PipelineTriggerActionAction = "trigger"
)

Defines values for PipelineTriggerActionAction.

type PrivateNetwork

type PrivateNetwork struct {
	Ipv6 struct {
		// Cidr The CIDR notation, describing the range of IP addresses.
		Cidr string `json:"cidr"`

		// Ip The IP address.
		Ip string `json:"ip"`
	} `json:"ipv6"`
	Legacy *LegacyNetwork `json:"legacy"`

	// Subnet The subnet ID.
	Subnet string `json:"subnet"`

	// VxlanTag The vxlan tag added to each packet to help identify the network.
	VxlanTag int `json:"vxlan_tag"`
}

PrivateNetwork defines model for PrivateNetwork.

type ProcessesSnapshot

type ProcessesSnapshot struct {
	// Current The current number of running processes in the instance.
	Current *float32 `json:"current,omitempty"`

	// Limit The maximum number of running processes for the instance.
	Limit *float32 `json:"limit,omitempty"`
}

ProcessesSnapshot Process information for a given snapshot.

type PromoCode

type PromoCode struct {
	// Code The promo "code".
	Code string `json:"code"`

	// Credit The amount of credit the promo code offers.
	Credit *struct {
		// Amount An object holding information about term and amount that relates to a specific billing component.
		Amount  *BillingAmount `json:"amount,omitempty"`
		Expires *struct {
			Interval string `json:"interval"`
			Number   int    `json:"number"`
		} `json:"expires,omitempty"`
	} `json:"credit"`
	Expires DateTime `json:"expires"`
	State   struct {
		Changed DateTime `json:"changed"`

		// Current The current state of the promo code.
		Current PromoCodeStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`
}

PromoCode A billing promo code.

type PromoCodeInclude

type PromoCodeInclude map[string]PromoCode

PromoCodeInclude A resource that is associated with a promo code.

type PromoCodeStateCurrent

type PromoCodeStateCurrent string

PromoCodeStateCurrent The current state of the promo code.

const (
	PromoCodeStateCurrentDeleted PromoCodeStateCurrent = "deleted"
	PromoCodeStateCurrentLive    PromoCodeStateCurrent = "live"
)

Defines values for PromoCodeStateCurrent.

type ProviderLocation

type ProviderLocation struct {
	// Abbreviation An abbreviation for the given provider locaiton.
	Abbreviation string `json:"abbreviation"`

	// Annotations Additional information about the given provider locaiton.
	Annotations map[string]interface{} `json:"annotations"`

	// Compatible A boolean where true means the locaiton is supported by the platform.
	Compatible bool `json:"compatible"`

	// Features Additional information about available and supported features of the provider location.
	Features struct {
		// Available Available features for the provider location.
		Available []string `json:"available"`

		// Supported Supported features for the provider location.
		Supported []string `json:"supported"`
	} `json:"features"`
	Geographic *ProviderLocationGeography `json:"geographic"`
	Id         string                     `json:"id"`

	// Name A name for the location.
	Name string `json:"name"`

	// Provider Information about the location of the provider.
	Provider ProviderLocationDetails `json:"provider"`
}

ProviderLocation Location information for a given provider.

type ProviderLocationDetails

type ProviderLocationDetails struct {
	AvailabilityZones *[]string `json:"availability_zones,omitempty"`

	// Code A location code returned from the provider.
	Code string `json:"code"`

	// Identifier An identifier for the given provider
	Identifier string `json:"identifier"`

	// IntegrationId A 24 character hex string used to identify a unique resource.
	IntegrationId *ID `json:"integration_id,omitempty"`

	// Location A location name returned from the provider.
	Location string `json:"location"`
	Vendor   string `json:"vendor"`
}

ProviderLocationDetails Information about the location of the provider.

type ProviderLocationGeography

type ProviderLocationGeography struct {
	// City The city the datacenter resides in.
	City string `json:"city"`

	// Country The country the datacenter resides in.
	Country string `json:"country"`

	// Latitude The latitude of the given provider datacenter.
	Latitude int `json:"latitude"`

	// Longitude The longitude of the given provider datacenter.
	Longitude int `json:"longitude"`

	// Region The region the datacenter resides in.
	Region string `json:"region"`

	// State The state the datacenter resides in.
	State string `json:"state"`
}

ProviderLocationGeography Geographic information about a provider location.

type ProviderServerModel

type ProviderServerModel struct {
	// Compatible A boolean where true signifies this server is compatible with the platform.
	Compatible bool `json:"compatible"`

	// Description A description of the server.
	Description string `json:"description"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// LocationIds An array of location IDs where this server type is available.
	LocationIds []string `json:"location_ids"`

	// LowResource A boolean where true signifies the server has a limited amount of resources and should only be used for very lightweight workloads.
	LowResource bool `json:"low_resource"`

	// Name A name for the server.
	Name string `json:"name"`

	// Price An object holding information about term and amount that relates to a specific billing component.
	Price BillingAmount `json:"price"`

	// Provider Higher level information about a providers server.
	Provider ProviderServerModelProviderSpec `json:"provider"`

	// Specs Specs for a given server
	Specs ProviderServerModelSpec `json:"specs"`
}

ProviderServerModel A server from a provider.

type ProviderServerModelProviderSpec added in v0.6.6

type ProviderServerModelProviderSpec struct {
	AvailabilityZones *map[string][]string `json:"availability_zones,omitempty"`

	// Category A category for the server.
	Category string `json:"category"`

	// Class A class for the server.
	Class *string `json:"class,omitempty"`

	// Identifier A provider identifier.
	Identifier    string `json:"identifier"`
	IntegrationId *ID    `json:"integration_id"`

	// Locations A list of location ID's this server is available.
	Locations []string `json:"locations"`

	// Model The model of the server.
	Model string `json:"model"`

	// Vendor The infrastructure vendor for the provider.
	Vendor *string `json:"vendor,omitempty"`
}

ProviderServerModelProviderSpec Higher level information about a providers server.

type ProviderServerModelSpec added in v0.6.6

type ProviderServerModelSpec struct {
	// Cpu Information about the CPU for a given server.
	Cpu CPUSpec `json:"cpu"`

	// Features The spec for server features.
	Features FeaturesSpec `json:"features"`

	// Gpu Information about a given servers GPU resources.
	Gpu GPUSpec `json:"gpu"`

	// Memory Information about the memory resources of a given server.
	Memory  MemorySpec    `json:"memory"`
	Network []NetworkSpec `json:"network"`
	Storage []StorageSpec `json:"storage"`
}

ProviderServerModelSpec Specs for a given server

type ProviderServerModelsIncludes added in v0.6.6

type ProviderServerModelsIncludes map[string]ProviderServerModel

ProviderServerModelsIncludes A resource associated with a server models.

type PublicAccount

type PublicAccount struct {
	// Email Email information for an account
	Email struct {
		// Address The email address associated with the account.
		Address string `json:"address"`
	} `json:"email"`
	Events *PublicAccount_Events `json:"events,omitempty"`

	// Id Id information for an account
	Id string `json:"id"`

	// Name The first and last name of an account owner
	Name struct {
		// First The first name of the account owner
		First string `json:"first"`

		// Last The last name of the account owner
		Last string `json:"last"`
	} `json:"name"`
	TwoFactorAuth struct {
		// Verified Indicates if the user account has two factor authentication enabled for log in.
		Verified bool `json:"verified"`
	} `json:"two_factor_auth"`
}

PublicAccount Publicly available information about an account

type PublicAccount_Events

type PublicAccount_Events struct {
	LastLogin            *DateTime           `json:"last_login,omitempty"`
	AdditionalProperties map[string]DateTime `json:"-"`
}

PublicAccount_Events defines model for PublicAccount.Events.

func (PublicAccount_Events) Get

func (a PublicAccount_Events) Get(fieldName string) (value DateTime, found bool)

Getter for additional properties for PublicAccount_Events. Returns the specified element and whether it was found

func (PublicAccount_Events) MarshalJSON

func (a PublicAccount_Events) MarshalJSON() ([]byte, error)

Override default JSON handling for PublicAccount_Events to handle AdditionalProperties

func (*PublicAccount_Events) Set

func (a *PublicAccount_Events) Set(fieldName string, value DateTime)

Setter for additional properties for PublicAccount_Events

func (*PublicAccount_Events) UnmarshalJSON

func (a *PublicAccount_Events) UnmarshalJSON(b []byte) error

Override default JSON handling for PublicAccount_Events to handle AdditionalProperties

type Range

type Range struct {
	End   DateTime `json:"end"`
	Start DateTime `json:"start"`
}

Range A start and end date-time pair indicating a range of time

type RawSource

type RawSource struct {
	Details struct {
		// Blob A boolean where true represents the text the user is entering will be multi line.
		Blob   bool `json:"blob"`
		Secret *struct {
			// Hint A user specified hint that will suggest what the encryption key might be
			Hint *string `json:"hint"`

			// Iv A string describing the IV Hex associated with the encryption of the variable
			Iv *string `json:"iv,omitempty"`
		} `json:"secret"`

		// Value The value of the variable.
		Value string `json:"value"`
	} `json:"details"`

	// Type The type of source value, can be either `raw` or `url`.
	Type RawSourceType `json:"type"`
}

RawSource The `raw` type of scoped variable `value`, referred to as a source. This means that the value is static, not the result of a call to an external or internal URL.

type RawSourceType

type RawSourceType string

RawSourceType The type of source value, can be either `raw` or `url`.

const (
	RawSourceTypeRaw RawSourceType = "raw"
)

Defines values for RawSourceType.

type ReconfigureSdnNetworkAction added in v0.6.4

type ReconfigureSdnNetworkAction struct {
	// Action The job to do.
	Action ReconfigureSdnNetworkActionAction `json:"action"`

	// Contents Additional information needed for the job.
	Contents struct {
		// EnvironmentIds An array of environment identifiers for the network.
		EnvironmentIds *[]string `json:"environment_ids"`
		L2             *struct {
			HostInterface *string `json:"host_interface"`
			LocationIds   *[]ID   `json:"location_ids,omitempty"`

			// Routes An array of defined L2 routes
			Routes *[]struct {
				// Gateway An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.
				Gateway *IpAddress `json:"gateway,omitempty"`

				// Usable A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix.
				// It combines an IP address with a suffix that indicates how many bits are fixed for routing.
				Usable *Cidr `json:"usable,omitempty"`
			} `json:"routes,omitempty"`
		} `json:"l2"`
	} `json:"contents"`
}

ReconfigureSdnNetworkAction defines model for ReconfigureSdnNetworkAction.

type ReconfigureSdnNetworkActionAction added in v0.6.4

type ReconfigureSdnNetworkActionAction string

ReconfigureSdnNetworkActionAction The job to do.

const (
	ReconfigureSdnNetworkActionActionReconfigure ReconfigureSdnNetworkActionAction = "reconfigure"
)

Defines values for ReconfigureSdnNetworkActionAction.

type RecordIncludeParam

type RecordIncludeParam = []string

RecordIncludeParam defines model for RecordIncludeParam.

type RecordIncludes

type RecordIncludes struct {
	Containers            *map[string]Container `json:"containers,omitempty"`
	ContainersIdentifiers *map[string]ID        `json:"containers:identifiers,omitempty"`

	// Creators An identity that created a resource.
	Creators                   *CreatorInclude            `json:"creators,omitempty"`
	VirtualMachines            *map[string]VirtualMachine `json:"virtual-machines,omitempty"`
	VirtualMachinesIdentifiers *map[string]ID             `json:"virtual-machines:identifiers,omitempty"`
}

RecordIncludes All includable resources linkable to the given records.

type RecoverTwoFactorAuthJSONBody

type RecoverTwoFactorAuthJSONBody struct {
	// Email The user's email
	Email         string   `json:"email"`
	Password      string   `json:"password"`
	RecoveryCodes []string `json:"recovery_codes"`
	Token         *string  `json:"token,omitempty"`
}

RecoverTwoFactorAuthJSONBody defines parameters for RecoverTwoFactorAuth.

type RecoverTwoFactorAuthJSONRequestBody

type RecoverTwoFactorAuthJSONRequestBody RecoverTwoFactorAuthJSONBody

RecoverTwoFactorAuthJSONRequestBody defines body for RecoverTwoFactorAuth for application/json ContentType.

type RecoverTwoFactorAuthResponse

type RecoverTwoFactorAuthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data TwoFactorAuthSetup `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseRecoverTwoFactorAuthResponse

func ParseRecoverTwoFactorAuthResponse(rsp *http.Response) (*RecoverTwoFactorAuthResponse, error)

ParseRecoverTwoFactorAuthResponse parses an HTTP response from a RecoverTwoFactorAuthWithResponse call

func (RecoverTwoFactorAuthResponse) Status

Status returns HTTPResponse.Status

func (RecoverTwoFactorAuthResponse) StatusCode

func (r RecoverTwoFactorAuthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Refund

type Refund struct {
	// Amount 1/10th of a cent.
	Amount int `json:"amount"`

	// Description Some information about the payment refund.
	Description string `json:"description"`

	// Gateway The type of payment gateway used.
	Gateway PaymentGateway `json:"gateway"`

	// Id A 24 character hex string used to identify a unique resource.
	Id   ID       `json:"id"`
	Time DateTime `json:"time"`
}

Refund A billing refund.

type RegistryAuth

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

RegistryAuth Authentication details for a third party image registry/source.

func (RegistryAuth) AsRegistryAuthProvider

func (t RegistryAuth) AsRegistryAuthProvider() (RegistryAuthProvider, error)

AsRegistryAuthProvider returns the union data inside the RegistryAuth as a RegistryAuthProvider

func (RegistryAuth) AsRegistryAuthUser

func (t RegistryAuth) AsRegistryAuthUser() (RegistryAuthUser, error)

AsRegistryAuthUser returns the union data inside the RegistryAuth as a RegistryAuthUser

func (RegistryAuth) AsRegistryAuthWebhook

func (t RegistryAuth) AsRegistryAuthWebhook() (RegistryAuthWebhook, error)

AsRegistryAuthWebhook returns the union data inside the RegistryAuth as a RegistryAuthWebhook

func (RegistryAuth) Discriminator

func (t RegistryAuth) Discriminator() (string, error)

func (*RegistryAuth) FromRegistryAuthProvider

func (t *RegistryAuth) FromRegistryAuthProvider(v RegistryAuthProvider) error

FromRegistryAuthProvider overwrites any union data inside the RegistryAuth as the provided RegistryAuthProvider

func (*RegistryAuth) FromRegistryAuthUser

func (t *RegistryAuth) FromRegistryAuthUser(v RegistryAuthUser) error

FromRegistryAuthUser overwrites any union data inside the RegistryAuth as the provided RegistryAuthUser

func (*RegistryAuth) FromRegistryAuthWebhook

func (t *RegistryAuth) FromRegistryAuthWebhook(v RegistryAuthWebhook) error

FromRegistryAuthWebhook overwrites any union data inside the RegistryAuth as the provided RegistryAuthWebhook

func (RegistryAuth) MarshalJSON

func (t RegistryAuth) MarshalJSON() ([]byte, error)

func (*RegistryAuth) MergeRegistryAuthProvider

func (t *RegistryAuth) MergeRegistryAuthProvider(v RegistryAuthProvider) error

MergeRegistryAuthProvider performs a merge with any union data inside the RegistryAuth, using the provided RegistryAuthProvider

func (*RegistryAuth) MergeRegistryAuthUser

func (t *RegistryAuth) MergeRegistryAuthUser(v RegistryAuthUser) error

MergeRegistryAuthUser performs a merge with any union data inside the RegistryAuth, using the provided RegistryAuthUser

func (*RegistryAuth) MergeRegistryAuthWebhook

func (t *RegistryAuth) MergeRegistryAuthWebhook(v RegistryAuthWebhook) error

MergeRegistryAuthWebhook performs a merge with any union data inside the RegistryAuth, using the provided RegistryAuthWebhook

func (*RegistryAuth) UnmarshalJSON

func (t *RegistryAuth) UnmarshalJSON(b []byte) error

func (RegistryAuth) ValueByDiscriminator

func (t RegistryAuth) ValueByDiscriminator() (interface{}, error)

type RegistryAuthProvider

type RegistryAuthProvider struct {
	Details struct {
		Credentials struct {
			ApiKey   *string `json:"api_key,omitempty"`
			ClientId *string `json:"client_id,omitempty"`

			// Config A base64'd string of additional configuration options.
			Config         *string `json:"config,omitempty"`
			Namespace      *string `json:"namespace,omitempty"`
			Region         *string `json:"region,omitempty"`
			Secret         *string `json:"secret,omitempty"`
			SubscriptionId *string `json:"subscription_id,omitempty"`
		} `json:"credentials"`
		Flavor RegistryAuthProviderDetailsFlavor `json:"flavor"`
	} `json:"details"`
	Type RegistryAuthProviderType `json:"type"`
}

RegistryAuthProvider Credentials for authentication to a provider-native image registry, such as AWS ECR.

type RegistryAuthProviderDetailsFlavor

type RegistryAuthProviderDetailsFlavor string

RegistryAuthProviderDetailsFlavor defines model for RegistryAuthProvider.Details.Flavor.

const (
	Ecr RegistryAuthProviderDetailsFlavor = "ecr"
)

Defines values for RegistryAuthProviderDetailsFlavor.

type RegistryAuthProviderType

type RegistryAuthProviderType string

RegistryAuthProviderType defines model for RegistryAuthProvider.Type.

const (
	Provider RegistryAuthProviderType = "provider"
)

Defines values for RegistryAuthProviderType.

type RegistryAuthUser

type RegistryAuthUser struct {
	Details struct {
		Token    *string `json:"token,omitempty"`
		Username *string `json:"username,omitempty"`
	} `json:"details"`
	Type RegistryAuthUserType `json:"type"`
}

RegistryAuthUser User/token based credentials for authentication to a third-party image source.

type RegistryAuthUserType

type RegistryAuthUserType string

RegistryAuthUserType defines model for RegistryAuthUser.Type.

const (
	User RegistryAuthUserType = "user"
)

Defines values for RegistryAuthUserType.

type RegistryAuthWebhook

type RegistryAuthWebhook struct {
	Details struct {
		Url string `json:"url"`
	} `json:"details"`
	Type RegistryAuthWebhookType `json:"type"`
}

RegistryAuthWebhook Webhook-based authentication to the provided URL. This webhook expects to receive a base-64 string that when decoded is in the format `username:password`

type RegistryAuthWebhookType

type RegistryAuthWebhookType string

RegistryAuthWebhookType defines model for RegistryAuthWebhook.Type.

const (
	Webhook RegistryAuthWebhookType = "webhook"
)

Defines values for RegistryAuthWebhookType.

type RepoType

type RepoType struct {
	// Auth Authentication information for the repository.
	Auth *RepoType_Auth `json:"auth,omitempty"`

	// Branch An optional branch arguement.  Default value is `master`.
	Branch *string `json:"branch,omitempty"`

	// Ref Repository reference information.
	Ref *struct {
		// Type The type of reference being used.
		Type string `json:"type"`

		// Value The value for the given reference type.
		Value string `json:"value"`
	} `json:"ref"`

	// Url The URL of the repository.
	Url string `json:"url"`
}

RepoType Information about the repository.

type RepoType_Auth

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

RepoType_Auth Authentication information for the repository.

func (RepoType_Auth) AsCredentialsHTTP

func (t RepoType_Auth) AsCredentialsHTTP() (CredentialsHTTP, error)

AsCredentialsHTTP returns the union data inside the RepoType_Auth as a CredentialsHTTP

func (RepoType_Auth) AsCredentialsSSH

func (t RepoType_Auth) AsCredentialsSSH() (CredentialsSSH, error)

AsCredentialsSSH returns the union data inside the RepoType_Auth as a CredentialsSSH

func (RepoType_Auth) Discriminator

func (t RepoType_Auth) Discriminator() (string, error)

func (*RepoType_Auth) FromCredentialsHTTP

func (t *RepoType_Auth) FromCredentialsHTTP(v CredentialsHTTP) error

FromCredentialsHTTP overwrites any union data inside the RepoType_Auth as the provided CredentialsHTTP

func (*RepoType_Auth) FromCredentialsSSH

func (t *RepoType_Auth) FromCredentialsSSH(v CredentialsSSH) error

FromCredentialsSSH overwrites any union data inside the RepoType_Auth as the provided CredentialsSSH

func (RepoType_Auth) MarshalJSON

func (t RepoType_Auth) MarshalJSON() ([]byte, error)

func (*RepoType_Auth) MergeCredentialsHTTP

func (t *RepoType_Auth) MergeCredentialsHTTP(v CredentialsHTTP) error

MergeCredentialsHTTP performs a merge with any union data inside the RepoType_Auth, using the provided CredentialsHTTP

func (*RepoType_Auth) MergeCredentialsSSH

func (t *RepoType_Auth) MergeCredentialsSSH(v CredentialsSSH) error

MergeCredentialsSSH performs a merge with any union data inside the RepoType_Auth, using the provided CredentialsSSH

func (*RepoType_Auth) UnmarshalJSON

func (t *RepoType_Auth) UnmarshalJSON(b []byte) error

func (RepoType_Auth) ValueByDiscriminator

func (t RepoType_Auth) ValueByDiscriminator() (interface{}, error)

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResetPasswordJSONBody

type ResetPasswordJSONBody = map[string]interface{}

ResetPasswordJSONBody defines parameters for ResetPassword.

type ResetPasswordJSONRequestBody

type ResetPasswordJSONRequestBody = ResetPasswordJSONBody

ResetPasswordJSONRequestBody defines body for ResetPassword for application/json ContentType.

type ResetPasswordResponse

type ResetPasswordResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			Success bool `json:"success"`
		} `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseResetPasswordResponse

func ParseResetPasswordResponse(rsp *http.Response) (*ResetPasswordResponse, error)

ParseResetPasswordResponse parses an HTTP response from a ResetPasswordWithResponse call

func (ResetPasswordResponse) Status

func (r ResetPasswordResponse) Status() string

Status returns HTTPResponse.Status

func (ResetPasswordResponse) StatusCode

func (r ResetPasswordResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ResourceAllowance added in v0.6.5

type ResourceAllowance struct {
	// Additional Cost for units that exceed the included amount.
	Additional struct {
		// Mills Cost in mills per additional unit.
		Mills int `json:"mills"`

		// Term Billing term that applies to the additional cost.
		Term ResourceAllowanceAdditionalTerm `json:"term"`
	} `json:"additional"`

	// HardCap Whether there is a hard limit on this resource.
	HardCap bool `json:"hard_cap"`

	// Included The number of units included in the tier price.
	Included int `json:"included"`
}

ResourceAllowance Generic structure for a resource with an included allotment, optional hard cap, and per-unit overage cost.

type ResourceAllowanceAdditionalTerm added in v0.6.5

type ResourceAllowanceAdditionalTerm string

ResourceAllowanceAdditionalTerm Billing term that applies to the additional cost.

const (
	ResourceAllowanceAdditionalTermMonthly ResourceAllowanceAdditionalTerm = "monthly"
	ResourceAllowanceAdditionalTermOnce    ResourceAllowanceAdditionalTerm = "once"
	ResourceAllowanceAdditionalTermYearly  ResourceAllowanceAdditionalTerm = "yearly"
)

Defines values for ResourceAllowanceAdditionalTerm.

type ResourceSnapshot

type ResourceSnapshot struct {
	Cluster     *Identifier `json:"cluster"`
	ContainerId *ID         `json:"container_id"`

	// Cpu A telemetry snapshot pertaining to CPU usage.
	Cpu           CPUSnapshot `json:"cpu"`
	EnvironmentId *ID         `json:"environment_id"`
	HubId         *HubID      `json:"hub_id"`

	// Hugetlb HugeTLB data.
	Hugetlb    *HugeTLB `json:"hugetlb,omitempty"`
	InstanceId *ID      `json:"instance_id"`

	// Memory A snapshot of memory usage statistics.
	Memory MemorySnapshot `json:"memory"`

	// Network A snapshot of network usage statistics.
	Network NetworkSnapshot `json:"network"`

	// Processes Process information for a given snapshot.
	Processes ProcessesSnapshot `json:"processes"`
	ServerId  *ID               `json:"server_id"`
	Time      DateTime          `json:"time"`
}

ResourceSnapshot A resource snapshot that shows instance telemetry.

type ResourceType

type ResourceType string

ResourceType defines model for ResourceType.

const (
	ResourceTypeAccount                      ResourceType = "account"
	ResourceTypeBillingInvoice               ResourceType = "billing.invoice"
	ResourceTypeBillingMethod                ResourceType = "billing.method"
	ResourceTypeContainer                    ResourceType = "container"
	ResourceTypeContainerInstance            ResourceType = "container.instance"
	ResourceTypeDnsCertificate               ResourceType = "dns.certificate"
	ResourceTypeDnsZone                      ResourceType = "dns.zone"
	ResourceTypeDnsZoneRecord                ResourceType = "dns.zone.record"
	ResourceTypeEnvironment                  ResourceType = "environment"
	ResourceTypeEnvironmentScopedVariable    ResourceType = "environment.scoped-variable"
	ResourceTypeHub                          ResourceType = "hub"
	ResourceTypeHubApiKey                    ResourceType = "hub.api_key"
	ResourceTypeHubMembership                ResourceType = "hub.membership"
	ResourceTypeHubRole                      ResourceType = "hub.role"
	ResourceTypeImage                        ResourceType = "image"
	ResourceTypeImageSource                  ResourceType = "image.source"
	ResourceTypeInfrastructureAutoscaleGroup ResourceType = "infrastructure.autoscale.group"
	ResourceTypeInfrastructureCluster        ResourceType = "infrastructure.cluster"
	ResourceTypeInfrastructureExternalVolume ResourceType = "infrastructure.external-volume"
	ResourceTypeInfrastructureIpsPool        ResourceType = "infrastructure.ips.pool"
	ResourceTypeInfrastructureProvider       ResourceType = "infrastructure.provider"
	ResourceTypeInfrastructureServer         ResourceType = "infrastructure.server"
	ResourceTypePipeline                     ResourceType = "pipeline"
	ResourceTypePipelineRun                  ResourceType = "pipeline.run"
	ResourceTypeSdnNetwork                   ResourceType = "sdn.network"
	ResourceTypeStack                        ResourceType = "stack"
	ResourceTypeStackBuild                   ResourceType = "stack.build"
	ResourceTypeVirtualMachine               ResourceType = "virtual-machine"
	ResourceTypeVirtualMachineSshKey         ResourceType = "virtual-machine.ssh-key"
)

Defines values for ResourceType.

type Role

type Role struct {
	// Capabilities The list of platform level capabilities assigned to this Role.
	Capabilities struct {
		// All If true, the Role has all capabilities.
		All      bool         `json:"all"`
		Specific []Capability `json:"specific"`
	} `json:"capabilities"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Default A reference to the original identifier of the default Role this Role was built from.  A value of null means it is a fully custom Role.
	Default *Identifier `json:"default"`

	// Events Timestamps for each event in the Role's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// Extra Custom user-defined properties for storing extra information on the Role. Not utilized by Cycle.
	Extra *map[string]string `json:"extra,omitempty"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID  `json:"hub_id"`
	Id    string `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Meta A list of meta fields that can be applied to a role.
	Meta *RoleMeta `json:"meta,omitempty"`
	Name *string   `json:"name"`

	// Rank An integer between 0 and 10 that indicates the Role hierarchy. An account can only edit a Role that is less than their rank. The 'owner' Role is rank 10.
	Rank int `json:"rank"`

	// Root The Role marked as root has full moderation control over all Roles.
	Root  bool `json:"root"`
	State struct {
		Changed DateTime `json:"changed"`

		// Current The current state of the Role.
		Current RoleStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`
}

Role A Role is a custom combination of platform-level capabilities, allowing for fully customizable role-based access controls across the platform.

type RoleMeta

type RoleMeta struct {
	Counts *struct {
		ApiKeys int `json:"api_keys"`
		Members int `json:"members"`
	} `json:"counts,omitempty"`
}

RoleMeta A list of meta fields that can be applied to a role.

type RoleStateCurrent

type RoleStateCurrent string

RoleStateCurrent The current state of the Role.

const (
	RoleStateCurrentLive RoleStateCurrent = "live"
)

Defines values for RoleStateCurrent.

type RunState

type RunState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the pipeline run.
	Current RunStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

RunState defines model for RunState.

type RunStateCurrent

type RunStateCurrent string

RunStateCurrent The current state of the pipeline run.

const (
	RunStateCurrentAcquiring RunStateCurrent = "acquiring"
	RunStateCurrentCancelled RunStateCurrent = "cancelled"
	RunStateCurrentComplete  RunStateCurrent = "complete"
	RunStateCurrentDeleted   RunStateCurrent = "deleted"
	RunStateCurrentQueued    RunStateCurrent = "queued"
	RunStateCurrentRunning   RunStateCurrent = "running"
)

Defines values for RunStateCurrent.

type RuntimeDevicePermission added in v0.6.5

type RuntimeDevicePermission struct {
	// Access The access mode permitted by this rule. Common conventions use a combination of letters (e.g., r, w, m) to indicate read, write, and mknod capabilities.
	Access RuntimeDevicePermissionAccess `json:"access"`

	// Allow Whether this rule allows (true) or denies (false) access.
	Allow bool `json:"allow"`

	// Major Device major number.
	Major *int64 `json:"major"`

	// Minor Device minor number.
	Minor *int64 `json:"minor"`

	// Type The class of device this rule applies to (for example, block devices or character devices).
	Type RuntimeDevicePermissionType `json:"type"`
}

RuntimeDevicePermission A rule that grants or denies access to a device node (e.g., Linux cgroup device rule). Controls which device type and major/minor numbers are allowed, and with what access.

type RuntimeDevicePermissionAccess added in v0.6.5

type RuntimeDevicePermissionAccess = string

RuntimeDevicePermissionAccess The access mode permitted by this rule. Common conventions use a combination of letters (e.g., r, w, m) to indicate read, write, and mknod capabilities.

type RuntimeDevicePermissionType added in v0.6.5

type RuntimeDevicePermissionType string

RuntimeDevicePermissionType The class of device this rule applies to (for example, block devices or character devices).

Defines values for RuntimeDevicePermissionType.

type RuntimeExposedDevice added in v0.6.5

type RuntimeExposedDevice struct {
	// Destination The path inside the container that the device is mapped to.
	Destination string `json:"destination"`

	// Options Options passed when mounting the device.
	Options *[]string `json:"options,omitempty"`

	// Source The path to the device on the host.
	Source string `json:"source"`
}

RuntimeExposedDevice A host device exposed to the container during runtime.

type SFTP

type SFTP struct {
	// Host The hostname for connecting to the volume over SFTP.
	Host string `json:"host"`

	// Password Password configuration settings for the remote access of the container volume.
	Password struct {
		// Algorithm The hashing algorithm used to has the password.
		Algorithm SFTPPasswordAlgorithm `json:"algorithm"`

		// Data The raw or hashed password.
		Data string `json:"data"`
	} `json:"password"`

	// Port The port number to use when connecting.
	Port float32 `json:"port"`

	// Username The username to use when connecting.
	Username string `json:"username"`
}

SFTP Information about connecting to a instance volume over SFTP.

type SFTPPasswordAlgorithm

type SFTPPasswordAlgorithm string

SFTPPasswordAlgorithm The hashing algorithm used to has the password.

const (
	SFTPPasswordAlgorithmMd5    SFTPPasswordAlgorithm = "md5"
	SFTPPasswordAlgorithmRaw    SFTPPasswordAlgorithm = "raw"
	SFTPPasswordAlgorithmSha512 SFTPPasswordAlgorithm = "sha512"
)

Defines values for SFTPPasswordAlgorithm.

type SSHResponse

type SSHResponse struct {
	// Address The SSH connection response address.
	Address string `json:"address"`

	// Secret The SSH connection response secret.
	Secret string `json:"secret"`

	// Token An Instance SSH token.
	Token SSHToken `json:"token"`
}

SSHResponse SSH connection information for a given container instance.

type SSHToken

type SSHToken struct {
	// ContainerId The ID of the container from which the instance was created.
	ContainerId string `json:"container_id"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the SSH token's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Expires DateTime `json:"expires"`
		Used    DateTime `json:"used"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// InstanceId The ID of the instance being connected to.
	InstanceId string `json:"instance_id"`

	// Valid A boolean where true represents the token as being a valid token to be used for connection.
	Valid bool `json:"valid"`
}

SSHToken An Instance SSH token.

type ScaleThresholdMetric

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

ScaleThresholdMetric Discriminated union describing the different types of scaling threshold and their respective details

func (ScaleThresholdMetric) AsScaleThresholdMetricCpu

func (t ScaleThresholdMetric) AsScaleThresholdMetricCpu() (ScaleThresholdMetricCpu, error)

AsScaleThresholdMetricCpu returns the union data inside the ScaleThresholdMetric as a ScaleThresholdMetricCpu

func (ScaleThresholdMetric) AsScaleThresholdMetricCustom

func (t ScaleThresholdMetric) AsScaleThresholdMetricCustom() (ScaleThresholdMetricCustom, error)

AsScaleThresholdMetricCustom returns the union data inside the ScaleThresholdMetric as a ScaleThresholdMetricCustom

func (ScaleThresholdMetric) AsScaleThresholdMetricNetworkConnections

func (t ScaleThresholdMetric) AsScaleThresholdMetricNetworkConnections() (ScaleThresholdMetricNetworkConnections, error)

AsScaleThresholdMetricNetworkConnections returns the union data inside the ScaleThresholdMetric as a ScaleThresholdMetricNetworkConnections

func (ScaleThresholdMetric) AsScaleThresholdMetricNetworkRequests

func (t ScaleThresholdMetric) AsScaleThresholdMetricNetworkRequests() (ScaleThresholdMetricNetworkRequests, error)

AsScaleThresholdMetricNetworkRequests returns the union data inside the ScaleThresholdMetric as a ScaleThresholdMetricNetworkRequests

func (ScaleThresholdMetric) AsScaleThresholdMetricNetworkThroughput

func (t ScaleThresholdMetric) AsScaleThresholdMetricNetworkThroughput() (ScaleThresholdMetricNetworkThroughput, error)

AsScaleThresholdMetricNetworkThroughput returns the union data inside the ScaleThresholdMetric as a ScaleThresholdMetricNetworkThroughput

func (ScaleThresholdMetric) AsScaleThresholdMetricRam

func (t ScaleThresholdMetric) AsScaleThresholdMetricRam() (ScaleThresholdMetricRam, error)

AsScaleThresholdMetricRam returns the union data inside the ScaleThresholdMetric as a ScaleThresholdMetricRam

func (ScaleThresholdMetric) Discriminator

func (t ScaleThresholdMetric) Discriminator() (string, error)

func (*ScaleThresholdMetric) FromScaleThresholdMetricCpu

func (t *ScaleThresholdMetric) FromScaleThresholdMetricCpu(v ScaleThresholdMetricCpu) error

FromScaleThresholdMetricCpu overwrites any union data inside the ScaleThresholdMetric as the provided ScaleThresholdMetricCpu

func (*ScaleThresholdMetric) FromScaleThresholdMetricCustom

func (t *ScaleThresholdMetric) FromScaleThresholdMetricCustom(v ScaleThresholdMetricCustom) error

FromScaleThresholdMetricCustom overwrites any union data inside the ScaleThresholdMetric as the provided ScaleThresholdMetricCustom

func (*ScaleThresholdMetric) FromScaleThresholdMetricNetworkConnections

func (t *ScaleThresholdMetric) FromScaleThresholdMetricNetworkConnections(v ScaleThresholdMetricNetworkConnections) error

FromScaleThresholdMetricNetworkConnections overwrites any union data inside the ScaleThresholdMetric as the provided ScaleThresholdMetricNetworkConnections

func (*ScaleThresholdMetric) FromScaleThresholdMetricNetworkRequests

func (t *ScaleThresholdMetric) FromScaleThresholdMetricNetworkRequests(v ScaleThresholdMetricNetworkRequests) error

FromScaleThresholdMetricNetworkRequests overwrites any union data inside the ScaleThresholdMetric as the provided ScaleThresholdMetricNetworkRequests

func (*ScaleThresholdMetric) FromScaleThresholdMetricNetworkThroughput

func (t *ScaleThresholdMetric) FromScaleThresholdMetricNetworkThroughput(v ScaleThresholdMetricNetworkThroughput) error

FromScaleThresholdMetricNetworkThroughput overwrites any union data inside the ScaleThresholdMetric as the provided ScaleThresholdMetricNetworkThroughput

func (*ScaleThresholdMetric) FromScaleThresholdMetricRam

func (t *ScaleThresholdMetric) FromScaleThresholdMetricRam(v ScaleThresholdMetricRam) error

FromScaleThresholdMetricRam overwrites any union data inside the ScaleThresholdMetric as the provided ScaleThresholdMetricRam

func (ScaleThresholdMetric) MarshalJSON

func (t ScaleThresholdMetric) MarshalJSON() ([]byte, error)

func (*ScaleThresholdMetric) MergeScaleThresholdMetricCpu

func (t *ScaleThresholdMetric) MergeScaleThresholdMetricCpu(v ScaleThresholdMetricCpu) error

MergeScaleThresholdMetricCpu performs a merge with any union data inside the ScaleThresholdMetric, using the provided ScaleThresholdMetricCpu

func (*ScaleThresholdMetric) MergeScaleThresholdMetricCustom

func (t *ScaleThresholdMetric) MergeScaleThresholdMetricCustom(v ScaleThresholdMetricCustom) error

MergeScaleThresholdMetricCustom performs a merge with any union data inside the ScaleThresholdMetric, using the provided ScaleThresholdMetricCustom

func (*ScaleThresholdMetric) MergeScaleThresholdMetricNetworkConnections

func (t *ScaleThresholdMetric) MergeScaleThresholdMetricNetworkConnections(v ScaleThresholdMetricNetworkConnections) error

MergeScaleThresholdMetricNetworkConnections performs a merge with any union data inside the ScaleThresholdMetric, using the provided ScaleThresholdMetricNetworkConnections

func (*ScaleThresholdMetric) MergeScaleThresholdMetricNetworkRequests

func (t *ScaleThresholdMetric) MergeScaleThresholdMetricNetworkRequests(v ScaleThresholdMetricNetworkRequests) error

MergeScaleThresholdMetricNetworkRequests performs a merge with any union data inside the ScaleThresholdMetric, using the provided ScaleThresholdMetricNetworkRequests

func (*ScaleThresholdMetric) MergeScaleThresholdMetricNetworkThroughput

func (t *ScaleThresholdMetric) MergeScaleThresholdMetricNetworkThroughput(v ScaleThresholdMetricNetworkThroughput) error

MergeScaleThresholdMetricNetworkThroughput performs a merge with any union data inside the ScaleThresholdMetric, using the provided ScaleThresholdMetricNetworkThroughput

func (*ScaleThresholdMetric) MergeScaleThresholdMetricRam

func (t *ScaleThresholdMetric) MergeScaleThresholdMetricRam(v ScaleThresholdMetricRam) error

MergeScaleThresholdMetricRam performs a merge with any union data inside the ScaleThresholdMetric, using the provided ScaleThresholdMetricRam

func (*ScaleThresholdMetric) UnmarshalJSON

func (t *ScaleThresholdMetric) UnmarshalJSON(b []byte) error

func (ScaleThresholdMetric) ValueByDiscriminator

func (t ScaleThresholdMetric) ValueByDiscriminator() (interface{}, error)

type ScaleThresholdMetricCpu

type ScaleThresholdMetricCpu struct {
	Details struct {
		Utilization int `json:"utilization"`
	} `json:"details"`
	Type ScaleThresholdMetricCpuType `json:"type"`
}

ScaleThresholdMetricCpu Describes the CPU threshold at which scaling will occur

type ScaleThresholdMetricCpuType

type ScaleThresholdMetricCpuType string

ScaleThresholdMetricCpuType defines model for ScaleThresholdMetricCpu.Type.

const (
	Cpu ScaleThresholdMetricCpuType = "cpu"
)

Defines values for ScaleThresholdMetricCpuType.

type ScaleThresholdMetricCustom

type ScaleThresholdMetricCustom struct {
	Details struct {
		// Webhook A URL describing the destination Cycle should send a POST webhook payload to.
		Webhook WebhookURL `json:"webhook"`
	} `json:"details"`
	Type ScaleThresholdMetricCustomType `json:"type"`
}

ScaleThresholdMetricCustom A custom threshold for defining a scaling event.

type ScaleThresholdMetricCustomType

type ScaleThresholdMetricCustomType string

ScaleThresholdMetricCustomType defines model for ScaleThresholdMetricCustom.Type.

const (
	ScaleThresholdMetricCustomTypeCustom ScaleThresholdMetricCustomType = "custom"
)

Defines values for ScaleThresholdMetricCustomType.

type ScaleThresholdMetricNetworkConnections

type ScaleThresholdMetricNetworkConnections struct {
	Details struct {
		Connections int `json:"connections"`
	} `json:"details"`
	Type ScaleThresholdMetricNetworkConnectionsType `json:"type"`
}

ScaleThresholdMetricNetworkConnections Describes the network connections threshold at which scaling will occur

type ScaleThresholdMetricNetworkConnectionsType

type ScaleThresholdMetricNetworkConnectionsType string

ScaleThresholdMetricNetworkConnectionsType defines model for ScaleThresholdMetricNetworkConnections.Type.

const (
	NetworkConnections ScaleThresholdMetricNetworkConnectionsType = "network-connections"
)

Defines values for ScaleThresholdMetricNetworkConnectionsType.

type ScaleThresholdMetricNetworkRequests

type ScaleThresholdMetricNetworkRequests struct {
	Details struct {
		Requests int `json:"requests"`
	} `json:"details"`
	Type ScaleThresholdMetricNetworkRequestsType `json:"type"`
}

ScaleThresholdMetricNetworkRequests Describes the network requests threshold at which scaling will occur

type ScaleThresholdMetricNetworkRequestsType

type ScaleThresholdMetricNetworkRequestsType string

ScaleThresholdMetricNetworkRequestsType defines model for ScaleThresholdMetricNetworkRequests.Type.

const (
	NetworkRequests ScaleThresholdMetricNetworkRequestsType = "network-requests"
)

Defines values for ScaleThresholdMetricNetworkRequestsType.

type ScaleThresholdMetricNetworkThroughput

type ScaleThresholdMetricNetworkThroughput struct {
	Details struct {
		// Bandwidth The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event.
		Bandwidth string `json:"bandwidth"`
		Private   bool   `json:"private"`
	} `json:"details"`
	Type ScaleThresholdMetricNetworkThroughputType `json:"type"`
}

ScaleThresholdMetricNetworkThroughput Describes the network throughput threshold at which scaling will occur

type ScaleThresholdMetricNetworkThroughputType

type ScaleThresholdMetricNetworkThroughputType string

ScaleThresholdMetricNetworkThroughputType defines model for ScaleThresholdMetricNetworkThroughput.Type.

const (
	NetworkThroughput ScaleThresholdMetricNetworkThroughputType = "network-throughput"
)

Defines values for ScaleThresholdMetricNetworkThroughputType.

type ScaleThresholdMetricRam

type ScaleThresholdMetricRam struct {
	Details struct {
		// Usage The target average RAM usage of all instances of this container. Going above this threshold will trigger a scaling event. This threshold must be greater than 25MB.
		Usage string `json:"usage"`
	} `json:"details"`
	Type ScaleThresholdMetricRamType `json:"type"`
}

ScaleThresholdMetricRam Describes the RAM threshold at which scaling will occur.

type ScaleThresholdMetricRamType

type ScaleThresholdMetricRamType string

ScaleThresholdMetricRamType defines model for ScaleThresholdMetricRam.Type.

const (
	Ram ScaleThresholdMetricRamType = "ram"
)

Defines values for ScaleThresholdMetricRamType.

type SchedulerAccessKey

type SchedulerAccessKey struct {
	// Ips Whitelisted IPs that are allowed to make requests to the scheduler service.
	Ips *[]string `json:"ips,omitempty"`

	// Name The name given to this access key
	Name string `json:"name"`

	// Secret The access key secret. This should be submitted with requests to a publicly accessible scheduler service.
	Secret string `json:"secret"`
}

SchedulerAccessKey Custom authorization keys for the scheduler service.

type SchedulerConfig

type SchedulerConfig struct {
	AccessKeys *[]SchedulerAccessKey `json:"access_keys,omitempty"`

	// Public If true, this scheduler will be accessible over the public internet. It will enable a LINKED record to be pointed to the scheduler container, and inbound requests to trigger function containers.
	Public bool `json:"public"`
}

SchedulerConfig Configuration options for the scheduler Environment service.

type SchedulerEnvironmentService

type SchedulerEnvironmentService struct {
	// AutoUpdate A boolean where `true` represents the desire to automatically update the environment scheduler service.
	AutoUpdate *bool            `json:"auto_update,omitempty"`
	Config     *SchedulerConfig `json:"config"`

	// ContainerId The ID of the scheduler service container.
	ContainerId *string `json:"container_id"`

	// Enable Whether or not the scheduler service is enabled.
	Enable bool `json:"enable"`

	// HighAvailability A boolean representing if the scheduler service container is set to high availability. mode or not. As of Jan 2024, this will always be false because HA is not availiable for the scheduler service.
	HighAvailability *bool `json:"high_availability,omitempty"`
}

SchedulerEnvironmentService Information about the environments scheduler service. The scheduler is used by containers with a function deployment strategy to route requests to the correct instances.

type ScopedVariable

type ScopedVariable struct {
	// Access The way the scoped variable is accessed.
	Access ScopedVariableAccess `json:"access"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator    CreatorScope `json:"creator"`
	Deployment *Deployment  `json:"deployment"`

	// EnvironmentId An identifier used to reference the environment this resource is scoped to.
	EnvironmentId string `json:"environment_id"`

	// Events A collection of timestamps for each event in the Scoped Variable's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Scope Information about the assignment of the scoped variable and how it is invoked.
	Scope ScopedVariableScope `json:"scope"`

	// Source The source or value of the scoped variable.
	Source ScopedVariable_Source `json:"source"`
	State  ScopedVariableState   `json:"state"`
}

ScopedVariable Scoped variables are a way for users to dynamically allocate runtime specific environment variables across any number of containers in an environment.

type ScopedVariableAccess

type ScopedVariableAccess struct {
	// EnvVariable When set to true, this scoped variable is set as an environment variable inside the container.
	EnvVariable *struct {
		// Key The name of the environment variable set on the target container.
		Key string `json:"key"`
	} `json:"env_variable"`

	// File File is an object that describes a path to mount the file to inside the container.
	File *struct {
		// Decode When true, Cycle will interpret this variable as a base-64 encoded string, and decode it before passing it into the container.
		Decode bool `json:"decode"`

		// Gid The linux GID to set on the file.
		Gid *int `json:"gid"`

		// Path The path to mount the file to inside the container.
		Path *string `json:"path"`

		// Permissions A linux file mode that will be set on the injected file.
		Permissions *string `json:"permissions"`

		// Uid The linux UID to set on the file.
		Uid *int `json:"uid"`
	} `json:"file"`

	// InternalApi If set, this scoped variable will be available over the internal API. Contains settings for accessing this variable over the internal API.
	InternalApi *struct {
		// Duration Duration is a time string that the internal API will serve that variable after runtime starts.
		Duration *Duration `json:"duration"`
	} `json:"internal_api"`
}

ScopedVariableAccess The way the scoped variable is accessed.

type ScopedVariableScope

type ScopedVariableScope struct {
	// Containers Information about the assignment of the scoped variable to different containers in the environment.
	Containers struct {
		// Global A boolean where true represents the scoped variables is globally assigned to all current and future containers in the environment.
		Global bool `json:"global"`

		// Identifiers An array of container identifiers, where each container identfied will have access to the scoped variable.
		Identifiers []string `json:"identifiers"`

		// Ids An array of container IDs, where each container identified will have access to the scoped variable.
		Ids []string `json:"ids"`
	} `json:"containers"`
}

ScopedVariableScope Information about the assignment of the scoped variable and how it is invoked.

type ScopedVariableState

type ScopedVariableState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the scoped variable.
	Current ScopedVariableStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

ScopedVariableState defines model for ScopedVariableState.

type ScopedVariableStateCurrent

type ScopedVariableStateCurrent string

ScopedVariableStateCurrent The current state of the scoped variable.

const (
	ScopedVariableStateCurrentDeleted  ScopedVariableStateCurrent = "deleted"
	ScopedVariableStateCurrentDeleting ScopedVariableStateCurrent = "deleting"
	ScopedVariableStateCurrentLive     ScopedVariableStateCurrent = "live"
)

Defines values for ScopedVariableStateCurrent.

type ScopedVariable_Source

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

ScopedVariable_Source The source or value of the scoped variable.

func (ScopedVariable_Source) AsRawSource

func (t ScopedVariable_Source) AsRawSource() (RawSource, error)

AsRawSource returns the union data inside the ScopedVariable_Source as a RawSource

func (ScopedVariable_Source) AsURLSource

func (t ScopedVariable_Source) AsURLSource() (URLSource, error)

AsURLSource returns the union data inside the ScopedVariable_Source as a URLSource

func (ScopedVariable_Source) Discriminator

func (t ScopedVariable_Source) Discriminator() (string, error)

func (*ScopedVariable_Source) FromRawSource

func (t *ScopedVariable_Source) FromRawSource(v RawSource) error

FromRawSource overwrites any union data inside the ScopedVariable_Source as the provided RawSource

func (*ScopedVariable_Source) FromURLSource

func (t *ScopedVariable_Source) FromURLSource(v URLSource) error

FromURLSource overwrites any union data inside the ScopedVariable_Source as the provided URLSource

func (ScopedVariable_Source) MarshalJSON

func (t ScopedVariable_Source) MarshalJSON() ([]byte, error)

func (*ScopedVariable_Source) MergeRawSource

func (t *ScopedVariable_Source) MergeRawSource(v RawSource) error

MergeRawSource performs a merge with any union data inside the ScopedVariable_Source, using the provided RawSource

func (*ScopedVariable_Source) MergeURLSource

func (t *ScopedVariable_Source) MergeURLSource(v URLSource) error

MergeURLSource performs a merge with any union data inside the ScopedVariable_Source, using the provided URLSource

func (*ScopedVariable_Source) UnmarshalJSON

func (t *ScopedVariable_Source) UnmarshalJSON(b []byte) error

func (ScopedVariable_Source) ValueByDiscriminator

func (t ScopedVariable_Source) ValueByDiscriminator() (interface{}, error)

type SdnNetworkTask added in v0.6.4

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

SdnNetworkTask defines model for SdnNetworkTask.

func (SdnNetworkTask) AsReconfigureSdnNetworkAction added in v0.6.4

func (t SdnNetworkTask) AsReconfigureSdnNetworkAction() (ReconfigureSdnNetworkAction, error)

AsReconfigureSdnNetworkAction returns the union data inside the SdnNetworkTask as a ReconfigureSdnNetworkAction

func (SdnNetworkTask) Discriminator added in v0.6.4

func (t SdnNetworkTask) Discriminator() (string, error)

func (*SdnNetworkTask) FromReconfigureSdnNetworkAction added in v0.6.4

func (t *SdnNetworkTask) FromReconfigureSdnNetworkAction(v ReconfigureSdnNetworkAction) error

FromReconfigureSdnNetworkAction overwrites any union data inside the SdnNetworkTask as the provided ReconfigureSdnNetworkAction

func (SdnNetworkTask) MarshalJSON added in v0.6.4

func (t SdnNetworkTask) MarshalJSON() ([]byte, error)

func (*SdnNetworkTask) MergeReconfigureSdnNetworkAction added in v0.6.4

func (t *SdnNetworkTask) MergeReconfigureSdnNetworkAction(v ReconfigureSdnNetworkAction) error

MergeReconfigureSdnNetworkAction performs a merge with any union data inside the SdnNetworkTask, using the provided ReconfigureSdnNetworkAction

func (*SdnNetworkTask) UnmarshalJSON added in v0.6.4

func (t *SdnNetworkTask) UnmarshalJSON(b []byte) error

func (SdnNetworkTask) ValueByDiscriminator added in v0.6.4

func (t SdnNetworkTask) ValueByDiscriminator() (interface{}, error)

type SeccompRule

type SeccompRule struct {
	Capabilities *struct {
		Excludes *string `json:"excludes,omitempty"`
		Includes *string `json:"includes,omitempty"`
	} `json:"capabilities,omitempty"`

	// Syscall LinuxSyscall is used to match a syscall in Seccomp
	Syscall *struct {
		Action string `json:"action"`
		Args   *[]struct {
			Index    int    `json:"index"`
			Op       string `json:"op"`
			Value    int    `json:"value"`
			ValueTwo *int   `json:"valueTwo,omitempty"`
		} `json:"args,omitempty"`
		ErrnoRet *int     `json:"errnoRet,omitempty"`
		Names    []string `json:"names"`
	} `json:"syscall,omitempty"`
}

SeccompRule Rules for controlling Linux seccomp inside a container.

type Server

type Server struct {
	Autoscale *struct {
		// GroupId A 24 character hex string used to identify a unique resource.
		GroupId ID `json:"group_id"`
	} `json:"autoscale"`

	// Cluster The cluster the given server is deployed to.
	Cluster string `json:"cluster"`

	// Constraints Constraints to apply to the server.
	Constraints ServerConstraints `json:"constraints"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Ephemeral Set to true when a server is created as part of an auto-scale event.
	Ephemeral bool `json:"ephemeral"`

	// Evacuate Details about a server's evacuation status. When an evacuation is in progress, no new container instances will be permitted on the server.
	Evacuate *struct {
		Started DateTime `json:"started"`
	} `json:"evacuate"`

	// Events A collection of timestamps for each event in the server's lifetime.
	Events struct {
		Created        DateTime `json:"created"`
		Deleted        DateTime `json:"deleted"`
		LatestInstance DateTime `json:"latest_instance"`

		// Provisioning Information about the provisioning of the server.
		Provisioning struct {
			Completed DateTime `json:"completed"`
			Failed    DateTime `json:"failed"`
			Started   DateTime `json:"started"`
		} `json:"provisioning"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// Features A set of features a given server can have and their information.
	Features ServerFeatures `json:"features"`

	// Hostname The server hostname.
	Hostname string `json:"hostname"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// LocationId An identifier for the location this server is deployed to.
	LocationId string `json:"location_id"`

	// Meta A list of meta fields that can be applied to a server.
	Meta *ServerMeta `json:"meta,omitempty"`

	// ModelId An identifier for the model of server that is deployed.
	ModelId string `json:"model_id"`

	// Nickname A custom name given to the server for identification purposes. Does not affect server hostname.
	Nickname *string `json:"nickname"`

	// NodeId An identifier for the node.
	NodeId string `json:"node_id"`

	// Provider A resource regarding the provider a given server is deployed from.
	Provider          ServerProvider          `json:"provider"`
	SharedFileSystems ServerSharedFileSystems `json:"shared_file_systems"`
	State             ServerState             `json:"state"`
}

Server The server resource, referring to servers that have been deployed to a Cycle hub.

type ServerAuthResetAction added in v0.6.3

type ServerAuthResetAction struct {
	// Action The action to take.
	Action ServerAuthResetActionAction `json:"action"`
}

ServerAuthResetAction A job that resets authentication for the server. Only for servers deployed from a virtual provider.

type ServerAuthResetActionAction added in v0.6.3

type ServerAuthResetActionAction string

ServerAuthResetActionAction The action to take.

const (
	AuthReset ServerAuthResetActionAction = "auth.reset"
)

Defines values for ServerAuthResetActionAction.

type ServerConstraints

type ServerConstraints struct {
	// Allow Settings for the server, things that are or are not allowed.
	Allow struct {
		// Overcommit A boolean where true means - allow twice the normal amount of CPU shares to be allocated to containers deployed to this server.
		Overcommit bool `json:"overcommit"`

		// Pool A boolean where true means - allow containers with no tags specified to be deployed to this server.
		Pool bool `json:"pool"`

		// Services A boolean where true means - allow service containers to be deployed to this container.
		Services bool `json:"services"`
	} `json:"allow"`

	// Tags A list of server tags to put on the given server.
	Tags []string `json:"tags"`
}

ServerConstraints Constraints to apply to the server.

type ServerEvacuateAction added in v0.6.1

type ServerEvacuateAction struct {
	// Action The action to take.
	Action   ServerEvacuateActionAction `json:"action"`
	Contents struct {
		Destination struct {
			ServerId *ID `json:"server_id"`
		} `json:"destination"`
	} `json:"contents"`
}

ServerEvacuateAction defines model for ServerEvacuateAction.

type ServerEvacuateActionAction added in v0.6.1

type ServerEvacuateActionAction string

ServerEvacuateActionAction The action to take.

const (
	EvacuationStart ServerEvacuateActionAction = "evacuation.start"
)

Defines values for ServerEvacuateActionAction.

type ServerEvacuateResetAction added in v0.6.1

type ServerEvacuateResetAction struct {
	// Action The action to take.
	Action ServerEvacuateResetActionAction `json:"action"`
}

ServerEvacuateResetAction defines model for ServerEvacuateResetAction.

type ServerEvacuateResetActionAction added in v0.6.1

type ServerEvacuateResetActionAction string

ServerEvacuateResetActionAction The action to take.

const (
	EvacuationReset ServerEvacuateResetActionAction = "evacuation.reset"
)

Defines values for ServerEvacuateResetActionAction.

type ServerFeatures

type ServerFeatures struct {
	// BaseVolumeGb The size of the base volume (where Cycle stores container images on this server).
	BaseVolumeGb *int `json:"base_volume_gb"`

	// Gateway Configuration options for running gateway services on this server.
	Gateway *struct {
		// Type The type of gateway service that can be run on this server.
		Type ServerFeaturesGatewayType `json:"type"`
	} `json:"gateway"`

	// Sftp A boolean where true means the server accepts incoming SFTP connections through the remote volume integration.
	Sftp bool `json:"sftp"`
}

ServerFeatures A set of features a given server can have and their information.

type ServerFeaturesGatewayType

type ServerFeaturesGatewayType string

ServerFeaturesGatewayType The type of gateway service that can be run on this server.

const (
	ServerFeaturesGatewayTypeBgp    ServerFeaturesGatewayType = "bgp"
	ServerFeaturesGatewayTypeStatic ServerFeaturesGatewayType = "static"
)

Defines values for ServerFeaturesGatewayType.

type ServerIncludes

type ServerIncludes struct {
	Clusters *map[string]Cluster `json:"clusters,omitempty"`

	// Integrations A resource that is associated with an integration.
	Integrations *IntegrationsIncludes `json:"integrations,omitempty"`

	// Locations A resource that is associated with a provider location.
	Locations *LocationsIncludes `json:"locations,omitempty"`

	// Models A resource associated with a server models.
	Models *ProviderServerModelsIncludes `json:"models,omitempty"`
}

ServerIncludes A resource associated with a server.

type ServerInstancesSummary

type ServerInstancesSummary struct {
	Instances int `json:"instances"`

	// ServerId A 24 character hex string used to identify a unique resource.
	ServerId ID `json:"server_id"`
}

ServerInstancesSummary A Server ID and number of Instances of a specific Container it hosts.

type ServerMeta

type ServerMeta struct {
	Allocations *struct {
		CpuShares struct {
			Allocatable int `json:"allocatable"`
			Allocated   int `json:"allocated"`
			Total       int `json:"total"`
		} `json:"cpu_shares"`
		Ram struct {
			AllocatableMb int `json:"allocatable_mb"`
			AllocatedMb   int `json:"allocated_mb"`
			TotalMb       int `json:"total_mb"`
		} `json:"ram"`
	} `json:"allocations,omitempty"`

	// InstancesCount A summary of resources by state
	InstancesCount *StateCountSummary `json:"instances_count,omitempty"`

	// Node Infrormation about the status of the server.
	Node *struct {
		// Drivers An array a drivers associated with the given server.
		Drivers []string `json:"drivers"`

		// Healthy A boolean where true means the platform is reporting the server as healthy.
		Healthy     bool     `json:"healthy"`
		LastCheckin DateTime `json:"last_checkin"`

		// Online A boolean where true means the server is online and reachable by the platform.
		Online bool      `json:"online"`
		State  NodeState `json:"state"`

		// Stats Statistics that pertain to a specific node.
		Stats NodeMetaStats `json:"stats"`
	} `json:"node,omitempty"`
}

ServerMeta A list of meta fields that can be applied to a server.

type ServerPowerOffAction added in v0.6.3

type ServerPowerOffAction struct {
	// Action The action to take.
	Action ServerPowerOffActionAction `json:"action"`
}

ServerPowerOffAction A job that powers the server off. Only for servers deployed from a virtual provider.

type ServerPowerOffActionAction added in v0.6.3

type ServerPowerOffActionAction string

ServerPowerOffActionAction The action to take.

const (
	PowerOff ServerPowerOffActionAction = "power-off"
)

Defines values for ServerPowerOffActionAction.

type ServerProvider

type ServerProvider struct {
	Extra *map[string]interface{} `json:"extra,omitempty"`

	// InitIps The IP's assigned to this server during provisioning.
	InitIps *[]string `json:"init_ips,omitempty"`

	// IntegrationId A 24 character hex string used to identify a unique resource.
	IntegrationId ID `json:"integration_id"`

	// Location A location where the server is deployed.
	Location string `json:"location"`

	// MacAddr The mac address for the server.
	MacAddr *string `json:"mac_addr,omitempty"`

	// Model The model of the server that is deployed.
	Model            string `json:"model"`
	ProvisionOptions *struct {
		EncryptStorage *bool    `json:"encrypt_storage,omitempty"`
		ReservationId  *string  `json:"reservation_id,omitempty"`
		StorageSize    *float32 `json:"storage_size,omitempty"`
	} `json:"provision_options,omitempty"`

	// Server A provider specific identifier for the server.
	Server string `json:"server"`

	// Vendor The vendor for the provider this server is deployed from.
	Vendor string `json:"vendor"`

	// Zone The zone of the server that is deployed, if defined.
	Zone *string `json:"zone"`
}

ServerProvider A resource regarding the provider a given server is deployed from.

type ServerReconfigureFeaturesAction added in v0.6.1

type ServerReconfigureFeaturesAction struct {
	// Action The action to take.
	Action ServerReconfigureFeaturesActionAction `json:"action"`

	// Contents Supplemental information needed to perform the action.
	Contents struct {
		// BaseVolumeGb A number in GB for how big the base volume should be.  This cannot be lower than the currently set value for the server.
		BaseVolumeGb *int `json:"base_volume_gb"`

		// Gateway Configuration options for running gateway services on this server.
		Gateway *struct {
			// Type The type of gateway service that can be run on this server.
			Type ServerReconfigureFeaturesActionContentsGatewayType `json:"type"`
		} `json:"gateway"`

		// Sftp A boolean where true represents the desire for the server to accept incoming SFTP requests for container volumes.
		Sftp *bool `json:"sftp,omitempty"`
	} `json:"contents"`
}

ServerReconfigureFeaturesAction defines model for ServerReconfigureFeaturesAction.

type ServerReconfigureFeaturesActionAction added in v0.6.1

type ServerReconfigureFeaturesActionAction string

ServerReconfigureFeaturesActionAction The action to take.

const (
	FeaturesReconfigure ServerReconfigureFeaturesActionAction = "features.reconfigure"
)

Defines values for ServerReconfigureFeaturesActionAction.

type ServerReconfigureFeaturesActionContentsGatewayType added in v0.6.1

type ServerReconfigureFeaturesActionContentsGatewayType string

ServerReconfigureFeaturesActionContentsGatewayType The type of gateway service that can be run on this server.

Defines values for ServerReconfigureFeaturesActionContentsGatewayType.

type ServerReconfigureSharedFsAction added in v0.6.1

type ServerReconfigureSharedFsAction struct {
	// Action The action to take.
	Action   ServerReconfigureSharedFsActionAction `json:"action"`
	Contents struct {
		// Directories An object describing directory identifiers with value {}.
		Directories *map[string]interface{} `json:"directories"`
		Mounts      *map[string]struct {
			// Options Comma separated string describing the server mount options.
			Options string `json:"options"`

			// Source String describing the server mount source.
			Source string `json:"source"`

			// Type String describing the server mount type.
			Type string `json:"type"`
		} `json:"mounts"`
	} `json:"contents"`
}

ServerReconfigureSharedFsAction defines model for ServerReconfigureSharedFsAction.

type ServerReconfigureSharedFsActionAction added in v0.6.1

type ServerReconfigureSharedFsActionAction string

ServerReconfigureSharedFsActionAction The action to take.

const (
	SharedfsReconfigure ServerReconfigureSharedFsActionAction = "sharedfs.reconfigure"
)

Defines values for ServerReconfigureSharedFsActionAction.

type ServerRestartAction added in v0.6.1

type ServerRestartAction struct {
	// Action The action to take.
	Action ServerRestartActionAction `json:"action"`
}

ServerRestartAction A job that restarts the server.

type ServerRestartActionAction added in v0.6.1

type ServerRestartActionAction string

ServerRestartActionAction The action to take.

const (
	ServerRestartActionActionRestart ServerRestartActionAction = "restart"
)

Defines values for ServerRestartActionAction.

type ServerRestartComputeAction added in v0.6.1

type ServerRestartComputeAction struct {
	// Action The action to take.
	Action ServerRestartComputeActionAction `json:"action"`
}

ServerRestartComputeAction A job that restarts compute service on a given server.

type ServerRestartComputeActionAction added in v0.6.1

type ServerRestartComputeActionAction string

ServerRestartComputeActionAction The action to take.

const (
	ComputeRestart ServerRestartComputeActionAction = "compute.restart"
)

Defines values for ServerRestartComputeActionAction.

type ServerRestartComputeSpawnerAction added in v0.6.1

type ServerRestartComputeSpawnerAction struct {
	// Action The action to take.
	Action ServerRestartComputeSpawnerActionAction `json:"action"`
}

ServerRestartComputeSpawnerAction A job that restarts compute service on a given server.

type ServerRestartComputeSpawnerActionAction added in v0.6.1

type ServerRestartComputeSpawnerActionAction string

ServerRestartComputeSpawnerActionAction The action to take.

const (
	ComputeSpawnerRestart ServerRestartComputeSpawnerActionAction = "compute.spawner.restart"
)

Defines values for ServerRestartComputeSpawnerActionAction.

type ServerSharedFileSystems

type ServerSharedFileSystems struct {
	// Directories An object describing directory identifiers with value {}.
	Directories *map[string]interface{} `json:"directories"`
	Mounts      *map[string]struct {
		// Options Comma separated string describing the server mount options.
		Options string `json:"options"`

		// Source String describing the server mount source.
		Source string `json:"source"`

		// Type String describing the server mount type.
		Type string `json:"type"`
	} `json:"mounts"`
}

ServerSharedFileSystems defines model for ServerSharedFileSystems.

type ServerState

type ServerState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the server.
	Current ServerStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

ServerState defines model for ServerState.

type ServerStateCurrent

type ServerStateCurrent string

ServerStateCurrent The current state of the server.

const (
	ServerStateCurrentConfiguring  ServerStateCurrent = "configuring"
	ServerStateCurrentDeleted      ServerStateCurrent = "deleted"
	ServerStateCurrentDeleting     ServerStateCurrent = "deleting"
	ServerStateCurrentLive         ServerStateCurrent = "live"
	ServerStateCurrentNew          ServerStateCurrent = "new"
	ServerStateCurrentProvisioning ServerStateCurrent = "provisioning"
	ServerStateCurrentQuarantined  ServerStateCurrent = "quarantined"
)

Defines values for ServerStateCurrent.

type ServerStatsCpu

type ServerStatsCpu struct {
	// Cores The number of CPU's or vCPU's for a given server.
	Cores *int `json:"cores,omitempty"`

	// Processors An array of processor information objects.
	Processors *[]struct {
		// Model The model of the processor.
		Model *string `json:"model,omitempty"`

		// Speed The speed of the processor.
		Speed *float32 `json:"speed,omitempty"`
	} `json:"processors,omitempty"`
	Usage *ServerStatsCpuUsage `json:"usage,omitempty"`

	// Virtualization A true value indicates the server supports virtualization.
	Virtualization *bool `json:"virtualization,omitempty"`
}

ServerStatsCpu Statistics about the CPU resources on a server.

type ServerStatsCpuUsage

type ServerStatsCpuUsage struct {
	Guest     *int `json:"guest,omitempty"`
	GuestNice *int `json:"guest_nice,omitempty"`
	Idle      *int `json:"idle,omitempty"`
	Iowait    *int `json:"iowait,omitempty"`
	Irq       *int `json:"irq,omitempty"`
	Nice      *int `json:"nice,omitempty"`
	SoftIrq   *int `json:"soft_irq,omitempty"`
	Steal     *int `json:"steal,omitempty"`
	System    *int `json:"system,omitempty"`
	User      *int `json:"user,omitempty"`
}

ServerStatsCpuUsage defines model for ServerStatsCpuUsage.

type ServerStatsCpuUsageTelemetry

type ServerStatsCpuUsageTelemetry struct {
	Guest     *float32 `json:"guest,omitempty"`
	GuestNice *float32 `json:"guest_nice,omitempty"`
	Idle      *float32 `json:"idle,omitempty"`
	Iowait    *float32 `json:"iowait,omitempty"`
	Irq       *float32 `json:"irq,omitempty"`
	Nice      *float32 `json:"nice,omitempty"`
	SoftIrq   *float32 `json:"soft_irq,omitempty"`
	Steal     *float32 `json:"steal,omitempty"`
	System    *float32 `json:"system,omitempty"`
	User      *float32 `json:"user,omitempty"`
}

ServerStatsCpuUsageTelemetry defines model for ServerStatsCpuUsageTelemetry.

type ServerStatsLoad

type ServerStatsLoad struct {
	// Avg15m the 15 minute load average.
	Avg15m float32 `json:"avg15m"`

	// Avg1m The 1 minute load average.
	Avg1m float32 `json:"avg1m"`

	// Avg5m The 5 minute load average.
	Avg5m float32 `json:"avg5m"`
}

ServerStatsLoad Statistics about the current load on the server.

type ServerStatsNetwork

type ServerStatsNetwork struct {
	// ExternalIpv4 The public IPv4 address used to connect to this server.
	ExternalIpv4 string `json:"external_ipv4"`

	// ExternalIpv6 The public IPv6 address used to connect to this server.
	ExternalIpv6 string `json:"external_ipv6"`

	// Interfaces Network interfaces for a given server.
	Interfaces *map[string]struct {
		// Addrs An array of IP addresses associated with the interface.
		Addrs *[]string `json:"addrs"`

		// Flags Flags for the given interface.
		Flags string `json:"flags"`

		// Interface The interface name.
		Interface string `json:"interface"`

		// MacAddr The mac address for the interface.
		MacAddr string `json:"mac_addr"`

		// Mtu The maximum transmission unit for the interface.
		Mtu int `json:"mtu"`

		// RxBytes The bytes received over the interface.
		RxBytes int `json:"rx_bytes"`

		// Speed The link speed for the interface in megabits.
		Speed int `json:"speed"`

		// TxBytes The bytes transmitted over the interface.
		TxBytes int `json:"tx_bytes"`
	} `json:"interfaces,omitempty"`
}

ServerStatsNetwork Statistics about the networks on a given server.

type ServerStatsOS

type ServerStatsOS struct {
	// Hostname The hostname as set by the given server's OS.
	Hostname *string `json:"hostname,omitempty"`

	// Kernel The currently installed kernel version.
	Kernel *string `json:"kernel,omitempty"`

	// Release The currently installed release version of the OS.
	Release *string `json:"release,omitempty"`
}

ServerStatsOS Statistics about the operating system installed on the server (CycleOS).

type ServerStatsRam

type ServerStatsRam struct {
	// Available The available RAM on the server.
	Available int `json:"available"`

	// Free The free RAM on the server.
	Free int `json:"free"`

	// Total The total RAM on the server.
	Total int `json:"total"`
}

ServerStatsRam Statistics about the RAM on a given server.

type ServerStatsRamTelemetry

type ServerStatsRamTelemetry struct {
	// Available The available RAM on the server.
	Available float32 `json:"available"`

	// Free The free RAM on the server.
	Free float32 `json:"free"`

	// Total The total RAM on the server.
	Total float32 `json:"total"`
}

ServerStatsRamTelemetry Statistics about the RAM on a given server.

type ServerStatsStorage

type ServerStatsStorage struct {
	// Mounts Records that show information about mounted filesystems where the key is the path to the mount.
	Mounts map[string]struct {
		// Device The device assocaited with the mount.
		Device *string `json:"device,omitempty"`

		// Free The amount of uninitialized storage in KB.
		Free int `json:"free"`

		// Mountpoint The path the mount is associated with.
		Mountpoint *string `json:"mountpoint,omitempty"`

		// Total The total amount of storage in KB available at this mount.
		Total int `json:"total"`

		// Type The type of filesystem in use by the mount.
		Type string `json:"type"`

		// Used The amount of storage being used in KB.
		Used int `json:"used"`
	} `json:"mounts"`

	// VolumeGroups An array of volume group objects.
	VolumeGroups map[string]struct {
		// Name A name for the volume group.
		Name string `json:"name"`

		// Size A number representing the aggregate group volume size in megabytes.
		Size int `json:"size"`

		// Volumes The actual volumes.
		Volumes map[string]struct {
			// DataPercent The percent of the volumes size being used by data.
			DataPercent int `json:"data_percent"`

			// MetaPercent The percent of the volumes size being used by meta data.
			MetaPercent int `json:"meta_percent"`

			// Name The name of the volume.
			Name string `json:"name"`

			// Pool The name of the volume pool this volume is associated with.
			Pool string `json:"pool"`

			// Size The size in megabytes of the volume.
			Size int `json:"size"`
		} `json:"volumes"`
	} `json:"volume_groups"`
}

ServerStatsStorage Statistics about storage for a given server.

type ServerStatsTelemetry

type ServerStatsTelemetry struct {
	CpuUsage *ServerStatsCpuUsageTelemetry `json:"cpu_usage,omitempty"`

	// Load Statistics about the current load on the server.
	Load ServerStatsLoad `json:"load"`

	// Ram Statistics about the RAM on a given server.
	Ram ServerStatsRamTelemetry `json:"ram"`

	// StorageBase Telemetry data for the base volume of a given server.
	StorageBase struct {
		// Free The amount of free space on the base volume.
		Free int `json:"free"`

		// Total The total amount of space on the base volume.
		Total int `json:"total"`

		// Used The amount of storage currently used in the base volume.
		Used int `json:"used"`
	} `json:"storage_base"`

	// StoragePool User data storage across all devices.
	StoragePool struct {
		// DataPercent The percentage of storage used by user data.
		DataPercent float32 `json:"data_percent"`

		// MetaPercent The percentage of storage used by the file allocation stables, etc.
		MetaPercent float32 `json:"meta_percent"`

		// Total The total amount of storage available.
		Total float32 `json:"total"`
	} `json:"storage_pool"`
	Time DateTime `json:"time"`
}

ServerStatsTelemetry Statistics about a given servers telemetery data.

type ServerStatsUptime

type ServerStatsUptime struct {
	// CpuIdle CPU idle time.
	CpuIdle *float32 `json:"cpu_idle,omitempty"`

	// Seconds The amount in seconds the server has been up (resets on restart).
	Seconds *float32 `json:"seconds,omitempty"`
}

ServerStatsUptime Statistics describing the uptime of a given server.

type ServerStatsVendor added in v0.6.3

type ServerStatsVendor struct {
	// BiosVendor The bios vendor of the server.
	BiosVendor *string `json:"bios_vendor,omitempty"`

	// BoardName The board name of the server.
	BoardName *string `json:"board_name,omitempty"`

	// BoardSerial The board serial number of the server.
	BoardSerial *string `json:"board_serial,omitempty"`

	// BoardVendor The board vendor of the server.
	BoardVendor *string `json:"board_vendor,omitempty"`

	// SystemVendor The system vendor of the server.
	SystemVendor *string `json:"system_vendor,omitempty"`
}

ServerStatsVendor Details about the vendors for the server.

type ServerStatsVersions

type ServerStatsVersions struct {
	// Services A list of records about Cycle services.
	Services map[string]string `json:"services"`
}

ServerStatsVersions Information about the versions of Cycle services on a given server.

type ServerTags

type ServerTags struct {
	// Data An array of server tags.
	Data []string `json:"data"`
}

ServerTags Tags for a given server.

type ServerTask added in v0.6.1

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

ServerTask defines model for ServerTask.

func (ServerTask) AsServerAuthResetAction added in v0.6.3

func (t ServerTask) AsServerAuthResetAction() (ServerAuthResetAction, error)

AsServerAuthResetAction returns the union data inside the ServerTask as a ServerAuthResetAction

func (ServerTask) AsServerEvacuateAction added in v0.6.1

func (t ServerTask) AsServerEvacuateAction() (ServerEvacuateAction, error)

AsServerEvacuateAction returns the union data inside the ServerTask as a ServerEvacuateAction

func (ServerTask) AsServerEvacuateResetAction added in v0.6.1

func (t ServerTask) AsServerEvacuateResetAction() (ServerEvacuateResetAction, error)

AsServerEvacuateResetAction returns the union data inside the ServerTask as a ServerEvacuateResetAction

func (ServerTask) AsServerPowerOffAction added in v0.6.3

func (t ServerTask) AsServerPowerOffAction() (ServerPowerOffAction, error)

AsServerPowerOffAction returns the union data inside the ServerTask as a ServerPowerOffAction

func (ServerTask) AsServerReconfigureFeaturesAction added in v0.6.1

func (t ServerTask) AsServerReconfigureFeaturesAction() (ServerReconfigureFeaturesAction, error)

AsServerReconfigureFeaturesAction returns the union data inside the ServerTask as a ServerReconfigureFeaturesAction

func (ServerTask) AsServerReconfigureSharedFsAction added in v0.6.1

func (t ServerTask) AsServerReconfigureSharedFsAction() (ServerReconfigureSharedFsAction, error)

AsServerReconfigureSharedFsAction returns the union data inside the ServerTask as a ServerReconfigureSharedFsAction

func (ServerTask) AsServerRestartAction added in v0.6.1

func (t ServerTask) AsServerRestartAction() (ServerRestartAction, error)

AsServerRestartAction returns the union data inside the ServerTask as a ServerRestartAction

func (ServerTask) AsServerRestartComputeAction added in v0.6.1

func (t ServerTask) AsServerRestartComputeAction() (ServerRestartComputeAction, error)

AsServerRestartComputeAction returns the union data inside the ServerTask as a ServerRestartComputeAction

func (ServerTask) AsServerRestartComputeSpawnerAction added in v0.6.1

func (t ServerTask) AsServerRestartComputeSpawnerAction() (ServerRestartComputeSpawnerAction, error)

AsServerRestartComputeSpawnerAction returns the union data inside the ServerTask as a ServerRestartComputeSpawnerAction

func (ServerTask) AsServerUnquarantineAction added in v0.6.3

func (t ServerTask) AsServerUnquarantineAction() (ServerUnquarantineAction, error)

AsServerUnquarantineAction returns the union data inside the ServerTask as a ServerUnquarantineAction

func (ServerTask) Discriminator added in v0.6.1

func (t ServerTask) Discriminator() (string, error)

func (*ServerTask) FromServerAuthResetAction added in v0.6.3

func (t *ServerTask) FromServerAuthResetAction(v ServerAuthResetAction) error

FromServerAuthResetAction overwrites any union data inside the ServerTask as the provided ServerAuthResetAction

func (*ServerTask) FromServerEvacuateAction added in v0.6.1

func (t *ServerTask) FromServerEvacuateAction(v ServerEvacuateAction) error

FromServerEvacuateAction overwrites any union data inside the ServerTask as the provided ServerEvacuateAction

func (*ServerTask) FromServerEvacuateResetAction added in v0.6.1

func (t *ServerTask) FromServerEvacuateResetAction(v ServerEvacuateResetAction) error

FromServerEvacuateResetAction overwrites any union data inside the ServerTask as the provided ServerEvacuateResetAction

func (*ServerTask) FromServerPowerOffAction added in v0.6.3

func (t *ServerTask) FromServerPowerOffAction(v ServerPowerOffAction) error

FromServerPowerOffAction overwrites any union data inside the ServerTask as the provided ServerPowerOffAction

func (*ServerTask) FromServerReconfigureFeaturesAction added in v0.6.1

func (t *ServerTask) FromServerReconfigureFeaturesAction(v ServerReconfigureFeaturesAction) error

FromServerReconfigureFeaturesAction overwrites any union data inside the ServerTask as the provided ServerReconfigureFeaturesAction

func (*ServerTask) FromServerReconfigureSharedFsAction added in v0.6.1

func (t *ServerTask) FromServerReconfigureSharedFsAction(v ServerReconfigureSharedFsAction) error

FromServerReconfigureSharedFsAction overwrites any union data inside the ServerTask as the provided ServerReconfigureSharedFsAction

func (*ServerTask) FromServerRestartAction added in v0.6.1

func (t *ServerTask) FromServerRestartAction(v ServerRestartAction) error

FromServerRestartAction overwrites any union data inside the ServerTask as the provided ServerRestartAction

func (*ServerTask) FromServerRestartComputeAction added in v0.6.1

func (t *ServerTask) FromServerRestartComputeAction(v ServerRestartComputeAction) error

FromServerRestartComputeAction overwrites any union data inside the ServerTask as the provided ServerRestartComputeAction

func (*ServerTask) FromServerRestartComputeSpawnerAction added in v0.6.1

func (t *ServerTask) FromServerRestartComputeSpawnerAction(v ServerRestartComputeSpawnerAction) error

FromServerRestartComputeSpawnerAction overwrites any union data inside the ServerTask as the provided ServerRestartComputeSpawnerAction

func (*ServerTask) FromServerUnquarantineAction added in v0.6.3

func (t *ServerTask) FromServerUnquarantineAction(v ServerUnquarantineAction) error

FromServerUnquarantineAction overwrites any union data inside the ServerTask as the provided ServerUnquarantineAction

func (ServerTask) MarshalJSON added in v0.6.1

func (t ServerTask) MarshalJSON() ([]byte, error)

func (*ServerTask) MergeServerAuthResetAction added in v0.6.3

func (t *ServerTask) MergeServerAuthResetAction(v ServerAuthResetAction) error

MergeServerAuthResetAction performs a merge with any union data inside the ServerTask, using the provided ServerAuthResetAction

func (*ServerTask) MergeServerEvacuateAction added in v0.6.1

func (t *ServerTask) MergeServerEvacuateAction(v ServerEvacuateAction) error

MergeServerEvacuateAction performs a merge with any union data inside the ServerTask, using the provided ServerEvacuateAction

func (*ServerTask) MergeServerEvacuateResetAction added in v0.6.1

func (t *ServerTask) MergeServerEvacuateResetAction(v ServerEvacuateResetAction) error

MergeServerEvacuateResetAction performs a merge with any union data inside the ServerTask, using the provided ServerEvacuateResetAction

func (*ServerTask) MergeServerPowerOffAction added in v0.6.3

func (t *ServerTask) MergeServerPowerOffAction(v ServerPowerOffAction) error

MergeServerPowerOffAction performs a merge with any union data inside the ServerTask, using the provided ServerPowerOffAction

func (*ServerTask) MergeServerReconfigureFeaturesAction added in v0.6.1

func (t *ServerTask) MergeServerReconfigureFeaturesAction(v ServerReconfigureFeaturesAction) error

MergeServerReconfigureFeaturesAction performs a merge with any union data inside the ServerTask, using the provided ServerReconfigureFeaturesAction

func (*ServerTask) MergeServerReconfigureSharedFsAction added in v0.6.1

func (t *ServerTask) MergeServerReconfigureSharedFsAction(v ServerReconfigureSharedFsAction) error

MergeServerReconfigureSharedFsAction performs a merge with any union data inside the ServerTask, using the provided ServerReconfigureSharedFsAction

func (*ServerTask) MergeServerRestartAction added in v0.6.1

func (t *ServerTask) MergeServerRestartAction(v ServerRestartAction) error

MergeServerRestartAction performs a merge with any union data inside the ServerTask, using the provided ServerRestartAction

func (*ServerTask) MergeServerRestartComputeAction added in v0.6.1

func (t *ServerTask) MergeServerRestartComputeAction(v ServerRestartComputeAction) error

MergeServerRestartComputeAction performs a merge with any union data inside the ServerTask, using the provided ServerRestartComputeAction

func (*ServerTask) MergeServerRestartComputeSpawnerAction added in v0.6.1

func (t *ServerTask) MergeServerRestartComputeSpawnerAction(v ServerRestartComputeSpawnerAction) error

MergeServerRestartComputeSpawnerAction performs a merge with any union data inside the ServerTask, using the provided ServerRestartComputeSpawnerAction

func (*ServerTask) MergeServerUnquarantineAction added in v0.6.3

func (t *ServerTask) MergeServerUnquarantineAction(v ServerUnquarantineAction) error

MergeServerUnquarantineAction performs a merge with any union data inside the ServerTask, using the provided ServerUnquarantineAction

func (*ServerTask) UnmarshalJSON added in v0.6.1

func (t *ServerTask) UnmarshalJSON(b []byte) error

func (ServerTask) ValueByDiscriminator added in v0.6.1

func (t ServerTask) ValueByDiscriminator() (interface{}, error)

type ServerUnquarantineAction added in v0.6.3

type ServerUnquarantineAction struct {
	// Action The action to take.
	Action   ServerUnquarantineActionAction `json:"action"`
	Contents struct {
		Cluster string `json:"cluster"`
	} `json:"contents"`
}

ServerUnquarantineAction defines model for ServerUnquarantineAction.

type ServerUnquarantineActionAction added in v0.6.3

type ServerUnquarantineActionAction string

ServerUnquarantineActionAction The action to take.

const (
	Unquarantine ServerUnquarantineActionAction = "unquarantine"
)

Defines values for ServerUnquarantineActionAction.

type ServersIncludes

type ServersIncludes map[string]Server

ServersIncludes A resource that is associated with a server.

type ServiceContainerIdentifier

type ServiceContainerIdentifier string

ServiceContainerIdentifier Identifier of a service Container within an Environment.

const (
	ServiceContainerIdentifierDiscovery    ServiceContainerIdentifier = "discovery"
	ServiceContainerIdentifierGateway      ServiceContainerIdentifier = "gateway"
	ServiceContainerIdentifierLoadbalancer ServiceContainerIdentifier = "loadbalancer"
	ServiceContainerIdentifierScheduler    ServiceContainerIdentifier = "scheduler"
	ServiceContainerIdentifierVpn          ServiceContainerIdentifier = "vpn"
)

Defines values for ServiceContainerIdentifier.

type ServiceItem

type ServiceItem struct {
	// Support Information about the support component of the billing item.
	Support *struct {
		// Id A 24 character hex string used to identify a unique resource.
		Id ID `json:"id"`

		// Name The support contract name.
		Name string `json:"name"`

		// Price The price of the support contract (monthly).
		Price int `json:"price"`
	} `json:"support,omitempty"`

	// Tier Information about the tier component of the billing item.
	Tier *struct {
		// Id A 24 character hex string used to identify a unique resource.
		Id ID `json:"id"`

		// Name The support contract name.
		Name string `json:"name"`

		// Price An object holding information about term and amount that relates to a specific billing component.
		Price BillingAmount `json:"price"`
	} `json:"tier,omitempty"`
}

ServiceItem Information for an item's plan.

type Session

type Session struct {
	// ApiKey The API key ID.
	ApiKey *string `json:"api_key"`

	// Ip The IP of the account associated with the session.
	Ip    string `json:"ip"`
	Token *struct {
		ApplicationCapabilitiesVersion int `json:"application_capabilities_version"`

		// ApplicationId A 24 character hex string used to identify a unique resource.
		ApplicationId ID `json:"application_id"`
	} `json:"token"`

	// Url URL endpoint assocaited with the activity context - does not include domain.
	Url string `json:"url"`
}

Session Session info about the activity entry.

type ShutdownSignal

type ShutdownSignal string

ShutdownSignal Process signals that Cycle can be configured to send to the container on a shutdown event.

const (
	SIGHUP  ShutdownSignal = "SIGHUP"
	SIGINT  ShutdownSignal = "SIGINT"
	SIGQUIT ShutdownSignal = "SIGQUIT"
	SIGTERM ShutdownSignal = "SIGTERM"
	SIGUSR1 ShutdownSignal = "SIGUSR1"
	SIGUSR2 ShutdownSignal = "SIGUSR2"
)

Defines values for ShutdownSignal.

type SleepStep

type SleepStep struct {
	// Action The action that the step takes.
	Action  SleepStepAction `json:"action"`
	Details struct {
		// Duration A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
		Duration *Duration `json:"duration,omitempty"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

SleepStep Settings for the sleep step for a pipeline.

type SleepStepAction

type SleepStepAction string

SleepStepAction The action that the step takes.

const (
	Sleep SleepStepAction = "sleep"
)

Defines values for SleepStepAction.

type SortParam

type SortParam = []string

SortParam defines model for SortParam.

type SourceAwsEbs added in v0.6.5

type SourceAwsEbs struct {
	Details struct {
		// Auth AWS credentials for accessing EBS. Either an instance role may be used or explicit Access Key credentials may be provided.
		Auth SourceAwsEbsAuth `json:"auth"`

		// Volume Reference to the specific EBS volume to attach.
		Volume SourceAwsEbsRef `json:"volume"`
	} `json:"details"`
	Type SourceAwsEbsType `json:"type"`
}

SourceAwsEbs An AWS EBS volume source. Defines how to authenticate to AWS and which EBS volume to attach.

type SourceAwsEbsAuth added in v0.6.5

type SourceAwsEbsAuth struct {
	// AccessKeyId AWS Access Key ID to use for authentication (optional if using instance role).
	AccessKeyId *string `json:"access_key_id,omitempty"`

	// SecretAccessKey AWS Secret Access Key to use for authentication (optional if using instance role).
	SecretAccessKey *string `json:"secret_access_key,omitempty"`

	// UseInstanceRole When true, use the instance's IAM role for authentication.
	UseInstanceRole *bool `json:"use_instance_role,omitempty"`
}

SourceAwsEbsAuth AWS credentials for accessing EBS. Either an instance role may be used or explicit Access Key credentials may be provided.

type SourceAwsEbsRef added in v0.6.5

type SourceAwsEbsRef struct {
	// Az Optional AWS Availability Zone where the volume resides (for example, "us-east-1a").
	Az *string `json:"az,omitempty"`

	// VolumeId The EBS volume ID (for example, "vol-0abcd1234ef567890").
	VolumeId string `json:"volume_id"`
}

SourceAwsEbsRef Reference to the specific EBS volume to attach.

type SourceAwsEbsType added in v0.6.5

type SourceAwsEbsType string

SourceAwsEbsType defines model for SourceAwsEbs.Type.

const (
	SourceAwsEbsTypeAwsEbs SourceAwsEbsType = "aws-ebs"
)

Defines values for SourceAwsEbsType.

type SourceCephRbd added in v0.6.5

type SourceCephRbd struct {
	Details struct {
		// Image Reference to the specific RBD image to attach.
		Image SourceCephRbdImageRef `json:"image"`

		// IntegrationId A 24 character hex string used to identify a unique resource.
		IntegrationId ID `json:"integration_id"`
	} `json:"details"`
	Type SourceCephRbdType `json:"type"`
}

SourceCephRbd A Ceph RBD volume source. Defines monitor endpoints, optional cluster FSID, client identity (CephX), and the specific image to attach.

type SourceCephRbdImageRef added in v0.6.5

type SourceCephRbdImageRef struct {
	// Name Name of the RBD image.
	Name string `json:"name"`

	// Namespace Optional RBD namespace within the pool.
	Namespace *string `json:"namespace,omitempty"`

	// Pool Name of the Ceph pool containing the RBD image.
	Pool string `json:"pool"`

	// Snapshot Optional snapshot name if attaching a snapshot view of the image.
	Snapshot *string `json:"snapshot,omitempty"`
}

SourceCephRbdImageRef Reference to the specific RBD image to attach.

type SourceCephRbdType added in v0.6.5

type SourceCephRbdType string

SourceCephRbdType defines model for SourceCephRbd.Type.

const (
	CephRbd SourceCephRbdType = "ceph-rbd"
)

Defines values for SourceCephRbdType.

type SourceIncludes

type SourceIncludes struct {
	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`

	// Integrations A resource that is associated with an integration.
	Integrations *IntegrationsIncludes `json:"integrations,omitempty"`

	// IntegrationsIdentifiers A map of identifiers to an array of resource IDs that are associated with it. All IDs point to the same type of resource.
	IntegrationsIdentifiers *IdentifierIncludes `json:"integrations:identifiers,omitempty"`
}

SourceIncludes A resource associate with an image source.

type SourceSanIscsi added in v0.6.5

type SourceSanIscsi struct {
	Details struct {
		// IntegrationIds One or more iSCSI integration IDs to use for authentication.
		IntegrationIds []ID `json:"integration_ids"`

		// Lun Logical Unit Number exposed by the target(s) to attach.
		Lun int32 `json:"lun"`
	} `json:"details"`
	Type SourceSanIscsiType `json:"type"`
}

SourceSanIscsi A SAN iSCSI volume source. Defines one or more iSCSI targets and the LUN number to attach.

type SourceSanIscsiType added in v0.6.5

type SourceSanIscsiType string

SourceSanIscsiType defines model for SourceSanIscsi.Type.

const (
	SanIscsi SourceSanIscsiType = "san-iscsi"
)

Defines values for SourceSanIscsiType.

type Stack

type Stack struct {
	Acl *ACL `json:"acl"`

	// Creator A type of creator and a matching identifier.
	Creator UserScope `json:"creator"`

	// Events A collection of timestamps for each event in the Stacks lifetime.
	Events struct {
		Created   DateTime `json:"created"`
		Deleted   DateTime `json:"deleted"`
		LastBuild DateTime `json:"last_build"`
		Updated   DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Meta A list of meta fields that can be applied to this stack.
	Meta *StackMeta `json:"meta,omitempty"`

	// Name A user defined name for the stack resource.
	Name string `json:"name"`

	// Source A source for a stack to be created from.
	Source StackSource `json:"source"`
	State  StackState  `json:"state"`

	// Variables A map of default variable values used when building this stack. A variable can be added anywhere in a stack using the format `{{var}}` where `var` would be a key in this map.
	Variables *map[string]string `json:"variables,omitempty"`
}

Stack Stacks are a way to orchestrate multiple containers atomically and automatically.

type StackBuild

type StackBuild struct {
	// About Information about the stack build.
	About struct {
		// Description Information describing the stack
		Description string `json:"description"`

		// GitCommit Information about the git commit this stack build was created from.
		GitCommit *StackGitCommit `json:"git_commit,omitempty"`

		// Version Information about the version of the stack.
		Version string `json:"version"`
	} `json:"about"`

	// Events A collection of timestamps for each event in the stack build's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Instructions Additional instructions used when generating this stack build.
	Instructions StackBuildInstructions `json:"instructions"`

	// Meta A list of meta fields that can be applied to a stack build.
	Meta *StackBuildMeta `json:"meta,omitempty"`
	Spec *StackSpec      `json:"spec"`

	// StackId An identifier for the stack related to this build.
	StackId string          `json:"stack_id"`
	State   StackBuildState `json:"state"`
}

StackBuild A stack build resource.

type StackBuildAbout

type StackBuildAbout struct {
	// Description A user defined description for the build.
	Description string `json:"description"`

	// GitCommit Information about the git commit this stack build was created from.
	GitCommit *StackGitCommit `json:"git_commit,omitempty"`

	// Version A user defined version of the build.
	Version string `json:"version"`
}

StackBuildAbout Information about the stack build.

type StackBuildCreateStep

type StackBuildCreateStep struct {
	// Action The action that the step takes.
	Action  StackBuildCreateStepAction `json:"action"`
	Details struct {
		// About Information about the stack build.
		About *struct {
			// Description A user defined description for the build.
			Description string `json:"description"`

			// Version A user defined version of the build.
			Version string `json:"version"`
		} `json:"about"`

		// Instructions Additional instructions used when generating this stack build.
		Instructions *struct {
			// Git Git information specifics.
			Git *struct {
				// Type The type of information the user is passing.
				Type StackBuildCreateStepDetailsInstructionsGitType `json:"type"`

				// Value The actual value to be passed.
				Value string `json:"value"`
			} `json:"git,omitempty"`

			// Variables Custom variables applied to the stack during build. Any place in the stack where a `{{variable}}` is used is replaced with the value of the variable supplied in this map.
			Variables *map[string]string `json:"variables,omitempty"`
		} `json:"instructions"`

		// Stack An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Stack FluidIdentifier `json:"stack"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

StackBuildCreateStep Settings for creating a stack build in a pipeline.

type StackBuildCreateStepAction

type StackBuildCreateStepAction string

StackBuildCreateStepAction The action that the step takes.

const (
	StackBuildCreate StackBuildCreateStepAction = "stack.build.create"
)

Defines values for StackBuildCreateStepAction.

type StackBuildCreateStepDetailsInstructionsGitType

type StackBuildCreateStepDetailsInstructionsGitType string

StackBuildCreateStepDetailsInstructionsGitType The type of information the user is passing.

const (
	StackBuildCreateStepDetailsInstructionsGitTypeBranch StackBuildCreateStepDetailsInstructionsGitType = "branch"
	StackBuildCreateStepDetailsInstructionsGitTypeHash   StackBuildCreateStepDetailsInstructionsGitType = "hash"
	StackBuildCreateStepDetailsInstructionsGitTypeTag    StackBuildCreateStepDetailsInstructionsGitType = "tag"
)

Defines values for StackBuildCreateStepDetailsInstructionsGitType.

type StackBuildDeployAction added in v0.6.1

type StackBuildDeployAction struct {
	// Action The action the job takes.
	Action StackBuildDeployActionAction `json:"action"`

	// Contents Additional information needed for the job.
	Contents struct {
		Deployment *Deployment `json:"deployment"`

		// EnvironmentId The ID for the environment this stack build will be deployed to.
		EnvironmentId string                       `json:"environment_id"`
		Update        *StackBuildDeploymentUpdates `json:"update"`

		// Variables Custom variables applied to the stack during deploy. Any place in the stack where a `{{variable}}` is used is replaced with the value of the variable supplied in this map.
		Variables *map[string]string `json:"variables,omitempty"`
	} `json:"contents"`
}

StackBuildDeployAction defines model for StackBuildDeployAction.

type StackBuildDeployActionAction added in v0.6.1

type StackBuildDeployActionAction string

StackBuildDeployActionAction The action the job takes.

const (
	Deploy StackBuildDeployActionAction = "deploy"
)

Defines values for StackBuildDeployActionAction.

type StackBuildDeployStep

type StackBuildDeployStep struct {
	// Action The action that the step takes.
	Action  StackBuildDeployStepAction `json:"action"`
	Details struct {
		// Build An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Build      FluidIdentifier `json:"build"`
		Deployment *Deployment     `json:"deployment"`

		// Environment An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Environment FluidIdentifier              `json:"environment"`
		Update      *StackBuildDeploymentUpdates `json:"update"`

		// Variables Custom variables applied to the stack during deploy. Any place in the stack where a `{{variable}}` is used is replaced with the value of the variable supplied in this map.
		Variables *map[string]string `json:"variables,omitempty"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

StackBuildDeployStep Settings for deploying a stack build in a pipeline.

type StackBuildDeployStepAction

type StackBuildDeployStepAction string

StackBuildDeployStepAction The action that the step takes.

const (
	StackBuildDeploy StackBuildDeployStepAction = "stack.build.deploy"
)

Defines values for StackBuildDeployStepAction.

type StackBuildDeploymentUpdates

type StackBuildDeploymentUpdates struct {
	// Containers A map of the container identifiers to update within the environment.
	Containers map[string]StackDeployContainersObject `json:"containers"`

	// ScopedVariables An object that describes configuration options for scoped variables on stack build. If null, scoped variables will be ignored during deployment events.
	ScopedVariables *struct {
		// AddNew If set to true, any scoped variables that are new to the environment will be created when deployed.
		AddNew bool `json:"add_new"`

		// AssociateDeployment If set to true and `add_new` is enabled, any variables that dont exist FOR THAT DEPLOYMENT will be created.
		// If set to true and `replace_existing` is enabled, any matching variables FOR THAT DEPLOYMENT will be replaced.
		AssociateDeployment bool `json:"associate_deployment"`

		// ReplaceExisting When deploying to the environment, any scoped variables defined in the build that match an existing scoped variable in the environment will cause the existing scoped variable to be updated to the new value.
		ReplaceExisting bool `json:"replace_existing"`
	} `json:"scoped_variables"`
}

StackBuildDeploymentUpdates Optional update object used to specify specific params to update from the stack build.

type StackBuildGenerateAction added in v0.6.1

type StackBuildGenerateAction struct {
	// Action The job to do.
	Action StackBuildGenerateActionAction `json:"action"`
}

StackBuildGenerateAction defines model for StackBuildGenerateAction.

type StackBuildGenerateActionAction added in v0.6.1

type StackBuildGenerateActionAction string

StackBuildGenerateActionAction The job to do.

const (
	StackBuildGenerateActionActionGenerate StackBuildGenerateActionAction = "generate"
)

Defines values for StackBuildGenerateActionAction.

type StackBuildGenerateStep

type StackBuildGenerateStep struct {
	// Action The action that the step takes.
	Action  StackBuildGenerateStepAction `json:"action"`
	Details struct {
		// Build An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Build FluidIdentifier `json:"build"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

StackBuildGenerateStep Settings for the stack build generate step for a pipeline.

type StackBuildGenerateStepAction

type StackBuildGenerateStepAction string

StackBuildGenerateStepAction The action that the step takes.

const (
	StackBuildGenerate StackBuildGenerateStepAction = "stack.build.generate"
)

Defines values for StackBuildGenerateStepAction.

type StackBuildIncludes

type StackBuildIncludes map[string]StackBuild

StackBuildIncludes A resource that is associated with a stack build.

type StackBuildInstructions

type StackBuildInstructions struct {
	// Git Git information specifics.
	Git *struct {
		// Type The type of information the user is passing.
		Type StackBuildInstructionsGitType `json:"type"`

		// Value The actual value to be passed.
		Value string `json:"value"`
	} `json:"git,omitempty"`

	// Variables Custom variables applied to the stack during build. Any place in the stack where a `{{variable}}` is used is replaced with the value of the variable supplied in this map.
	Variables *map[string]string `json:"variables,omitempty"`
}

StackBuildInstructions Additional instructions used when generating this stack build.

type StackBuildInstructionsGitType

type StackBuildInstructionsGitType string

StackBuildInstructionsGitType The type of information the user is passing.

const (
	StackBuildInstructionsGitTypeBranch StackBuildInstructionsGitType = "branch"
	StackBuildInstructionsGitTypeHash   StackBuildInstructionsGitType = "hash"
	StackBuildInstructionsGitTypeTag    StackBuildInstructionsGitType = "tag"
)

Defines values for StackBuildInstructionsGitType.

type StackBuildLog

type StackBuildLog struct {
	// BuildId The ID of stack build the build log pertains to.
	BuildId string `json:"build_id"`

	// Events A collection of timestamps for each event in the build log's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Log The log itself.
	Log string `json:"log"`

	// StackId The ID of stack the build log pertains to.
	StackId string `json:"stack_id"`
}

StackBuildLog A build log for a given stack build.

type StackBuildMeta

type StackBuildMeta struct {
	// ContainersCount A summary of resources by state
	ContainersCount *StateCountSummary `json:"containers_count,omitempty"`
}

StackBuildMeta A list of meta fields that can be applied to a stack build.

type StackBuildState

type StackBuildState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the stack build.
	Current StackBuildStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

StackBuildState defines model for StackBuildState.

type StackBuildStateCurrent

type StackBuildStateCurrent string

StackBuildStateCurrent The current state of the stack build.

const (
	StackBuildStateCurrentBuilding  StackBuildStateCurrent = "building"
	StackBuildStateCurrentDeleted   StackBuildStateCurrent = "deleted"
	StackBuildStateCurrentDeleting  StackBuildStateCurrent = "deleting"
	StackBuildStateCurrentDeploying StackBuildStateCurrent = "deploying"
	StackBuildStateCurrentImporting StackBuildStateCurrent = "importing"
	StackBuildStateCurrentLive      StackBuildStateCurrent = "live"
	StackBuildStateCurrentNew       StackBuildStateCurrent = "new"
	StackBuildStateCurrentSaving    StackBuildStateCurrent = "saving"
	StackBuildStateCurrentVerifying StackBuildStateCurrent = "verifying"
)

Defines values for StackBuildStateCurrent.

type StackBuildTask added in v0.6.1

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

StackBuildTask defines model for StackBuildTask.

func (StackBuildTask) AsStackBuildDeployAction added in v0.6.1

func (t StackBuildTask) AsStackBuildDeployAction() (StackBuildDeployAction, error)

AsStackBuildDeployAction returns the union data inside the StackBuildTask as a StackBuildDeployAction

func (StackBuildTask) AsStackBuildGenerateAction added in v0.6.1

func (t StackBuildTask) AsStackBuildGenerateAction() (StackBuildGenerateAction, error)

AsStackBuildGenerateAction returns the union data inside the StackBuildTask as a StackBuildGenerateAction

func (StackBuildTask) Discriminator added in v0.6.1

func (t StackBuildTask) Discriminator() (string, error)

func (*StackBuildTask) FromStackBuildDeployAction added in v0.6.1

func (t *StackBuildTask) FromStackBuildDeployAction(v StackBuildDeployAction) error

FromStackBuildDeployAction overwrites any union data inside the StackBuildTask as the provided StackBuildDeployAction

func (*StackBuildTask) FromStackBuildGenerateAction added in v0.6.1

func (t *StackBuildTask) FromStackBuildGenerateAction(v StackBuildGenerateAction) error

FromStackBuildGenerateAction overwrites any union data inside the StackBuildTask as the provided StackBuildGenerateAction

func (StackBuildTask) MarshalJSON added in v0.6.1

func (t StackBuildTask) MarshalJSON() ([]byte, error)

func (*StackBuildTask) MergeStackBuildDeployAction added in v0.6.1

func (t *StackBuildTask) MergeStackBuildDeployAction(v StackBuildDeployAction) error

MergeStackBuildDeployAction performs a merge with any union data inside the StackBuildTask, using the provided StackBuildDeployAction

func (*StackBuildTask) MergeStackBuildGenerateAction added in v0.6.1

func (t *StackBuildTask) MergeStackBuildGenerateAction(v StackBuildGenerateAction) error

MergeStackBuildGenerateAction performs a merge with any union data inside the StackBuildTask, using the provided StackBuildGenerateAction

func (*StackBuildTask) UnmarshalJSON added in v0.6.1

func (t *StackBuildTask) UnmarshalJSON(b []byte) error

func (StackBuildTask) ValueByDiscriminator added in v0.6.1

func (t StackBuildTask) ValueByDiscriminator() (interface{}, error)

type StackDeployContainersObject

type StackDeployContainersObject struct {
	// Reconfigure A boolean where true represents the container is to be reconfigured.
	Reconfigure bool `json:"reconfigure"`

	// Reimage A boolean where true represents the container is to be reimaged.
	Reimage bool `json:"reimage"`
}

StackDeployContainersObject Options to control how a container behaves when a stack build is deployed.

type StackGitCommit

type StackGitCommit struct {
	// Author Inforamtion about the author of the commit.
	Author struct {
		// Email The commit authors email address.
		Email string `json:"email"`

		// Name The commit authors name.
		Name string `json:"name"`
	} `json:"author"`

	// Hash The commit hash for the given stack build.
	Hash string `json:"hash"`

	// Message The commit message for the given stack build hash.
	Message string   `json:"message"`
	Time    DateTime `json:"time"`
}

StackGitCommit Information about the git commit this stack build was created from.

type StackImageSourceType

type StackImageSourceType struct {
	Details struct {
		Containers []Identifier `json:"containers"`
		Id         string       `json:"id"`

		// Origin The origin of the image.
		Origin  ImageOrigin `json:"origin"`
		StackId string      `json:"stack_id"`
	} `json:"details"`
	Override *struct {
		Target   *string `json:"target,omitempty"`
		TargzUrl *string `json:"targz_url,omitempty"`
	} `json:"override,omitempty"`
	Type StackImageSourceTypeType `json:"type"`
}

StackImageSourceType defines model for StackImageSourceType.

type StackImageSourceTypeType

type StackImageSourceTypeType string

StackImageSourceTypeType defines model for StackImageSourceType.Type.

const (
	StackImageSourceTypeTypeStackBuild StackImageSourceTypeType = "stack-build"
)

Defines values for StackImageSourceTypeType.

type StackInclude

type StackInclude struct {
	// Creators An identity that created a resource.
	Creators *CreatorInclude `json:"creators,omitempty"`
}

StackInclude All includable resources linkable to the given stack.

type StackIncludes

type StackIncludes map[string]Stack

StackIncludes A resource associated with a stack.

type StackMeta

type StackMeta struct {
	// BuildsCount A summary of resources by state
	BuildsCount *StateCountSummary `json:"builds_count,omitempty"`

	// ContainersCount A summary of resources by state
	ContainersCount *StateCountSummary `json:"containers_count,omitempty"`
}

StackMeta A list of meta fields that can be applied to this stack.

type StackPruneStep

type StackPruneStep struct {
	// Action The action that the step takes.
	Action  StackPruneStepAction `json:"action"`
	Details struct {
		Criteria *struct {
			Expire *Duration `json:"expire"`
		} `json:"criteria"`

		// Stack An identifier used in pipelines to refer to different kinds of resources across Cycle.
		//
		// - `id:<mongo id>`: A raw resource ID
		// - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
		// - `from:<stage/step>`: For referencing a previous pipeline step.
		Stack FluidIdentifier `json:"stack"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

StackPruneStep Settings for pruning a stack in a pipeline.

type StackPruneStepAction

type StackPruneStepAction string

StackPruneStepAction The action that the step takes.

const (
	StackPrune StackPruneStepAction = "stack.prune"
)

Defines values for StackPruneStepAction.

type StackRawSource

type StackRawSource struct {
	Details *StackSpec         `json:"details"`
	Type    StackRawSourceType `json:"type"`
}

StackRawSource A stack spec resource.

type StackRawSourceType

type StackRawSourceType string

StackRawSourceType defines model for StackRawSource.Type.

const (
	StackRawSourceTypeRaw StackRawSourceType = "raw"
)

Defines values for StackRawSourceType.

type StackRepoSource

type StackRepoSource struct {
	Details struct {
		// Auth Authentication information for the repository.
		Auth *StackRepoSource_Details_Auth `json:"auth,omitempty"`

		// Branch An optional branch arguement.  Default value is `master`.
		Branch *string `json:"branch,omitempty"`

		// Ref Repository reference information.
		Ref *struct {
			// Type The type of reference being used.
			Type string `json:"type"`

			// Value The value for the given reference type.
			Value string `json:"value"`
		} `json:"ref,omitempty"`

		// StackFile Specify which file in the repo contains the stack spec. By default, it is `cycle.json` in the root of the repo.
		StackFile *string `json:"stack_file"`

		// Url The URL of the repository.
		Url string `json:"url"`
	} `json:"details"`
	Type StackRepoSourceType `json:"type"`
}

StackRepoSource A repo source type for a stack.

type StackRepoSourceType

type StackRepoSourceType string

StackRepoSourceType defines model for StackRepoSource.Type.

const (
	GitRepo StackRepoSourceType = "git-repo"
)

Defines values for StackRepoSourceType.

type StackRepoSource_Details_Auth

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

StackRepoSource_Details_Auth Authentication information for the repository.

func (StackRepoSource_Details_Auth) AsCredentialsHTTP

func (t StackRepoSource_Details_Auth) AsCredentialsHTTP() (CredentialsHTTP, error)

AsCredentialsHTTP returns the union data inside the StackRepoSource_Details_Auth as a CredentialsHTTP

func (StackRepoSource_Details_Auth) AsCredentialsSSH

func (t StackRepoSource_Details_Auth) AsCredentialsSSH() (CredentialsSSH, error)

AsCredentialsSSH returns the union data inside the StackRepoSource_Details_Auth as a CredentialsSSH

func (StackRepoSource_Details_Auth) Discriminator

func (t StackRepoSource_Details_Auth) Discriminator() (string, error)

func (*StackRepoSource_Details_Auth) FromCredentialsHTTP

func (t *StackRepoSource_Details_Auth) FromCredentialsHTTP(v CredentialsHTTP) error

FromCredentialsHTTP overwrites any union data inside the StackRepoSource_Details_Auth as the provided CredentialsHTTP

func (*StackRepoSource_Details_Auth) FromCredentialsSSH

func (t *StackRepoSource_Details_Auth) FromCredentialsSSH(v CredentialsSSH) error

FromCredentialsSSH overwrites any union data inside the StackRepoSource_Details_Auth as the provided CredentialsSSH

func (StackRepoSource_Details_Auth) MarshalJSON

func (t StackRepoSource_Details_Auth) MarshalJSON() ([]byte, error)

func (*StackRepoSource_Details_Auth) MergeCredentialsHTTP

func (t *StackRepoSource_Details_Auth) MergeCredentialsHTTP(v CredentialsHTTP) error

MergeCredentialsHTTP performs a merge with any union data inside the StackRepoSource_Details_Auth, using the provided CredentialsHTTP

func (*StackRepoSource_Details_Auth) MergeCredentialsSSH

func (t *StackRepoSource_Details_Auth) MergeCredentialsSSH(v CredentialsSSH) error

MergeCredentialsSSH performs a merge with any union data inside the StackRepoSource_Details_Auth, using the provided CredentialsSSH

func (*StackRepoSource_Details_Auth) UnmarshalJSON

func (t *StackRepoSource_Details_Auth) UnmarshalJSON(b []byte) error

func (StackRepoSource_Details_Auth) ValueByDiscriminator

func (t StackRepoSource_Details_Auth) ValueByDiscriminator() (interface{}, error)

type StackSource

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

StackSource A source for a stack to be created from.

func (StackSource) AsStackRawSource

func (t StackSource) AsStackRawSource() (StackRawSource, error)

AsStackRawSource returns the union data inside the StackSource as a StackRawSource

func (StackSource) AsStackRepoSource

func (t StackSource) AsStackRepoSource() (StackRepoSource, error)

AsStackRepoSource returns the union data inside the StackSource as a StackRepoSource

func (StackSource) Discriminator

func (t StackSource) Discriminator() (string, error)

func (*StackSource) FromStackRawSource

func (t *StackSource) FromStackRawSource(v StackRawSource) error

FromStackRawSource overwrites any union data inside the StackSource as the provided StackRawSource

func (*StackSource) FromStackRepoSource

func (t *StackSource) FromStackRepoSource(v StackRepoSource) error

FromStackRepoSource overwrites any union data inside the StackSource as the provided StackRepoSource

func (StackSource) MarshalJSON

func (t StackSource) MarshalJSON() ([]byte, error)

func (*StackSource) MergeStackRawSource

func (t *StackSource) MergeStackRawSource(v StackRawSource) error

MergeStackRawSource performs a merge with any union data inside the StackSource, using the provided StackRawSource

func (*StackSource) MergeStackRepoSource

func (t *StackSource) MergeStackRepoSource(v StackRepoSource) error

MergeStackRepoSource performs a merge with any union data inside the StackSource, using the provided StackRepoSource

func (*StackSource) UnmarshalJSON

func (t *StackSource) UnmarshalJSON(b []byte) error

func (StackSource) ValueByDiscriminator

func (t StackSource) ValueByDiscriminator() (interface{}, error)

type StackSpec

type StackSpec struct {
	About *StackSpec_About `json:"about,omitempty"`

	// Annotations Additional meta info about the stack.
	Annotations *StackSpec_Annotations `json:"annotations,omitempty"`
	Containers  StackSpec_Containers   `json:"containers"`

	// Monitoring Monitoring options for containers within this stack.
	Monitoring *StackSpec_Monitoring `json:"monitoring,omitempty"`

	// ScopedVariables Describes variables that are assigned to one or more containers at runtime. Can be assigned as an environment variable, written as a file inside the container(s), or accessed over the internal API.
	ScopedVariables *StackSpec_ScopedVariables `json:"scoped_variables,omitempty"`

	// Services Settings for any auxillary services deployed as part of the environment, such as load balancer and discovery services.
	Services *StackSpec_Services `json:"services,omitempty"`

	// Version The version of the Cycle stack file used.
	Version StackSpecVersion `json:"version"`
}

StackSpec A Cycle stack file is an "environment as code". This allows an environment to be generated consistently based on a fixed specification. Stack files can describe multiple containers and their configurations, environment service settings, scoped variables, and important metadata.

type StackSpecAbout0

type StackSpecAbout0 struct {
	// Description Custom, user-defined details about this stack.
	Description string `json:"description"`

	// Version A custom, user-defined version of the stack.
	Version string `json:"version"`
}

StackSpecAbout0 defines model for .

type StackSpecAnnotations0

type StackSpecAnnotations0 map[string]interface{}

StackSpecAnnotations0 defines model for .

type StackSpecContainer

type StackSpecContainer struct {
	Annotations *StackSpecContainer_Annotations `json:"annotations,omitempty"`
	Config      StackSpecContainer_Config       `json:"config"`

	// Deprecate If true, the container is marked as `deprecated`, and cannot be started anymore. Deprecated containers also don't count toward resource utilization.
	Deprecate *StackSpecContainer_Deprecate `json:"deprecate,omitempty"`

	// Image Details about the image used for this container.
	Image StackSpecContainer_Image `json:"image"`

	// Lock If true, the container is marked as `locked` and cannot be deleted in any way until the lock is lifted.
	Lock *StackSpecContainer_Lock `json:"lock,omitempty"`

	// Name The human-readable name of this container.
	Name string `json:"name"`

	// Role The role applied to this container. **Not yet implemented**
	Role *StackSpecContainerRole `json:"role"`

	// Stateful Whether or not to mark the container as stateful when deployed. Stateful containers can utilize volumes (stateful data) and are generally used for running databases or other data management applications.
	Stateful StackSpecContainer_Stateful `json:"stateful"`

	// Volumes A list of configurations for volumes that will be attached to the container. Only applicable if the container is set to `stateful`.
	Volumes *StackSpecContainer_Volumes `json:"volumes,omitempty"`
}

StackSpecContainer A container template defined within a stack.

type StackSpecContainerAnnotations0

type StackSpecContainerAnnotations0 map[string]interface{}

StackSpecContainerAnnotations0 Additional user-provided meta data about the container.

type StackSpecContainerConfig0

type StackSpecContainerConfig0 struct {
	Deploy       StackSpecContainer_Config_0_Deploy  `json:"deploy"`
	Integrations *StackVariable                      `json:"integrations"`
	Network      StackSpecContainer_Config_0_Network `json:"network"`
	Resources    *StackVariable                      `json:"resources"`
	Runtime      *StackVariable                      `json:"runtime"`

	// Scaling Configuration options for auto-scaling.
	Scaling *StackVariable `json:"scaling"`
}

StackSpecContainerConfig0 Configuration options for this container that will be applied when deployed as part of the stack.

type StackSpecContainerConfigDeploy

type StackSpecContainerConfigDeploy struct {
	// Constraints A variable specified in a stack spec.
	Constraints *StackVariable `json:"constraints,omitempty"`

	// Function A variable specified in a stack spec.
	Function *StackVariable `json:"function,omitempty"`

	// HealthCheck A variable specified in a stack spec.
	HealthCheck *StackVariable `json:"health_check,omitempty"`

	// Instances The number of desired instances to deploy.
	Instances StackSpecContainerConfigDeploy_Instances `json:"instances"`

	// ReadinessCheck A variable specified in a stack spec.
	ReadinessCheck *StackVariable `json:"readiness_check,omitempty"`

	// Restart A variable specified in a stack spec.
	Restart *StackVariable `json:"restart,omitempty"`

	// Shutdown A variable specified in a stack spec.
	Shutdown *StackVariable `json:"shutdown,omitempty"`

	// Startup A variable specified in a stack spec.
	Startup *StackVariable `json:"startup,omitempty"`

	// Stateful A variable specified in a stack spec.
	Stateful *StackVariable `json:"stateful,omitempty"`

	// Strategy A variable specified in a stack spec.
	Strategy *StackVariable `json:"strategy,omitempty"`

	// Telemetry A variable specified in a stack spec.
	Telemetry *StackVariable `json:"telemetry,omitempty"`

	// Update A variable specified in a stack spec.
	Update *StackVariable `json:"update,omitempty"`
}

StackSpecContainerConfigDeploy Stack configuration options related to how the container behaves over its lifecycle (startup, shutdown, health checks, etc).

type StackSpecContainerConfigDeployInstances0

type StackSpecContainerConfigDeployInstances0 = int

StackSpecContainerConfigDeployInstances0 defines model for .

type StackSpecContainerConfigDeploy_Instances

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

StackSpecContainerConfigDeploy_Instances The number of desired instances to deploy.

func (StackSpecContainerConfigDeploy_Instances) AsStackSpecContainerConfigDeployInstances0

func (t StackSpecContainerConfigDeploy_Instances) AsStackSpecContainerConfigDeployInstances0() (StackSpecContainerConfigDeployInstances0, error)

AsStackSpecContainerConfigDeployInstances0 returns the union data inside the StackSpecContainerConfigDeploy_Instances as a StackSpecContainerConfigDeployInstances0

func (StackSpecContainerConfigDeploy_Instances) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainerConfigDeploy_Instances as a StackVariable

func (*StackSpecContainerConfigDeploy_Instances) FromStackSpecContainerConfigDeployInstances0

func (t *StackSpecContainerConfigDeploy_Instances) FromStackSpecContainerConfigDeployInstances0(v StackSpecContainerConfigDeployInstances0) error

FromStackSpecContainerConfigDeployInstances0 overwrites any union data inside the StackSpecContainerConfigDeploy_Instances as the provided StackSpecContainerConfigDeployInstances0

func (*StackSpecContainerConfigDeploy_Instances) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecContainerConfigDeploy_Instances as the provided StackVariable

func (StackSpecContainerConfigDeploy_Instances) MarshalJSON

func (*StackSpecContainerConfigDeploy_Instances) MergeStackSpecContainerConfigDeployInstances0

func (t *StackSpecContainerConfigDeploy_Instances) MergeStackSpecContainerConfigDeployInstances0(v StackSpecContainerConfigDeployInstances0) error

MergeStackSpecContainerConfigDeployInstances0 performs a merge with any union data inside the StackSpecContainerConfigDeploy_Instances, using the provided StackSpecContainerConfigDeployInstances0

func (*StackSpecContainerConfigDeploy_Instances) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecContainerConfigDeploy_Instances, using the provided StackVariable

func (*StackSpecContainerConfigDeploy_Instances) UnmarshalJSON

func (t *StackSpecContainerConfigDeploy_Instances) UnmarshalJSON(b []byte) error

type StackSpecContainerConfigNetwork

type StackSpecContainerConfigNetwork struct {
	// Hostname The hostname of the container. This is how it can be referenced by other containers in the same environment.
	Hostname string `json:"hostname"`

	// Ports A list of port mappings on this container.
	Ports *StackSpecContainerConfigNetwork_Ports `json:"ports,omitempty"`

	// Public The level of public network access this container should have.
	Public string `json:"public"`
}

StackSpecContainerConfigNetwork Stack configuration options related to the container's network.

type StackSpecContainerConfigNetworkPorts0

type StackSpecContainerConfigNetworkPorts0 = []string

StackSpecContainerConfigNetworkPorts0 defines model for .

type StackSpecContainerConfigNetwork_Ports

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

StackSpecContainerConfigNetwork_Ports A list of port mappings on this container.

func (StackSpecContainerConfigNetwork_Ports) AsStackSpecContainerConfigNetworkPorts0

func (t StackSpecContainerConfigNetwork_Ports) AsStackSpecContainerConfigNetworkPorts0() (StackSpecContainerConfigNetworkPorts0, error)

AsStackSpecContainerConfigNetworkPorts0 returns the union data inside the StackSpecContainerConfigNetwork_Ports as a StackSpecContainerConfigNetworkPorts0

func (StackSpecContainerConfigNetwork_Ports) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainerConfigNetwork_Ports as a StackVariable

func (*StackSpecContainerConfigNetwork_Ports) FromStackSpecContainerConfigNetworkPorts0

func (t *StackSpecContainerConfigNetwork_Ports) FromStackSpecContainerConfigNetworkPorts0(v StackSpecContainerConfigNetworkPorts0) error

FromStackSpecContainerConfigNetworkPorts0 overwrites any union data inside the StackSpecContainerConfigNetwork_Ports as the provided StackSpecContainerConfigNetworkPorts0

func (*StackSpecContainerConfigNetwork_Ports) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecContainerConfigNetwork_Ports as the provided StackVariable

func (StackSpecContainerConfigNetwork_Ports) MarshalJSON

func (t StackSpecContainerConfigNetwork_Ports) MarshalJSON() ([]byte, error)

func (*StackSpecContainerConfigNetwork_Ports) MergeStackSpecContainerConfigNetworkPorts0

func (t *StackSpecContainerConfigNetwork_Ports) MergeStackSpecContainerConfigNetworkPorts0(v StackSpecContainerConfigNetworkPorts0) error

MergeStackSpecContainerConfigNetworkPorts0 performs a merge with any union data inside the StackSpecContainerConfigNetwork_Ports, using the provided StackSpecContainerConfigNetworkPorts0

func (*StackSpecContainerConfigNetwork_Ports) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecContainerConfigNetwork_Ports, using the provided StackVariable

func (*StackSpecContainerConfigNetwork_Ports) UnmarshalJSON

func (t *StackSpecContainerConfigNetwork_Ports) UnmarshalJSON(b []byte) error

type StackSpecContainerDeprecate0

type StackSpecContainerDeprecate0 = bool

StackSpecContainerDeprecate0 defines model for .

type StackSpecContainerImage

type StackSpecContainerImage struct {
	// Build Additional details applied when building an image.
	Build *StackSpecContainerImage_Build `json:"build,omitempty"`

	// Builder A specific builder to use. By default, Cycle uses its factory service and a standard build command to build images, but this can be enhanced by using an image builder integration.
	Builder *StackSpecContainerImage_Builder `json:"builder,omitempty"`

	// Name The human-readable name of this image.
	Name *string `json:"name,omitempty"`

	// Origin Instructions on how to fetch or build this image.
	Origin StackSpecContainerImage_Origin `json:"origin"`
}

StackSpecContainerImage defines model for StackSpecContainerImage.

type StackSpecContainerImageBuild0

type StackSpecContainerImageBuild0 struct {
	// Args A map of build arguments applied to the image at build time.
	Args *StackSpecContainerImage_Build_0_Args `json:"args,omitempty"`

	// UseDisk If true, will skip using /dev/shm when building an image on factory, which is limited to `6.5GB`. Allows for building much larger images, up to `20GB`.
	UseDisk *bool `json:"use_disk,omitempty"`
}

StackSpecContainerImageBuild0 defines model for .

type StackSpecContainerImageBuild0Args0

type StackSpecContainerImageBuild0Args0 map[string]string

StackSpecContainerImageBuild0Args0 defines model for .

type StackSpecContainerImageBuilder0

type StackSpecContainerImageBuilder0 struct {
	// IntegrationId Either a resource ID (objectid - i.e. 651586fca6078e98982dbd90) or a resource Identifier (human-readable)
	IntegrationId HybridIdentifier `json:"integration_id"`
}

StackSpecContainerImageBuilder0 defines model for .

type StackSpecContainerImage_Build

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

StackSpecContainerImage_Build Additional details applied when building an image.

func (StackSpecContainerImage_Build) AsStackSpecContainerImageBuild0

func (t StackSpecContainerImage_Build) AsStackSpecContainerImageBuild0() (StackSpecContainerImageBuild0, error)

AsStackSpecContainerImageBuild0 returns the union data inside the StackSpecContainerImage_Build as a StackSpecContainerImageBuild0

func (StackSpecContainerImage_Build) AsStackVariable

func (t StackSpecContainerImage_Build) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainerImage_Build as a StackVariable

func (*StackSpecContainerImage_Build) FromStackSpecContainerImageBuild0

func (t *StackSpecContainerImage_Build) FromStackSpecContainerImageBuild0(v StackSpecContainerImageBuild0) error

FromStackSpecContainerImageBuild0 overwrites any union data inside the StackSpecContainerImage_Build as the provided StackSpecContainerImageBuild0

func (*StackSpecContainerImage_Build) FromStackVariable

func (t *StackSpecContainerImage_Build) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainerImage_Build as the provided StackVariable

func (StackSpecContainerImage_Build) MarshalJSON

func (t StackSpecContainerImage_Build) MarshalJSON() ([]byte, error)

func (*StackSpecContainerImage_Build) MergeStackSpecContainerImageBuild0

func (t *StackSpecContainerImage_Build) MergeStackSpecContainerImageBuild0(v StackSpecContainerImageBuild0) error

MergeStackSpecContainerImageBuild0 performs a merge with any union data inside the StackSpecContainerImage_Build, using the provided StackSpecContainerImageBuild0

func (*StackSpecContainerImage_Build) MergeStackVariable

func (t *StackSpecContainerImage_Build) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainerImage_Build, using the provided StackVariable

func (*StackSpecContainerImage_Build) UnmarshalJSON

func (t *StackSpecContainerImage_Build) UnmarshalJSON(b []byte) error

type StackSpecContainerImage_Build_0_Args

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

StackSpecContainerImage_Build_0_Args A map of build arguments applied to the image at build time.

func (StackSpecContainerImage_Build_0_Args) AsStackSpecContainerImageBuild0Args0

func (t StackSpecContainerImage_Build_0_Args) AsStackSpecContainerImageBuild0Args0() (StackSpecContainerImageBuild0Args0, error)

AsStackSpecContainerImageBuild0Args0 returns the union data inside the StackSpecContainerImage_Build_0_Args as a StackSpecContainerImageBuild0Args0

func (StackSpecContainerImage_Build_0_Args) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainerImage_Build_0_Args as a StackVariable

func (*StackSpecContainerImage_Build_0_Args) FromStackSpecContainerImageBuild0Args0

func (t *StackSpecContainerImage_Build_0_Args) FromStackSpecContainerImageBuild0Args0(v StackSpecContainerImageBuild0Args0) error

FromStackSpecContainerImageBuild0Args0 overwrites any union data inside the StackSpecContainerImage_Build_0_Args as the provided StackSpecContainerImageBuild0Args0

func (*StackSpecContainerImage_Build_0_Args) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecContainerImage_Build_0_Args as the provided StackVariable

func (StackSpecContainerImage_Build_0_Args) MarshalJSON

func (t StackSpecContainerImage_Build_0_Args) MarshalJSON() ([]byte, error)

func (*StackSpecContainerImage_Build_0_Args) MergeStackSpecContainerImageBuild0Args0

func (t *StackSpecContainerImage_Build_0_Args) MergeStackSpecContainerImageBuild0Args0(v StackSpecContainerImageBuild0Args0) error

MergeStackSpecContainerImageBuild0Args0 performs a merge with any union data inside the StackSpecContainerImage_Build_0_Args, using the provided StackSpecContainerImageBuild0Args0

func (*StackSpecContainerImage_Build_0_Args) MergeStackVariable

func (t *StackSpecContainerImage_Build_0_Args) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainerImage_Build_0_Args, using the provided StackVariable

func (*StackSpecContainerImage_Build_0_Args) UnmarshalJSON

func (t *StackSpecContainerImage_Build_0_Args) UnmarshalJSON(b []byte) error

type StackSpecContainerImage_Builder

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

StackSpecContainerImage_Builder A specific builder to use. By default, Cycle uses its factory service and a standard build command to build images, but this can be enhanced by using an image builder integration.

func (StackSpecContainerImage_Builder) AsStackSpecContainerImageBuilder0

func (t StackSpecContainerImage_Builder) AsStackSpecContainerImageBuilder0() (StackSpecContainerImageBuilder0, error)

AsStackSpecContainerImageBuilder0 returns the union data inside the StackSpecContainerImage_Builder as a StackSpecContainerImageBuilder0

func (StackSpecContainerImage_Builder) AsStackVariable

func (t StackSpecContainerImage_Builder) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainerImage_Builder as a StackVariable

func (*StackSpecContainerImage_Builder) FromStackSpecContainerImageBuilder0

func (t *StackSpecContainerImage_Builder) FromStackSpecContainerImageBuilder0(v StackSpecContainerImageBuilder0) error

FromStackSpecContainerImageBuilder0 overwrites any union data inside the StackSpecContainerImage_Builder as the provided StackSpecContainerImageBuilder0

func (*StackSpecContainerImage_Builder) FromStackVariable

func (t *StackSpecContainerImage_Builder) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainerImage_Builder as the provided StackVariable

func (StackSpecContainerImage_Builder) MarshalJSON

func (t StackSpecContainerImage_Builder) MarshalJSON() ([]byte, error)

func (*StackSpecContainerImage_Builder) MergeStackSpecContainerImageBuilder0

func (t *StackSpecContainerImage_Builder) MergeStackSpecContainerImageBuilder0(v StackSpecContainerImageBuilder0) error

MergeStackSpecContainerImageBuilder0 performs a merge with any union data inside the StackSpecContainerImage_Builder, using the provided StackSpecContainerImageBuilder0

func (*StackSpecContainerImage_Builder) MergeStackVariable

func (t *StackSpecContainerImage_Builder) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainerImage_Builder, using the provided StackVariable

func (*StackSpecContainerImage_Builder) UnmarshalJSON

func (t *StackSpecContainerImage_Builder) UnmarshalJSON(b []byte) error

type StackSpecContainerImage_Origin

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

StackSpecContainerImage_Origin Instructions on how to fetch or build this image.

func (StackSpecContainerImage_Origin) AsStackSpecImageOrigin

func (t StackSpecContainerImage_Origin) AsStackSpecImageOrigin() (StackSpecImageOrigin, error)

AsStackSpecImageOrigin returns the union data inside the StackSpecContainerImage_Origin as a StackSpecImageOrigin

func (StackSpecContainerImage_Origin) AsStackVariable

func (t StackSpecContainerImage_Origin) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainerImage_Origin as a StackVariable

func (*StackSpecContainerImage_Origin) FromStackSpecImageOrigin

func (t *StackSpecContainerImage_Origin) FromStackSpecImageOrigin(v StackSpecImageOrigin) error

FromStackSpecImageOrigin overwrites any union data inside the StackSpecContainerImage_Origin as the provided StackSpecImageOrigin

func (*StackSpecContainerImage_Origin) FromStackVariable

func (t *StackSpecContainerImage_Origin) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainerImage_Origin as the provided StackVariable

func (StackSpecContainerImage_Origin) MarshalJSON

func (t StackSpecContainerImage_Origin) MarshalJSON() ([]byte, error)

func (*StackSpecContainerImage_Origin) MergeStackSpecImageOrigin

func (t *StackSpecContainerImage_Origin) MergeStackSpecImageOrigin(v StackSpecImageOrigin) error

MergeStackSpecImageOrigin performs a merge with any union data inside the StackSpecContainerImage_Origin, using the provided StackSpecImageOrigin

func (*StackSpecContainerImage_Origin) MergeStackVariable

func (t *StackSpecContainerImage_Origin) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainerImage_Origin, using the provided StackVariable

func (*StackSpecContainerImage_Origin) UnmarshalJSON

func (t *StackSpecContainerImage_Origin) UnmarshalJSON(b []byte) error

type StackSpecContainerLock0

type StackSpecContainerLock0 = bool

StackSpecContainerLock0 defines model for .

type StackSpecContainerRole

type StackSpecContainerRole string

StackSpecContainerRole The role applied to this container. **Not yet implemented**

const (
	Conductor StackSpecContainerRole = "conductor"
)

Defines values for StackSpecContainerRole.

type StackSpecContainerStateful0

type StackSpecContainerStateful0 = bool

StackSpecContainerStateful0 defines model for .

type StackSpecContainerVolume

type StackSpecContainerVolume struct {
	// BlockDevice Indicates that the volume will be used as unformatted block storage.
	BlockDevice *StackSpecContainerVolume_BlockDevice `json:"block_device,omitempty"`

	// Destination The path this volume should be mounted at inside the container.
	Destination string         `json:"destination"`
	External    *StackVariable `json:"external"`

	// Local Configuration options for local volumes.
	Local *StackSpecContainerVolume_Local `json:"local,omitempty"`

	// ReadOnly If true, the container will be unable to write data to the volume.
	ReadOnly *StackSpecContainerVolume_ReadOnly `json:"read_only,omitempty"`

	// RemoteAccess Configuration options for setting up remote access to this volume via SFTP.
	RemoteAccess *StackSpecContainerVolume_RemoteAccess `json:"remote_access,omitempty"`
}

StackSpecContainerVolume A container volume configuration.

type StackSpecContainerVolumeBlockDevice0

type StackSpecContainerVolumeBlockDevice0 = bool

StackSpecContainerVolumeBlockDevice0 defines model for .

type StackSpecContainerVolumeLocal0

type StackSpecContainerVolumeLocal0 struct {
	// MaxSize The maximum size this volume can grow to. Container volumes on Cycle are thinly provisioned, meaning this isn't an allocation - the volume will only use the space it needs up to this size.
	MaxSize string `json:"max_size"`

	// StoragePool A boolean where true signifies using the largest drive over 2TB for the target server.
	StoragePool *StackSpecContainerVolume_Local_0_StoragePool `json:"storage_pool,omitempty"`
}

StackSpecContainerVolumeLocal0 defines model for .

type StackSpecContainerVolumeLocal0StoragePool0

type StackSpecContainerVolumeLocal0StoragePool0 = bool

StackSpecContainerVolumeLocal0StoragePool0 defines model for .

type StackSpecContainerVolumeReadOnly0

type StackSpecContainerVolumeReadOnly0 = bool

StackSpecContainerVolumeReadOnly0 defines model for .

type StackSpecContainerVolumeRemoteAccess0

type StackSpecContainerVolumeRemoteAccess0 struct {
	// Enable If true, this volume will be accessible over SFTP.
	Enable StackSpecContainerVolume_RemoteAccess_0_Enable `json:"enable"`

	// Ips A list of IPs that SFTP access will be limited to.
	Ips *StackSpecContainerVolume_RemoteAccess_0_Ips `json:"ips,omitempty"`

	// Password The password used for logging in to this volume via SFTP.
	Password StackSpecContainerVolume_RemoteAccess_0_Password `json:"password"`

	// Webhook If set, Cycle will call out to this URL for authentication. Anything other than a 200 response will be considered a validation failure.
	Webhook *string `json:"webhook,omitempty"`
}

StackSpecContainerVolumeRemoteAccess0 defines model for .

type StackSpecContainerVolumeRemoteAccess0Enable0

type StackSpecContainerVolumeRemoteAccess0Enable0 = bool

StackSpecContainerVolumeRemoteAccess0Enable0 defines model for .

type StackSpecContainerVolumeRemoteAccess0Ips0

type StackSpecContainerVolumeRemoteAccess0Ips0 = []string

StackSpecContainerVolumeRemoteAccess0Ips0 defines model for .

type StackSpecContainerVolumeRemoteAccess0Password0

type StackSpecContainerVolumeRemoteAccess0Password0 struct {
	// Algorithm The algorithm the password is encoded with. `raw` means the password is plain-text.
	Algorithm string `json:"algorithm"`

	// Data The password string.
	Data string `json:"data"`
}

StackSpecContainerVolumeRemoteAccess0Password0 defines model for .

type StackSpecContainerVolume_BlockDevice

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

StackSpecContainerVolume_BlockDevice Indicates that the volume will be used as unformatted block storage.

func (StackSpecContainerVolume_BlockDevice) AsStackSpecContainerVolumeBlockDevice0

func (t StackSpecContainerVolume_BlockDevice) AsStackSpecContainerVolumeBlockDevice0() (StackSpecContainerVolumeBlockDevice0, error)

AsStackSpecContainerVolumeBlockDevice0 returns the union data inside the StackSpecContainerVolume_BlockDevice as a StackSpecContainerVolumeBlockDevice0

func (StackSpecContainerVolume_BlockDevice) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainerVolume_BlockDevice as a StackVariable

func (*StackSpecContainerVolume_BlockDevice) FromStackSpecContainerVolumeBlockDevice0

func (t *StackSpecContainerVolume_BlockDevice) FromStackSpecContainerVolumeBlockDevice0(v StackSpecContainerVolumeBlockDevice0) error

FromStackSpecContainerVolumeBlockDevice0 overwrites any union data inside the StackSpecContainerVolume_BlockDevice as the provided StackSpecContainerVolumeBlockDevice0

func (*StackSpecContainerVolume_BlockDevice) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecContainerVolume_BlockDevice as the provided StackVariable

func (StackSpecContainerVolume_BlockDevice) MarshalJSON

func (t StackSpecContainerVolume_BlockDevice) MarshalJSON() ([]byte, error)

func (*StackSpecContainerVolume_BlockDevice) MergeStackSpecContainerVolumeBlockDevice0

func (t *StackSpecContainerVolume_BlockDevice) MergeStackSpecContainerVolumeBlockDevice0(v StackSpecContainerVolumeBlockDevice0) error

MergeStackSpecContainerVolumeBlockDevice0 performs a merge with any union data inside the StackSpecContainerVolume_BlockDevice, using the provided StackSpecContainerVolumeBlockDevice0

func (*StackSpecContainerVolume_BlockDevice) MergeStackVariable

func (t *StackSpecContainerVolume_BlockDevice) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainerVolume_BlockDevice, using the provided StackVariable

func (*StackSpecContainerVolume_BlockDevice) UnmarshalJSON

func (t *StackSpecContainerVolume_BlockDevice) UnmarshalJSON(b []byte) error

type StackSpecContainerVolume_Local

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

StackSpecContainerVolume_Local Configuration options for local volumes.

func (StackSpecContainerVolume_Local) AsStackSpecContainerVolumeLocal0

func (t StackSpecContainerVolume_Local) AsStackSpecContainerVolumeLocal0() (StackSpecContainerVolumeLocal0, error)

AsStackSpecContainerVolumeLocal0 returns the union data inside the StackSpecContainerVolume_Local as a StackSpecContainerVolumeLocal0

func (StackSpecContainerVolume_Local) AsStackVariable

func (t StackSpecContainerVolume_Local) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainerVolume_Local as a StackVariable

func (*StackSpecContainerVolume_Local) FromStackSpecContainerVolumeLocal0

func (t *StackSpecContainerVolume_Local) FromStackSpecContainerVolumeLocal0(v StackSpecContainerVolumeLocal0) error

FromStackSpecContainerVolumeLocal0 overwrites any union data inside the StackSpecContainerVolume_Local as the provided StackSpecContainerVolumeLocal0

func (*StackSpecContainerVolume_Local) FromStackVariable

func (t *StackSpecContainerVolume_Local) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainerVolume_Local as the provided StackVariable

func (StackSpecContainerVolume_Local) MarshalJSON

func (t StackSpecContainerVolume_Local) MarshalJSON() ([]byte, error)

func (*StackSpecContainerVolume_Local) MergeStackSpecContainerVolumeLocal0

func (t *StackSpecContainerVolume_Local) MergeStackSpecContainerVolumeLocal0(v StackSpecContainerVolumeLocal0) error

MergeStackSpecContainerVolumeLocal0 performs a merge with any union data inside the StackSpecContainerVolume_Local, using the provided StackSpecContainerVolumeLocal0

func (*StackSpecContainerVolume_Local) MergeStackVariable

func (t *StackSpecContainerVolume_Local) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainerVolume_Local, using the provided StackVariable

func (*StackSpecContainerVolume_Local) UnmarshalJSON

func (t *StackSpecContainerVolume_Local) UnmarshalJSON(b []byte) error

type StackSpecContainerVolume_Local_0_StoragePool

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

StackSpecContainerVolume_Local_0_StoragePool A boolean where true signifies using the largest drive over 2TB for the target server.

func (StackSpecContainerVolume_Local_0_StoragePool) AsStackSpecContainerVolumeLocal0StoragePool0

func (t StackSpecContainerVolume_Local_0_StoragePool) AsStackSpecContainerVolumeLocal0StoragePool0() (StackSpecContainerVolumeLocal0StoragePool0, error)

AsStackSpecContainerVolumeLocal0StoragePool0 returns the union data inside the StackSpecContainerVolume_Local_0_StoragePool as a StackSpecContainerVolumeLocal0StoragePool0

func (StackSpecContainerVolume_Local_0_StoragePool) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainerVolume_Local_0_StoragePool as a StackVariable

func (*StackSpecContainerVolume_Local_0_StoragePool) FromStackSpecContainerVolumeLocal0StoragePool0

func (t *StackSpecContainerVolume_Local_0_StoragePool) FromStackSpecContainerVolumeLocal0StoragePool0(v StackSpecContainerVolumeLocal0StoragePool0) error

FromStackSpecContainerVolumeLocal0StoragePool0 overwrites any union data inside the StackSpecContainerVolume_Local_0_StoragePool as the provided StackSpecContainerVolumeLocal0StoragePool0

func (*StackSpecContainerVolume_Local_0_StoragePool) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecContainerVolume_Local_0_StoragePool as the provided StackVariable

func (StackSpecContainerVolume_Local_0_StoragePool) MarshalJSON

func (*StackSpecContainerVolume_Local_0_StoragePool) MergeStackSpecContainerVolumeLocal0StoragePool0

func (t *StackSpecContainerVolume_Local_0_StoragePool) MergeStackSpecContainerVolumeLocal0StoragePool0(v StackSpecContainerVolumeLocal0StoragePool0) error

MergeStackSpecContainerVolumeLocal0StoragePool0 performs a merge with any union data inside the StackSpecContainerVolume_Local_0_StoragePool, using the provided StackSpecContainerVolumeLocal0StoragePool0

func (*StackSpecContainerVolume_Local_0_StoragePool) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecContainerVolume_Local_0_StoragePool, using the provided StackVariable

func (*StackSpecContainerVolume_Local_0_StoragePool) UnmarshalJSON

type StackSpecContainerVolume_ReadOnly

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

StackSpecContainerVolume_ReadOnly If true, the container will be unable to write data to the volume.

func (StackSpecContainerVolume_ReadOnly) AsStackSpecContainerVolumeReadOnly0

func (t StackSpecContainerVolume_ReadOnly) AsStackSpecContainerVolumeReadOnly0() (StackSpecContainerVolumeReadOnly0, error)

AsStackSpecContainerVolumeReadOnly0 returns the union data inside the StackSpecContainerVolume_ReadOnly as a StackSpecContainerVolumeReadOnly0

func (StackSpecContainerVolume_ReadOnly) AsStackVariable

func (t StackSpecContainerVolume_ReadOnly) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainerVolume_ReadOnly as a StackVariable

func (*StackSpecContainerVolume_ReadOnly) FromStackSpecContainerVolumeReadOnly0

func (t *StackSpecContainerVolume_ReadOnly) FromStackSpecContainerVolumeReadOnly0(v StackSpecContainerVolumeReadOnly0) error

FromStackSpecContainerVolumeReadOnly0 overwrites any union data inside the StackSpecContainerVolume_ReadOnly as the provided StackSpecContainerVolumeReadOnly0

func (*StackSpecContainerVolume_ReadOnly) FromStackVariable

func (t *StackSpecContainerVolume_ReadOnly) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainerVolume_ReadOnly as the provided StackVariable

func (StackSpecContainerVolume_ReadOnly) MarshalJSON

func (t StackSpecContainerVolume_ReadOnly) MarshalJSON() ([]byte, error)

func (*StackSpecContainerVolume_ReadOnly) MergeStackSpecContainerVolumeReadOnly0

func (t *StackSpecContainerVolume_ReadOnly) MergeStackSpecContainerVolumeReadOnly0(v StackSpecContainerVolumeReadOnly0) error

MergeStackSpecContainerVolumeReadOnly0 performs a merge with any union data inside the StackSpecContainerVolume_ReadOnly, using the provided StackSpecContainerVolumeReadOnly0

func (*StackSpecContainerVolume_ReadOnly) MergeStackVariable

func (t *StackSpecContainerVolume_ReadOnly) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainerVolume_ReadOnly, using the provided StackVariable

func (*StackSpecContainerVolume_ReadOnly) UnmarshalJSON

func (t *StackSpecContainerVolume_ReadOnly) UnmarshalJSON(b []byte) error

type StackSpecContainerVolume_RemoteAccess

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

StackSpecContainerVolume_RemoteAccess Configuration options for setting up remote access to this volume via SFTP.

func (StackSpecContainerVolume_RemoteAccess) AsStackSpecContainerVolumeRemoteAccess0

func (t StackSpecContainerVolume_RemoteAccess) AsStackSpecContainerVolumeRemoteAccess0() (StackSpecContainerVolumeRemoteAccess0, error)

AsStackSpecContainerVolumeRemoteAccess0 returns the union data inside the StackSpecContainerVolume_RemoteAccess as a StackSpecContainerVolumeRemoteAccess0

func (StackSpecContainerVolume_RemoteAccess) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainerVolume_RemoteAccess as a StackVariable

func (*StackSpecContainerVolume_RemoteAccess) FromStackSpecContainerVolumeRemoteAccess0

func (t *StackSpecContainerVolume_RemoteAccess) FromStackSpecContainerVolumeRemoteAccess0(v StackSpecContainerVolumeRemoteAccess0) error

FromStackSpecContainerVolumeRemoteAccess0 overwrites any union data inside the StackSpecContainerVolume_RemoteAccess as the provided StackSpecContainerVolumeRemoteAccess0

func (*StackSpecContainerVolume_RemoteAccess) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecContainerVolume_RemoteAccess as the provided StackVariable

func (StackSpecContainerVolume_RemoteAccess) MarshalJSON

func (t StackSpecContainerVolume_RemoteAccess) MarshalJSON() ([]byte, error)

func (*StackSpecContainerVolume_RemoteAccess) MergeStackSpecContainerVolumeRemoteAccess0

func (t *StackSpecContainerVolume_RemoteAccess) MergeStackSpecContainerVolumeRemoteAccess0(v StackSpecContainerVolumeRemoteAccess0) error

MergeStackSpecContainerVolumeRemoteAccess0 performs a merge with any union data inside the StackSpecContainerVolume_RemoteAccess, using the provided StackSpecContainerVolumeRemoteAccess0

func (*StackSpecContainerVolume_RemoteAccess) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecContainerVolume_RemoteAccess, using the provided StackVariable

func (*StackSpecContainerVolume_RemoteAccess) UnmarshalJSON

func (t *StackSpecContainerVolume_RemoteAccess) UnmarshalJSON(b []byte) error

type StackSpecContainerVolume_RemoteAccess_0_Enable

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

StackSpecContainerVolume_RemoteAccess_0_Enable If true, this volume will be accessible over SFTP.

func (StackSpecContainerVolume_RemoteAccess_0_Enable) AsStackSpecContainerVolumeRemoteAccess0Enable0

func (t StackSpecContainerVolume_RemoteAccess_0_Enable) AsStackSpecContainerVolumeRemoteAccess0Enable0() (StackSpecContainerVolumeRemoteAccess0Enable0, error)

AsStackSpecContainerVolumeRemoteAccess0Enable0 returns the union data inside the StackSpecContainerVolume_RemoteAccess_0_Enable as a StackSpecContainerVolumeRemoteAccess0Enable0

func (StackSpecContainerVolume_RemoteAccess_0_Enable) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainerVolume_RemoteAccess_0_Enable as a StackVariable

func (*StackSpecContainerVolume_RemoteAccess_0_Enable) FromStackSpecContainerVolumeRemoteAccess0Enable0

func (t *StackSpecContainerVolume_RemoteAccess_0_Enable) FromStackSpecContainerVolumeRemoteAccess0Enable0(v StackSpecContainerVolumeRemoteAccess0Enable0) error

FromStackSpecContainerVolumeRemoteAccess0Enable0 overwrites any union data inside the StackSpecContainerVolume_RemoteAccess_0_Enable as the provided StackSpecContainerVolumeRemoteAccess0Enable0

func (*StackSpecContainerVolume_RemoteAccess_0_Enable) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecContainerVolume_RemoteAccess_0_Enable as the provided StackVariable

func (StackSpecContainerVolume_RemoteAccess_0_Enable) MarshalJSON

func (*StackSpecContainerVolume_RemoteAccess_0_Enable) MergeStackSpecContainerVolumeRemoteAccess0Enable0

func (t *StackSpecContainerVolume_RemoteAccess_0_Enable) MergeStackSpecContainerVolumeRemoteAccess0Enable0(v StackSpecContainerVolumeRemoteAccess0Enable0) error

MergeStackSpecContainerVolumeRemoteAccess0Enable0 performs a merge with any union data inside the StackSpecContainerVolume_RemoteAccess_0_Enable, using the provided StackSpecContainerVolumeRemoteAccess0Enable0

func (*StackSpecContainerVolume_RemoteAccess_0_Enable) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecContainerVolume_RemoteAccess_0_Enable, using the provided StackVariable

func (*StackSpecContainerVolume_RemoteAccess_0_Enable) UnmarshalJSON

type StackSpecContainerVolume_RemoteAccess_0_Ips

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

StackSpecContainerVolume_RemoteAccess_0_Ips A list of IPs that SFTP access will be limited to.

func (StackSpecContainerVolume_RemoteAccess_0_Ips) AsStackSpecContainerVolumeRemoteAccess0Ips0

func (t StackSpecContainerVolume_RemoteAccess_0_Ips) AsStackSpecContainerVolumeRemoteAccess0Ips0() (StackSpecContainerVolumeRemoteAccess0Ips0, error)

AsStackSpecContainerVolumeRemoteAccess0Ips0 returns the union data inside the StackSpecContainerVolume_RemoteAccess_0_Ips as a StackSpecContainerVolumeRemoteAccess0Ips0

func (StackSpecContainerVolume_RemoteAccess_0_Ips) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainerVolume_RemoteAccess_0_Ips as a StackVariable

func (*StackSpecContainerVolume_RemoteAccess_0_Ips) FromStackSpecContainerVolumeRemoteAccess0Ips0

func (t *StackSpecContainerVolume_RemoteAccess_0_Ips) FromStackSpecContainerVolumeRemoteAccess0Ips0(v StackSpecContainerVolumeRemoteAccess0Ips0) error

FromStackSpecContainerVolumeRemoteAccess0Ips0 overwrites any union data inside the StackSpecContainerVolume_RemoteAccess_0_Ips as the provided StackSpecContainerVolumeRemoteAccess0Ips0

func (*StackSpecContainerVolume_RemoteAccess_0_Ips) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecContainerVolume_RemoteAccess_0_Ips as the provided StackVariable

func (StackSpecContainerVolume_RemoteAccess_0_Ips) MarshalJSON

func (*StackSpecContainerVolume_RemoteAccess_0_Ips) MergeStackSpecContainerVolumeRemoteAccess0Ips0

func (t *StackSpecContainerVolume_RemoteAccess_0_Ips) MergeStackSpecContainerVolumeRemoteAccess0Ips0(v StackSpecContainerVolumeRemoteAccess0Ips0) error

MergeStackSpecContainerVolumeRemoteAccess0Ips0 performs a merge with any union data inside the StackSpecContainerVolume_RemoteAccess_0_Ips, using the provided StackSpecContainerVolumeRemoteAccess0Ips0

func (*StackSpecContainerVolume_RemoteAccess_0_Ips) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecContainerVolume_RemoteAccess_0_Ips, using the provided StackVariable

func (*StackSpecContainerVolume_RemoteAccess_0_Ips) UnmarshalJSON

type StackSpecContainerVolume_RemoteAccess_0_Password

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

StackSpecContainerVolume_RemoteAccess_0_Password The password used for logging in to this volume via SFTP.

func (StackSpecContainerVolume_RemoteAccess_0_Password) AsStackSpecContainerVolumeRemoteAccess0Password0

func (t StackSpecContainerVolume_RemoteAccess_0_Password) AsStackSpecContainerVolumeRemoteAccess0Password0() (StackSpecContainerVolumeRemoteAccess0Password0, error)

AsStackSpecContainerVolumeRemoteAccess0Password0 returns the union data inside the StackSpecContainerVolume_RemoteAccess_0_Password as a StackSpecContainerVolumeRemoteAccess0Password0

func (StackSpecContainerVolume_RemoteAccess_0_Password) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainerVolume_RemoteAccess_0_Password as a StackVariable

func (*StackSpecContainerVolume_RemoteAccess_0_Password) FromStackSpecContainerVolumeRemoteAccess0Password0

func (t *StackSpecContainerVolume_RemoteAccess_0_Password) FromStackSpecContainerVolumeRemoteAccess0Password0(v StackSpecContainerVolumeRemoteAccess0Password0) error

FromStackSpecContainerVolumeRemoteAccess0Password0 overwrites any union data inside the StackSpecContainerVolume_RemoteAccess_0_Password as the provided StackSpecContainerVolumeRemoteAccess0Password0

func (*StackSpecContainerVolume_RemoteAccess_0_Password) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecContainerVolume_RemoteAccess_0_Password as the provided StackVariable

func (StackSpecContainerVolume_RemoteAccess_0_Password) MarshalJSON

func (*StackSpecContainerVolume_RemoteAccess_0_Password) MergeStackSpecContainerVolumeRemoteAccess0Password0

func (t *StackSpecContainerVolume_RemoteAccess_0_Password) MergeStackSpecContainerVolumeRemoteAccess0Password0(v StackSpecContainerVolumeRemoteAccess0Password0) error

MergeStackSpecContainerVolumeRemoteAccess0Password0 performs a merge with any union data inside the StackSpecContainerVolume_RemoteAccess_0_Password, using the provided StackSpecContainerVolumeRemoteAccess0Password0

func (*StackSpecContainerVolume_RemoteAccess_0_Password) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecContainerVolume_RemoteAccess_0_Password, using the provided StackVariable

func (*StackSpecContainerVolume_RemoteAccess_0_Password) UnmarshalJSON

type StackSpecContainerVolumes0

type StackSpecContainerVolumes0 = []StackSpecContainerVolume

StackSpecContainerVolumes0 defines model for .

type StackSpecContainer_Annotations

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

StackSpecContainer_Annotations defines model for StackSpecContainer.Annotations.

func (StackSpecContainer_Annotations) AsStackSpecContainerAnnotations0

func (t StackSpecContainer_Annotations) AsStackSpecContainerAnnotations0() (StackSpecContainerAnnotations0, error)

AsStackSpecContainerAnnotations0 returns the union data inside the StackSpecContainer_Annotations as a StackSpecContainerAnnotations0

func (StackSpecContainer_Annotations) AsStackVariable

func (t StackSpecContainer_Annotations) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainer_Annotations as a StackVariable

func (*StackSpecContainer_Annotations) FromStackSpecContainerAnnotations0

func (t *StackSpecContainer_Annotations) FromStackSpecContainerAnnotations0(v StackSpecContainerAnnotations0) error

FromStackSpecContainerAnnotations0 overwrites any union data inside the StackSpecContainer_Annotations as the provided StackSpecContainerAnnotations0

func (*StackSpecContainer_Annotations) FromStackVariable

func (t *StackSpecContainer_Annotations) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainer_Annotations as the provided StackVariable

func (StackSpecContainer_Annotations) MarshalJSON

func (t StackSpecContainer_Annotations) MarshalJSON() ([]byte, error)

func (*StackSpecContainer_Annotations) MergeStackSpecContainerAnnotations0

func (t *StackSpecContainer_Annotations) MergeStackSpecContainerAnnotations0(v StackSpecContainerAnnotations0) error

MergeStackSpecContainerAnnotations0 performs a merge with any union data inside the StackSpecContainer_Annotations, using the provided StackSpecContainerAnnotations0

func (*StackSpecContainer_Annotations) MergeStackVariable

func (t *StackSpecContainer_Annotations) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainer_Annotations, using the provided StackVariable

func (*StackSpecContainer_Annotations) UnmarshalJSON

func (t *StackSpecContainer_Annotations) UnmarshalJSON(b []byte) error

type StackSpecContainer_Config

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

StackSpecContainer_Config defines model for StackSpecContainer.Config.

func (StackSpecContainer_Config) AsStackSpecContainerConfig0

func (t StackSpecContainer_Config) AsStackSpecContainerConfig0() (StackSpecContainerConfig0, error)

AsStackSpecContainerConfig0 returns the union data inside the StackSpecContainer_Config as a StackSpecContainerConfig0

func (StackSpecContainer_Config) AsStackVariable

func (t StackSpecContainer_Config) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainer_Config as a StackVariable

func (*StackSpecContainer_Config) FromStackSpecContainerConfig0

func (t *StackSpecContainer_Config) FromStackSpecContainerConfig0(v StackSpecContainerConfig0) error

FromStackSpecContainerConfig0 overwrites any union data inside the StackSpecContainer_Config as the provided StackSpecContainerConfig0

func (*StackSpecContainer_Config) FromStackVariable

func (t *StackSpecContainer_Config) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainer_Config as the provided StackVariable

func (StackSpecContainer_Config) MarshalJSON

func (t StackSpecContainer_Config) MarshalJSON() ([]byte, error)

func (*StackSpecContainer_Config) MergeStackSpecContainerConfig0

func (t *StackSpecContainer_Config) MergeStackSpecContainerConfig0(v StackSpecContainerConfig0) error

MergeStackSpecContainerConfig0 performs a merge with any union data inside the StackSpecContainer_Config, using the provided StackSpecContainerConfig0

func (*StackSpecContainer_Config) MergeStackVariable

func (t *StackSpecContainer_Config) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainer_Config, using the provided StackVariable

func (*StackSpecContainer_Config) UnmarshalJSON

func (t *StackSpecContainer_Config) UnmarshalJSON(b []byte) error

type StackSpecContainer_Config_0_Deploy

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

StackSpecContainer_Config_0_Deploy defines model for StackSpecContainer.Config.0.Deploy.

func (StackSpecContainer_Config_0_Deploy) AsStackSpecContainerConfigDeploy

func (t StackSpecContainer_Config_0_Deploy) AsStackSpecContainerConfigDeploy() (StackSpecContainerConfigDeploy, error)

AsStackSpecContainerConfigDeploy returns the union data inside the StackSpecContainer_Config_0_Deploy as a StackSpecContainerConfigDeploy

func (StackSpecContainer_Config_0_Deploy) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainer_Config_0_Deploy as a StackVariable

func (*StackSpecContainer_Config_0_Deploy) FromStackSpecContainerConfigDeploy

func (t *StackSpecContainer_Config_0_Deploy) FromStackSpecContainerConfigDeploy(v StackSpecContainerConfigDeploy) error

FromStackSpecContainerConfigDeploy overwrites any union data inside the StackSpecContainer_Config_0_Deploy as the provided StackSpecContainerConfigDeploy

func (*StackSpecContainer_Config_0_Deploy) FromStackVariable

func (t *StackSpecContainer_Config_0_Deploy) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainer_Config_0_Deploy as the provided StackVariable

func (StackSpecContainer_Config_0_Deploy) MarshalJSON

func (t StackSpecContainer_Config_0_Deploy) MarshalJSON() ([]byte, error)

func (*StackSpecContainer_Config_0_Deploy) MergeStackSpecContainerConfigDeploy

func (t *StackSpecContainer_Config_0_Deploy) MergeStackSpecContainerConfigDeploy(v StackSpecContainerConfigDeploy) error

MergeStackSpecContainerConfigDeploy performs a merge with any union data inside the StackSpecContainer_Config_0_Deploy, using the provided StackSpecContainerConfigDeploy

func (*StackSpecContainer_Config_0_Deploy) MergeStackVariable

func (t *StackSpecContainer_Config_0_Deploy) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainer_Config_0_Deploy, using the provided StackVariable

func (*StackSpecContainer_Config_0_Deploy) UnmarshalJSON

func (t *StackSpecContainer_Config_0_Deploy) UnmarshalJSON(b []byte) error

type StackSpecContainer_Config_0_Network

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

StackSpecContainer_Config_0_Network defines model for StackSpecContainer.Config.0.Network.

func (StackSpecContainer_Config_0_Network) AsStackSpecContainerConfigNetwork

func (t StackSpecContainer_Config_0_Network) AsStackSpecContainerConfigNetwork() (StackSpecContainerConfigNetwork, error)

AsStackSpecContainerConfigNetwork returns the union data inside the StackSpecContainer_Config_0_Network as a StackSpecContainerConfigNetwork

func (StackSpecContainer_Config_0_Network) AsStackVariable

AsStackVariable returns the union data inside the StackSpecContainer_Config_0_Network as a StackVariable

func (*StackSpecContainer_Config_0_Network) FromStackSpecContainerConfigNetwork

func (t *StackSpecContainer_Config_0_Network) FromStackSpecContainerConfigNetwork(v StackSpecContainerConfigNetwork) error

FromStackSpecContainerConfigNetwork overwrites any union data inside the StackSpecContainer_Config_0_Network as the provided StackSpecContainerConfigNetwork

func (*StackSpecContainer_Config_0_Network) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecContainer_Config_0_Network as the provided StackVariable

func (StackSpecContainer_Config_0_Network) MarshalJSON

func (t StackSpecContainer_Config_0_Network) MarshalJSON() ([]byte, error)

func (*StackSpecContainer_Config_0_Network) MergeStackSpecContainerConfigNetwork

func (t *StackSpecContainer_Config_0_Network) MergeStackSpecContainerConfigNetwork(v StackSpecContainerConfigNetwork) error

MergeStackSpecContainerConfigNetwork performs a merge with any union data inside the StackSpecContainer_Config_0_Network, using the provided StackSpecContainerConfigNetwork

func (*StackSpecContainer_Config_0_Network) MergeStackVariable

func (t *StackSpecContainer_Config_0_Network) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainer_Config_0_Network, using the provided StackVariable

func (*StackSpecContainer_Config_0_Network) UnmarshalJSON

func (t *StackSpecContainer_Config_0_Network) UnmarshalJSON(b []byte) error

type StackSpecContainer_Deprecate

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

StackSpecContainer_Deprecate If true, the container is marked as `deprecated`, and cannot be started anymore. Deprecated containers also don't count toward resource utilization.

func (StackSpecContainer_Deprecate) AsStackSpecContainerDeprecate0

func (t StackSpecContainer_Deprecate) AsStackSpecContainerDeprecate0() (StackSpecContainerDeprecate0, error)

AsStackSpecContainerDeprecate0 returns the union data inside the StackSpecContainer_Deprecate as a StackSpecContainerDeprecate0

func (StackSpecContainer_Deprecate) AsStackVariable

func (t StackSpecContainer_Deprecate) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainer_Deprecate as a StackVariable

func (*StackSpecContainer_Deprecate) FromStackSpecContainerDeprecate0

func (t *StackSpecContainer_Deprecate) FromStackSpecContainerDeprecate0(v StackSpecContainerDeprecate0) error

FromStackSpecContainerDeprecate0 overwrites any union data inside the StackSpecContainer_Deprecate as the provided StackSpecContainerDeprecate0

func (*StackSpecContainer_Deprecate) FromStackVariable

func (t *StackSpecContainer_Deprecate) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainer_Deprecate as the provided StackVariable

func (StackSpecContainer_Deprecate) MarshalJSON

func (t StackSpecContainer_Deprecate) MarshalJSON() ([]byte, error)

func (*StackSpecContainer_Deprecate) MergeStackSpecContainerDeprecate0

func (t *StackSpecContainer_Deprecate) MergeStackSpecContainerDeprecate0(v StackSpecContainerDeprecate0) error

MergeStackSpecContainerDeprecate0 performs a merge with any union data inside the StackSpecContainer_Deprecate, using the provided StackSpecContainerDeprecate0

func (*StackSpecContainer_Deprecate) MergeStackVariable

func (t *StackSpecContainer_Deprecate) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainer_Deprecate, using the provided StackVariable

func (*StackSpecContainer_Deprecate) UnmarshalJSON

func (t *StackSpecContainer_Deprecate) UnmarshalJSON(b []byte) error

type StackSpecContainer_Image

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

StackSpecContainer_Image Details about the image used for this container.

func (StackSpecContainer_Image) AsStackSpecContainerImage

func (t StackSpecContainer_Image) AsStackSpecContainerImage() (StackSpecContainerImage, error)

AsStackSpecContainerImage returns the union data inside the StackSpecContainer_Image as a StackSpecContainerImage

func (StackSpecContainer_Image) AsStackVariable

func (t StackSpecContainer_Image) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainer_Image as a StackVariable

func (*StackSpecContainer_Image) FromStackSpecContainerImage

func (t *StackSpecContainer_Image) FromStackSpecContainerImage(v StackSpecContainerImage) error

FromStackSpecContainerImage overwrites any union data inside the StackSpecContainer_Image as the provided StackSpecContainerImage

func (*StackSpecContainer_Image) FromStackVariable

func (t *StackSpecContainer_Image) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainer_Image as the provided StackVariable

func (StackSpecContainer_Image) MarshalJSON

func (t StackSpecContainer_Image) MarshalJSON() ([]byte, error)

func (*StackSpecContainer_Image) MergeStackSpecContainerImage

func (t *StackSpecContainer_Image) MergeStackSpecContainerImage(v StackSpecContainerImage) error

MergeStackSpecContainerImage performs a merge with any union data inside the StackSpecContainer_Image, using the provided StackSpecContainerImage

func (*StackSpecContainer_Image) MergeStackVariable

func (t *StackSpecContainer_Image) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainer_Image, using the provided StackVariable

func (*StackSpecContainer_Image) UnmarshalJSON

func (t *StackSpecContainer_Image) UnmarshalJSON(b []byte) error

type StackSpecContainer_Lock

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

StackSpecContainer_Lock If true, the container is marked as `locked` and cannot be deleted in any way until the lock is lifted.

func (StackSpecContainer_Lock) AsStackSpecContainerLock0

func (t StackSpecContainer_Lock) AsStackSpecContainerLock0() (StackSpecContainerLock0, error)

AsStackSpecContainerLock0 returns the union data inside the StackSpecContainer_Lock as a StackSpecContainerLock0

func (StackSpecContainer_Lock) AsStackVariable

func (t StackSpecContainer_Lock) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainer_Lock as a StackVariable

func (*StackSpecContainer_Lock) FromStackSpecContainerLock0

func (t *StackSpecContainer_Lock) FromStackSpecContainerLock0(v StackSpecContainerLock0) error

FromStackSpecContainerLock0 overwrites any union data inside the StackSpecContainer_Lock as the provided StackSpecContainerLock0

func (*StackSpecContainer_Lock) FromStackVariable

func (t *StackSpecContainer_Lock) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainer_Lock as the provided StackVariable

func (StackSpecContainer_Lock) MarshalJSON

func (t StackSpecContainer_Lock) MarshalJSON() ([]byte, error)

func (*StackSpecContainer_Lock) MergeStackSpecContainerLock0

func (t *StackSpecContainer_Lock) MergeStackSpecContainerLock0(v StackSpecContainerLock0) error

MergeStackSpecContainerLock0 performs a merge with any union data inside the StackSpecContainer_Lock, using the provided StackSpecContainerLock0

func (*StackSpecContainer_Lock) MergeStackVariable

func (t *StackSpecContainer_Lock) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainer_Lock, using the provided StackVariable

func (*StackSpecContainer_Lock) UnmarshalJSON

func (t *StackSpecContainer_Lock) UnmarshalJSON(b []byte) error

type StackSpecContainer_Stateful

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

StackSpecContainer_Stateful Whether or not to mark the container as stateful when deployed. Stateful containers can utilize volumes (stateful data) and are generally used for running databases or other data management applications.

func (StackSpecContainer_Stateful) AsStackSpecContainerStateful0

func (t StackSpecContainer_Stateful) AsStackSpecContainerStateful0() (StackSpecContainerStateful0, error)

AsStackSpecContainerStateful0 returns the union data inside the StackSpecContainer_Stateful as a StackSpecContainerStateful0

func (StackSpecContainer_Stateful) AsStackVariable

func (t StackSpecContainer_Stateful) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainer_Stateful as a StackVariable

func (*StackSpecContainer_Stateful) FromStackSpecContainerStateful0

func (t *StackSpecContainer_Stateful) FromStackSpecContainerStateful0(v StackSpecContainerStateful0) error

FromStackSpecContainerStateful0 overwrites any union data inside the StackSpecContainer_Stateful as the provided StackSpecContainerStateful0

func (*StackSpecContainer_Stateful) FromStackVariable

func (t *StackSpecContainer_Stateful) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainer_Stateful as the provided StackVariable

func (StackSpecContainer_Stateful) MarshalJSON

func (t StackSpecContainer_Stateful) MarshalJSON() ([]byte, error)

func (*StackSpecContainer_Stateful) MergeStackSpecContainerStateful0

func (t *StackSpecContainer_Stateful) MergeStackSpecContainerStateful0(v StackSpecContainerStateful0) error

MergeStackSpecContainerStateful0 performs a merge with any union data inside the StackSpecContainer_Stateful, using the provided StackSpecContainerStateful0

func (*StackSpecContainer_Stateful) MergeStackVariable

func (t *StackSpecContainer_Stateful) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainer_Stateful, using the provided StackVariable

func (*StackSpecContainer_Stateful) UnmarshalJSON

func (t *StackSpecContainer_Stateful) UnmarshalJSON(b []byte) error

type StackSpecContainer_Volumes

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

StackSpecContainer_Volumes A list of configurations for volumes that will be attached to the container. Only applicable if the container is set to `stateful`.

func (StackSpecContainer_Volumes) AsStackSpecContainerVolumes0

func (t StackSpecContainer_Volumes) AsStackSpecContainerVolumes0() (StackSpecContainerVolumes0, error)

AsStackSpecContainerVolumes0 returns the union data inside the StackSpecContainer_Volumes as a StackSpecContainerVolumes0

func (StackSpecContainer_Volumes) AsStackVariable

func (t StackSpecContainer_Volumes) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecContainer_Volumes as a StackVariable

func (*StackSpecContainer_Volumes) FromStackSpecContainerVolumes0

func (t *StackSpecContainer_Volumes) FromStackSpecContainerVolumes0(v StackSpecContainerVolumes0) error

FromStackSpecContainerVolumes0 overwrites any union data inside the StackSpecContainer_Volumes as the provided StackSpecContainerVolumes0

func (*StackSpecContainer_Volumes) FromStackVariable

func (t *StackSpecContainer_Volumes) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecContainer_Volumes as the provided StackVariable

func (StackSpecContainer_Volumes) MarshalJSON

func (t StackSpecContainer_Volumes) MarshalJSON() ([]byte, error)

func (*StackSpecContainer_Volumes) MergeStackSpecContainerVolumes0

func (t *StackSpecContainer_Volumes) MergeStackSpecContainerVolumes0(v StackSpecContainerVolumes0) error

MergeStackSpecContainerVolumes0 performs a merge with any union data inside the StackSpecContainer_Volumes, using the provided StackSpecContainerVolumes0

func (*StackSpecContainer_Volumes) MergeStackVariable

func (t *StackSpecContainer_Volumes) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecContainer_Volumes, using the provided StackVariable

func (*StackSpecContainer_Volumes) UnmarshalJSON

func (t *StackSpecContainer_Volumes) UnmarshalJSON(b []byte) error

type StackSpecContainers0

type StackSpecContainers0 map[string]StackSpecContainer

StackSpecContainers0 A mapping of containers that will be deployed as a part of this stack. The key is used as the container's identifier.

type StackSpecImageOrigin

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

StackSpecImageOrigin The origin of the image.

func (StackSpecImageOrigin) AsCycleSourceOrigin

func (t StackSpecImageOrigin) AsCycleSourceOrigin() (CycleSourceOrigin, error)

AsCycleSourceOrigin returns the union data inside the StackSpecImageOrigin as a CycleSourceOrigin

func (StackSpecImageOrigin) AsDockerFileOrigin

func (t StackSpecImageOrigin) AsDockerFileOrigin() (DockerFileOrigin, error)

AsDockerFileOrigin returns the union data inside the StackSpecImageOrigin as a DockerFileOrigin

func (StackSpecImageOrigin) AsDockerHubOrigin

func (t StackSpecImageOrigin) AsDockerHubOrigin() (DockerHubOrigin, error)

AsDockerHubOrigin returns the union data inside the StackSpecImageOrigin as a DockerHubOrigin

func (StackSpecImageOrigin) AsDockerRegistryOrigin

func (t StackSpecImageOrigin) AsDockerRegistryOrigin() (DockerRegistryOrigin, error)

AsDockerRegistryOrigin returns the union data inside the StackSpecImageOrigin as a DockerRegistryOrigin

func (StackSpecImageOrigin) AsOciRegistryOrigin

func (t StackSpecImageOrigin) AsOciRegistryOrigin() (OciRegistryOrigin, error)

AsOciRegistryOrigin returns the union data inside the StackSpecImageOrigin as a OciRegistryOrigin

func (StackSpecImageOrigin) Discriminator

func (t StackSpecImageOrigin) Discriminator() (string, error)

func (*StackSpecImageOrigin) FromCycleSourceOrigin

func (t *StackSpecImageOrigin) FromCycleSourceOrigin(v CycleSourceOrigin) error

FromCycleSourceOrigin overwrites any union data inside the StackSpecImageOrigin as the provided CycleSourceOrigin

func (*StackSpecImageOrigin) FromDockerFileOrigin

func (t *StackSpecImageOrigin) FromDockerFileOrigin(v DockerFileOrigin) error

FromDockerFileOrigin overwrites any union data inside the StackSpecImageOrigin as the provided DockerFileOrigin

func (*StackSpecImageOrigin) FromDockerHubOrigin

func (t *StackSpecImageOrigin) FromDockerHubOrigin(v DockerHubOrigin) error

FromDockerHubOrigin overwrites any union data inside the StackSpecImageOrigin as the provided DockerHubOrigin

func (*StackSpecImageOrigin) FromDockerRegistryOrigin

func (t *StackSpecImageOrigin) FromDockerRegistryOrigin(v DockerRegistryOrigin) error

FromDockerRegistryOrigin overwrites any union data inside the StackSpecImageOrigin as the provided DockerRegistryOrigin

func (*StackSpecImageOrigin) FromOciRegistryOrigin

func (t *StackSpecImageOrigin) FromOciRegistryOrigin(v OciRegistryOrigin) error

FromOciRegistryOrigin overwrites any union data inside the StackSpecImageOrigin as the provided OciRegistryOrigin

func (StackSpecImageOrigin) MarshalJSON

func (t StackSpecImageOrigin) MarshalJSON() ([]byte, error)

func (*StackSpecImageOrigin) MergeCycleSourceOrigin

func (t *StackSpecImageOrigin) MergeCycleSourceOrigin(v CycleSourceOrigin) error

MergeCycleSourceOrigin performs a merge with any union data inside the StackSpecImageOrigin, using the provided CycleSourceOrigin

func (*StackSpecImageOrigin) MergeDockerFileOrigin

func (t *StackSpecImageOrigin) MergeDockerFileOrigin(v DockerFileOrigin) error

MergeDockerFileOrigin performs a merge with any union data inside the StackSpecImageOrigin, using the provided DockerFileOrigin

func (*StackSpecImageOrigin) MergeDockerHubOrigin

func (t *StackSpecImageOrigin) MergeDockerHubOrigin(v DockerHubOrigin) error

MergeDockerHubOrigin performs a merge with any union data inside the StackSpecImageOrigin, using the provided DockerHubOrigin

func (*StackSpecImageOrigin) MergeDockerRegistryOrigin

func (t *StackSpecImageOrigin) MergeDockerRegistryOrigin(v DockerRegistryOrigin) error

MergeDockerRegistryOrigin performs a merge with any union data inside the StackSpecImageOrigin, using the provided DockerRegistryOrigin

func (*StackSpecImageOrigin) MergeOciRegistryOrigin

func (t *StackSpecImageOrigin) MergeOciRegistryOrigin(v OciRegistryOrigin) error

MergeOciRegistryOrigin performs a merge with any union data inside the StackSpecImageOrigin, using the provided OciRegistryOrigin

func (*StackSpecImageOrigin) UnmarshalJSON

func (t *StackSpecImageOrigin) UnmarshalJSON(b []byte) error

func (StackSpecImageOrigin) ValueByDiscriminator

func (t StackSpecImageOrigin) ValueByDiscriminator() (interface{}, error)

type StackSpecMonitoringConfig added in v0.6.3

type StackSpecMonitoringConfig struct {
	// Logs A variable specified in a stack spec.
	Logs *StackVariable `json:"logs,omitempty"`
}

StackSpecMonitoringConfig Monitoring options for the stack build & containers within this stack.

type StackSpecScopedVariable

type StackSpecScopedVariable struct {
	Access     StackSpecScopedVariable_Access `json:"access"`
	Identifier string                         `json:"identifier"`
	Scope      StackSpecScopedVariable_Scope  `json:"scope"`
	Source     *StackVariable                 `json:"source"`
}

StackSpecScopedVariable defines model for StackSpecScopedVariable.

type StackSpecScopedVariableAccess0

type StackSpecScopedVariableAccess0 struct {
	// EnvVariable A variable specified in a stack spec.
	EnvVariable *StackVariable `json:"env_variable,omitempty"`

	// File Grants access to this variable as a file inside the container.
	File *StackSpecScopedVariable_Access_0_File `json:"file,omitempty"`

	// InternalApi Grants access to this variable over the Internal API.
	InternalApi *StackSpecScopedVariable_Access_0_InternalApi `json:"internal_api,omitempty"`
}

StackSpecScopedVariableAccess0 defines model for .

type StackSpecScopedVariableAccess0File0

type StackSpecScopedVariableAccess0File0 struct {
	// Decode When true, Cycle will interpret this variable as a base-64 encoded string, and decode it before writing it to the file inside the container.
	Decode StackSpecScopedVariable_Access_0_File_0_Decode `json:"decode"`

	// Gid The linux GID to set on the file.
	Gid *StackSpecScopedVariable_Access_0_File_0_Gid `json:"gid,omitempty"`

	// Path The absolute path to write the variable to (including file name). If `null`, it will be written to `/var/run/cycle/variables/{variable-identifier}`.
	Path string `json:"path"`

	// Permissions A linux file mode that will be set on the injected file.
	Permissions *string `json:"permissions,omitempty"`

	// Uid The linux UID to set on the file.
	Uid *StackSpecScopedVariable_Access_0_File_0_Uid `json:"uid,omitempty"`
}

StackSpecScopedVariableAccess0File0 defines model for .

type StackSpecScopedVariableAccess0File0Decode0

type StackSpecScopedVariableAccess0File0Decode0 = bool

StackSpecScopedVariableAccess0File0Decode0 defines model for .

type StackSpecScopedVariableAccess0File0Gid0 added in v0.6.3

type StackSpecScopedVariableAccess0File0Gid0 = int

StackSpecScopedVariableAccess0File0Gid0 defines model for .

type StackSpecScopedVariableAccess0File0Uid0 added in v0.6.3

type StackSpecScopedVariableAccess0File0Uid0 = int

StackSpecScopedVariableAccess0File0Uid0 defines model for .

type StackSpecScopedVariableAccess0InternalApi0

type StackSpecScopedVariableAccess0InternalApi0 struct {
	// Duration Sets the duration that this variable can be accessed over the Internal API, after container start. Provides additional security as sensitive data can only be accessed for a limited time.
	Duration *StackVariable `json:"duration"`
}

StackSpecScopedVariableAccess0InternalApi0 defines model for .

type StackSpecScopedVariableScope0

type StackSpecScopedVariableScope0 struct {
	// Containers Describes the containers that have access to this scoped variable.
	Containers StackSpecScopedVariable_Scope_0_Containers `json:"containers"`
}

StackSpecScopedVariableScope0 defines model for .

type StackSpecScopedVariableScope0Containers0

type StackSpecScopedVariableScope0Containers0 struct {
	// Global If true, all containers in the environment will have access to this variable.
	Global StackSpecScopedVariable_Scope_0_Containers_0_Global `json:"global"`

	// Identifiers A list of container identifiers that are granted access to this variable.
	Identifiers *StackSpecScopedVariable_Scope_0_Containers_0_Identifiers `json:"identifiers,omitempty"`

	// Ids A list of container IDs that are granted access to this variable.
	Ids *StackSpecScopedVariable_Scope_0_Containers_0_Ids `json:"ids,omitempty"`
}

StackSpecScopedVariableScope0Containers0 defines model for .

type StackSpecScopedVariableScope0Containers0Global0

type StackSpecScopedVariableScope0Containers0Global0 = bool

StackSpecScopedVariableScope0Containers0Global0 defines model for .

type StackSpecScopedVariableScope0Containers0Identifiers0

type StackSpecScopedVariableScope0Containers0Identifiers0 = []Identifier

StackSpecScopedVariableScope0Containers0Identifiers0 defines model for .

type StackSpecScopedVariableScope0Containers0Ids0

type StackSpecScopedVariableScope0Containers0Ids0 = []string

StackSpecScopedVariableScope0Containers0Ids0 defines model for .

type StackSpecScopedVariable_Access

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

StackSpecScopedVariable_Access defines model for StackSpecScopedVariable.Access.

func (StackSpecScopedVariable_Access) AsStackSpecScopedVariableAccess0

func (t StackSpecScopedVariable_Access) AsStackSpecScopedVariableAccess0() (StackSpecScopedVariableAccess0, error)

AsStackSpecScopedVariableAccess0 returns the union data inside the StackSpecScopedVariable_Access as a StackSpecScopedVariableAccess0

func (StackSpecScopedVariable_Access) AsStackVariable

func (t StackSpecScopedVariable_Access) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecScopedVariable_Access as a StackVariable

func (*StackSpecScopedVariable_Access) FromStackSpecScopedVariableAccess0

func (t *StackSpecScopedVariable_Access) FromStackSpecScopedVariableAccess0(v StackSpecScopedVariableAccess0) error

FromStackSpecScopedVariableAccess0 overwrites any union data inside the StackSpecScopedVariable_Access as the provided StackSpecScopedVariableAccess0

func (*StackSpecScopedVariable_Access) FromStackVariable

func (t *StackSpecScopedVariable_Access) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Access as the provided StackVariable

func (StackSpecScopedVariable_Access) MarshalJSON

func (t StackSpecScopedVariable_Access) MarshalJSON() ([]byte, error)

func (*StackSpecScopedVariable_Access) MergeStackSpecScopedVariableAccess0

func (t *StackSpecScopedVariable_Access) MergeStackSpecScopedVariableAccess0(v StackSpecScopedVariableAccess0) error

MergeStackSpecScopedVariableAccess0 performs a merge with any union data inside the StackSpecScopedVariable_Access, using the provided StackSpecScopedVariableAccess0

func (*StackSpecScopedVariable_Access) MergeStackVariable

func (t *StackSpecScopedVariable_Access) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Access, using the provided StackVariable

func (*StackSpecScopedVariable_Access) UnmarshalJSON

func (t *StackSpecScopedVariable_Access) UnmarshalJSON(b []byte) error

type StackSpecScopedVariable_Access_0_File

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

StackSpecScopedVariable_Access_0_File Grants access to this variable as a file inside the container.

func (StackSpecScopedVariable_Access_0_File) AsStackSpecScopedVariableAccess0File0

func (t StackSpecScopedVariable_Access_0_File) AsStackSpecScopedVariableAccess0File0() (StackSpecScopedVariableAccess0File0, error)

AsStackSpecScopedVariableAccess0File0 returns the union data inside the StackSpecScopedVariable_Access_0_File as a StackSpecScopedVariableAccess0File0

func (StackSpecScopedVariable_Access_0_File) AsStackVariable

AsStackVariable returns the union data inside the StackSpecScopedVariable_Access_0_File as a StackVariable

func (*StackSpecScopedVariable_Access_0_File) FromStackSpecScopedVariableAccess0File0

func (t *StackSpecScopedVariable_Access_0_File) FromStackSpecScopedVariableAccess0File0(v StackSpecScopedVariableAccess0File0) error

FromStackSpecScopedVariableAccess0File0 overwrites any union data inside the StackSpecScopedVariable_Access_0_File as the provided StackSpecScopedVariableAccess0File0

func (*StackSpecScopedVariable_Access_0_File) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Access_0_File as the provided StackVariable

func (StackSpecScopedVariable_Access_0_File) MarshalJSON

func (t StackSpecScopedVariable_Access_0_File) MarshalJSON() ([]byte, error)

func (*StackSpecScopedVariable_Access_0_File) MergeStackSpecScopedVariableAccess0File0

func (t *StackSpecScopedVariable_Access_0_File) MergeStackSpecScopedVariableAccess0File0(v StackSpecScopedVariableAccess0File0) error

MergeStackSpecScopedVariableAccess0File0 performs a merge with any union data inside the StackSpecScopedVariable_Access_0_File, using the provided StackSpecScopedVariableAccess0File0

func (*StackSpecScopedVariable_Access_0_File) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Access_0_File, using the provided StackVariable

func (*StackSpecScopedVariable_Access_0_File) UnmarshalJSON

func (t *StackSpecScopedVariable_Access_0_File) UnmarshalJSON(b []byte) error

type StackSpecScopedVariable_Access_0_File_0_Decode

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

StackSpecScopedVariable_Access_0_File_0_Decode When true, Cycle will interpret this variable as a base-64 encoded string, and decode it before writing it to the file inside the container.

func (StackSpecScopedVariable_Access_0_File_0_Decode) AsStackSpecScopedVariableAccess0File0Decode0

func (t StackSpecScopedVariable_Access_0_File_0_Decode) AsStackSpecScopedVariableAccess0File0Decode0() (StackSpecScopedVariableAccess0File0Decode0, error)

AsStackSpecScopedVariableAccess0File0Decode0 returns the union data inside the StackSpecScopedVariable_Access_0_File_0_Decode as a StackSpecScopedVariableAccess0File0Decode0

func (StackSpecScopedVariable_Access_0_File_0_Decode) AsStackVariable

AsStackVariable returns the union data inside the StackSpecScopedVariable_Access_0_File_0_Decode as a StackVariable

func (*StackSpecScopedVariable_Access_0_File_0_Decode) FromStackSpecScopedVariableAccess0File0Decode0

func (t *StackSpecScopedVariable_Access_0_File_0_Decode) FromStackSpecScopedVariableAccess0File0Decode0(v StackSpecScopedVariableAccess0File0Decode0) error

FromStackSpecScopedVariableAccess0File0Decode0 overwrites any union data inside the StackSpecScopedVariable_Access_0_File_0_Decode as the provided StackSpecScopedVariableAccess0File0Decode0

func (*StackSpecScopedVariable_Access_0_File_0_Decode) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Access_0_File_0_Decode as the provided StackVariable

func (StackSpecScopedVariable_Access_0_File_0_Decode) MarshalJSON

func (*StackSpecScopedVariable_Access_0_File_0_Decode) MergeStackSpecScopedVariableAccess0File0Decode0

func (t *StackSpecScopedVariable_Access_0_File_0_Decode) MergeStackSpecScopedVariableAccess0File0Decode0(v StackSpecScopedVariableAccess0File0Decode0) error

MergeStackSpecScopedVariableAccess0File0Decode0 performs a merge with any union data inside the StackSpecScopedVariable_Access_0_File_0_Decode, using the provided StackSpecScopedVariableAccess0File0Decode0

func (*StackSpecScopedVariable_Access_0_File_0_Decode) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Access_0_File_0_Decode, using the provided StackVariable

func (*StackSpecScopedVariable_Access_0_File_0_Decode) UnmarshalJSON

type StackSpecScopedVariable_Access_0_File_0_Gid added in v0.6.3

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

StackSpecScopedVariable_Access_0_File_0_Gid The linux GID to set on the file.

func (StackSpecScopedVariable_Access_0_File_0_Gid) AsStackSpecScopedVariableAccess0File0Gid0 added in v0.6.3

func (t StackSpecScopedVariable_Access_0_File_0_Gid) AsStackSpecScopedVariableAccess0File0Gid0() (StackSpecScopedVariableAccess0File0Gid0, error)

AsStackSpecScopedVariableAccess0File0Gid0 returns the union data inside the StackSpecScopedVariable_Access_0_File_0_Gid as a StackSpecScopedVariableAccess0File0Gid0

func (StackSpecScopedVariable_Access_0_File_0_Gid) AsStackVariable added in v0.6.3

AsStackVariable returns the union data inside the StackSpecScopedVariable_Access_0_File_0_Gid as a StackVariable

func (*StackSpecScopedVariable_Access_0_File_0_Gid) FromStackSpecScopedVariableAccess0File0Gid0 added in v0.6.3

func (t *StackSpecScopedVariable_Access_0_File_0_Gid) FromStackSpecScopedVariableAccess0File0Gid0(v StackSpecScopedVariableAccess0File0Gid0) error

FromStackSpecScopedVariableAccess0File0Gid0 overwrites any union data inside the StackSpecScopedVariable_Access_0_File_0_Gid as the provided StackSpecScopedVariableAccess0File0Gid0

func (*StackSpecScopedVariable_Access_0_File_0_Gid) FromStackVariable added in v0.6.3

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Access_0_File_0_Gid as the provided StackVariable

func (StackSpecScopedVariable_Access_0_File_0_Gid) MarshalJSON added in v0.6.3

func (*StackSpecScopedVariable_Access_0_File_0_Gid) MergeStackSpecScopedVariableAccess0File0Gid0 added in v0.6.3

func (t *StackSpecScopedVariable_Access_0_File_0_Gid) MergeStackSpecScopedVariableAccess0File0Gid0(v StackSpecScopedVariableAccess0File0Gid0) error

MergeStackSpecScopedVariableAccess0File0Gid0 performs a merge with any union data inside the StackSpecScopedVariable_Access_0_File_0_Gid, using the provided StackSpecScopedVariableAccess0File0Gid0

func (*StackSpecScopedVariable_Access_0_File_0_Gid) MergeStackVariable added in v0.6.3

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Access_0_File_0_Gid, using the provided StackVariable

func (*StackSpecScopedVariable_Access_0_File_0_Gid) UnmarshalJSON added in v0.6.3

type StackSpecScopedVariable_Access_0_File_0_Uid added in v0.6.3

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

StackSpecScopedVariable_Access_0_File_0_Uid The linux UID to set on the file.

func (StackSpecScopedVariable_Access_0_File_0_Uid) AsStackSpecScopedVariableAccess0File0Uid0 added in v0.6.3

func (t StackSpecScopedVariable_Access_0_File_0_Uid) AsStackSpecScopedVariableAccess0File0Uid0() (StackSpecScopedVariableAccess0File0Uid0, error)

AsStackSpecScopedVariableAccess0File0Uid0 returns the union data inside the StackSpecScopedVariable_Access_0_File_0_Uid as a StackSpecScopedVariableAccess0File0Uid0

func (StackSpecScopedVariable_Access_0_File_0_Uid) AsStackVariable added in v0.6.3

AsStackVariable returns the union data inside the StackSpecScopedVariable_Access_0_File_0_Uid as a StackVariable

func (*StackSpecScopedVariable_Access_0_File_0_Uid) FromStackSpecScopedVariableAccess0File0Uid0 added in v0.6.3

func (t *StackSpecScopedVariable_Access_0_File_0_Uid) FromStackSpecScopedVariableAccess0File0Uid0(v StackSpecScopedVariableAccess0File0Uid0) error

FromStackSpecScopedVariableAccess0File0Uid0 overwrites any union data inside the StackSpecScopedVariable_Access_0_File_0_Uid as the provided StackSpecScopedVariableAccess0File0Uid0

func (*StackSpecScopedVariable_Access_0_File_0_Uid) FromStackVariable added in v0.6.3

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Access_0_File_0_Uid as the provided StackVariable

func (StackSpecScopedVariable_Access_0_File_0_Uid) MarshalJSON added in v0.6.3

func (*StackSpecScopedVariable_Access_0_File_0_Uid) MergeStackSpecScopedVariableAccess0File0Uid0 added in v0.6.3

func (t *StackSpecScopedVariable_Access_0_File_0_Uid) MergeStackSpecScopedVariableAccess0File0Uid0(v StackSpecScopedVariableAccess0File0Uid0) error

MergeStackSpecScopedVariableAccess0File0Uid0 performs a merge with any union data inside the StackSpecScopedVariable_Access_0_File_0_Uid, using the provided StackSpecScopedVariableAccess0File0Uid0

func (*StackSpecScopedVariable_Access_0_File_0_Uid) MergeStackVariable added in v0.6.3

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Access_0_File_0_Uid, using the provided StackVariable

func (*StackSpecScopedVariable_Access_0_File_0_Uid) UnmarshalJSON added in v0.6.3

type StackSpecScopedVariable_Access_0_InternalApi

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

StackSpecScopedVariable_Access_0_InternalApi Grants access to this variable over the Internal API.

func (StackSpecScopedVariable_Access_0_InternalApi) AsStackSpecScopedVariableAccess0InternalApi0

func (t StackSpecScopedVariable_Access_0_InternalApi) AsStackSpecScopedVariableAccess0InternalApi0() (StackSpecScopedVariableAccess0InternalApi0, error)

AsStackSpecScopedVariableAccess0InternalApi0 returns the union data inside the StackSpecScopedVariable_Access_0_InternalApi as a StackSpecScopedVariableAccess0InternalApi0

func (StackSpecScopedVariable_Access_0_InternalApi) AsStackVariable

AsStackVariable returns the union data inside the StackSpecScopedVariable_Access_0_InternalApi as a StackVariable

func (*StackSpecScopedVariable_Access_0_InternalApi) FromStackSpecScopedVariableAccess0InternalApi0

func (t *StackSpecScopedVariable_Access_0_InternalApi) FromStackSpecScopedVariableAccess0InternalApi0(v StackSpecScopedVariableAccess0InternalApi0) error

FromStackSpecScopedVariableAccess0InternalApi0 overwrites any union data inside the StackSpecScopedVariable_Access_0_InternalApi as the provided StackSpecScopedVariableAccess0InternalApi0

func (*StackSpecScopedVariable_Access_0_InternalApi) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Access_0_InternalApi as the provided StackVariable

func (StackSpecScopedVariable_Access_0_InternalApi) MarshalJSON

func (*StackSpecScopedVariable_Access_0_InternalApi) MergeStackSpecScopedVariableAccess0InternalApi0

func (t *StackSpecScopedVariable_Access_0_InternalApi) MergeStackSpecScopedVariableAccess0InternalApi0(v StackSpecScopedVariableAccess0InternalApi0) error

MergeStackSpecScopedVariableAccess0InternalApi0 performs a merge with any union data inside the StackSpecScopedVariable_Access_0_InternalApi, using the provided StackSpecScopedVariableAccess0InternalApi0

func (*StackSpecScopedVariable_Access_0_InternalApi) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Access_0_InternalApi, using the provided StackVariable

func (*StackSpecScopedVariable_Access_0_InternalApi) UnmarshalJSON

type StackSpecScopedVariable_Scope

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

StackSpecScopedVariable_Scope defines model for StackSpecScopedVariable.Scope.

func (StackSpecScopedVariable_Scope) AsStackSpecScopedVariableScope0

func (t StackSpecScopedVariable_Scope) AsStackSpecScopedVariableScope0() (StackSpecScopedVariableScope0, error)

AsStackSpecScopedVariableScope0 returns the union data inside the StackSpecScopedVariable_Scope as a StackSpecScopedVariableScope0

func (StackSpecScopedVariable_Scope) AsStackVariable

func (t StackSpecScopedVariable_Scope) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpecScopedVariable_Scope as a StackVariable

func (*StackSpecScopedVariable_Scope) FromStackSpecScopedVariableScope0

func (t *StackSpecScopedVariable_Scope) FromStackSpecScopedVariableScope0(v StackSpecScopedVariableScope0) error

FromStackSpecScopedVariableScope0 overwrites any union data inside the StackSpecScopedVariable_Scope as the provided StackSpecScopedVariableScope0

func (*StackSpecScopedVariable_Scope) FromStackVariable

func (t *StackSpecScopedVariable_Scope) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Scope as the provided StackVariable

func (StackSpecScopedVariable_Scope) MarshalJSON

func (t StackSpecScopedVariable_Scope) MarshalJSON() ([]byte, error)

func (*StackSpecScopedVariable_Scope) MergeStackSpecScopedVariableScope0

func (t *StackSpecScopedVariable_Scope) MergeStackSpecScopedVariableScope0(v StackSpecScopedVariableScope0) error

MergeStackSpecScopedVariableScope0 performs a merge with any union data inside the StackSpecScopedVariable_Scope, using the provided StackSpecScopedVariableScope0

func (*StackSpecScopedVariable_Scope) MergeStackVariable

func (t *StackSpecScopedVariable_Scope) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Scope, using the provided StackVariable

func (*StackSpecScopedVariable_Scope) UnmarshalJSON

func (t *StackSpecScopedVariable_Scope) UnmarshalJSON(b []byte) error

type StackSpecScopedVariable_Scope_0_Containers

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

StackSpecScopedVariable_Scope_0_Containers Describes the containers that have access to this scoped variable.

func (StackSpecScopedVariable_Scope_0_Containers) AsStackSpecScopedVariableScope0Containers0

func (t StackSpecScopedVariable_Scope_0_Containers) AsStackSpecScopedVariableScope0Containers0() (StackSpecScopedVariableScope0Containers0, error)

AsStackSpecScopedVariableScope0Containers0 returns the union data inside the StackSpecScopedVariable_Scope_0_Containers as a StackSpecScopedVariableScope0Containers0

func (StackSpecScopedVariable_Scope_0_Containers) AsStackVariable

AsStackVariable returns the union data inside the StackSpecScopedVariable_Scope_0_Containers as a StackVariable

func (*StackSpecScopedVariable_Scope_0_Containers) FromStackSpecScopedVariableScope0Containers0

func (t *StackSpecScopedVariable_Scope_0_Containers) FromStackSpecScopedVariableScope0Containers0(v StackSpecScopedVariableScope0Containers0) error

FromStackSpecScopedVariableScope0Containers0 overwrites any union data inside the StackSpecScopedVariable_Scope_0_Containers as the provided StackSpecScopedVariableScope0Containers0

func (*StackSpecScopedVariable_Scope_0_Containers) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Scope_0_Containers as the provided StackVariable

func (StackSpecScopedVariable_Scope_0_Containers) MarshalJSON

func (*StackSpecScopedVariable_Scope_0_Containers) MergeStackSpecScopedVariableScope0Containers0

func (t *StackSpecScopedVariable_Scope_0_Containers) MergeStackSpecScopedVariableScope0Containers0(v StackSpecScopedVariableScope0Containers0) error

MergeStackSpecScopedVariableScope0Containers0 performs a merge with any union data inside the StackSpecScopedVariable_Scope_0_Containers, using the provided StackSpecScopedVariableScope0Containers0

func (*StackSpecScopedVariable_Scope_0_Containers) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Scope_0_Containers, using the provided StackVariable

func (*StackSpecScopedVariable_Scope_0_Containers) UnmarshalJSON

type StackSpecScopedVariable_Scope_0_Containers_0_Global

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

StackSpecScopedVariable_Scope_0_Containers_0_Global If true, all containers in the environment will have access to this variable.

func (StackSpecScopedVariable_Scope_0_Containers_0_Global) AsStackSpecScopedVariableScope0Containers0Global0

AsStackSpecScopedVariableScope0Containers0Global0 returns the union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Global as a StackSpecScopedVariableScope0Containers0Global0

func (StackSpecScopedVariable_Scope_0_Containers_0_Global) AsStackVariable

AsStackVariable returns the union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Global as a StackVariable

func (*StackSpecScopedVariable_Scope_0_Containers_0_Global) FromStackSpecScopedVariableScope0Containers0Global0

func (t *StackSpecScopedVariable_Scope_0_Containers_0_Global) FromStackSpecScopedVariableScope0Containers0Global0(v StackSpecScopedVariableScope0Containers0Global0) error

FromStackSpecScopedVariableScope0Containers0Global0 overwrites any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Global as the provided StackSpecScopedVariableScope0Containers0Global0

func (*StackSpecScopedVariable_Scope_0_Containers_0_Global) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Global as the provided StackVariable

func (StackSpecScopedVariable_Scope_0_Containers_0_Global) MarshalJSON

func (*StackSpecScopedVariable_Scope_0_Containers_0_Global) MergeStackSpecScopedVariableScope0Containers0Global0

func (t *StackSpecScopedVariable_Scope_0_Containers_0_Global) MergeStackSpecScopedVariableScope0Containers0Global0(v StackSpecScopedVariableScope0Containers0Global0) error

MergeStackSpecScopedVariableScope0Containers0Global0 performs a merge with any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Global, using the provided StackSpecScopedVariableScope0Containers0Global0

func (*StackSpecScopedVariable_Scope_0_Containers_0_Global) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Global, using the provided StackVariable

func (*StackSpecScopedVariable_Scope_0_Containers_0_Global) UnmarshalJSON

type StackSpecScopedVariable_Scope_0_Containers_0_Identifiers

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

StackSpecScopedVariable_Scope_0_Containers_0_Identifiers A list of container identifiers that are granted access to this variable.

func (StackSpecScopedVariable_Scope_0_Containers_0_Identifiers) AsStackSpecScopedVariableScope0Containers0Identifiers0

AsStackSpecScopedVariableScope0Containers0Identifiers0 returns the union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Identifiers as a StackSpecScopedVariableScope0Containers0Identifiers0

func (StackSpecScopedVariable_Scope_0_Containers_0_Identifiers) AsStackVariable

AsStackVariable returns the union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Identifiers as a StackVariable

func (*StackSpecScopedVariable_Scope_0_Containers_0_Identifiers) FromStackSpecScopedVariableScope0Containers0Identifiers0

FromStackSpecScopedVariableScope0Containers0Identifiers0 overwrites any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Identifiers as the provided StackSpecScopedVariableScope0Containers0Identifiers0

func (*StackSpecScopedVariable_Scope_0_Containers_0_Identifiers) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Identifiers as the provided StackVariable

func (StackSpecScopedVariable_Scope_0_Containers_0_Identifiers) MarshalJSON

func (*StackSpecScopedVariable_Scope_0_Containers_0_Identifiers) MergeStackSpecScopedVariableScope0Containers0Identifiers0

MergeStackSpecScopedVariableScope0Containers0Identifiers0 performs a merge with any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Identifiers, using the provided StackSpecScopedVariableScope0Containers0Identifiers0

func (*StackSpecScopedVariable_Scope_0_Containers_0_Identifiers) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Identifiers, using the provided StackVariable

func (*StackSpecScopedVariable_Scope_0_Containers_0_Identifiers) UnmarshalJSON

type StackSpecScopedVariable_Scope_0_Containers_0_Ids

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

StackSpecScopedVariable_Scope_0_Containers_0_Ids A list of container IDs that are granted access to this variable.

func (StackSpecScopedVariable_Scope_0_Containers_0_Ids) AsStackSpecScopedVariableScope0Containers0Ids0

func (t StackSpecScopedVariable_Scope_0_Containers_0_Ids) AsStackSpecScopedVariableScope0Containers0Ids0() (StackSpecScopedVariableScope0Containers0Ids0, error)

AsStackSpecScopedVariableScope0Containers0Ids0 returns the union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Ids as a StackSpecScopedVariableScope0Containers0Ids0

func (StackSpecScopedVariable_Scope_0_Containers_0_Ids) AsStackVariable

AsStackVariable returns the union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Ids as a StackVariable

func (*StackSpecScopedVariable_Scope_0_Containers_0_Ids) FromStackSpecScopedVariableScope0Containers0Ids0

func (t *StackSpecScopedVariable_Scope_0_Containers_0_Ids) FromStackSpecScopedVariableScope0Containers0Ids0(v StackSpecScopedVariableScope0Containers0Ids0) error

FromStackSpecScopedVariableScope0Containers0Ids0 overwrites any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Ids as the provided StackSpecScopedVariableScope0Containers0Ids0

func (*StackSpecScopedVariable_Scope_0_Containers_0_Ids) FromStackVariable

FromStackVariable overwrites any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Ids as the provided StackVariable

func (StackSpecScopedVariable_Scope_0_Containers_0_Ids) MarshalJSON

func (*StackSpecScopedVariable_Scope_0_Containers_0_Ids) MergeStackSpecScopedVariableScope0Containers0Ids0

func (t *StackSpecScopedVariable_Scope_0_Containers_0_Ids) MergeStackSpecScopedVariableScope0Containers0Ids0(v StackSpecScopedVariableScope0Containers0Ids0) error

MergeStackSpecScopedVariableScope0Containers0Ids0 performs a merge with any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Ids, using the provided StackSpecScopedVariableScope0Containers0Ids0

func (*StackSpecScopedVariable_Scope_0_Containers_0_Ids) MergeStackVariable

MergeStackVariable performs a merge with any union data inside the StackSpecScopedVariable_Scope_0_Containers_0_Ids, using the provided StackVariable

func (*StackSpecScopedVariable_Scope_0_Containers_0_Ids) UnmarshalJSON

type StackSpecScopedVariables0

type StackSpecScopedVariables0 = []StackSpecScopedVariable

StackSpecScopedVariables0 defines model for .

type StackSpecServices0

type StackSpecServices0 struct {
	Discovery    *StackVariable `json:"discovery"`
	Loadbalancer *StackVariable `json:"loadbalancer"`
	Scheduler    *StackVariable `json:"scheduler"`
	Vpn          *StackVariable `json:"vpn"`
}

StackSpecServices0 defines model for .

type StackSpecVersion

type StackSpecVersion string

StackSpecVersion The version of the Cycle stack file used.

const (
	N10 StackSpecVersion = "1.0"
)

Defines values for StackSpecVersion.

type StackSpec_About

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

StackSpec_About defines model for StackSpec.About.

func (StackSpec_About) AsStackSpecAbout0

func (t StackSpec_About) AsStackSpecAbout0() (StackSpecAbout0, error)

AsStackSpecAbout0 returns the union data inside the StackSpec_About as a StackSpecAbout0

func (StackSpec_About) AsStackVariable

func (t StackSpec_About) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpec_About as a StackVariable

func (*StackSpec_About) FromStackSpecAbout0

func (t *StackSpec_About) FromStackSpecAbout0(v StackSpecAbout0) error

FromStackSpecAbout0 overwrites any union data inside the StackSpec_About as the provided StackSpecAbout0

func (*StackSpec_About) FromStackVariable

func (t *StackSpec_About) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpec_About as the provided StackVariable

func (StackSpec_About) MarshalJSON

func (t StackSpec_About) MarshalJSON() ([]byte, error)

func (*StackSpec_About) MergeStackSpecAbout0

func (t *StackSpec_About) MergeStackSpecAbout0(v StackSpecAbout0) error

MergeStackSpecAbout0 performs a merge with any union data inside the StackSpec_About, using the provided StackSpecAbout0

func (*StackSpec_About) MergeStackVariable

func (t *StackSpec_About) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpec_About, using the provided StackVariable

func (*StackSpec_About) UnmarshalJSON

func (t *StackSpec_About) UnmarshalJSON(b []byte) error

type StackSpec_Annotations

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

StackSpec_Annotations Additional meta info about the stack.

func (StackSpec_Annotations) AsStackSpecAnnotations0

func (t StackSpec_Annotations) AsStackSpecAnnotations0() (StackSpecAnnotations0, error)

AsStackSpecAnnotations0 returns the union data inside the StackSpec_Annotations as a StackSpecAnnotations0

func (StackSpec_Annotations) AsStackVariable

func (t StackSpec_Annotations) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpec_Annotations as a StackVariable

func (*StackSpec_Annotations) FromStackSpecAnnotations0

func (t *StackSpec_Annotations) FromStackSpecAnnotations0(v StackSpecAnnotations0) error

FromStackSpecAnnotations0 overwrites any union data inside the StackSpec_Annotations as the provided StackSpecAnnotations0

func (*StackSpec_Annotations) FromStackVariable

func (t *StackSpec_Annotations) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpec_Annotations as the provided StackVariable

func (StackSpec_Annotations) MarshalJSON

func (t StackSpec_Annotations) MarshalJSON() ([]byte, error)

func (*StackSpec_Annotations) MergeStackSpecAnnotations0

func (t *StackSpec_Annotations) MergeStackSpecAnnotations0(v StackSpecAnnotations0) error

MergeStackSpecAnnotations0 performs a merge with any union data inside the StackSpec_Annotations, using the provided StackSpecAnnotations0

func (*StackSpec_Annotations) MergeStackVariable

func (t *StackSpec_Annotations) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpec_Annotations, using the provided StackVariable

func (*StackSpec_Annotations) UnmarshalJSON

func (t *StackSpec_Annotations) UnmarshalJSON(b []byte) error

type StackSpec_Containers

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

StackSpec_Containers defines model for StackSpec.Containers.

func (StackSpec_Containers) AsStackSpecContainers0

func (t StackSpec_Containers) AsStackSpecContainers0() (StackSpecContainers0, error)

AsStackSpecContainers0 returns the union data inside the StackSpec_Containers as a StackSpecContainers0

func (StackSpec_Containers) AsStackVariable

func (t StackSpec_Containers) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpec_Containers as a StackVariable

func (*StackSpec_Containers) FromStackSpecContainers0

func (t *StackSpec_Containers) FromStackSpecContainers0(v StackSpecContainers0) error

FromStackSpecContainers0 overwrites any union data inside the StackSpec_Containers as the provided StackSpecContainers0

func (*StackSpec_Containers) FromStackVariable

func (t *StackSpec_Containers) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpec_Containers as the provided StackVariable

func (StackSpec_Containers) MarshalJSON

func (t StackSpec_Containers) MarshalJSON() ([]byte, error)

func (*StackSpec_Containers) MergeStackSpecContainers0

func (t *StackSpec_Containers) MergeStackSpecContainers0(v StackSpecContainers0) error

MergeStackSpecContainers0 performs a merge with any union data inside the StackSpec_Containers, using the provided StackSpecContainers0

func (*StackSpec_Containers) MergeStackVariable

func (t *StackSpec_Containers) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpec_Containers, using the provided StackVariable

func (*StackSpec_Containers) UnmarshalJSON

func (t *StackSpec_Containers) UnmarshalJSON(b []byte) error

type StackSpec_Monitoring added in v0.6.3

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

StackSpec_Monitoring Monitoring options for containers within this stack.

func (StackSpec_Monitoring) AsStackSpecMonitoringConfig added in v0.6.3

func (t StackSpec_Monitoring) AsStackSpecMonitoringConfig() (StackSpecMonitoringConfig, error)

AsStackSpecMonitoringConfig returns the union data inside the StackSpec_Monitoring as a StackSpecMonitoringConfig

func (StackSpec_Monitoring) AsStackVariable added in v0.6.3

func (t StackSpec_Monitoring) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpec_Monitoring as a StackVariable

func (*StackSpec_Monitoring) FromStackSpecMonitoringConfig added in v0.6.3

func (t *StackSpec_Monitoring) FromStackSpecMonitoringConfig(v StackSpecMonitoringConfig) error

FromStackSpecMonitoringConfig overwrites any union data inside the StackSpec_Monitoring as the provided StackSpecMonitoringConfig

func (*StackSpec_Monitoring) FromStackVariable added in v0.6.3

func (t *StackSpec_Monitoring) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpec_Monitoring as the provided StackVariable

func (StackSpec_Monitoring) MarshalJSON added in v0.6.3

func (t StackSpec_Monitoring) MarshalJSON() ([]byte, error)

func (*StackSpec_Monitoring) MergeStackSpecMonitoringConfig added in v0.6.3

func (t *StackSpec_Monitoring) MergeStackSpecMonitoringConfig(v StackSpecMonitoringConfig) error

MergeStackSpecMonitoringConfig performs a merge with any union data inside the StackSpec_Monitoring, using the provided StackSpecMonitoringConfig

func (*StackSpec_Monitoring) MergeStackVariable added in v0.6.3

func (t *StackSpec_Monitoring) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpec_Monitoring, using the provided StackVariable

func (*StackSpec_Monitoring) UnmarshalJSON added in v0.6.3

func (t *StackSpec_Monitoring) UnmarshalJSON(b []byte) error

type StackSpec_ScopedVariables

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

StackSpec_ScopedVariables Describes variables that are assigned to one or more containers at runtime. Can be assigned as an environment variable, written as a file inside the container(s), or accessed over the internal API.

func (StackSpec_ScopedVariables) AsStackSpecScopedVariables0

func (t StackSpec_ScopedVariables) AsStackSpecScopedVariables0() (StackSpecScopedVariables0, error)

AsStackSpecScopedVariables0 returns the union data inside the StackSpec_ScopedVariables as a StackSpecScopedVariables0

func (StackSpec_ScopedVariables) AsStackVariable

func (t StackSpec_ScopedVariables) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpec_ScopedVariables as a StackVariable

func (*StackSpec_ScopedVariables) FromStackSpecScopedVariables0

func (t *StackSpec_ScopedVariables) FromStackSpecScopedVariables0(v StackSpecScopedVariables0) error

FromStackSpecScopedVariables0 overwrites any union data inside the StackSpec_ScopedVariables as the provided StackSpecScopedVariables0

func (*StackSpec_ScopedVariables) FromStackVariable

func (t *StackSpec_ScopedVariables) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpec_ScopedVariables as the provided StackVariable

func (StackSpec_ScopedVariables) MarshalJSON

func (t StackSpec_ScopedVariables) MarshalJSON() ([]byte, error)

func (*StackSpec_ScopedVariables) MergeStackSpecScopedVariables0

func (t *StackSpec_ScopedVariables) MergeStackSpecScopedVariables0(v StackSpecScopedVariables0) error

MergeStackSpecScopedVariables0 performs a merge with any union data inside the StackSpec_ScopedVariables, using the provided StackSpecScopedVariables0

func (*StackSpec_ScopedVariables) MergeStackVariable

func (t *StackSpec_ScopedVariables) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpec_ScopedVariables, using the provided StackVariable

func (*StackSpec_ScopedVariables) UnmarshalJSON

func (t *StackSpec_ScopedVariables) UnmarshalJSON(b []byte) error

type StackSpec_Services

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

StackSpec_Services Settings for any auxillary services deployed as part of the environment, such as load balancer and discovery services.

func (StackSpec_Services) AsStackSpecServices0

func (t StackSpec_Services) AsStackSpecServices0() (StackSpecServices0, error)

AsStackSpecServices0 returns the union data inside the StackSpec_Services as a StackSpecServices0

func (StackSpec_Services) AsStackVariable

func (t StackSpec_Services) AsStackVariable() (StackVariable, error)

AsStackVariable returns the union data inside the StackSpec_Services as a StackVariable

func (*StackSpec_Services) FromStackSpecServices0

func (t *StackSpec_Services) FromStackSpecServices0(v StackSpecServices0) error

FromStackSpecServices0 overwrites any union data inside the StackSpec_Services as the provided StackSpecServices0

func (*StackSpec_Services) FromStackVariable

func (t *StackSpec_Services) FromStackVariable(v StackVariable) error

FromStackVariable overwrites any union data inside the StackSpec_Services as the provided StackVariable

func (StackSpec_Services) MarshalJSON

func (t StackSpec_Services) MarshalJSON() ([]byte, error)

func (*StackSpec_Services) MergeStackSpecServices0

func (t *StackSpec_Services) MergeStackSpecServices0(v StackSpecServices0) error

MergeStackSpecServices0 performs a merge with any union data inside the StackSpec_Services, using the provided StackSpecServices0

func (*StackSpec_Services) MergeStackVariable

func (t *StackSpec_Services) MergeStackVariable(v StackVariable) error

MergeStackVariable performs a merge with any union data inside the StackSpec_Services, using the provided StackVariable

func (*StackSpec_Services) UnmarshalJSON

func (t *StackSpec_Services) UnmarshalJSON(b []byte) error

type StackState

type StackState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the stack.
	Current StackStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

StackState defines model for StackState.

type StackStateCurrent

type StackStateCurrent string

StackStateCurrent The current state of the stack.

const (
	StackStateCurrentDeleted  StackStateCurrent = "deleted"
	StackStateCurrentDeleting StackStateCurrent = "deleting"
	StackStateCurrentLive     StackStateCurrent = "live"
)

Defines values for StackStateCurrent.

type StackSummary

type StackSummary struct {
	// BuildId The ID of the stack build this container is associated with.
	BuildId *string `json:"build_id,omitempty"`

	// Id A 24 character hex string used to identify a unique resource.
	Id *ID `json:"id,omitempty"`

	// Identifier The container identifier, usually the key to the container section of a stack file.
	Identifier *string `json:"identifier,omitempty"`
}

StackSummary A summary of the stack this container was created format.

type StackVariable

type StackVariable = string

StackVariable A variable specified in a stack spec.

type State

type State struct {
	Changed DateTime `json:"changed"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

State Information regarding the current state of the resource.

type StateCountSummary

type StateCountSummary struct {
	// Available The total number of this resource available, less any deleted ones.
	Available int `json:"available"`

	// State A count of this resource, grouped by state.
	State map[string]int `json:"state"`

	// Total The total number of this resource
	Total int `json:"total"`
}

StateCountSummary A summary of resources by state

type StorageSpec

type StorageSpec struct {
	// Count The number of storage devices for a given server.
	Count int `json:"count"`

	// Extra Extra information about the storage resources for a given server.
	Extra map[string]string `json:"extra"`

	// SizeGb The total amount of storage on a given server, in GB.
	SizeGb int `json:"size_gb"`

	// Type The type of the storage device(s).
	Type string `json:"type"`
}

StorageSpec Information about the storage resources for a given server.

type StripeCreditCard

type StripeCreditCard struct {
	Details struct {
		// Brand The brand of card.
		Brand      string `json:"brand"`
		Expiration struct {
			// Month The month the billing method expires.
			Month int `json:"month"`

			// Year The year the billing method expires.
			Year int `json:"year"`
		} `json:"expiration"`

		// Last4 The last 4 digits of the card.
		Last4 string `json:"last_4"`

		// Name The name on the credit card.
		Name string `json:"name"`
	} `json:"details"`
	Type StripeCreditCardType `json:"type"`
}

StripeCreditCard A payment method that utilizes a credit card via Stripe.

type StripeCreditCardType

type StripeCreditCardType string

StripeCreditCardType defines model for StripeCreditCard.Type.

const (
	StripeCreditCardTypeStripeCreditCard StripeCreditCardType = "stripe-credit-card"
)

Defines values for StripeCreditCardType.

type StripeUsBankAcct

type StripeUsBankAcct struct {
	Details struct {
		// Last4 The last 4 numbers of the bank account number.
		Last4 string `json:"last_4"`

		// Name The name of the owner of the bank account.
		Name string `json:"name"`
	} `json:"details"`
	Type StripeUsBankAcctType `json:"type"`
}

StripeUsBankAcct A payment method that utilizes a US bank account via Stripe.

type StripeUsBankAcctType

type StripeUsBankAcctType string

StripeUsBankAcctType defines model for StripeUsBankAcct.Type.

const (
	StripeUsBankAcctTypeStripeUsBankAcct StripeUsBankAcctType = "stripe-us-bank-acct"
)

Defines values for StripeUsBankAcctType.

type SupportPlan

type SupportPlan struct {
	// Contract A boolean where true represents the plan is a long term contract, not just month to month.
	Contract bool `json:"contract"`

	// Default This returns true if it shows up.
	Default bool `json:"default"`

	// Description Information about the billing support plan that describes the plan.
	Description string `json:"description"`

	// Features Information about billing support plan features.
	Features SupportPlanFeatures `json:"features"`

	// Name The name of the support plan.
	Name string `json:"name"`

	// Price An object holding information about term and amount that relates to a specific billing component.
	Price BillingAmount `json:"price"`
}

SupportPlan Information about a billing support plan.

type SupportPlanFeatures

type SupportPlanFeatures struct {
	// EngineeringSupport A boolean where true indicates the contract includes support for engineering.
	EngineeringSupport bool `json:"engineering_support"`

	// GuaranteedResponseTime The time in which this support contract guarantees response time.
	GuaranteedResponseTime *string `json:"guaranteed_response_time"`

	// UptimeSla A boolean where true represents the contract has an uptime SLA agreement.
	UptimeSla bool `json:"uptime_sla"`
}

SupportPlanFeatures Information about billing support plan features.

type TaskState

type TaskState struct {
	Changed *DateTime `json:"changed,omitempty"`

	// Current The current state of the task.
	Current *TaskStateCurrent `json:"current,omitempty"`
}

TaskState defines model for TaskState.

type TaskStateCurrent

type TaskStateCurrent string

TaskStateCurrent The current state of the task.

const (
	TaskStateCurrentCompleted TaskStateCurrent = "completed"
	TaskStateCurrentError     TaskStateCurrent = "error"
	TaskStateCurrentPending   TaskStateCurrent = "pending"
	TaskStateCurrentRunning   TaskStateCurrent = "running"
)

Defines values for TaskStateCurrent.

type TaskStep

type TaskStep struct {
	// Caption A short description of the step.
	Caption   string   `json:"caption"`
	Completed DateTime `json:"completed"`

	// Description A more verbose description.
	Description string   `json:"description"`
	Started     DateTime `json:"started"`
}

TaskStep A step for a given job task.

type TcpRouterConfig

type TcpRouterConfig struct {
	Details map[string]interface{} `json:"details"`
	Type    TcpRouterConfigType    `json:"type"`
}

TcpRouterConfig Additional configuration options for TCP mode routers

type TcpRouterConfigType

type TcpRouterConfigType string

TcpRouterConfigType defines model for TcpRouterConfig.Type.

const (
	TcpRouterConfigTypeTcp TcpRouterConfigType = "tcp"
)

Defines values for TcpRouterConfigType.

type TcpTransportConfig

type TcpTransportConfig struct {
	Details struct {
		Connections map[string]interface{} `json:"connections"`

		// Telemetry Configuration options for how telemetry is handled on the load balancer.
		Telemetry map[string]interface{} `json:"telemetry"`
	} `json:"details"`
	Type TcpTransportConfigType `json:"type"`
}

TcpTransportConfig Additional configuration options for the TCP transport mode.

type TcpTransportConfigType

type TcpTransportConfigType string

TcpTransportConfigType defines model for TcpTransportConfig.Type.

const (
	TcpTransportConfigTypeTcp TcpTransportConfigType = "tcp"
)

Defines values for TcpTransportConfigType.

type TelemetryReportRequest

type TelemetryReportRequest struct {
	End DateTime `json:"end"`

	// InstanceId The ID of the instance this telemetry reporting pertains to.
	InstanceId string   `json:"instance_id"`
	Start      DateTime `json:"start"`
}

TelemetryReportRequest A summary of report requests and when they occured.

type Term

type Term struct {
	End DateTime `json:"end"`

	// Renew The term renewal period.
	Renew *TermRenew `json:"renew"`
	Start DateTime   `json:"start"`
}

Term Information about a billing term.

type TermRenew

type TermRenew string

TermRenew The term renewal period.

const (
	TermRenewMonthly TermRenew = "monthly"
	TermRenewOnce    TermRenew = "once"
	TermRenewYearly  TermRenew = "yearly"
)

Defines values for TermRenew.

type TierPlan

type TierPlan struct {
	AdvancedFeatures struct {
		Autoscale            bool  `json:"autoscale"`
		Deployments          bool  `json:"deployments"`
		ExternalVolumes      *bool `json:"external_volumes,omitempty"`
		Geodns               bool  `json:"geodns"`
		Gpu                  bool  `json:"gpu"`
		Ial                  bool  `json:"ial"`
		ProviderMultiAccount bool  `json:"provider_multi_account"`
		VirtualProvider      bool  `json:"virtual_provider"`
	} `json:"advanced_features"`

	// Builds An object holding information about servers included in Billing tier
	Builds      BillingBuilds `json:"builds"`
	Code        string        `json:"code"`
	Description string        `json:"description"`

	// DnsLinkedRecords Generic structure for a resource with an included allotment, optional hard cap, and per-unit overage cost.
	DnsLinkedRecords ResourceAllowance `json:"dns_linked_records"`

	// DnsZones Generic structure for a resource with an included allotment, optional hard cap, and per-unit overage cost.
	DnsZones   ResourceAllowance `json:"dns_zones"`
	Generation int               `json:"generation"`
	Hidden     bool              `json:"hidden"`

	// Hubs An array of hub IDs with access to the tier.
	Hubs *[]Identifier `json:"hubs"`
	Id   string        `json:"id"`

	// ImageStorage An object holding information about servers included in Billing tier
	ImageStorage        BillingImageStorage `json:"image_storage"`
	MaxDailyApiRequests *int                `json:"max_daily_api_requests"`
	MaxMembers          *int                `json:"max_members"`
	MaxNodes            *int                `json:"max_nodes"`

	// Members Generic structure for a resource with an included allotment, optional hard cap, and per-unit overage cost.
	Members ResourceAllowance `json:"members"`
	Name    string            `json:"name"`

	// Price An object holding information about term and amount that relates to a specific billing component.
	Price BillingAmount `json:"price"`

	// Ram An object holding information about servers included in Billing tier
	Ram BillingRam `json:"ram"`

	// Servers Generic structure for a resource with an included allotment, optional hard cap, and per-unit overage cost.
	Servers ResourceAllowance `json:"servers"`
	Usable  bool              `json:"usable"`
}

TierPlan A TierPlan object describes the attributes of a subscription tier

type TlsCertificate

type TlsCertificate struct {
	// Domains A list of domains associated with the certificate.
	Domains []string `json:"domains"`

	// Events A collection of timestamps for each event in the TLS certificate's lifetime.
	Events struct {
		Created   DateTime `json:"created"`
		Deleted   DateTime `json:"deleted"`
		Generated DateTime `json:"generated"`
		Updated   DateTime `json:"updated"`
	} `json:"events"`
	Expires DateTime `json:"expires"`
	HubId   *ID      `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id    ID `json:"id"`
	State struct {
		Changed DateTime `json:"changed"`

		// Current The current state of the TLS certificate.
		Current TlsCertificateStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`

	// UserSupplied Whether or not this certificate was uploaded instead of generated by the platform.
	UserSupplied bool `json:"user_supplied"`
}

TlsCertificate A TLS certificate.

type TlsCertificateStateCurrent

type TlsCertificateStateCurrent string

TlsCertificateStateCurrent The current state of the TLS certificate.

const (
	TlsCertificateStateCurrentDeprecated TlsCertificateStateCurrent = "deprecated"
	TlsCertificateStateCurrentLive       TlsCertificateStateCurrent = "live"
	TlsCertificateStateCurrentNew        TlsCertificateStateCurrent = "new"
	TlsCertificateStateCurrentProcessing TlsCertificateStateCurrent = "processing"
)

Defines values for TlsCertificateStateCurrent.

type TriggerKey

type TriggerKey struct {
	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the trigger key's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Ips An array of ips this trigger key is usable from.
	Ips []string `json:"ips"`

	// Name The name of the trigger key.
	Name string `json:"name"`

	// PipelineId The ID for the pipeline related to this trigger key.
	PipelineId string `json:"pipeline_id"`

	// Secret The secret used when calling the trigger key programmatically.
	Secret string          `json:"secret"`
	State  TriggerKeyState `json:"state"`
}

TriggerKey A pipeline trigger key resource.

type TriggerKeyState

type TriggerKeyState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the trigger key.
	Current TriggerKeyStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

TriggerKeyState defines model for TriggerKeyState.

type TriggerKeyStateCurrent

type TriggerKeyStateCurrent string

TriggerKeyStateCurrent The current state of the trigger key.

const (
	TriggerKeyStateCurrentDeleted  TriggerKeyStateCurrent = "deleted"
	TriggerKeyStateCurrentDeleting TriggerKeyStateCurrent = "deleting"
	TriggerKeyStateCurrentLive     TriggerKeyStateCurrent = "live"
)

Defines values for TriggerKeyStateCurrent.

type TriggerPipelineJSONBody

type TriggerPipelineJSONBody struct {
	Advanced *struct {
		// SkipLocks To enable skip locks, pass the current UNIX timestamp. Must be accurate within 10 minutes of the current UTC time.
		// This will skip lock checks when running a pipeline - the user takes all risk of ensuring two pipeline runs won't make conflicting changes.
		SkipLocks *int `json:"skip_locks"`

		// SubQueue Sub queue allows multiple concurrent pipeline runs.
		SubQueue *string `json:"sub_queue"`
	} `json:"advanced,omitempty"`

	// Secret The trigger key secret.
	Secret string `json:"secret"`

	// Variables A map of variables to pass into the pipeline when it runs.
	Variables map[string]string `json:"variables"`
}

TriggerPipelineJSONBody defines parameters for TriggerPipeline.

type TriggerPipelineJSONRequestBody

type TriggerPipelineJSONRequestBody TriggerPipelineJSONBody

TriggerPipelineJSONRequestBody defines body for TriggerPipeline for application/json ContentType.

type TriggerPipelineResponse

type TriggerPipelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data A Job Descriptor is returned on success by API calls that create jobs. It contains the action that was requested, as well as the ID of the job created as a result.
		Data JobDescriptor `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseTriggerPipelineResponse

func ParseTriggerPipelineResponse(rsp *http.Response) (*TriggerPipelineResponse, error)

ParseTriggerPipelineResponse parses an HTTP response from a TriggerPipelineWithResponse call

func (TriggerPipelineResponse) Status

func (r TriggerPipelineResponse) Status() string

Status returns HTTPResponse.Status

func (TriggerPipelineResponse) StatusCode

func (r TriggerPipelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TwoFactorAuthRecovery

type TwoFactorAuthRecovery struct {
	RecoveryCodes []string `json:"recovery_codes"`
	TotpPasscode  string   `json:"totp_passcode"`
}

TwoFactorAuthRecovery defines model for TwoFactorAuthRecovery.

type TwoFactorAuthSetup

type TwoFactorAuthSetup struct {
	Qr     string `json:"qr"`
	Secret string `json:"secret"`
}

TwoFactorAuthSetup defines model for TwoFactorAuthSetup.

type URLSource

type URLSource struct {
	Details struct {
		// AuthTokenUrl A URL that can be provided to authenticate with a third party secret service. Cycle will make a request to this URL before fetching the secret URL, and use the response as the value of an Authorization header when requesting the secret.
		AuthTokenUrl *string `json:"auth_token_url"`

		// Headers Additional headers that can be attached to the URL request. Useful for adding metadata to third-party services.
		Headers map[string]interface{} `json:"headers"`

		// Url The URL to call to produce the value.
		Url string `json:"url"`
	} `json:"details"`

	// Type The type of source value, can be either `raw` or `url`.
	Type URLSourceType `json:"type"`
}

URLSource The `URL` type of scoped variable `value`, referred to as a source. This means the value of this variable is the result of calling the given URL. It is dynamic, in that Cycle will refetch the contents on every start.

type URLSourceType

type URLSourceType string

URLSourceType The type of source value, can be either `raw` or `url`.

const (
	URLSourceTypeUrl URLSourceType = "url"
)

Defines values for URLSourceType.

type UdpRouterConfig

type UdpRouterConfig struct {
	Details map[string]interface{} `json:"details"`
	Type    UdpRouterConfigType    `json:"type"`
}

UdpRouterConfig Additional configuration options for UDP mode routers

type UdpRouterConfigType

type UdpRouterConfigType string

UdpRouterConfigType defines model for UdpRouterConfig.Type.

const (
	UdpRouterConfigTypeUdp UdpRouterConfigType = "udp"
)

Defines values for UdpRouterConfigType.

type UdpTransportConfig

type UdpTransportConfig struct {
	Details struct {
		// Telemetry Configuration options for how telemetry is handled on the load balancer.
		Telemetry map[string]interface{} `json:"telemetry"`
	} `json:"details"`
	Type UdpTransportConfigType `json:"type"`
}

UdpTransportConfig Additional configuration options for the UDP transport mode.

type UdpTransportConfigType

type UdpTransportConfigType string

UdpTransportConfigType defines model for UdpTransportConfig.Type.

const (
	UdpTransportConfigTypeUdp UdpTransportConfigType = "udp"
)

Defines values for UdpTransportConfigType.

type UpdateAPIKeyJSONBody

type UpdateAPIKeyJSONBody struct {
	// Ips An array of approved IPs from which this API Key can be used.
	Ips *[]string `json:"ips"`

	// Name A name given to the API Key.
	Name *string `json:"name,omitempty"`

	// RoleId A 24 character hex string used to identify a unique resource.
	RoleId *ID `json:"role_id,omitempty"`
}

UpdateAPIKeyJSONBody defines parameters for UpdateAPIKey.

type UpdateAPIKeyJSONRequestBody

type UpdateAPIKeyJSONRequestBody UpdateAPIKeyJSONBody

UpdateAPIKeyJSONRequestBody defines body for UpdateAPIKey for application/json ContentType.

type UpdateAPIKeyResponse

type UpdateAPIKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An API key resource
		Data ApiKey `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateAPIKeyResponse

func ParseUpdateAPIKeyResponse(rsp *http.Response) (*UpdateAPIKeyResponse, error)

ParseUpdateAPIKeyResponse parses an HTTP response from a UpdateAPIKeyWithResponse call

func (UpdateAPIKeyResponse) Status

func (r UpdateAPIKeyResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateAPIKeyResponse) StatusCode

func (r UpdateAPIKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateAccountInviteJSONBody

type UpdateAccountInviteJSONBody struct {
	// Accept If true, the Invite will be accepted and the associated Account will join the Hub.
	Accept *bool `json:"accept,omitempty"`

	// Decline If true, the Invite will be declined and the associated Account will NOT join the Hub.
	Decline *bool `json:"decline,omitempty"`
}

UpdateAccountInviteJSONBody defines parameters for UpdateAccountInvite.

type UpdateAccountInviteJSONRequestBody

type UpdateAccountInviteJSONRequestBody UpdateAccountInviteJSONBody

UpdateAccountInviteJSONRequestBody defines body for UpdateAccountInvite for application/json ContentType.

type UpdateAccountInviteParams

type UpdateAccountInviteParams struct {
	Include *MembershipIncludeParam `form:"include,omitempty" json:"include,omitempty"`
}

UpdateAccountInviteParams defines parameters for UpdateAccountInvite.

type UpdateAccountInviteParamsInclude

type UpdateAccountInviteParamsInclude string

UpdateAccountInviteParamsInclude defines parameters for UpdateAccountInvite.

const (
	UpdateAccountInviteParamsIncludeHubs    UpdateAccountInviteParamsInclude = "hubs"
	UpdateAccountInviteParamsIncludeRoles   UpdateAccountInviteParamsInclude = "roles"
	UpdateAccountInviteParamsIncludeSenders UpdateAccountInviteParamsInclude = "senders"
)

Defines values for UpdateAccountInviteParamsInclude.

type UpdateAccountInviteResponse

type UpdateAccountInviteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A membership resource that is scoped to an individual hub.
		Data HubMembership `json:"data"`

		// Includes A resource that is associated with an account's membership.
		Includes *AccountMembershipIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateAccountInviteResponse

func ParseUpdateAccountInviteResponse(rsp *http.Response) (*UpdateAccountInviteResponse, error)

ParseUpdateAccountInviteResponse parses an HTTP response from a UpdateAccountInviteWithResponse call

func (UpdateAccountInviteResponse) Status

Status returns HTTPResponse.Status

func (UpdateAccountInviteResponse) StatusCode

func (r UpdateAccountInviteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateAccountJSONBody

type UpdateAccountJSONBody struct {
	// AllowSupportLogin If true, Cycle employees will have the ability, upon consent, to access the account for support purposes. This access will be logged.
	AllowSupportLogin *bool `json:"allow_support_login,omitempty"`

	// Name The new name on the Account.
	Name *struct {
		First *string `json:"first,omitempty"`
		Last  *string `json:"last,omitempty"`
	} `json:"name,omitempty"`
}

UpdateAccountJSONBody defines parameters for UpdateAccount.

type UpdateAccountJSONRequestBody

type UpdateAccountJSONRequestBody UpdateAccountJSONBody

UpdateAccountJSONRequestBody defines body for UpdateAccount for application/json ContentType.

type UpdateAccountResponse

type UpdateAccountResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An object representing information about the currently logged-in user.
		Data Account `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateAccountResponse

func ParseUpdateAccountResponse(rsp *http.Response) (*UpdateAccountResponse, error)

ParseUpdateAccountResponse parses an HTTP response from a UpdateAccountWithResponse call

func (UpdateAccountResponse) Status

func (r UpdateAccountResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateAccountResponse) StatusCode

func (r UpdateAccountResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateAutoScaleGroupAccessJSONBody

type UpdateAutoScaleGroupAccessJSONBody struct {
	Acl *ACL `json:"acl"`
}

UpdateAutoScaleGroupAccessJSONBody defines parameters for UpdateAutoScaleGroupAccess.

type UpdateAutoScaleGroupAccessJSONRequestBody

type UpdateAutoScaleGroupAccessJSONRequestBody UpdateAutoScaleGroupAccessJSONBody

UpdateAutoScaleGroupAccessJSONRequestBody defines body for UpdateAutoScaleGroupAccess for application/json ContentType.

type UpdateAutoScaleGroupAccessResponse

type UpdateAutoScaleGroupAccessResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data AutoScaleGroup `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateAutoScaleGroupAccessResponse

func ParseUpdateAutoScaleGroupAccessResponse(rsp *http.Response) (*UpdateAutoScaleGroupAccessResponse, error)

ParseUpdateAutoScaleGroupAccessResponse parses an HTTP response from a UpdateAutoScaleGroupAccessWithResponse call

func (UpdateAutoScaleGroupAccessResponse) Status

Status returns HTTPResponse.Status

func (UpdateAutoScaleGroupAccessResponse) StatusCode

func (r UpdateAutoScaleGroupAccessResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateAutoScaleGroupJSONBody

type UpdateAutoScaleGroupJSONBody struct {
	Identifier     *string                       `json:"identifier"`
	Infrastructure *AutoScaleGroupInfrastructure `json:"infrastructure"`
	Name           *string                       `json:"name"`
	Scale          *AutoScaleGroupScale          `json:"scale"`
}

UpdateAutoScaleGroupJSONBody defines parameters for UpdateAutoScaleGroup.

type UpdateAutoScaleGroupJSONRequestBody

type UpdateAutoScaleGroupJSONRequestBody UpdateAutoScaleGroupJSONBody

UpdateAutoScaleGroupJSONRequestBody defines body for UpdateAutoScaleGroup for application/json ContentType.

type UpdateAutoScaleGroupResponse

type UpdateAutoScaleGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data AutoScaleGroup `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateAutoScaleGroupResponse

func ParseUpdateAutoScaleGroupResponse(rsp *http.Response) (*UpdateAutoScaleGroupResponse, error)

ParseUpdateAutoScaleGroupResponse parses an HTTP response from a UpdateAutoScaleGroupWithResponse call

func (UpdateAutoScaleGroupResponse) Status

Status returns HTTPResponse.Status

func (UpdateAutoScaleGroupResponse) StatusCode

func (r UpdateAutoScaleGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateBillingMethodJSONBody

type UpdateBillingMethodJSONBody struct {
	// Name A name for the billing method.
	Name *string `json:"name,omitempty"`

	// Primary A boolean where true represents a billing method being primary.
	Primary *bool `json:"primary,omitempty"`
}

UpdateBillingMethodJSONBody defines parameters for UpdateBillingMethod.

type UpdateBillingMethodJSONRequestBody

type UpdateBillingMethodJSONRequestBody UpdateBillingMethodJSONBody

UpdateBillingMethodJSONRequestBody defines body for UpdateBillingMethod for application/json ContentType.

type UpdateBillingMethodResponse

type UpdateBillingMethodResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Information about a billing method, usable to pay invoices.
		Data Method `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateBillingMethodResponse

func ParseUpdateBillingMethodResponse(rsp *http.Response) (*UpdateBillingMethodResponse, error)

ParseUpdateBillingMethodResponse parses an HTTP response from a UpdateBillingMethodWithResponse call

func (UpdateBillingMethodResponse) Status

Status returns HTTPResponse.Status

func (UpdateBillingMethodResponse) StatusCode

func (r UpdateBillingMethodResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateBillingOrderJSONBody

type UpdateBillingOrderJSONBody struct {
	// PromoCode String that defines a promo code
	PromoCode *string `json:"promo_code,omitempty"`

	// SupportPlanId ID associated with the support plan
	SupportPlanId *string `json:"support_plan_id,omitempty"`

	// TermLength String that defines term length
	TermLength *UpdateBillingOrderJSONBodyTermLength `json:"term_length,omitempty"`

	// TierPlanId ID associated with the tier plan
	TierPlanId *string `json:"tier_plan_id,omitempty"`
}

UpdateBillingOrderJSONBody defines parameters for UpdateBillingOrder.

type UpdateBillingOrderJSONBodyTermLength

type UpdateBillingOrderJSONBodyTermLength string

UpdateBillingOrderJSONBodyTermLength defines parameters for UpdateBillingOrder.

Defines values for UpdateBillingOrderJSONBodyTermLength.

type UpdateBillingOrderJSONRequestBody

type UpdateBillingOrderJSONRequestBody UpdateBillingOrderJSONBody

UpdateBillingOrderJSONRequestBody defines body for UpdateBillingOrder for application/json ContentType.

type UpdateBillingOrderParams

type UpdateBillingOrderParams struct {
	Meta    *[]UpdateBillingOrderParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
	Include *OrderIncludeParam              `form:"include,omitempty" json:"include,omitempty"`
}

UpdateBillingOrderParams defines parameters for UpdateBillingOrder.

type UpdateBillingOrderParamsInclude

type UpdateBillingOrderParamsInclude string

UpdateBillingOrderParamsInclude defines parameters for UpdateBillingOrder.

const (
	UpdateBillingOrderParamsIncludePromoCodes UpdateBillingOrderParamsInclude = "promo_codes"
)

Defines values for UpdateBillingOrderParamsInclude.

type UpdateBillingOrderParamsMeta

type UpdateBillingOrderParamsMeta string

UpdateBillingOrderParamsMeta defines parameters for UpdateBillingOrder.

const (
	UpdateBillingOrderParamsMetaDue UpdateBillingOrderParamsMeta = "due"
)

Defines values for UpdateBillingOrderParamsMeta.

type UpdateBillingOrderResponse

type UpdateBillingOrderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An order is a resource that describes a billing order
		Data     Order                 `json:"data"`
		Includes *BillingOrderIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateBillingOrderResponse

func ParseUpdateBillingOrderResponse(rsp *http.Response) (*UpdateBillingOrderResponse, error)

ParseUpdateBillingOrderResponse parses an HTTP response from a UpdateBillingOrderWithResponse call

func (UpdateBillingOrderResponse) Status

Status returns HTTPResponse.Status

func (UpdateBillingOrderResponse) StatusCode

func (r UpdateBillingOrderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateClusterAccessJSONBody

type UpdateClusterAccessJSONBody struct {
	Acl *ACL `json:"acl"`
}

UpdateClusterAccessJSONBody defines parameters for UpdateClusterAccess.

type UpdateClusterAccessJSONRequestBody

type UpdateClusterAccessJSONRequestBody UpdateClusterAccessJSONBody

UpdateClusterAccessJSONRequestBody defines body for UpdateClusterAccess for application/json ContentType.

type UpdateClusterAccessResponse

type UpdateClusterAccessResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Clusters are groups of servers that allow physical separation of resources.
		Data Cluster `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateClusterAccessResponse

func ParseUpdateClusterAccessResponse(rsp *http.Response) (*UpdateClusterAccessResponse, error)

ParseUpdateClusterAccessResponse parses an HTTP response from a UpdateClusterAccessWithResponse call

func (UpdateClusterAccessResponse) Status

Status returns HTTPResponse.Status

func (UpdateClusterAccessResponse) StatusCode

func (r UpdateClusterAccessResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateClusterJSONBody

type UpdateClusterJSONBody struct {
	// NonEssential Set to true to mark the cluster as 'non-essential'. Non-essential cluster resources are excluded by default from certain metrics and summaries unless opted in.
	NonEssential *bool `json:"non_essential,omitempty"`
}

UpdateClusterJSONBody defines parameters for UpdateCluster.

type UpdateClusterJSONRequestBody

type UpdateClusterJSONRequestBody UpdateClusterJSONBody

UpdateClusterJSONRequestBody defines body for UpdateCluster for application/json ContentType.

type UpdateClusterResponse

type UpdateClusterResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Clusters are groups of servers that allow physical separation of resources.
		Data Cluster `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateClusterResponse

func ParseUpdateClusterResponse(rsp *http.Response) (*UpdateClusterResponse, error)

ParseUpdateClusterResponse parses an HTTP response from a UpdateClusterWithResponse call

func (UpdateClusterResponse) Status

func (r UpdateClusterResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateClusterResponse) StatusCode

func (r UpdateClusterResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateContainerJSONBody

type UpdateContainerJSONBody struct {
	// Annotation User meta data for the Container.
	Annotation *map[string]string `json:"annotation,omitempty"`

	// Deprecate Sets whether Container should be deprecated.
	Deprecate *bool `json:"deprecate,omitempty"`

	// Identifier The name for the identifier.
	Identifier *string `json:"identifier,omitempty"`

	// Lock When set to true, prevents this Container from being deleted.
	Lock *bool `json:"lock,omitempty"`

	// Name The name for the Container.
	Name *string `json:"name,omitempty"`
}

UpdateContainerJSONBody defines parameters for UpdateContainer.

type UpdateContainerJSONRequestBody

type UpdateContainerJSONRequestBody UpdateContainerJSONBody

UpdateContainerJSONRequestBody defines body for UpdateContainer for application/json ContentType.

type UpdateContainerResponse

type UpdateContainerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Containers are a way to package together your application along with it's dependencies, and run in a resource isolated process. They provide consistency across different hosts, efficiency over traditional hosting methods, and facilitate a micro-service based approach, where each logical piece of your application is split into multiple, easily testable parts (such as API, Backend, Frontend, etc).
		Data Container `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateContainerResponse

func ParseUpdateContainerResponse(rsp *http.Response) (*UpdateContainerResponse, error)

ParseUpdateContainerResponse parses an HTTP response from a UpdateContainerWithResponse call

func (UpdateContainerResponse) Status

func (r UpdateContainerResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateContainerResponse) StatusCode

func (r UpdateContainerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateDNSZoneAccessJSONBody

type UpdateDNSZoneAccessJSONBody struct {
	Acl *ACL `json:"acl"`
}

UpdateDNSZoneAccessJSONBody defines parameters for UpdateDNSZoneAccess.

type UpdateDNSZoneAccessJSONRequestBody

type UpdateDNSZoneAccessJSONRequestBody UpdateDNSZoneAccessJSONBody

UpdateDNSZoneAccessJSONRequestBody defines body for UpdateDNSZoneAccess for application/json ContentType.

type UpdateDNSZoneAccessParams

type UpdateDNSZoneAccessParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]UpdateDNSZoneAccessParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

UpdateDNSZoneAccessParams defines parameters for UpdateDNSZoneAccess.

type UpdateDNSZoneAccessParamsInclude

type UpdateDNSZoneAccessParamsInclude string

UpdateDNSZoneAccessParamsInclude defines parameters for UpdateDNSZoneAccess.

const (
	UpdateDNSZoneAccessParamsIncludeCreators UpdateDNSZoneAccessParamsInclude = "creators"
)

Defines values for UpdateDNSZoneAccessParamsInclude.

type UpdateDNSZoneAccessResponse

type UpdateDNSZoneAccessResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data DNS (Domain Name System), in short, is a decentralized naming system for computers, services, or other resources connected to the internet or a private network. It is what allows the translation of a URL, such as http://example.com, to an IP address.
		Data DnsZone `json:"data"`

		// Includes All includable resources linkable to the given Zone.
		Includes *DnsZoneIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateDNSZoneAccessResponse

func ParseUpdateDNSZoneAccessResponse(rsp *http.Response) (*UpdateDNSZoneAccessResponse, error)

ParseUpdateDNSZoneAccessResponse parses an HTTP response from a UpdateDNSZoneAccessWithResponse call

func (UpdateDNSZoneAccessResponse) Status

Status returns HTTPResponse.Status

func (UpdateDNSZoneAccessResponse) StatusCode

func (r UpdateDNSZoneAccessResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateDNSZoneJSONBody

type UpdateDNSZoneJSONBody struct {
	// Hosted A boolean where true represents the desire for the origin to be of the type `hosted`.
	Hosted *bool `json:"hosted"`
}

UpdateDNSZoneJSONBody defines parameters for UpdateDNSZone.

type UpdateDNSZoneJSONRequestBody

type UpdateDNSZoneJSONRequestBody UpdateDNSZoneJSONBody

UpdateDNSZoneJSONRequestBody defines body for UpdateDNSZone for application/json ContentType.

type UpdateDNSZoneParams

type UpdateDNSZoneParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]UpdateDNSZoneParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

UpdateDNSZoneParams defines parameters for UpdateDNSZone.

type UpdateDNSZoneParamsInclude

type UpdateDNSZoneParamsInclude string

UpdateDNSZoneParamsInclude defines parameters for UpdateDNSZone.

const (
	UpdateDNSZoneParamsIncludeCreators UpdateDNSZoneParamsInclude = "creators"
)

Defines values for UpdateDNSZoneParamsInclude.

type UpdateDNSZoneRecordJSONBody

type UpdateDNSZoneRecordJSONBody struct {
	// Type DNS record types the platform supports.
	Type DnsRecordTypes `json:"type"`
}

UpdateDNSZoneRecordJSONBody defines parameters for UpdateDNSZoneRecord.

type UpdateDNSZoneRecordJSONRequestBody

type UpdateDNSZoneRecordJSONRequestBody UpdateDNSZoneRecordJSONBody

UpdateDNSZoneRecordJSONRequestBody defines body for UpdateDNSZoneRecord for application/json ContentType.

type UpdateDNSZoneRecordParams

type UpdateDNSZoneRecordParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *RecordIncludeParam `form:"include,omitempty" json:"include,omitempty"`
}

UpdateDNSZoneRecordParams defines parameters for UpdateDNSZoneRecord.

type UpdateDNSZoneRecordParamsInclude

type UpdateDNSZoneRecordParamsInclude string

UpdateDNSZoneRecordParamsInclude defines parameters for UpdateDNSZoneRecord.

const (
	UpdateDNSZoneRecordParamsIncludeContainers                 UpdateDNSZoneRecordParamsInclude = "containers"
	UpdateDNSZoneRecordParamsIncludeContainersIdentifiers      UpdateDNSZoneRecordParamsInclude = "containers:identifiers"
	UpdateDNSZoneRecordParamsIncludeCreators                   UpdateDNSZoneRecordParamsInclude = "creators"
	UpdateDNSZoneRecordParamsIncludeVirtualMachines            UpdateDNSZoneRecordParamsInclude = "virtual-machines"
	UpdateDNSZoneRecordParamsIncludeVirtualMachinesIdentifiers UpdateDNSZoneRecordParamsInclude = "virtual-machines:identifiers"
)

Defines values for UpdateDNSZoneRecordParamsInclude.

type UpdateDNSZoneRecordResponse

type UpdateDNSZoneRecordResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A DNS record.
		Data DnsRecord `json:"data"`

		// Includes All includable resources linkable to the given records.
		Includes *RecordIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateDNSZoneRecordResponse

func ParseUpdateDNSZoneRecordResponse(rsp *http.Response) (*UpdateDNSZoneRecordResponse, error)

ParseUpdateDNSZoneRecordResponse parses an HTTP response from a UpdateDNSZoneRecordWithResponse call

func (UpdateDNSZoneRecordResponse) Status

Status returns HTTPResponse.Status

func (UpdateDNSZoneRecordResponse) StatusCode

func (r UpdateDNSZoneRecordResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateDNSZoneResponse

type UpdateDNSZoneResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data DNS (Domain Name System), in short, is a decentralized naming system for computers, services, or other resources connected to the internet or a private network. It is what allows the translation of a URL, such as http://example.com, to an IP address.
		Data DnsZone `json:"data"`

		// Includes All includable resources linkable to the given Zone.
		Includes *DnsZoneIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateDNSZoneResponse

func ParseUpdateDNSZoneResponse(rsp *http.Response) (*UpdateDNSZoneResponse, error)

ParseUpdateDNSZoneResponse parses an HTTP response from a UpdateDNSZoneWithResponse call

func (UpdateDNSZoneResponse) Status

func (r UpdateDNSZoneResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateDNSZoneResponse) StatusCode

func (r UpdateDNSZoneResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateEnvironmentAccessJSONBody

type UpdateEnvironmentAccessJSONBody struct {
	Acl *ACL `json:"acl"`
}

UpdateEnvironmentAccessJSONBody defines parameters for UpdateEnvironmentAccess.

type UpdateEnvironmentAccessJSONRequestBody

type UpdateEnvironmentAccessJSONRequestBody UpdateEnvironmentAccessJSONBody

UpdateEnvironmentAccessJSONRequestBody defines body for UpdateEnvironmentAccess for application/json ContentType.

type UpdateEnvironmentAccessResponse

type UpdateEnvironmentAccessResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Environments are groups of containers with a private network built between them. For more information on environments, see the [main docs](https://cycle.io/docs/platform/introduction-to-environments).
		Data Environment `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateEnvironmentAccessResponse

func ParseUpdateEnvironmentAccessResponse(rsp *http.Response) (*UpdateEnvironmentAccessResponse, error)

ParseUpdateEnvironmentAccessResponse parses an HTTP response from a UpdateEnvironmentAccessWithResponse call

func (UpdateEnvironmentAccessResponse) Status

Status returns HTTPResponse.Status

func (UpdateEnvironmentAccessResponse) StatusCode

func (r UpdateEnvironmentAccessResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateEnvironmentJSONBody

type UpdateEnvironmentJSONBody struct {
	About      *EnvironmentAbout `json:"about"`
	Identifier *string           `json:"identifier"`
	Name       *string           `json:"name"`
	Version    *string           `json:"version"`
}

UpdateEnvironmentJSONBody defines parameters for UpdateEnvironment.

type UpdateEnvironmentJSONRequestBody

type UpdateEnvironmentJSONRequestBody UpdateEnvironmentJSONBody

UpdateEnvironmentJSONRequestBody defines body for UpdateEnvironment for application/json ContentType.

type UpdateEnvironmentResponse

type UpdateEnvironmentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Environments are groups of containers with a private network built between them. For more information on environments, see the [main docs](https://cycle.io/docs/platform/introduction-to-environments).
		Data Environment `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateEnvironmentResponse

func ParseUpdateEnvironmentResponse(rsp *http.Response) (*UpdateEnvironmentResponse, error)

ParseUpdateEnvironmentResponse parses an HTTP response from a UpdateEnvironmentWithResponse call

func (UpdateEnvironmentResponse) Status

func (r UpdateEnvironmentResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateEnvironmentResponse) StatusCode

func (r UpdateEnvironmentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateExternalVolumeAccessJSONBody added in v0.6.5

type UpdateExternalVolumeAccessJSONBody struct {
	Acl *ACL `json:"acl"`
}

UpdateExternalVolumeAccessJSONBody defines parameters for UpdateExternalVolumeAccess.

type UpdateExternalVolumeAccessJSONRequestBody added in v0.6.5

type UpdateExternalVolumeAccessJSONRequestBody UpdateExternalVolumeAccessJSONBody

UpdateExternalVolumeAccessJSONRequestBody defines body for UpdateExternalVolumeAccess for application/json ContentType.

type UpdateExternalVolumeAccessResponse added in v0.6.5

type UpdateExternalVolumeAccessResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A persistent storage volume within a cluster. Volumes may be attached to containers or VMs and can originate from different storage sources.
		Data ExternalVolume `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateExternalVolumeAccessResponse added in v0.6.5

func ParseUpdateExternalVolumeAccessResponse(rsp *http.Response) (*UpdateExternalVolumeAccessResponse, error)

ParseUpdateExternalVolumeAccessResponse parses an HTTP response from a UpdateExternalVolumeAccessWithResponse call

func (UpdateExternalVolumeAccessResponse) Status added in v0.6.5

Status returns HTTPResponse.Status

func (UpdateExternalVolumeAccessResponse) StatusCode added in v0.6.5

func (r UpdateExternalVolumeAccessResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateExternalVolumeJSONBody added in v0.6.5

type UpdateExternalVolumeJSONBody struct {
	About *struct {
		// Description Updated description for the attached volume.
		Description *string `json:"description,omitempty"`
	} `json:"about,omitempty"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Name The new name of the external volume.
	Name *string `json:"name,omitempty"`

	// Options Configuration options controlling the behavior of the volume.
	Options *ExternalVolumeOptions `json:"options,omitempty"`
}

UpdateExternalVolumeJSONBody defines parameters for UpdateExternalVolume.

type UpdateExternalVolumeJSONRequestBody added in v0.6.5

type UpdateExternalVolumeJSONRequestBody UpdateExternalVolumeJSONBody

UpdateExternalVolumeJSONRequestBody defines body for UpdateExternalVolume for application/json ContentType.

type UpdateExternalVolumeParams added in v0.6.5

type UpdateExternalVolumeParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]UpdateExternalVolumeParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`

	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]UpdateExternalVolumeParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

UpdateExternalVolumeParams defines parameters for UpdateExternalVolume.

type UpdateExternalVolumeParamsInclude added in v0.6.5

type UpdateExternalVolumeParamsInclude string

UpdateExternalVolumeParamsInclude defines parameters for UpdateExternalVolume.

const (
	UpdateExternalVolumeParamsIncludeLocations UpdateExternalVolumeParamsInclude = "locations"
	UpdateExternalVolumeParamsIncludeServers   UpdateExternalVolumeParamsInclude = "servers"
)

Defines values for UpdateExternalVolumeParamsInclude.

type UpdateExternalVolumeParamsMeta added in v0.6.5

type UpdateExternalVolumeParamsMeta string

UpdateExternalVolumeParamsMeta defines parameters for UpdateExternalVolume.

const (
	UpdateExternalVolumeParamsMetaContainers UpdateExternalVolumeParamsMeta = "containers"
)

Defines values for UpdateExternalVolumeParamsMeta.

type UpdateExternalVolumeResponse added in v0.6.5

type UpdateExternalVolumeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A persistent storage volume within a cluster. Volumes may be attached to containers or VMs and can originate from different storage sources.
		Data ExternalVolume `json:"data"`

		// Includes All includable resources linked to the given external volume.
		Includes *ExternalVolumeIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateExternalVolumeResponse added in v0.6.5

func ParseUpdateExternalVolumeResponse(rsp *http.Response) (*UpdateExternalVolumeResponse, error)

ParseUpdateExternalVolumeResponse parses an HTTP response from a UpdateExternalVolumeWithResponse call

func (UpdateExternalVolumeResponse) Status added in v0.6.5

Status returns HTTPResponse.Status

func (UpdateExternalVolumeResponse) StatusCode added in v0.6.5

func (r UpdateExternalVolumeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateHubJSONBody

type UpdateHubJSONBody struct {
	BillingContact *struct {
		LegalBusinessName *string `json:"legal_business_name"`
		Name              *string `json:"name"`
		TaxId             *string `json:"tax_id"`
	} `json:"billing_contact"`

	// BillingEmails Email addresses that will receive any invoices or billing related correspondence.
	BillingEmails *[]string `json:"billing_emails,omitempty"`
	Identifier    *string   `json:"identifier,omitempty"`

	// Name A name for the hub.
	Name *string `json:"name,omitempty"`

	// Security Security options for a hub.
	Security *HubSecurity `json:"security,omitempty"`

	// Webhooks Hub related webhooks. When supplied, the given webhook will be called with a payload any time one of these events occurs.
	Webhooks *HubWebhooks `json:"webhooks,omitempty"`
}

UpdateHubJSONBody defines parameters for UpdateHub.

type UpdateHubJSONRequestBody

type UpdateHubJSONRequestBody UpdateHubJSONBody

UpdateHubJSONRequestBody defines body for UpdateHub for application/json ContentType.

type UpdateHubMemberJSONBody

type UpdateHubMemberJSONBody struct {
	// Permissions Permissions information for an API Key
	Permissions *Permissions `json:"permissions,omitempty"`

	// RoleId A 24 character hex string used to identify a unique resource.
	RoleId *ID `json:"role_id,omitempty"`
}

UpdateHubMemberJSONBody defines parameters for UpdateHubMember.

type UpdateHubMemberJSONRequestBody

type UpdateHubMemberJSONRequestBody UpdateHubMemberJSONBody

UpdateHubMemberJSONRequestBody defines body for UpdateHubMember for application/json ContentType.

type UpdateHubMemberResponse

type UpdateHubMemberResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A membership resource that is scoped to an individual hub.
		Data HubMembership `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateHubMemberResponse

func ParseUpdateHubMemberResponse(rsp *http.Response) (*UpdateHubMemberResponse, error)

ParseUpdateHubMemberResponse parses an HTTP response from a UpdateHubMemberWithResponse call

func (UpdateHubMemberResponse) Status

func (r UpdateHubMemberResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateHubMemberResponse) StatusCode

func (r UpdateHubMemberResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateHubResponse

type UpdateHubResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A hub resource.
		Data Hub `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateHubResponse

func ParseUpdateHubResponse(rsp *http.Response) (*UpdateHubResponse, error)

ParseUpdateHubResponse parses an HTTP response from a UpdateHubWithResponse call

func (UpdateHubResponse) Status

func (r UpdateHubResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateHubResponse) StatusCode

func (r UpdateHubResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateImageJSONBody

type UpdateImageJSONBody struct {
	// Name A name for the image.
	Name *string `json:"name,omitempty"`
}

UpdateImageJSONBody defines parameters for UpdateImage.

type UpdateImageJSONRequestBody

type UpdateImageJSONRequestBody UpdateImageJSONBody

UpdateImageJSONRequestBody defines body for UpdateImage for application/json ContentType.

type UpdateImageResponse

type UpdateImageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An image is a point in time build on a given image source, and what is distributed by Cycle to run containers.
		Data Image `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateImageResponse

func ParseUpdateImageResponse(rsp *http.Response) (*UpdateImageResponse, error)

ParseUpdateImageResponse parses an HTTP response from a UpdateImageWithResponse call

func (UpdateImageResponse) Status

func (r UpdateImageResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateImageResponse) StatusCode

func (r UpdateImageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateImageSourceAccessJSONBody

type UpdateImageSourceAccessJSONBody struct {
	Acl *ACL `json:"acl"`
}

UpdateImageSourceAccessJSONBody defines parameters for UpdateImageSourceAccess.

type UpdateImageSourceAccessJSONRequestBody

type UpdateImageSourceAccessJSONRequestBody UpdateImageSourceAccessJSONBody

UpdateImageSourceAccessJSONRequestBody defines body for UpdateImageSourceAccess for application/json ContentType.

type UpdateImageSourceAccessResponse

type UpdateImageSourceAccessResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An image source is a set of resources that direct the platform on where it can find the resources needed to build an image resource.
		Data ImageSource `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateImageSourceAccessResponse

func ParseUpdateImageSourceAccessResponse(rsp *http.Response) (*UpdateImageSourceAccessResponse, error)

ParseUpdateImageSourceAccessResponse parses an HTTP response from a UpdateImageSourceAccessWithResponse call

func (UpdateImageSourceAccessResponse) Status

Status returns HTTPResponse.Status

func (UpdateImageSourceAccessResponse) StatusCode

func (r UpdateImageSourceAccessResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateImageSourceJSONBody

type UpdateImageSourceJSONBody struct {
	// About User defined information about the image source.
	About *struct {
		// Description A description of the image source.
		Description *string `json:"description"`
	} `json:"about,omitempty"`
	Builder *struct {
		IntegrationId *HybridIdentifier `json:"integration_id"`
	} `json:"builder"`
	Identifier *Identifier `json:"identifier"`

	// Name A name for the image source.
	Name *string `json:"name,omitempty"`

	// Origin The origin of the image.
	Origin *ImageOrigin `json:"origin,omitempty"`
}

UpdateImageSourceJSONBody defines parameters for UpdateImageSource.

type UpdateImageSourceJSONRequestBody

type UpdateImageSourceJSONRequestBody UpdateImageSourceJSONBody

UpdateImageSourceJSONRequestBody defines body for UpdateImageSource for application/json ContentType.

type UpdateImageSourceResponse

type UpdateImageSourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data An image source is a set of resources that direct the platform on where it can find the resources needed to build an image resource.
		Data ImageSource `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateImageSourceResponse

func ParseUpdateImageSourceResponse(rsp *http.Response) (*UpdateImageSourceResponse, error)

ParseUpdateImageSourceResponse parses an HTTP response from a UpdateImageSourceWithResponse call

func (UpdateImageSourceResponse) Status

func (r UpdateImageSourceResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateImageSourceResponse) StatusCode

func (r UpdateImageSourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateIntegrationJSONBody

type UpdateIntegrationJSONBody struct {
	Auth *IntegrationAuth `json:"auth"`

	// Extra Updated key-value pairs associated with the integration.
	Extra *map[string]string `json:"extra"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Name A new name for the integration.
	Name *string `json:"name"`
}

UpdateIntegrationJSONBody defines parameters for UpdateIntegration.

type UpdateIntegrationJSONRequestBody

type UpdateIntegrationJSONRequestBody UpdateIntegrationJSONBody

UpdateIntegrationJSONRequestBody defines body for UpdateIntegration for application/json ContentType.

type UpdateIntegrationParams

type UpdateIntegrationParams struct {
	// Meta A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
	Meta *[]UpdateIntegrationParamsMeta `form:"meta,omitempty" json:"meta,omitempty"`
}

UpdateIntegrationParams defines parameters for UpdateIntegration.

type UpdateIntegrationParamsMeta

type UpdateIntegrationParamsMeta string

UpdateIntegrationParamsMeta defines parameters for UpdateIntegration.

const (
	UpdateIntegrationParamsMetaDefinition UpdateIntegrationParamsMeta = "definition"
)

Defines values for UpdateIntegrationParamsMeta.

type UpdateIntegrationResponse

type UpdateIntegrationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data Integration `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateIntegrationResponse

func ParseUpdateIntegrationResponse(rsp *http.Response) (*UpdateIntegrationResponse, error)

ParseUpdateIntegrationResponse parses an HTTP response from a UpdateIntegrationWithResponse call

func (UpdateIntegrationResponse) Status

func (r UpdateIntegrationResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateIntegrationResponse) StatusCode

func (r UpdateIntegrationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateNetworkAccessJSONBody

type UpdateNetworkAccessJSONBody struct {
	Acl *ACL `json:"acl"`
}

UpdateNetworkAccessJSONBody defines parameters for UpdateNetworkAccess.

type UpdateNetworkAccessJSONRequestBody

type UpdateNetworkAccessJSONRequestBody UpdateNetworkAccessJSONBody

UpdateNetworkAccessJSONRequestBody defines body for UpdateNetworkAccess for application/json ContentType.

type UpdateNetworkAccessParams

type UpdateNetworkAccessParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]UpdateNetworkAccessParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

UpdateNetworkAccessParams defines parameters for UpdateNetworkAccess.

type UpdateNetworkAccessParamsInclude

type UpdateNetworkAccessParamsInclude string

UpdateNetworkAccessParamsInclude defines parameters for UpdateNetworkAccess.

const (
	UpdateNetworkAccessParamsIncludeCreators     UpdateNetworkAccessParamsInclude = "creators"
	UpdateNetworkAccessParamsIncludeEnvironments UpdateNetworkAccessParamsInclude = "environments"
)

Defines values for UpdateNetworkAccessParamsInclude.

type UpdateNetworkAccessResponse

type UpdateNetworkAccessResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data SDN Network resource.
		Data Network `json:"data"`

		// Includes All includable resource linkable to the given network.
		Includes *NetworkIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateNetworkAccessResponse

func ParseUpdateNetworkAccessResponse(rsp *http.Response) (*UpdateNetworkAccessResponse, error)

ParseUpdateNetworkAccessResponse parses an HTTP response from a UpdateNetworkAccessWithResponse call

func (UpdateNetworkAccessResponse) Status

Status returns HTTPResponse.Status

func (UpdateNetworkAccessResponse) StatusCode

func (r UpdateNetworkAccessResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateNetworkJSONBody

type UpdateNetworkJSONBody struct {
	// Name The name of the network.
	Name *string `json:"name,omitempty"`
}

UpdateNetworkJSONBody defines parameters for UpdateNetwork.

type UpdateNetworkJSONRequestBody

type UpdateNetworkJSONRequestBody UpdateNetworkJSONBody

UpdateNetworkJSONRequestBody defines body for UpdateNetwork for application/json ContentType.

type UpdateNetworkParams

type UpdateNetworkParams struct {
	// Include A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.
	Include *[]UpdateNetworkParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

UpdateNetworkParams defines parameters for UpdateNetwork.

type UpdateNetworkParamsInclude

type UpdateNetworkParamsInclude string

UpdateNetworkParamsInclude defines parameters for UpdateNetwork.

const (
	UpdateNetworkParamsIncludeCreators     UpdateNetworkParamsInclude = "creators"
	UpdateNetworkParamsIncludeEnvironments UpdateNetworkParamsInclude = "environments"
)

Defines values for UpdateNetworkParamsInclude.

type UpdateNetworkResponse

type UpdateNetworkResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data SDN Network resource.
		Data Network `json:"data"`

		// Includes All includable resource linkable to the given network.
		Includes *NetworkIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateNetworkResponse

func ParseUpdateNetworkResponse(rsp *http.Response) (*UpdateNetworkResponse, error)

ParseUpdateNetworkResponse parses an HTTP response from a UpdateNetworkWithResponse call

func (UpdateNetworkResponse) Status

func (r UpdateNetworkResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateNetworkResponse) StatusCode

func (r UpdateNetworkResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdatePipelineAccessJSONBody

type UpdatePipelineAccessJSONBody struct {
	Acl *ACL `json:"acl"`
}

UpdatePipelineAccessJSONBody defines parameters for UpdatePipelineAccess.

type UpdatePipelineAccessJSONRequestBody

type UpdatePipelineAccessJSONRequestBody UpdatePipelineAccessJSONBody

UpdatePipelineAccessJSONRequestBody defines body for UpdatePipelineAccess for application/json ContentType.

type UpdatePipelineAccessResponse

type UpdatePipelineAccessResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A pipeline resource.
		Data Pipeline `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdatePipelineAccessResponse

func ParseUpdatePipelineAccessResponse(rsp *http.Response) (*UpdatePipelineAccessResponse, error)

ParseUpdatePipelineAccessResponse parses an HTTP response from a UpdatePipelineAccessWithResponse call

func (UpdatePipelineAccessResponse) Status

Status returns HTTPResponse.Status

func (UpdatePipelineAccessResponse) StatusCode

func (r UpdatePipelineAccessResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdatePipelineJSONBody

type UpdatePipelineJSONBody struct {
	// Disable A boolean where true signifies the Pipeline is disabled.
	Disable *bool `json:"disable,omitempty"`

	// Dynamic Setting to true enables variable and other advanced logic support on this Pipeline. This is a one-way toggle. Once set to true, it cannot be set back to false.
	Dynamic *bool `json:"dynamic,omitempty"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier *Identifier `json:"identifier,omitempty"`

	// Name A name for the Pipeline.
	Name *string `json:"name,omitempty"`

	// Stages An array of stages.
	Stages *[]PipelineStage `json:"stages,omitempty"`
}

UpdatePipelineJSONBody defines parameters for UpdatePipeline.

type UpdatePipelineJSONRequestBody

type UpdatePipelineJSONRequestBody UpdatePipelineJSONBody

UpdatePipelineJSONRequestBody defines body for UpdatePipeline for application/json ContentType.

type UpdatePipelineResponse

type UpdatePipelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A pipeline resource.
		Data Pipeline `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdatePipelineResponse

func ParseUpdatePipelineResponse(rsp *http.Response) (*UpdatePipelineResponse, error)

ParseUpdatePipelineResponse parses an HTTP response from a UpdatePipelineWithResponse call

func (UpdatePipelineResponse) Status

func (r UpdatePipelineResponse) Status() string

Status returns HTTPResponse.Status

func (UpdatePipelineResponse) StatusCode

func (r UpdatePipelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdatePipelineTriggerKeyJSONBody

type UpdatePipelineTriggerKeyJSONBody struct {
	// Ips List of IP Restrictions
	Ips *[]string `json:"ips,omitempty"`

	// Name Set name of Trigger Key
	Name *string `json:"name,omitempty"`
}

UpdatePipelineTriggerKeyJSONBody defines parameters for UpdatePipelineTriggerKey.

type UpdatePipelineTriggerKeyJSONRequestBody

type UpdatePipelineTriggerKeyJSONRequestBody UpdatePipelineTriggerKeyJSONBody

UpdatePipelineTriggerKeyJSONRequestBody defines body for UpdatePipelineTriggerKey for application/json ContentType.

type UpdatePipelineTriggerKeyResponse

type UpdatePipelineTriggerKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A pipeline trigger key resource.
		Data TriggerKey `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdatePipelineTriggerKeyResponse

func ParseUpdatePipelineTriggerKeyResponse(rsp *http.Response) (*UpdatePipelineTriggerKeyResponse, error)

ParseUpdatePipelineTriggerKeyResponse parses an HTTP response from a UpdatePipelineTriggerKeyWithResponse call

func (UpdatePipelineTriggerKeyResponse) Status

Status returns HTTPResponse.Status

func (UpdatePipelineTriggerKeyResponse) StatusCode

func (r UpdatePipelineTriggerKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateRoleJSONBody

type UpdateRoleJSONBody struct {
	// Capabilities The list of platform level capabilities assigned to this Role.
	Capabilities *struct {
		// All If true, the Role has all capabilities.
		All      bool         `json:"all"`
		Specific []Capability `json:"specific"`
	} `json:"capabilities"`

	// Extra Custom user-defined properties for storing extra information on the Role. Not utilized by Cycle.
	Extra      *map[string]string `json:"extra"`
	Identifier string             `json:"identifier"`

	// Name A name given to the Role.
	Name *string `json:"name"`
	Rank int     `json:"rank"`
}

UpdateRoleJSONBody defines parameters for UpdateRole.

type UpdateRoleJSONRequestBody

type UpdateRoleJSONRequestBody UpdateRoleJSONBody

UpdateRoleJSONRequestBody defines body for UpdateRole for application/json ContentType.

type UpdateRoleResponse

type UpdateRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data A Role is a custom combination of platform-level capabilities, allowing for fully customizable role-based access controls across the platform.
		Data Role `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateRoleResponse

func ParseUpdateRoleResponse(rsp *http.Response) (*UpdateRoleResponse, error)

ParseUpdateRoleResponse parses an HTTP response from a UpdateRoleWithResponse call

func (UpdateRoleResponse) Status

func (r UpdateRoleResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateRoleResponse) StatusCode

func (r UpdateRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateScopedVariableJSONBody

type UpdateScopedVariableJSONBody struct {
	// Access The way the scoped variable is accessed.
	Access *ScopedVariableAccess `json:"access,omitempty"`

	// Identifier An identifier, similar to a key in an Environment variable.  Its used when envoking the Scoped Variable.
	Identifier *string `json:"identifier,omitempty"`

	// Scope Information about the assignment of the scoped variable and how it is invoked.
	Scope *ScopedVariableScope `json:"scope,omitempty"`

	// Source The source or value of the Scoped Variable.
	Source *UpdateScopedVariableJSONBody_Source `json:"source,omitempty"`
}

UpdateScopedVariableJSONBody defines parameters for UpdateScopedVariable.

type UpdateScopedVariableJSONBody_Source

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

UpdateScopedVariableJSONBody_Source defines parameters for UpdateScopedVariable.

type UpdateScopedVariableJSONRequestBody

type UpdateScopedVariableJSONRequestBody UpdateScopedVariableJSONBody

UpdateScopedVariableJSONRequestBody defines body for UpdateScopedVariable for application/json ContentType.

type UpdateScopedVariableResponse

type UpdateScopedVariableResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Scoped variables are a way for users to dynamically allocate runtime specific environment variables across any number of containers in an environment.
		Data ScopedVariable `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateScopedVariableResponse

func ParseUpdateScopedVariableResponse(rsp *http.Response) (*UpdateScopedVariableResponse, error)

ParseUpdateScopedVariableResponse parses an HTTP response from a UpdateScopedVariableWithResponse call

func (UpdateScopedVariableResponse) Status

Status returns HTTPResponse.Status

func (UpdateScopedVariableResponse) StatusCode

func (r UpdateScopedVariableResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateServerJSONBody

type UpdateServerJSONBody struct {
	// Constraints Server constriants.
	Constraints struct {
		// Allow Server constraints for the given Server.
		Allow *struct {
			// Overcommit A boolean where true represents the desire for the Server to allow the overcommitting of shares.
			Overcommit bool `json:"overcommit"`

			// OvercommitMultiple An integer that describes the capability of a server to overcommit shares.  This will allow more containers to run on a given server based on the servers available CPU cores. 1 CPU core = 10 shares by default.
			OvercommitMultiple *int `json:"overcommit_multiple"`

			// Pool A boolean where true represents the Server can accept containers with no tags set.
			Pool bool `json:"pool"`

			// Services A boolean where true represents the Server being a target for service containers.
			Services bool `json:"services"`
		} `json:"allow,omitempty"`

		// Tags A list of Server tags.
		Tags *[]string `json:"tags,omitempty"`
	} `json:"constraints"`

	// Nickname A custom name given to the server for identification purposes. Does not affect server hostname.
	Nickname *string `json:"nickname"`
}

UpdateServerJSONBody defines parameters for UpdateServer.

type UpdateServerJSONRequestBody

type UpdateServerJSONRequestBody UpdateServerJSONBody

UpdateServerJSONRequestBody defines body for UpdateServer for application/json ContentType.

type UpdateServerResponse

type UpdateServerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data The server resource, referring to servers that have been deployed to a Cycle hub.
		Data Server `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateServerResponse

func ParseUpdateServerResponse(rsp *http.Response) (*UpdateServerResponse, error)

ParseUpdateServerResponse parses an HTTP response from a UpdateServerWithResponse call

func (UpdateServerResponse) Status

func (r UpdateServerResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateServerResponse) StatusCode

func (r UpdateServerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateStackAccessJSONBody

type UpdateStackAccessJSONBody struct {
	Acl *ACL `json:"acl"`
}

UpdateStackAccessJSONBody defines parameters for UpdateStackAccess.

type UpdateStackAccessJSONRequestBody

type UpdateStackAccessJSONRequestBody UpdateStackAccessJSONBody

UpdateStackAccessJSONRequestBody defines body for UpdateStackAccess for application/json ContentType.

type UpdateStackAccessResponse

type UpdateStackAccessResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Stacks are a way to orchestrate multiple containers atomically and automatically.
		Data Stack `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateStackAccessResponse

func ParseUpdateStackAccessResponse(rsp *http.Response) (*UpdateStackAccessResponse, error)

ParseUpdateStackAccessResponse parses an HTTP response from a UpdateStackAccessWithResponse call

func (UpdateStackAccessResponse) Status

func (r UpdateStackAccessResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateStackAccessResponse) StatusCode

func (r UpdateStackAccessResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateStackJSONBody

type UpdateStackJSONBody struct {
	// Name A name for the Stack.
	Name *string `json:"name,omitempty"`

	// Source A source for a stack to be created from.
	Source *StackSource `json:"source,omitempty"`

	// Variables A map of default variable values used when building this Stack. A variable can be added anywhere in a Stack using the format `{{var}}` where `var` would be a key in this map.
	Variables *map[string]string `json:"variables,omitempty"`
}

UpdateStackJSONBody defines parameters for UpdateStack.

type UpdateStackJSONRequestBody

type UpdateStackJSONRequestBody UpdateStackJSONBody

UpdateStackJSONRequestBody defines body for UpdateStack for application/json ContentType.

type UpdateStackResponse

type UpdateStackResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Stacks are a way to orchestrate multiple containers atomically and automatically.
		Data Stack `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateStackResponse

func ParseUpdateStackResponse(rsp *http.Response) (*UpdateStackResponse, error)

ParseUpdateStackResponse parses an HTTP response from a UpdateStackWithResponse call

func (UpdateStackResponse) Status

func (r UpdateStackResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateStackResponse) StatusCode

func (r UpdateStackResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateVirtualMachineJSONBody

type UpdateVirtualMachineJSONBody struct {
	// Annotations Metadata annotations for the virtual machine.
	Annotations *map[string]string `json:"annotations,omitempty"`

	// Deprecate A boolean flag indicating if this virtual machine is deprecated.
	Deprecate *bool `json:"deprecate,omitempty"`

	// Identifier The identifier of the virtual machine.
	Identifier *string `json:"identifier,omitempty"`

	// Lock Prevents this virtual machine from being deleted when true.
	Lock *bool `json:"lock,omitempty"`

	// Name The name of the virtual machine.
	Name *string `json:"name,omitempty"`

	// SshKeys An array of SSH key IDs that should be applied to this virtual machine.
	SshKeys *[]ID `json:"ssh_keys,omitempty"`
}

UpdateVirtualMachineJSONBody defines parameters for UpdateVirtualMachine.

type UpdateVirtualMachineJSONRequestBody

type UpdateVirtualMachineJSONRequestBody UpdateVirtualMachineJSONBody

UpdateVirtualMachineJSONRequestBody defines body for UpdateVirtualMachine for application/json ContentType.

type UpdateVirtualMachineResponse

type UpdateVirtualMachineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Describes a virtual machine running on the Cycle Platform.
		Data VirtualMachine `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateVirtualMachineResponse

func ParseUpdateVirtualMachineResponse(rsp *http.Response) (*UpdateVirtualMachineResponse, error)

ParseUpdateVirtualMachineResponse parses an HTTP response from a UpdateVirtualMachineWithResponse call

func (UpdateVirtualMachineResponse) Status

Status returns HTTPResponse.Status

func (UpdateVirtualMachineResponse) StatusCode

func (r UpdateVirtualMachineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateVirtualMachineSshKeyJSONBody

type UpdateVirtualMachineSshKeyJSONBody struct {
	// Name The name of the virtual machine SSH key.
	Name *string `json:"name,omitempty"`
}

UpdateVirtualMachineSshKeyJSONBody defines parameters for UpdateVirtualMachineSshKey.

type UpdateVirtualMachineSshKeyJSONRequestBody

type UpdateVirtualMachineSshKeyJSONRequestBody UpdateVirtualMachineSshKeyJSONBody

UpdateVirtualMachineSshKeyJSONRequestBody defines body for UpdateVirtualMachineSshKey for application/json ContentType.

type UpdateVirtualMachineSshKeyParams

type UpdateVirtualMachineSshKeyParams struct {
	// Include A comma-separated list of include values. Included resources will show up under the root document's `include` field.
	// In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
	Include *[]UpdateVirtualMachineSshKeyParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

UpdateVirtualMachineSshKeyParams defines parameters for UpdateVirtualMachineSshKey.

type UpdateVirtualMachineSshKeyParamsInclude

type UpdateVirtualMachineSshKeyParamsInclude string

UpdateVirtualMachineSshKeyParamsInclude defines parameters for UpdateVirtualMachineSshKey.

const (
	UpdateVirtualMachineSshKeyParamsIncludeCreators     UpdateVirtualMachineSshKeyParamsInclude = "creators"
	UpdateVirtualMachineSshKeyParamsIncludeEnvironments UpdateVirtualMachineSshKeyParamsInclude = "environments"
)

Defines values for UpdateVirtualMachineSshKeyParamsInclude.

type UpdateVirtualMachineSshKeyResponse

type UpdateVirtualMachineSshKeyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Data Describes an SSH key used to access a virtual machine.
		Data VirtualMachineSshKey `json:"data"`

		// Includes All includable resources linkable to the given virtual machine SSH key.
		Includes *VirtualMachineSshIncludes `json:"includes,omitempty"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateVirtualMachineSshKeyResponse

func ParseUpdateVirtualMachineSshKeyResponse(rsp *http.Response) (*UpdateVirtualMachineSshKeyResponse, error)

ParseUpdateVirtualMachineSshKeyResponse parses an HTTP response from a UpdateVirtualMachineSshKeyWithResponse call

func (UpdateVirtualMachineSshKeyResponse) Status

Status returns HTTPResponse.Status

func (UpdateVirtualMachineSshKeyResponse) StatusCode

func (r UpdateVirtualMachineSshKeyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateVirtualProviderIsoJSONBody added in v0.6.3

type UpdateVirtualProviderIsoJSONBody struct {
	Config *struct {
		// Ipxe ISO IPXE configuration. Only available when ISO is in new state.
		Ipxe *struct {
			// DnsIp DNS IP assigned to the IPXE boot.
			DnsIp *string `json:"dns_ip"`

			// GatewayIp Gateway IP assigned to the IPXE boot.
			GatewayIp *string `json:"gateway_ip"`

			// Netmask Netmask assigned to the IPXE boot.
			Netmask *string `json:"netmask"`

			// NetworkInterface Network interface for the IPXE boot.
			NetworkInterface *int `json:"network_interface"`

			// StaticIp Static IP assigned to the IPXE boot.
			StaticIp *string `json:"static_ip"`

			// VlanId VLAN ID for the IPXE boot.
			VlanId *int `json:"vlan_id"`
		} `json:"ipxe"`
		Server *struct {
			// AdditionalKernelArgs Appends additional kernel arguments when booting CycleOS.
			AdditionalKernelArgs *string `json:"additional_kernel_args"`

			// Bonds An array of bonds
			Bonds *[]VirtualProviderIsoBond `json:"bonds,omitempty"`

			// Nics An array of server network interfaces.
			Nics                  []VirtualProviderIsoNic                                            `json:"nics"`
			SdnNeighborPreference *UpdateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference `json:"sdn_neighbor_preference"`
			Storage               *struct {
				ConditionalFormat *bool `json:"conditional_format,omitempty"`
			} `json:"storage"`
		} `json:"server"`

		// Token Authentication token for the ISO. Only available when ISO is in new state.
		Token *string `json:"token,omitempty"`
	} `json:"config,omitempty"`

	// Name The name of the ISO.
	Name *string `json:"name,omitempty"`
}

UpdateVirtualProviderIsoJSONBody defines parameters for UpdateVirtualProviderIso.

type UpdateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference added in v0.6.3

type UpdateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference string

UpdateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference defines parameters for UpdateVirtualProviderIso.

const (
	UpdateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreferenceIpv4 UpdateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference = "ipv4"
	UpdateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreferenceIpv6 UpdateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference = "ipv6"
)

Defines values for UpdateVirtualProviderIsoJSONBodyConfigServerSdnNeighborPreference.

type UpdateVirtualProviderIsoJSONRequestBody added in v0.6.3

type UpdateVirtualProviderIsoJSONRequestBody UpdateVirtualProviderIsoJSONBody

UpdateVirtualProviderIsoJSONRequestBody defines body for UpdateVirtualProviderIso for application/json ContentType.

type UpdateVirtualProviderIsoResponse added in v0.6.3

type UpdateVirtualProviderIsoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// Data The ISO image for a virtual provider.
		Data VirtualProviderIso `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUpdateVirtualProviderIsoResponse added in v0.6.3

func ParseUpdateVirtualProviderIsoResponse(rsp *http.Response) (*UpdateVirtualProviderIsoResponse, error)

ParseUpdateVirtualProviderIsoResponse parses an HTTP response from a UpdateVirtualProviderIsoWithResponse call

func (UpdateVirtualProviderIsoResponse) Status added in v0.6.3

Status returns HTTPResponse.Status

func (UpdateVirtualProviderIsoResponse) StatusCode added in v0.6.3

func (r UpdateVirtualProviderIsoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UploadUserSuppliedCertificateJSONBody

type UploadUserSuppliedCertificateJSONBody struct {
	// Bundle A PEM encoded certificate bundle.
	Bundle string `json:"bundle"`

	// PrivateKey The certificate's private key.
	PrivateKey string `json:"private_key"`
}

UploadUserSuppliedCertificateJSONBody defines parameters for UploadUserSuppliedCertificate.

type UploadUserSuppliedCertificateJSONRequestBody

type UploadUserSuppliedCertificateJSONRequestBody UploadUserSuppliedCertificateJSONBody

UploadUserSuppliedCertificateJSONRequestBody defines body for UploadUserSuppliedCertificate for application/json ContentType.

type UploadUserSuppliedCertificateResponse

type UploadUserSuppliedCertificateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Data A TLS certificate.
		Data TlsCertificate `json:"data"`
	}
	JSONDefault *DefaultError
}

func ParseUploadUserSuppliedCertificateResponse

func ParseUploadUserSuppliedCertificateResponse(rsp *http.Response) (*UploadUserSuppliedCertificateResponse, error)

ParseUploadUserSuppliedCertificateResponse parses an HTTP response from a UploadUserSuppliedCertificateWithResponse call

func (UploadUserSuppliedCertificateResponse) Status

Status returns HTTPResponse.Status

func (UploadUserSuppliedCertificateResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type UsageDatum

type UsageDatum struct {
	// MemoryGb A number in GB representing memory.
	MemoryGb int `json:"memory_gb"`

	// Nodes The number of nodes the data is pulled from.
	Nodes int      `json:"nodes"`
	Time  DateTime `json:"time"`
}

UsageDatum Server usage data.

type UserScope

type UserScope struct {
	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Type The type of user that created the resource.
	Type UserScopeType `json:"type"`
}

UserScope A type of creator and a matching identifier.

type UserScopeType

type UserScopeType string

UserScopeType The type of user that created the resource.

const (
	UserScopeTypeAccount          UserScopeType = "account"
	UserScopeTypeApiKey           UserScopeType = "api-key"
	UserScopeTypeEmployee         UserScopeType = "employee"
	UserScopeTypeEnvironment      UserScopeType = "environment"
	UserScopeTypePlatform         UserScopeType = "platform"
	UserScopeTypePlatformPipeline UserScopeType = "platform-pipeline"
	UserScopeTypeVisitor          UserScopeType = "visitor"
)

Defines values for UserScopeType.

type V1LbConfig

type V1LbConfig struct {
	ControllerTemplate *V1LbController `json:"controller_template"`

	// Controllers A configuration for a specific port.
	Controllers []V1LbController `json:"controllers"`
	Waf         *WafConfig       `json:"waf"`
}

V1LbConfig defines model for V1LbConfig.

type V1LbConfigRouter

type V1LbConfigRouter struct {
	Config struct {
		// DestinationPrioritization Hints to the load balancer how to prioritize traffic to instances.
		// **random**: Chooses a random instance. **latency**: Prioritizes lower latency instances. **fixed**: The order of the destinations will be the same regardless of instance or load balancer location.  Used primarily with source IP routing.
		DestinationPrioritization *V1LbConfigRouterConfigDestinationPrioritization `json:"destination_prioritization"`

		// DestinationRetries If a destination is unavailable, retry up to [x] times, instead of immediately failing with a 503/504 error.
		DestinationRetries int `json:"destination_retries"`

		// Extension Additional configuration options specific to the selected mode (tcp/http).
		Extension *V1LbConfigRouter_Config_Extension `json:"extension,omitempty"`

		// StickySessions If a request comes in from the same origin, ensure it hits the same destination.
		StickySessions bool `json:"sticky_sessions"`

		// Timeouts Defines how the length of various sorts of timeouts when communicating with the destination.
		Timeouts struct {
			// DestinationConnection A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
			DestinationConnection Duration `json:"destination_connection"`
		} `json:"timeouts"`

		// Tls TLS termination configuration. If null, the platform will use the default configuration. Port 443 by default has TLS termination enabled.
		Tls *struct {
			// AllowInsecure If enabled, accept TLS traffic with an invalid certificate. This is usually done for development/testing, and is not recommended for production use.
			AllowInsecure *bool `json:"allow_insecure"`

			// ClientAuth Defines how to validate the connecting TLS certificate.
			// `none`: Do not require a TLS certificate to be sent
			// `request`: Asks the client to send a TLS certificate, but does not require nor validate it.
			// `require`: Requires a certificate be sent for the request to be valid, but does not validate the certificate.
			// `require-verify`: Requires both that the client send a certificate, and that the certificate is valid. This is required when using https.
			ClientAuth *V1LbConfigRouterConfigTlsClientAuth `json:"client_auth"`

			// ClientCertAuth A PEM encoded string of certificates.
			ClientCertAuth *string `json:"client_cert_auth"`

			// ServerName [Advanced] Change the domain the controller listens on.
			ServerName *string `json:"server_name"`
		} `json:"tls"`
	} `json:"config"`

	// Match The ruleset for this router to be selected. If both `domains“ and `internal_port` are null, then this match acts as a wildcard and will match all.
	Match struct {
		// Containers Match traffic destined (or not destined) for a particular container.
		Containers *struct {
			// Exclude Match any traffic that would NOT be routed to one of these containers.
			Exclude *[]HybridIdentifier `json:"exclude"`

			// Include Match any traffic that would be routed to one of these containers.
			Include *[]HybridIdentifier `json:"include"`
		} `json:"containers"`

		// Domains The specific domains to match against.
		Domains *[]string `json:"domains"`

		// InternalPorts The specific ports to match against.
		InternalPorts *[]int  `json:"internal_ports"`
		Path          *string `json:"path"`
	} `json:"match"`

	// Mode How to route the traffic to the destination.
	// `random`: Pick a valid destination at random.
	// `round-robin`: Send each request to the 'next' destination on the list, restarting from the beginning when the last destination is used.
	// `source-ip`: Utilizes a hash function to ensure traffic from an IP will always hit the same destination instance.
	Mode V1LbConfigRouterMode `json:"mode"`
}

V1LbConfigRouter A specific router configuration that describes how traffic matching the rule is handled.

type V1LbConfigRouterConfigDestinationPrioritization

type V1LbConfigRouterConfigDestinationPrioritization string

V1LbConfigRouterConfigDestinationPrioritization Hints to the load balancer how to prioritize traffic to instances. **random**: Chooses a random instance. **latency**: Prioritizes lower latency instances. **fixed**: The order of the destinations will be the same regardless of instance or load balancer location. Used primarily with source IP routing.

const (
	V1LbConfigRouterConfigDestinationPrioritizationFixed   V1LbConfigRouterConfigDestinationPrioritization = "fixed"
	V1LbConfigRouterConfigDestinationPrioritizationLatency V1LbConfigRouterConfigDestinationPrioritization = "latency"
	V1LbConfigRouterConfigDestinationPrioritizationRandom  V1LbConfigRouterConfigDestinationPrioritization = "random"
)

Defines values for V1LbConfigRouterConfigDestinationPrioritization.

type V1LbConfigRouterConfigTlsClientAuth

type V1LbConfigRouterConfigTlsClientAuth string

V1LbConfigRouterConfigTlsClientAuth Defines how to validate the connecting TLS certificate. `none`: Do not require a TLS certificate to be sent `request`: Asks the client to send a TLS certificate, but does not require nor validate it. `require`: Requires a certificate be sent for the request to be valid, but does not validate the certificate. `require-verify`: Requires both that the client send a certificate, and that the certificate is valid. This is required when using https.

const (
	V1LbConfigRouterConfigTlsClientAuthNone          V1LbConfigRouterConfigTlsClientAuth = "none"
	V1LbConfigRouterConfigTlsClientAuthRequest       V1LbConfigRouterConfigTlsClientAuth = "request"
	V1LbConfigRouterConfigTlsClientAuthRequire       V1LbConfigRouterConfigTlsClientAuth = "require"
	V1LbConfigRouterConfigTlsClientAuthRequireVerify V1LbConfigRouterConfigTlsClientAuth = "require-verify"
)

Defines values for V1LbConfigRouterConfigTlsClientAuth.

type V1LbConfigRouterMode

type V1LbConfigRouterMode string

V1LbConfigRouterMode How to route the traffic to the destination. `random`: Pick a valid destination at random. `round-robin`: Send each request to the 'next' destination on the list, restarting from the beginning when the last destination is used. `source-ip`: Utilizes a hash function to ensure traffic from an IP will always hit the same destination instance.

const (
	V1LbConfigRouterModeRandom     V1LbConfigRouterMode = "random"
	V1LbConfigRouterModeRoundRobin V1LbConfigRouterMode = "round-robin"
	V1LbConfigRouterModeSourceIp   V1LbConfigRouterMode = "source-ip"
)

Defines values for V1LbConfigRouterMode.

type V1LbConfigRouter_Config_Extension

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

V1LbConfigRouter_Config_Extension Additional configuration options specific to the selected mode (tcp/http).

func (V1LbConfigRouter_Config_Extension) AsHttpRouterConfig

func (t V1LbConfigRouter_Config_Extension) AsHttpRouterConfig() (HttpRouterConfig, error)

AsHttpRouterConfig returns the union data inside the V1LbConfigRouter_Config_Extension as a HttpRouterConfig

func (V1LbConfigRouter_Config_Extension) AsTcpRouterConfig

func (t V1LbConfigRouter_Config_Extension) AsTcpRouterConfig() (TcpRouterConfig, error)

AsTcpRouterConfig returns the union data inside the V1LbConfigRouter_Config_Extension as a TcpRouterConfig

func (V1LbConfigRouter_Config_Extension) AsUdpRouterConfig

func (t V1LbConfigRouter_Config_Extension) AsUdpRouterConfig() (UdpRouterConfig, error)

AsUdpRouterConfig returns the union data inside the V1LbConfigRouter_Config_Extension as a UdpRouterConfig

func (V1LbConfigRouter_Config_Extension) Discriminator

func (t V1LbConfigRouter_Config_Extension) Discriminator() (string, error)

func (*V1LbConfigRouter_Config_Extension) FromHttpRouterConfig

func (t *V1LbConfigRouter_Config_Extension) FromHttpRouterConfig(v HttpRouterConfig) error

FromHttpRouterConfig overwrites any union data inside the V1LbConfigRouter_Config_Extension as the provided HttpRouterConfig

func (*V1LbConfigRouter_Config_Extension) FromTcpRouterConfig

func (t *V1LbConfigRouter_Config_Extension) FromTcpRouterConfig(v TcpRouterConfig) error

FromTcpRouterConfig overwrites any union data inside the V1LbConfigRouter_Config_Extension as the provided TcpRouterConfig

func (*V1LbConfigRouter_Config_Extension) FromUdpRouterConfig

func (t *V1LbConfigRouter_Config_Extension) FromUdpRouterConfig(v UdpRouterConfig) error

FromUdpRouterConfig overwrites any union data inside the V1LbConfigRouter_Config_Extension as the provided UdpRouterConfig

func (V1LbConfigRouter_Config_Extension) MarshalJSON

func (t V1LbConfigRouter_Config_Extension) MarshalJSON() ([]byte, error)

func (*V1LbConfigRouter_Config_Extension) MergeHttpRouterConfig

func (t *V1LbConfigRouter_Config_Extension) MergeHttpRouterConfig(v HttpRouterConfig) error

MergeHttpRouterConfig performs a merge with any union data inside the V1LbConfigRouter_Config_Extension, using the provided HttpRouterConfig

func (*V1LbConfigRouter_Config_Extension) MergeTcpRouterConfig

func (t *V1LbConfigRouter_Config_Extension) MergeTcpRouterConfig(v TcpRouterConfig) error

MergeTcpRouterConfig performs a merge with any union data inside the V1LbConfigRouter_Config_Extension, using the provided TcpRouterConfig

func (*V1LbConfigRouter_Config_Extension) MergeUdpRouterConfig

func (t *V1LbConfigRouter_Config_Extension) MergeUdpRouterConfig(v UdpRouterConfig) error

MergeUdpRouterConfig performs a merge with any union data inside the V1LbConfigRouter_Config_Extension, using the provided UdpRouterConfig

func (*V1LbConfigRouter_Config_Extension) UnmarshalJSON

func (t *V1LbConfigRouter_Config_Extension) UnmarshalJSON(b []byte) error

func (V1LbConfigRouter_Config_Extension) ValueByDiscriminator

func (t V1LbConfigRouter_Config_Extension) ValueByDiscriminator() (interface{}, error)

type V1LbController

type V1LbController struct {
	// Identifier A human-readable identifier for this controller. It will default to the port, i.e. `port-443`, but can be renamed to anything, such as the service this controller represents.
	Identifier string `json:"identifier"`

	// Port The port inbound trafic is accepted on.
	Port int `json:"port"`

	// Transport Defines how traffic comes in to the load balancer, and how the load balancer handles it.
	Transport *struct {
		// Config Defines how the transport for this controller operates.
		Config struct {
			// Extension Extended configurations for the specified transport mode (http/tcp)
			Extension *V1LbController_Transport_Config_Extension `json:"extension,omitempty"`

			// Ingress Defines how traffic gets into the load balancer.
			Ingress struct {
				Tls *struct {
					// Enable Enables or disables TLS.
					Enable bool `json:"enable"`
				} `json:"tls"`
			} `json:"ingress"`

			// Performance Enable/disable performance mode. If enabled, some telemetry will be disabled to dedicate full processing to handling requests.
			// You will not see per-request breakdowns or URL logging if performance mode is enabled.
			Performance bool `json:"performance"`

			// Timeouts Defines settings for various types of timeouts.
			Timeouts struct {
				// Idle A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
				Idle Duration `json:"idle"`
			} `json:"timeouts"`

			// Verbosity Verbosity describes the level of logging detail for the controller
			Verbosity V1LbControllerTransportConfigVerbosity `json:"verbosity"`
		} `json:"config"`

		// Disable When true, this controller is disabled and will not be used.
		Disable bool `json:"disable"`

		// Mode The kind of traffic (http/tcp/udp) that will be sent to the load balancer.
		Mode V1LbControllerTransportMode `json:"mode"`

		// Routers Defines where traffic is sent. Many can be defined per controller.
		Routers []V1LbConfigRouter `json:"routers"`
	} `json:"transport"`
	Waf *WafConfig `json:"waf"`
}

V1LbController defines model for V1LbController.

type V1LbControllerTransportConfigVerbosity

type V1LbControllerTransportConfigVerbosity string

V1LbControllerTransportConfigVerbosity Verbosity describes the level of logging detail for the controller

const (
	V1LbControllerTransportConfigVerbosityDebug  V1LbControllerTransportConfigVerbosity = "debug"
	V1LbControllerTransportConfigVerbosityHigh   V1LbControllerTransportConfigVerbosity = "high"
	V1LbControllerTransportConfigVerbosityLow    V1LbControllerTransportConfigVerbosity = "low"
	V1LbControllerTransportConfigVerbosityNormal V1LbControllerTransportConfigVerbosity = "normal"
)

Defines values for V1LbControllerTransportConfigVerbosity.

type V1LbControllerTransportMode

type V1LbControllerTransportMode string

V1LbControllerTransportMode The kind of traffic (http/tcp/udp) that will be sent to the load balancer.

Defines values for V1LbControllerTransportMode.

type V1LbController_Transport_Config_Extension

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

V1LbController_Transport_Config_Extension Extended configurations for the specified transport mode (http/tcp)

func (V1LbController_Transport_Config_Extension) AsHttpTransportConfig

AsHttpTransportConfig returns the union data inside the V1LbController_Transport_Config_Extension as a HttpTransportConfig

func (V1LbController_Transport_Config_Extension) AsTcpTransportConfig

AsTcpTransportConfig returns the union data inside the V1LbController_Transport_Config_Extension as a TcpTransportConfig

func (V1LbController_Transport_Config_Extension) AsUdpTransportConfig

AsUdpTransportConfig returns the union data inside the V1LbController_Transport_Config_Extension as a UdpTransportConfig

func (V1LbController_Transport_Config_Extension) Discriminator

func (*V1LbController_Transport_Config_Extension) FromHttpTransportConfig

FromHttpTransportConfig overwrites any union data inside the V1LbController_Transport_Config_Extension as the provided HttpTransportConfig

func (*V1LbController_Transport_Config_Extension) FromTcpTransportConfig

FromTcpTransportConfig overwrites any union data inside the V1LbController_Transport_Config_Extension as the provided TcpTransportConfig

func (*V1LbController_Transport_Config_Extension) FromUdpTransportConfig

FromUdpTransportConfig overwrites any union data inside the V1LbController_Transport_Config_Extension as the provided UdpTransportConfig

func (V1LbController_Transport_Config_Extension) MarshalJSON

func (*V1LbController_Transport_Config_Extension) MergeHttpTransportConfig

MergeHttpTransportConfig performs a merge with any union data inside the V1LbController_Transport_Config_Extension, using the provided HttpTransportConfig

func (*V1LbController_Transport_Config_Extension) MergeTcpTransportConfig

MergeTcpTransportConfig performs a merge with any union data inside the V1LbController_Transport_Config_Extension, using the provided TcpTransportConfig

func (*V1LbController_Transport_Config_Extension) MergeUdpTransportConfig

MergeUdpTransportConfig performs a merge with any union data inside the V1LbController_Transport_Config_Extension, using the provided UdpTransportConfig

func (*V1LbController_Transport_Config_Extension) UnmarshalJSON

func (V1LbController_Transport_Config_Extension) ValueByDiscriminator

func (t V1LbController_Transport_Config_Extension) ValueByDiscriminator() (interface{}, error)

type V1LbType

type V1LbType struct {
	Details V1LbConfig `json:"details"`

	// Ipv4 Allow / disallow traffic to be routed via IPv4.
	Ipv4 bool `json:"ipv4"`

	// Ipv6 Allow / disallow traffic to be routed via IPv6.
	Ipv6 bool         `json:"ipv6"`
	Type V1LbTypeType `json:"type"`
}

V1LbType defines model for V1LbType.

type V1LbTypeType

type V1LbTypeType string

V1LbTypeType defines model for V1LbType.Type.

const (
	V1LbTypeTypeV1 V1LbTypeType = "v1"
)

Defines values for V1LbTypeType.

type VPNInfoReturn

type VPNInfoReturn struct {
	Service *VpnEnvironmentService `json:"service"`

	// Url A url associated with the VPN service.
	Url string `json:"url"`
}

VPNInfoReturn A summary of a VPN service for a given environment.

type VPNLogin

type VPNLogin struct {
	// EnvironmentId The ID of the environment the VPN service is in.
	EnvironmentId string `json:"environment_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Ip The IP address of the machine the user has logged in from.
	Ip string `json:"ip"`

	// Success A boolean where true means the login attempt was successful.
	Success bool     `json:"success"`
	Time    DateTime `json:"time"`

	// Username The username used when logging in.
	Username string `json:"username"`
}

VPNLogin A VPN login event record.

type VPNUsers

type VPNUsers struct {
	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// EnvironmentId An identifier for the environment the VPN service is associated with.
	EnvironmentId string `json:"environment_id"`

	// Events A collection of timestamps for each event in the VPN user's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id        ID       `json:"id"`
	LastLogin DateTime `json:"last_login"`

	// Username The username for the login.
	Username string `json:"username"`
}

VPNUsers A VPN user for a given VPN.

type VariableString

type VariableString = string

VariableString A string value for a pipeline that supports a variable. To use as a variable, set this string to `{{variable}}` where `variable` is a custom name.

type Version

type Version = string

Version Version can be any string, but if it begins with a "v", semantic version will be enforced. A [Semantic Version](https://semver.org/) string. Follows the format vMAJOR.MINOR.PATCH-build.

type VirtualMachine

type VirtualMachine struct {
	// Annotations Metadata annotations for the virtual machine.
	Annotations *map[string]interface{} `json:"annotations"`

	// Config Defines the network and deployment configurations for a virtual machine.
	Config VirtualMachineConfig `json:"config"`

	// ContainerId A 24 character hex string used to identify a unique resource.
	ContainerId *ID `json:"container_id,omitempty"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Deprecate A boolean flag indicating if this virtual machine is deprecated.
	Deprecate bool `json:"deprecate"`

	// Environment Basic information about the environment this virtual machine is in.
	Environment struct {
		// Cluster A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
		// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
		// have the identifier of `my-container` and is automatically created by the platform.
		//
		// The identifier does not have to be unique.
		Cluster Identifier `json:"cluster"`

		// Id A 24 character hex string used to identify a unique resource.
		Id ID `json:"id"`
	} `json:"environment"`

	// Events A collection of timestamps for each event in the virtual machine's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Started DateTime `json:"started"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Image Represents the image used by a virtual machine. It can either reference a URL where the image is located or specify a base image provided by Cycle.
	Image VirtualMachineImage `json:"image"`

	// Lock Prevents this virtual machine from being deleted when true.
	Lock bool                `json:"lock"`
	Meta *VirtualMachineMeta `json:"meta"`

	// Name A user-defined name for the virtual machine.
	Name string `json:"name"`

	// RootPassword The generated root password for the virtual machine. Only visible by the owner, or if it was created in the last ten minutes.
	RootPassword *struct {
		Changed DateTime `json:"changed"`

		// Current The root password.
		Current *string `json:"current"`
	} `json:"root_password,omitempty"`

	// SshKeys An array of IDs corresponding to SSH keys that have been assigned to this virtual machine.
	SshKeys *[]ID                   `json:"ssh_keys,omitempty"`
	State   VirtualMachineState     `json:"state"`
	Volumes *[]VirtualMachineVolume `json:"volumes,omitempty"`
}

VirtualMachine Describes a virtual machine running on the Cycle Platform.

type VirtualMachineAttachmentTypeIso added in v0.6.5

type VirtualMachineAttachmentTypeIso struct {
	Details struct {
		// Url The URL of the ISO to download and attach to this virtual machine.
		Url string `json:"url"`
	} `json:"details"`

	// Type The type of the attachment (iso)
	Type VirtualMachineAttachmentTypeIsoType `json:"type"`
}

VirtualMachineAttachmentTypeIso Details of an ISO attachment for a virtual machine.

type VirtualMachineAttachmentTypeIsoType added in v0.6.5

type VirtualMachineAttachmentTypeIsoType string

VirtualMachineAttachmentTypeIsoType The type of the attachment (iso)

const (
	Iso VirtualMachineAttachmentTypeIsoType = "iso"
)

Defines values for VirtualMachineAttachmentTypeIsoType.

type VirtualMachineBaseImage

type VirtualMachineBaseImage struct {
	// Description A detailed description of the base image.
	Description string `json:"description"`

	// Homepage The official homepage for the base image.
	Homepage string `json:"homepage"`

	// Title The name of the base image (e.g., "Alpine Linux").
	Title string `json:"title"`

	// Versions A list of available versions for the base image, including details like version number and disk image URL.
	Versions []struct {
		// DiskImageUrl The URL where the disk image can be downloaded.
		DiskImageUrl string `json:"disk_image_url"`

		// Identifier A unique identifier for the version.
		Identifier string `json:"identifier"`

		// Supported A flag indicating whether the version is currently supported.
		Supported bool `json:"supported"`

		// Uefi Whether the image supports UEFI.
		Uefi bool `json:"uefi"`

		// Version The version number of the base image.
		Version string `json:"version"`
	} `json:"versions"`
}

VirtualMachineBaseImage Represents a virtual machine base OS image provided by Cycle.

type VirtualMachineConfig

type VirtualMachineConfig struct {
	// Deploy Represents the deployment configuration for a virtual machine, including constraints, shutdown/startup policies, restart conditions, and telemetry settings.
	Deploy VirtualMachineDeployConfig `json:"deploy"`

	// Network Defines the network settings for a virtual machine, including public access mode, hostname, and ports.
	Network VirtualMachineNetworkConfig `json:"network"`

	// Resources Defines the resource settings for a virtual machine, including CPU and RAM.
	Resources VirtualMachineResourcesConfig `json:"resources"`

	// Runtime Defines the runtime settings for a virtual machine.
	Runtime *VirtualMachineRuntimeConfig `json:"runtime,omitempty"`
}

VirtualMachineConfig Defines the network and deployment configurations for a virtual machine.

type VirtualMachineCpuConfigCustom added in v0.6.5

type VirtualMachineCpuConfigCustom struct {
	Details struct {
		// FeatureFlags Additional CPU feature flags to enable. Will start with a "+" or "-" to include or exclude.
		FeatureFlags *[]string `json:"feature_flags"`

		// Model CPU model string (for example "Skylake-Client").
		Model string `json:"model"`
	} `json:"details"`

	// Type Custom CPU definition.
	Type VirtualMachineCpuConfigCustomType `json:"type"`
}

VirtualMachineCpuConfigCustom Custom CPU selection with model and feature flags.

type VirtualMachineCpuConfigCustomType added in v0.6.5

type VirtualMachineCpuConfigCustomType string

VirtualMachineCpuConfigCustomType Custom CPU definition.

const (
	VirtualMachineCpuConfigCustomTypeCustom VirtualMachineCpuConfigCustomType = "custom"
)

Defines values for VirtualMachineCpuConfigCustomType.

type VirtualMachineCpuConfigDefault added in v0.6.5

type VirtualMachineCpuConfigDefault struct {
	// Details An object with no properties.
	Details map[string]interface{} `json:"details"`

	// Type Predefined CPU type.
	Type VirtualMachineCpuConfigDefaultType `json:"type"`
}

VirtualMachineCpuConfigDefault Predefined CPU selection.

type VirtualMachineCpuConfigDefaultType added in v0.6.5

type VirtualMachineCpuConfigDefaultType string

VirtualMachineCpuConfigDefaultType Predefined CPU type.

Defines values for VirtualMachineCpuConfigDefaultType.

type VirtualMachineCpuResources

type VirtualMachineCpuResources struct {
	Cores *struct {
		// Allocate If true, reserves the cores so they cannot be used by any other virtual machine.
		Allocate *bool `json:"allocate"`

		// Number The number of cores to assign to this virtual machine. Must be between 1 and 32.
		Number int `json:"number"`
	} `json:"cores,omitempty"`

	// Cpus The specific cores/range of cores to allocate to the virtual machine. An 'x' indicates the maximum core for a given machine.
	Cpus *string `json:"cpus"`
}

VirtualMachineCpuResources Defines the CPU configuration of a virtual machine. Set **either** `cores` or `cpus`.

type VirtualMachineDeployConfig

type VirtualMachineDeployConfig struct {
	Constraints *VirtualMachineDeployConstraints `json:"constraints"`
	Shutdown    *VirtualMachineShutdownPolicy    `json:"shutdown"`
	Startup     *VirtualMachineStartupPolicy     `json:"startup"`
	Telemetry   *VirtualMachineTelemetryConfig   `json:"telemetry"`
}

VirtualMachineDeployConfig Represents the deployment configuration for a virtual machine, including constraints, shutdown/startup policies, restart conditions, and telemetry settings.

type VirtualMachineDeployConstraints

type VirtualMachineDeployConstraints struct {
	Containers *[]string                      `json:"containers,omitempty"`
	Node       *VirtualMachineNodeConstraints `json:"node"`
	Secrets    *[]string                      `json:"secrets,omitempty"`
}

VirtualMachineDeployConstraints Constraints define node-level and resource restrictions for the virtual machine deployment.

type VirtualMachineDeployTags

type VirtualMachineDeployTags struct {
	All *[]string `json:"all,omitempty"`
	Any *[]string `json:"any,omitempty"`
}

VirtualMachineDeployTags Tags that define node requirements for the deployment. The `any` tag must match at least one condition, while `all` must match all conditions.

type VirtualMachineImage

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

VirtualMachineImage Represents the image used by a virtual machine. It can either reference a URL where the image is located or specify a base image provided by Cycle.

func (VirtualMachineImage) AsVirtualMachineImageSourceBase

func (t VirtualMachineImage) AsVirtualMachineImageSourceBase() (VirtualMachineImageSourceBase, error)

AsVirtualMachineImageSourceBase returns the union data inside the VirtualMachineImage as a VirtualMachineImageSourceBase

func (VirtualMachineImage) AsVirtualMachineImageSourceExternalVolume added in v0.6.5

func (t VirtualMachineImage) AsVirtualMachineImageSourceExternalVolume() (VirtualMachineImageSourceExternalVolume, error)

AsVirtualMachineImageSourceExternalVolume returns the union data inside the VirtualMachineImage as a VirtualMachineImageSourceExternalVolume

func (VirtualMachineImage) AsVirtualMachineImageSourceIpxe

func (t VirtualMachineImage) AsVirtualMachineImageSourceIpxe() (VirtualMachineImageSourceIpxe, error)

AsVirtualMachineImageSourceIpxe returns the union data inside the VirtualMachineImage as a VirtualMachineImageSourceIpxe

func (VirtualMachineImage) AsVirtualMachineImageSourceUrl

func (t VirtualMachineImage) AsVirtualMachineImageSourceUrl() (VirtualMachineImageSourceUrl, error)

AsVirtualMachineImageSourceUrl returns the union data inside the VirtualMachineImage as a VirtualMachineImageSourceUrl

func (VirtualMachineImage) Discriminator

func (t VirtualMachineImage) Discriminator() (string, error)

func (*VirtualMachineImage) FromVirtualMachineImageSourceBase

func (t *VirtualMachineImage) FromVirtualMachineImageSourceBase(v VirtualMachineImageSourceBase) error

FromVirtualMachineImageSourceBase overwrites any union data inside the VirtualMachineImage as the provided VirtualMachineImageSourceBase

func (*VirtualMachineImage) FromVirtualMachineImageSourceExternalVolume added in v0.6.5

func (t *VirtualMachineImage) FromVirtualMachineImageSourceExternalVolume(v VirtualMachineImageSourceExternalVolume) error

FromVirtualMachineImageSourceExternalVolume overwrites any union data inside the VirtualMachineImage as the provided VirtualMachineImageSourceExternalVolume

func (*VirtualMachineImage) FromVirtualMachineImageSourceIpxe

func (t *VirtualMachineImage) FromVirtualMachineImageSourceIpxe(v VirtualMachineImageSourceIpxe) error

FromVirtualMachineImageSourceIpxe overwrites any union data inside the VirtualMachineImage as the provided VirtualMachineImageSourceIpxe

func (*VirtualMachineImage) FromVirtualMachineImageSourceUrl

func (t *VirtualMachineImage) FromVirtualMachineImageSourceUrl(v VirtualMachineImageSourceUrl) error

FromVirtualMachineImageSourceUrl overwrites any union data inside the VirtualMachineImage as the provided VirtualMachineImageSourceUrl

func (VirtualMachineImage) MarshalJSON

func (t VirtualMachineImage) MarshalJSON() ([]byte, error)

func (*VirtualMachineImage) MergeVirtualMachineImageSourceBase

func (t *VirtualMachineImage) MergeVirtualMachineImageSourceBase(v VirtualMachineImageSourceBase) error

MergeVirtualMachineImageSourceBase performs a merge with any union data inside the VirtualMachineImage, using the provided VirtualMachineImageSourceBase

func (*VirtualMachineImage) MergeVirtualMachineImageSourceExternalVolume added in v0.6.5

func (t *VirtualMachineImage) MergeVirtualMachineImageSourceExternalVolume(v VirtualMachineImageSourceExternalVolume) error

MergeVirtualMachineImageSourceExternalVolume performs a merge with any union data inside the VirtualMachineImage, using the provided VirtualMachineImageSourceExternalVolume

func (*VirtualMachineImage) MergeVirtualMachineImageSourceIpxe

func (t *VirtualMachineImage) MergeVirtualMachineImageSourceIpxe(v VirtualMachineImageSourceIpxe) error

MergeVirtualMachineImageSourceIpxe performs a merge with any union data inside the VirtualMachineImage, using the provided VirtualMachineImageSourceIpxe

func (*VirtualMachineImage) MergeVirtualMachineImageSourceUrl

func (t *VirtualMachineImage) MergeVirtualMachineImageSourceUrl(v VirtualMachineImageSourceUrl) error

MergeVirtualMachineImageSourceUrl performs a merge with any union data inside the VirtualMachineImage, using the provided VirtualMachineImageSourceUrl

func (*VirtualMachineImage) UnmarshalJSON

func (t *VirtualMachineImage) UnmarshalJSON(b []byte) error

func (VirtualMachineImage) ValueByDiscriminator

func (t VirtualMachineImage) ValueByDiscriminator() (interface{}, error)

type VirtualMachineImageSourceBase

type VirtualMachineImageSourceBase struct {
	Details struct {
		// Identifier The base image identifier.
		Identifier string `json:"identifier"`
	} `json:"details"`
	Type VirtualMachineImageSourceBaseType `json:"type"`
}

VirtualMachineImageSourceBase A virtual machine image sourced from a Cycle base image.

type VirtualMachineImageSourceBaseType

type VirtualMachineImageSourceBaseType string

VirtualMachineImageSourceBaseType defines model for VirtualMachineImageSourceBase.Type.

const (
	Base VirtualMachineImageSourceBaseType = "base"
)

Defines values for VirtualMachineImageSourceBaseType.

type VirtualMachineImageSourceExternalVolume added in v0.6.5

type VirtualMachineImageSourceExternalVolume struct {
	Details struct {
		// Id A 24 character hex string used to identify a unique resource.
		Id *ID `json:"id,omitempty"`

		// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
		// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
		// have the identifier of `my-container` and is automatically created by the platform.
		//
		// The identifier does not have to be unique.
		Identifier *Identifier `json:"identifier,omitempty"`
	} `json:"details"`
	Type VirtualMachineImageSourceExternalVolumeType `json:"type"`
}

VirtualMachineImageSourceExternalVolume A virtual machine image sourced from a SAN target.

type VirtualMachineImageSourceExternalVolumeType added in v0.6.5

type VirtualMachineImageSourceExternalVolumeType string

VirtualMachineImageSourceExternalVolumeType defines model for VirtualMachineImageSourceExternalVolume.Type.

const (
	VirtualMachineImageSourceExternalVolumeTypeExternalVolume VirtualMachineImageSourceExternalVolumeType = "external-volume"
)

Defines values for VirtualMachineImageSourceExternalVolumeType.

type VirtualMachineImageSourceIpxe

type VirtualMachineImageSourceIpxe struct {
	Details struct {
		// ChainUrl A URL that points to an IPXE script.
		ChainUrl *string `json:"chain_url"`

		// Script An inline IPXE script.
		Script *string `json:"script"`
	} `json:"details"`
	Type VirtualMachineImageSourceIpxeType `json:"type"`
}

VirtualMachineImageSourceIpxe A virtual machine image sourced from an IPXE script.

type VirtualMachineImageSourceIpxeType

type VirtualMachineImageSourceIpxeType string

VirtualMachineImageSourceIpxeType defines model for VirtualMachineImageSourceIpxe.Type.

const (
	Ipxe VirtualMachineImageSourceIpxeType = "ipxe"
)

Defines values for VirtualMachineImageSourceIpxeType.

type VirtualMachineImageSourceUrl

type VirtualMachineImageSourceUrl struct {
	Details struct {
		// Url The URL where a custom image is located.
		Url string `json:"url"`
	} `json:"details"`
	Type VirtualMachineImageSourceUrlType `json:"type"`
}

VirtualMachineImageSourceUrl A virtual machine image sourced from a URL.

type VirtualMachineImageSourceUrlType

type VirtualMachineImageSourceUrlType string

VirtualMachineImageSourceUrlType defines model for VirtualMachineImageSourceUrl.Type.

const (
	VirtualMachineImageSourceUrlTypeUrl VirtualMachineImageSourceUrlType = "url"
)

Defines values for VirtualMachineImageSourceUrlType.

type VirtualMachineIncludes

type VirtualMachineIncludes struct {
	Clusters   *map[string]Cluster   `json:"clusters,omitempty"`
	Containers *map[string]Container `json:"containers,omitempty"`

	// Creators An identity that created a resource.
	Creators                *CreatorInclude         `json:"creators,omitempty"`
	Environments            *map[string]Environment `json:"environments,omitempty"`
	EnvironmentsIdentifiers *map[string]ID          `json:"environments:identifiers,omitempty"`
}

VirtualMachineIncludes All includable resources linkable to the given virtual machine.

type VirtualMachineIpAllocateAction added in v0.6.1

type VirtualMachineIpAllocateAction struct {
	// Action The action to take.
	Action   VirtualMachineIpAllocateActionAction `json:"action"`
	Contents struct {
		// IpId A 24 character hex string used to identify a unique resource.
		IpId *ID `json:"ip_id,omitempty"`
	} `json:"contents"`
}

VirtualMachineIpAllocateAction defines model for VirtualMachineIpAllocateAction.

type VirtualMachineIpAllocateActionAction added in v0.6.1

type VirtualMachineIpAllocateActionAction string

VirtualMachineIpAllocateActionAction The action to take.

const (
	IpAllocate VirtualMachineIpAllocateActionAction = "ip.allocate"
)

Defines values for VirtualMachineIpAllocateActionAction.

type VirtualMachineIpUnallocateAction added in v0.6.1

type VirtualMachineIpUnallocateAction struct {
	// Action The action to take.
	Action   VirtualMachineIpUnallocateActionAction `json:"action"`
	Contents struct {
		// IpId A 24 character hex string used to identify a unique resource.
		IpId ID `json:"ip_id"`
	} `json:"contents"`
}

VirtualMachineIpUnallocateAction defines model for VirtualMachineIpUnallocateAction.

type VirtualMachineIpUnallocateActionAction added in v0.6.1

type VirtualMachineIpUnallocateActionAction string

VirtualMachineIpUnallocateActionAction The action to take.

const (
	IpUnallocate VirtualMachineIpUnallocateActionAction = "ip.unallocate"
)

Defines values for VirtualMachineIpUnallocateActionAction.

type VirtualMachineMeta

type VirtualMachineMeta struct {
	Domains *[]struct {
		// Fqdn The fully qualified domain name.
		Fqdn   string     `json:"fqdn"`
		Record *DnsRecord `json:"record"`
	} `json:"domains,omitempty"`

	// HypervisorIps An array of private IP addresses associated with the hypervisor for this virtual machine..
	HypervisorIps *struct {
		Ipv4 *string `json:"ipv4,omitempty"`
		Ipv6 *string `json:"ipv6,omitempty"`
	} `json:"hypervisor_ips,omitempty"`

	// Ips An array of public IP addresses associated with this virtual machine.
	Ips *[]Ip `json:"ips,omitempty"`

	// Server The server the virtual machine is deployed to.
	Server *Server `json:"server"`
}

VirtualMachineMeta Fields that can be included on a per-virtual machine basis, specific to that virtual machine.

type VirtualMachineNetworkConfig

type VirtualMachineNetworkConfig struct {
	// EgressViaGateway True indicates that traffic should leave via the gateway, not the underlying host.
	EgressViaGateway bool `json:"egress_via_gateway"`

	// Hostname The hostname assigned to the virtual machine.
	Hostname string `json:"hostname"`

	// Ports Port configurations for the virtual machine.
	Ports *[]string `json:"ports,omitempty"`

	// Public Controls the public network mode for the virtual machine.
	Public VirtualMachineNetworkConfigPublic `json:"public"`
}

VirtualMachineNetworkConfig Defines the network settings for a virtual machine, including public access mode, hostname, and ports.

type VirtualMachineNetworkConfigPublic

type VirtualMachineNetworkConfigPublic string

VirtualMachineNetworkConfigPublic Controls the public network mode for the virtual machine.

const (
	VirtualMachineNetworkConfigPublicDisable    VirtualMachineNetworkConfigPublic = "disable"
	VirtualMachineNetworkConfigPublicEgressOnly VirtualMachineNetworkConfigPublic = "egress-only"
	VirtualMachineNetworkConfigPublicEnable     VirtualMachineNetworkConfigPublic = "enable"
)

Defines values for VirtualMachineNetworkConfigPublic.

type VirtualMachineNodeConstraints

type VirtualMachineNodeConstraints struct {
	// Tags Tags that define node requirements for the deployment. The `any` tag must match at least one condition, while `all` must match all conditions.
	Tags VirtualMachineDeployTags `json:"tags"`
}

VirtualMachineNodeConstraints Node-level constraints for the virtual machine deployment, specifying tags that must or must not be present.

type VirtualMachineRamResources

type VirtualMachineRamResources struct {
	// Allocate Whether or not the RAM set in limit should be preallocated.
	Allocate *bool `json:"allocate"`

	// Limit The limit (maximum) amount of RAM the virtual machine can consume. Must be at least 512M and less than 65GB.
	Limit string `json:"limit"`
}

VirtualMachineRamResources Defines the RAM configuration of a virtual machine.

type VirtualMachineReconfigureAction added in v0.6.1

type VirtualMachineReconfigureAction struct {
	// Action The action to take.
	Action VirtualMachineReconfigureActionAction `json:"action"`

	// Contents Defines the network and deployment configurations for a virtual machine.
	Contents VirtualMachineConfig `json:"contents"`
}

VirtualMachineReconfigureAction defines model for VirtualMachineReconfigureAction.

type VirtualMachineReconfigureActionAction added in v0.6.1

type VirtualMachineReconfigureActionAction string

VirtualMachineReconfigureActionAction The action to take.

const (
	VirtualMachineReconfigureActionActionReconfigure VirtualMachineReconfigureActionAction = "reconfigure"
)

Defines values for VirtualMachineReconfigureActionAction.

type VirtualMachineReconfigureVolumesAction added in v0.6.5

type VirtualMachineReconfigureVolumesAction struct {
	// Action The action to take.
	Action VirtualMachineReconfigureVolumesActionAction `json:"action"`

	// Contents A map of volume objects where the key is the id and the value is the volume's config.
	Contents map[string]VirtualMachineVolumeConfig `json:"contents"`
}

VirtualMachineReconfigureVolumesAction defines model for VirtualMachineReconfigureVolumesAction.

type VirtualMachineReconfigureVolumesActionAction added in v0.6.5

type VirtualMachineReconfigureVolumesActionAction string

VirtualMachineReconfigureVolumesActionAction The action to take.

const (
	VirtualMachineReconfigureVolumesActionActionVolumesReconfigure VirtualMachineReconfigureVolumesActionAction = "volumes.reconfigure"
)

Defines values for VirtualMachineReconfigureVolumesActionAction.

type VirtualMachineResourcesConfig

type VirtualMachineResourcesConfig struct {
	// Cpu Defines the CPU configuration of a virtual machine. Set **either** `cores` or `cpus`.
	Cpu VirtualMachineCpuResources `json:"cpu"`

	// Ram Defines the RAM configuration of a virtual machine.
	Ram VirtualMachineRamResources `json:"ram"`
}

VirtualMachineResourcesConfig Defines the resource settings for a virtual machine, including CPU and RAM.

type VirtualMachineRestartAction added in v0.6.5

type VirtualMachineRestartAction struct {
	// Action The name of the action to perform.
	Action VirtualMachineRestartActionAction `json:"action"`
}

VirtualMachineRestartAction defines model for VirtualMachineRestartAction.

type VirtualMachineRestartActionAction added in v0.6.5

type VirtualMachineRestartActionAction string

VirtualMachineRestartActionAction The name of the action to perform.

const (
	Restart VirtualMachineRestartActionAction = "restart"
)

Defines values for VirtualMachineRestartActionAction.

type VirtualMachineRootPwChangeAction added in v0.6.1

type VirtualMachineRootPwChangeAction struct {
	// Action The action to take.
	Action   VirtualMachineRootPwChangeActionAction `json:"action"`
	Contents struct {
		// Password The new password. Must be at least 10 characters.
		Password string `json:"password"`
	} `json:"contents"`
}

VirtualMachineRootPwChangeAction defines model for VirtualMachineRootPwChangeAction.

type VirtualMachineRootPwChangeActionAction added in v0.6.1

type VirtualMachineRootPwChangeActionAction string

VirtualMachineRootPwChangeActionAction The action to take.

const (
	RootpwChange VirtualMachineRootPwChangeActionAction = "rootpw.change"
)

Defines values for VirtualMachineRootPwChangeActionAction.

type VirtualMachineRuntimeConfig added in v0.6.5

type VirtualMachineRuntimeConfig struct {
	// Attach An array of attachments to 'plug in' to the virtual machine.
	Attach *[]VirtualMachineRuntimeConfigAttachment `json:"attach"`

	// Hardware Hardware parameters applied for VM runtime.
	Hardware *VirtualMachineRuntimeConfigHardware `json:"hardware,omitempty"`

	// OsFlavor The type of operating system that will be installed to the virtual machine. Allows for preconfigured settings, such as virtio-win drivers for Windows.
	OsFlavor *string `json:"os_flavor,omitempty"`
}

VirtualMachineRuntimeConfig Defines the runtime settings for a virtual machine.

type VirtualMachineRuntimeConfigAttachment added in v0.6.5

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

VirtualMachineRuntimeConfigAttachment Additional attachment (ISO, etc) added during runtime.

func (VirtualMachineRuntimeConfigAttachment) AsVirtualMachineAttachmentTypeIso added in v0.6.5

func (t VirtualMachineRuntimeConfigAttachment) AsVirtualMachineAttachmentTypeIso() (VirtualMachineAttachmentTypeIso, error)

AsVirtualMachineAttachmentTypeIso returns the union data inside the VirtualMachineRuntimeConfigAttachment as a VirtualMachineAttachmentTypeIso

func (VirtualMachineRuntimeConfigAttachment) Discriminator added in v0.6.5

func (t VirtualMachineRuntimeConfigAttachment) Discriminator() (string, error)

func (*VirtualMachineRuntimeConfigAttachment) FromVirtualMachineAttachmentTypeIso added in v0.6.5

func (t *VirtualMachineRuntimeConfigAttachment) FromVirtualMachineAttachmentTypeIso(v VirtualMachineAttachmentTypeIso) error

FromVirtualMachineAttachmentTypeIso overwrites any union data inside the VirtualMachineRuntimeConfigAttachment as the provided VirtualMachineAttachmentTypeIso

func (VirtualMachineRuntimeConfigAttachment) MarshalJSON added in v0.6.5

func (t VirtualMachineRuntimeConfigAttachment) MarshalJSON() ([]byte, error)

func (*VirtualMachineRuntimeConfigAttachment) MergeVirtualMachineAttachmentTypeIso added in v0.6.5

func (t *VirtualMachineRuntimeConfigAttachment) MergeVirtualMachineAttachmentTypeIso(v VirtualMachineAttachmentTypeIso) error

MergeVirtualMachineAttachmentTypeIso performs a merge with any union data inside the VirtualMachineRuntimeConfigAttachment, using the provided VirtualMachineAttachmentTypeIso

func (*VirtualMachineRuntimeConfigAttachment) UnmarshalJSON added in v0.6.5

func (t *VirtualMachineRuntimeConfigAttachment) UnmarshalJSON(b []byte) error

func (VirtualMachineRuntimeConfigAttachment) ValueByDiscriminator added in v0.6.5

func (t VirtualMachineRuntimeConfigAttachment) ValueByDiscriminator() (interface{}, error)

type VirtualMachineRuntimeConfigHardware added in v0.6.5

type VirtualMachineRuntimeConfigHardware struct {
	// Cpu CPU configuration for the VM. Discriminated by `type`.
	Cpu VirtualMachineRuntimeConfigHardware_Cpu `json:"cpu"`

	// MachineType QEMU machine type to emulate.
	MachineType *VirtualMachineRuntimeConfigHardwareMachineType `json:"machine_type"`
}

VirtualMachineRuntimeConfigHardware Hardware parameters applied for VM runtime.

type VirtualMachineRuntimeConfigHardwareMachineType added in v0.6.5

type VirtualMachineRuntimeConfigHardwareMachineType string

VirtualMachineRuntimeConfigHardwareMachineType QEMU machine type to emulate.

Defines values for VirtualMachineRuntimeConfigHardwareMachineType.

type VirtualMachineRuntimeConfigHardware_Cpu added in v0.6.5

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

VirtualMachineRuntimeConfigHardware_Cpu CPU configuration for the VM. Discriminated by `type`.

func (VirtualMachineRuntimeConfigHardware_Cpu) AsVirtualMachineCpuConfigCustom added in v0.6.5

func (t VirtualMachineRuntimeConfigHardware_Cpu) AsVirtualMachineCpuConfigCustom() (VirtualMachineCpuConfigCustom, error)

AsVirtualMachineCpuConfigCustom returns the union data inside the VirtualMachineRuntimeConfigHardware_Cpu as a VirtualMachineCpuConfigCustom

func (VirtualMachineRuntimeConfigHardware_Cpu) AsVirtualMachineCpuConfigDefault added in v0.6.5

func (t VirtualMachineRuntimeConfigHardware_Cpu) AsVirtualMachineCpuConfigDefault() (VirtualMachineCpuConfigDefault, error)

AsVirtualMachineCpuConfigDefault returns the union data inside the VirtualMachineRuntimeConfigHardware_Cpu as a VirtualMachineCpuConfigDefault

func (VirtualMachineRuntimeConfigHardware_Cpu) Discriminator added in v0.6.5

func (*VirtualMachineRuntimeConfigHardware_Cpu) FromVirtualMachineCpuConfigCustom added in v0.6.5

func (t *VirtualMachineRuntimeConfigHardware_Cpu) FromVirtualMachineCpuConfigCustom(v VirtualMachineCpuConfigCustom) error

FromVirtualMachineCpuConfigCustom overwrites any union data inside the VirtualMachineRuntimeConfigHardware_Cpu as the provided VirtualMachineCpuConfigCustom

func (*VirtualMachineRuntimeConfigHardware_Cpu) FromVirtualMachineCpuConfigDefault added in v0.6.5

func (t *VirtualMachineRuntimeConfigHardware_Cpu) FromVirtualMachineCpuConfigDefault(v VirtualMachineCpuConfigDefault) error

FromVirtualMachineCpuConfigDefault overwrites any union data inside the VirtualMachineRuntimeConfigHardware_Cpu as the provided VirtualMachineCpuConfigDefault

func (VirtualMachineRuntimeConfigHardware_Cpu) MarshalJSON added in v0.6.5

func (t VirtualMachineRuntimeConfigHardware_Cpu) MarshalJSON() ([]byte, error)

func (*VirtualMachineRuntimeConfigHardware_Cpu) MergeVirtualMachineCpuConfigCustom added in v0.6.5

func (t *VirtualMachineRuntimeConfigHardware_Cpu) MergeVirtualMachineCpuConfigCustom(v VirtualMachineCpuConfigCustom) error

MergeVirtualMachineCpuConfigCustom performs a merge with any union data inside the VirtualMachineRuntimeConfigHardware_Cpu, using the provided VirtualMachineCpuConfigCustom

func (*VirtualMachineRuntimeConfigHardware_Cpu) MergeVirtualMachineCpuConfigDefault added in v0.6.5

func (t *VirtualMachineRuntimeConfigHardware_Cpu) MergeVirtualMachineCpuConfigDefault(v VirtualMachineCpuConfigDefault) error

MergeVirtualMachineCpuConfigDefault performs a merge with any union data inside the VirtualMachineRuntimeConfigHardware_Cpu, using the provided VirtualMachineCpuConfigDefault

func (*VirtualMachineRuntimeConfigHardware_Cpu) UnmarshalJSON added in v0.6.5

func (t *VirtualMachineRuntimeConfigHardware_Cpu) UnmarshalJSON(b []byte) error

func (VirtualMachineRuntimeConfigHardware_Cpu) ValueByDiscriminator added in v0.6.5

func (t VirtualMachineRuntimeConfigHardware_Cpu) ValueByDiscriminator() (interface{}, error)

type VirtualMachineShutdownPolicy

type VirtualMachineShutdownPolicy struct {
	// GracefulTimeout The timeout period for graceful shutdown.
	GracefulTimeout *Duration `json:"graceful_timeout"`
}

VirtualMachineShutdownPolicy The shutdown policy defines how the virtual machine should handle shutdown, including a timeout and signals to be sent during shutdown.

type VirtualMachineSosConnection

type VirtualMachineSosConnection struct {
	// Address The serial-over-SSH connection address.
	Address string `json:"address"`

	// Secret The secret used to connect.
	Secret string `json:"secret"`

	// Token A token used to connect to a virtual machine using serial-over-SSH.
	Token VirtualMachineSosToken `json:"token"`
}

VirtualMachineSosConnection Connection details for connecting to a virtual machine using serial-over-SSH.

type VirtualMachineSosToken

type VirtualMachineSosToken struct {
	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the serial-over-SSH token's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Expires DateTime `json:"expires"`
		Used    DateTime `json:"used"`
	} `json:"events"`

	// HubId The unique ID of the Hub this resource was created in.
	HubId HubID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Valid A boolean where true represents the token as being a valid token to be used for connection.
	Valid bool `json:"valid"`

	// VirtualMachineId The ID of the virtual machine being connected to.
	VirtualMachineId string `json:"virtual_machine_id"`
}

VirtualMachineSosToken A token used to connect to a virtual machine using serial-over-SSH.

type VirtualMachineSshIncludes

type VirtualMachineSshIncludes struct {
	// Creators An identity that created a resource.
	Creators                *CreatorInclude         `json:"creators,omitempty"`
	Environments            *map[string]Environment `json:"environments,omitempty"`
	EnvironmentsIdentifiers *map[string]ID          `json:"environments:identifiers,omitempty"`
}

VirtualMachineSshIncludes All includable resources linkable to the given virtual machine SSH key.

type VirtualMachineSshKey

type VirtualMachineSshKey struct {
	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// EnvironmentId A 24 character hex string used to identify a unique resource.
	EnvironmentId ID `json:"environment_id"`

	// HubId A 24 character hex string used to identify a unique resource.
	HubId ID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// Name A user-defined name for the SSH key.
	Name string `json:"name"`

	// PublicKey The public key value of this SSH key.
	PublicKey string `json:"public_key"`
	State     struct {
		Changed DateTime `json:"changed"`

		// Current The current state of the SSH key.
		Current VirtualMachineSshKeyStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`
}

VirtualMachineSshKey Describes an SSH key used to access a virtual machine.

type VirtualMachineSshKeyStateCurrent

type VirtualMachineSshKeyStateCurrent string

VirtualMachineSshKeyStateCurrent The current state of the SSH key.

const (
	VirtualMachineSshKeyStateCurrentDeleted  VirtualMachineSshKeyStateCurrent = "deleted"
	VirtualMachineSshKeyStateCurrentDeleting VirtualMachineSshKeyStateCurrent = "deleting"
	VirtualMachineSshKeyStateCurrentLive     VirtualMachineSshKeyStateCurrent = "live"
)

Defines values for VirtualMachineSshKeyStateCurrent.

type VirtualMachineStartAction added in v0.6.1

type VirtualMachineStartAction struct {
	Action VirtualMachineStartActionAction `json:"action"`
}

VirtualMachineStartAction defines model for VirtualMachineStartAction.

type VirtualMachineStartActionAction added in v0.6.1

type VirtualMachineStartActionAction string

VirtualMachineStartActionAction defines model for VirtualMachineStartAction.Action.

const (
	Start VirtualMachineStartActionAction = "start"
)

Defines values for VirtualMachineStartActionAction.

type VirtualMachineStartupPolicy

type VirtualMachineStartupPolicy struct {
	// Delay Delay before startup.
	Delay *Duration `json:"delay"`
}

VirtualMachineStartupPolicy The startup policy defines how the virtual machine should handle startup, including a possible delay before starting the machine.

type VirtualMachineState

type VirtualMachineState struct {
	Changed DateTime `json:"changed"`

	// Current The current state of the virtual machine.
	Current VirtualMachineStateCurrent `json:"current"`

	// Error An error, if any, that has occurred for this resource.
	Error *struct {
		// Message Details about the error that has occurred.
		Message *string   `json:"message,omitempty"`
		Time    *DateTime `json:"time,omitempty"`
	} `json:"error,omitempty"`
}

VirtualMachineState defines model for VirtualMachineState.

type VirtualMachineStateCurrent

type VirtualMachineStateCurrent string

VirtualMachineStateCurrent The current state of the virtual machine.

const (
	VirtualMachineStateCurrentConfiguring VirtualMachineStateCurrent = "configuring"
	VirtualMachineStateCurrentDeleted     VirtualMachineStateCurrent = "deleted"
	VirtualMachineStateCurrentDeleting    VirtualMachineStateCurrent = "deleting"
	VirtualMachineStateCurrentNew         VirtualMachineStateCurrent = "new"
	VirtualMachineStateCurrentRunning     VirtualMachineStateCurrent = "running"
	VirtualMachineStateCurrentStarting    VirtualMachineStateCurrent = "starting"
	VirtualMachineStateCurrentStopped     VirtualMachineStateCurrent = "stopped"
	VirtualMachineStateCurrentStopping    VirtualMachineStateCurrent = "stopping"
)

Defines values for VirtualMachineStateCurrent.

type VirtualMachineStopAction added in v0.6.1

type VirtualMachineStopAction struct {
	Action VirtualMachineStopActionAction `json:"action"`
}

VirtualMachineStopAction defines model for VirtualMachineStopAction.

type VirtualMachineStopActionAction added in v0.6.1

type VirtualMachineStopActionAction string

VirtualMachineStopActionAction defines model for VirtualMachineStopAction.Action.

const (
	Stop VirtualMachineStopActionAction = "stop"
)

Defines values for VirtualMachineStopActionAction.

type VirtualMachineTask added in v0.6.1

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

VirtualMachineTask defines model for VirtualMachineTask.

func (VirtualMachineTask) AsVirtualMachineIpAllocateAction added in v0.6.1

func (t VirtualMachineTask) AsVirtualMachineIpAllocateAction() (VirtualMachineIpAllocateAction, error)

AsVirtualMachineIpAllocateAction returns the union data inside the VirtualMachineTask as a VirtualMachineIpAllocateAction

func (VirtualMachineTask) AsVirtualMachineIpUnallocateAction added in v0.6.1

func (t VirtualMachineTask) AsVirtualMachineIpUnallocateAction() (VirtualMachineIpUnallocateAction, error)

AsVirtualMachineIpUnallocateAction returns the union data inside the VirtualMachineTask as a VirtualMachineIpUnallocateAction

func (VirtualMachineTask) AsVirtualMachineReconfigureAction added in v0.6.1

func (t VirtualMachineTask) AsVirtualMachineReconfigureAction() (VirtualMachineReconfigureAction, error)

AsVirtualMachineReconfigureAction returns the union data inside the VirtualMachineTask as a VirtualMachineReconfigureAction

func (VirtualMachineTask) AsVirtualMachineReconfigureVolumesAction added in v0.6.5

func (t VirtualMachineTask) AsVirtualMachineReconfigureVolumesAction() (VirtualMachineReconfigureVolumesAction, error)

AsVirtualMachineReconfigureVolumesAction returns the union data inside the VirtualMachineTask as a VirtualMachineReconfigureVolumesAction

func (VirtualMachineTask) AsVirtualMachineRestartAction added in v0.6.5

func (t VirtualMachineTask) AsVirtualMachineRestartAction() (VirtualMachineRestartAction, error)

AsVirtualMachineRestartAction returns the union data inside the VirtualMachineTask as a VirtualMachineRestartAction

func (VirtualMachineTask) AsVirtualMachineRootPwChangeAction added in v0.6.1

func (t VirtualMachineTask) AsVirtualMachineRootPwChangeAction() (VirtualMachineRootPwChangeAction, error)

AsVirtualMachineRootPwChangeAction returns the union data inside the VirtualMachineTask as a VirtualMachineRootPwChangeAction

func (VirtualMachineTask) AsVirtualMachineStartAction added in v0.6.1

func (t VirtualMachineTask) AsVirtualMachineStartAction() (VirtualMachineStartAction, error)

AsVirtualMachineStartAction returns the union data inside the VirtualMachineTask as a VirtualMachineStartAction

func (VirtualMachineTask) AsVirtualMachineStopAction added in v0.6.1

func (t VirtualMachineTask) AsVirtualMachineStopAction() (VirtualMachineStopAction, error)

AsVirtualMachineStopAction returns the union data inside the VirtualMachineTask as a VirtualMachineStopAction

func (VirtualMachineTask) Discriminator added in v0.6.1

func (t VirtualMachineTask) Discriminator() (string, error)

func (*VirtualMachineTask) FromVirtualMachineIpAllocateAction added in v0.6.1

func (t *VirtualMachineTask) FromVirtualMachineIpAllocateAction(v VirtualMachineIpAllocateAction) error

FromVirtualMachineIpAllocateAction overwrites any union data inside the VirtualMachineTask as the provided VirtualMachineIpAllocateAction

func (*VirtualMachineTask) FromVirtualMachineIpUnallocateAction added in v0.6.1

func (t *VirtualMachineTask) FromVirtualMachineIpUnallocateAction(v VirtualMachineIpUnallocateAction) error

FromVirtualMachineIpUnallocateAction overwrites any union data inside the VirtualMachineTask as the provided VirtualMachineIpUnallocateAction

func (*VirtualMachineTask) FromVirtualMachineReconfigureAction added in v0.6.1

func (t *VirtualMachineTask) FromVirtualMachineReconfigureAction(v VirtualMachineReconfigureAction) error

FromVirtualMachineReconfigureAction overwrites any union data inside the VirtualMachineTask as the provided VirtualMachineReconfigureAction

func (*VirtualMachineTask) FromVirtualMachineReconfigureVolumesAction added in v0.6.5

func (t *VirtualMachineTask) FromVirtualMachineReconfigureVolumesAction(v VirtualMachineReconfigureVolumesAction) error

FromVirtualMachineReconfigureVolumesAction overwrites any union data inside the VirtualMachineTask as the provided VirtualMachineReconfigureVolumesAction

func (*VirtualMachineTask) FromVirtualMachineRestartAction added in v0.6.5

func (t *VirtualMachineTask) FromVirtualMachineRestartAction(v VirtualMachineRestartAction) error

FromVirtualMachineRestartAction overwrites any union data inside the VirtualMachineTask as the provided VirtualMachineRestartAction

func (*VirtualMachineTask) FromVirtualMachineRootPwChangeAction added in v0.6.1

func (t *VirtualMachineTask) FromVirtualMachineRootPwChangeAction(v VirtualMachineRootPwChangeAction) error

FromVirtualMachineRootPwChangeAction overwrites any union data inside the VirtualMachineTask as the provided VirtualMachineRootPwChangeAction

func (*VirtualMachineTask) FromVirtualMachineStartAction added in v0.6.1

func (t *VirtualMachineTask) FromVirtualMachineStartAction(v VirtualMachineStartAction) error

FromVirtualMachineStartAction overwrites any union data inside the VirtualMachineTask as the provided VirtualMachineStartAction

func (*VirtualMachineTask) FromVirtualMachineStopAction added in v0.6.1

func (t *VirtualMachineTask) FromVirtualMachineStopAction(v VirtualMachineStopAction) error

FromVirtualMachineStopAction overwrites any union data inside the VirtualMachineTask as the provided VirtualMachineStopAction

func (VirtualMachineTask) MarshalJSON added in v0.6.1

func (t VirtualMachineTask) MarshalJSON() ([]byte, error)

func (*VirtualMachineTask) MergeVirtualMachineIpAllocateAction added in v0.6.1

func (t *VirtualMachineTask) MergeVirtualMachineIpAllocateAction(v VirtualMachineIpAllocateAction) error

MergeVirtualMachineIpAllocateAction performs a merge with any union data inside the VirtualMachineTask, using the provided VirtualMachineIpAllocateAction

func (*VirtualMachineTask) MergeVirtualMachineIpUnallocateAction added in v0.6.1

func (t *VirtualMachineTask) MergeVirtualMachineIpUnallocateAction(v VirtualMachineIpUnallocateAction) error

MergeVirtualMachineIpUnallocateAction performs a merge with any union data inside the VirtualMachineTask, using the provided VirtualMachineIpUnallocateAction

func (*VirtualMachineTask) MergeVirtualMachineReconfigureAction added in v0.6.1

func (t *VirtualMachineTask) MergeVirtualMachineReconfigureAction(v VirtualMachineReconfigureAction) error

MergeVirtualMachineReconfigureAction performs a merge with any union data inside the VirtualMachineTask, using the provided VirtualMachineReconfigureAction

func (*VirtualMachineTask) MergeVirtualMachineReconfigureVolumesAction added in v0.6.5

func (t *VirtualMachineTask) MergeVirtualMachineReconfigureVolumesAction(v VirtualMachineReconfigureVolumesAction) error

MergeVirtualMachineReconfigureVolumesAction performs a merge with any union data inside the VirtualMachineTask, using the provided VirtualMachineReconfigureVolumesAction

func (*VirtualMachineTask) MergeVirtualMachineRestartAction added in v0.6.5

func (t *VirtualMachineTask) MergeVirtualMachineRestartAction(v VirtualMachineRestartAction) error

MergeVirtualMachineRestartAction performs a merge with any union data inside the VirtualMachineTask, using the provided VirtualMachineRestartAction

func (*VirtualMachineTask) MergeVirtualMachineRootPwChangeAction added in v0.6.1

func (t *VirtualMachineTask) MergeVirtualMachineRootPwChangeAction(v VirtualMachineRootPwChangeAction) error

MergeVirtualMachineRootPwChangeAction performs a merge with any union data inside the VirtualMachineTask, using the provided VirtualMachineRootPwChangeAction

func (*VirtualMachineTask) MergeVirtualMachineStartAction added in v0.6.1

func (t *VirtualMachineTask) MergeVirtualMachineStartAction(v VirtualMachineStartAction) error

MergeVirtualMachineStartAction performs a merge with any union data inside the VirtualMachineTask, using the provided VirtualMachineStartAction

func (*VirtualMachineTask) MergeVirtualMachineStopAction added in v0.6.1

func (t *VirtualMachineTask) MergeVirtualMachineStopAction(v VirtualMachineStopAction) error

MergeVirtualMachineStopAction performs a merge with any union data inside the VirtualMachineTask, using the provided VirtualMachineStopAction

func (*VirtualMachineTask) UnmarshalJSON added in v0.6.1

func (t *VirtualMachineTask) UnmarshalJSON(b []byte) error

func (VirtualMachineTask) ValueByDiscriminator added in v0.6.1

func (t VirtualMachineTask) ValueByDiscriminator() (interface{}, error)

type VirtualMachineTelemetryConfig

type VirtualMachineTelemetryConfig struct {
	// Disable Whether telemetry collection is disabled.
	Disable bool `json:"disable"`

	// Interval Telemetry collection interval.
	Interval *Duration `json:"interval"`

	// Retention Data retention duration for telemetry.
	Retention *Duration `json:"retention"`
}

VirtualMachineTelemetryConfig The telemetry configuration defines how telemetry data is handled, including retention, interval, and whether telemetry is disabled.

type VirtualMachineVolume

type VirtualMachineVolume struct {
	// Config Represents the configuration for a volume attached to a virtual machine.
	Config VirtualMachineVolumeConfig `json:"config"`

	// Hash A unique hash identifying the volume for the virtual machine.
	Hash string `json:"hash"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`
}

VirtualMachineVolume Represents a storage volume attached to a virtual machine.

type VirtualMachineVolumeConfig

type VirtualMachineVolumeConfig struct {
	// External Configuration details for a SAN volume.
	External *struct {
		// Id A 24 character hex string used to identify a unique resource.
		Id *ID `json:"id,omitempty"`
	} `json:"external,omitempty"`

	// Identifier A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient.
	// The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will
	// have the identifier of `my-container` and is automatically created by the platform.
	//
	// The identifier does not have to be unique.
	Identifier Identifier `json:"identifier"`

	// Local Configuration details for a local volume.
	Local *struct {
		// MaxSize The maximum size allowed for the local volume.
		MaxSize string `json:"max_size"`

		// StoragePool Indicates if the volume is part of a storage pool.
		StoragePool *bool `json:"storage_pool,omitempty"`
	} `json:"local,omitempty"`

	// ReadOnly Specifies if the volume is mounted as read-only.
	ReadOnly bool `json:"read_only"`
}

VirtualMachineVolumeConfig Represents the configuration for a volume attached to a virtual machine.

type VirtualProviderGenerateIsoAction added in v0.6.3

type VirtualProviderGenerateIsoAction struct {
	// Action The action to take.
	Action VirtualProviderGenerateIsoActionAction `json:"action"`
}

VirtualProviderGenerateIsoAction defines model for VirtualProviderGenerateIsoAction.

type VirtualProviderGenerateIsoActionAction added in v0.6.3

type VirtualProviderGenerateIsoActionAction string

VirtualProviderGenerateIsoActionAction The action to take.

const (
	VirtualProviderGenerateIsoActionActionGenerate VirtualProviderGenerateIsoActionAction = "generate"
)

Defines values for VirtualProviderGenerateIsoActionAction.

type VirtualProviderIso added in v0.6.3

type VirtualProviderIso struct {
	Backend *struct {
		// FileId Unique identifier for the ISO file.
		FileId *string `json:"file_id,omitempty"`

		// FileName Name of the ISO file.
		FileName *string `json:"file_name,omitempty"`

		// Provider The provider responsible for storing the ISO.
		Provider *VirtualProviderIsoBackendProvider `json:"provider,omitempty"`

		// Size Size of the ISO file in bytes.
		Size *int64 `json:"size,omitempty"`
	} `json:"backend"`
	Config struct {
		Ipxe *struct {
			// DnsIp DNS IP assigned to the IPXE boot.
			DnsIp *string `json:"dns_ip"`

			// GatewayIp Gateway IP assigned to the IPXE boot.
			GatewayIp *string `json:"gateway_ip"`

			// Netmask Netmask assigned to the IPXE boot.
			Netmask *string `json:"netmask"`

			// NetworkInterface Network interface for the IPXE boot.
			NetworkInterface *int `json:"network_interface"`

			// StaticIp Static IP assigned to the IPXE boot.
			StaticIp *string `json:"static_ip"`

			// VlanId VLAN ID for the IPXE boot.
			VlanId *int `json:"vlan_id"`
		} `json:"ipxe"`
		Server *struct {
			// AdditionalKernelArgs Appends additional kernel arguments when booting CycleOS.
			AdditionalKernelArgs *string `json:"additional_kernel_args"`

			// Bonds An array of bonds
			Bonds *[]VirtualProviderIsoBond `json:"bonds,omitempty"`

			// Nics An array of server network interfaces.
			Nics                  []VirtualProviderIsoNic                              `json:"nics"`
			SdnNeighborPreference *VirtualProviderIsoConfigServerSdnNeighborPreference `json:"sdn_neighbor_preference"`
			Storage               *struct {
				ConditionalFormat *bool `json:"conditional_format,omitempty"`
			} `json:"storage"`
		} `json:"server"`

		// Token Authentication token for the ISO.
		Token string `json:"token"`
	} `json:"config"`

	// Creator The creator scope is embedded in resource objects to describe who created them
	Creator CreatorScope `json:"creator"`

	// Events A collection of timestamps for each event in the ISO's lifetime.
	Events struct {
		Created DateTime `json:"created"`
		Deleted DateTime `json:"deleted"`
		Updated DateTime `json:"updated"`
	} `json:"events"`

	// HubId A 24 character hex string used to identify a unique resource.
	HubId ID `json:"hub_id"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`

	// IntegrationId A 24 character hex string used to identify a unique resource.
	IntegrationId ID `json:"integration_id"`

	// Name The name of the ISO.
	Name  string `json:"name"`
	State struct {
		Changed DateTime `json:"changed"`

		// Current The current state of the environment.
		Current VirtualProviderIsoStateCurrent `json:"current"`

		// Error An error, if any, that has occurred for this resource.
		Error *struct {
			// Message Details about the error that has occurred.
			Message *string   `json:"message,omitempty"`
			Time    *DateTime `json:"time,omitempty"`
		} `json:"error,omitempty"`
	} `json:"state"`
}

VirtualProviderIso The ISO image for a virtual provider.

type VirtualProviderIsoBackendProvider added in v0.6.3

type VirtualProviderIsoBackendProvider string

VirtualProviderIsoBackendProvider The provider responsible for storing the ISO.

Defines values for VirtualProviderIsoBackendProvider.

type VirtualProviderIsoBond added in v0.6.3

type VirtualProviderIsoBond struct {
	InterfaceName string `json:"interface_name"`
	Interfaces    *[]struct {
		// InterfaceName The name of the interface on the server.
		InterfaceName *string `json:"interface_name"`

		// MacAddress The mac address of the server.
		MacAddress *string `json:"mac_address"`
	} `json:"interfaces,omitempty"`

	// Mode balance-rr - Rotate packets evenly across all links.
	// active-backup - One link active, failover to backup if needed.
	// balance-xor - Distributes based on a hash (MAC/IP/port).
	// lacp - Standard link aggregations using LACP.
	// balance-tlb - Adaptive transmit-side balancing (no switch config needed)..
	// balance-alb - TLB + receive load balancing (no switch config needed)..
	Mode VirtualProviderIsoBondMode `json:"mode"`
}

VirtualProviderIsoBond Server ISO bond.

type VirtualProviderIsoBondMode added in v0.6.3

type VirtualProviderIsoBondMode string

VirtualProviderIsoBondMode balance-rr - Rotate packets evenly across all links. active-backup - One link active, failover to backup if needed. balance-xor - Distributes based on a hash (MAC/IP/port). lacp - Standard link aggregations using LACP. balance-tlb - Adaptive transmit-side balancing (no switch config needed).. balance-alb - TLB + receive load balancing (no switch config needed)..

const (
	ActiveBackup VirtualProviderIsoBondMode = "active-backup"
	BalanceAlb   VirtualProviderIsoBondMode = "balance-alb"
	BalanceRr    VirtualProviderIsoBondMode = "balance-rr"
	BalanceTlb   VirtualProviderIsoBondMode = "balance-tlb"
	BalanceXor   VirtualProviderIsoBondMode = "balance-xor"
	Lacp         VirtualProviderIsoBondMode = "lacp"
)

Defines values for VirtualProviderIsoBondMode.

type VirtualProviderIsoConfigServerSdnNeighborPreference added in v0.6.3

type VirtualProviderIsoConfigServerSdnNeighborPreference string

VirtualProviderIsoConfigServerSdnNeighborPreference defines model for VirtualProviderIso.Config.Server.SdnNeighborPreference.

const (
	VirtualProviderIsoConfigServerSdnNeighborPreferenceIpv4 VirtualProviderIsoConfigServerSdnNeighborPreference = "ipv4"
	VirtualProviderIsoConfigServerSdnNeighborPreferenceIpv6 VirtualProviderIsoConfigServerSdnNeighborPreference = "ipv6"
)

Defines values for VirtualProviderIsoConfigServerSdnNeighborPreference.

type VirtualProviderIsoIncludes added in v0.6.3

type VirtualProviderIsoIncludes struct {
	Integrations *map[string]Integration `json:"integrations,omitempty"`
}

VirtualProviderIsoIncludes A resource that is associated with an ISO.

type VirtualProviderIsoNic added in v0.6.3

type VirtualProviderIsoNic struct {
	// Dhcp The DHCP configuration for the network interface.
	Dhcp *struct {
		Mode VirtualProviderIsoNicDhcpMode `json:"mode"`
	} `json:"dhcp"`

	// L2 Configuration options for extending the L2 network into containers directly via a bridge.
	L2 *struct {
		// Domain A standardized name for different layer-2 networks that can be configured on virtual provider hosts.
		//  Containers will utilize this name to determine which network to attach to on the host, if set in the config.
		Domain L2Domain `json:"domain"`
	} `json:"l2"`

	// Match The criteria used to match the server to the interface.
	Match struct {
		// InterfaceName The name of the interface on the server.
		InterfaceName *string `json:"interface_name"`

		// MacAddress The mac address of the server.
		MacAddress *string `json:"mac_address"`
	} `json:"match"`

	// Static The static configuration for the network interface.
	Static *struct {
		// Ipv4 The static subconfiguration for ipv4 or ipv6.
		Ipv4 *VirtualProviderIsoNicStaticFlavor `json:"ipv4,omitempty"`

		// Ipv6 The static subconfiguration for ipv4 or ipv6.
		Ipv6 *VirtualProviderIsoNicStaticFlavor `json:"ipv6,omitempty"`
	} `json:"static"`

	// VlanId VLAN ID for the serer.
	VlanId *int `json:"vlan_id"`
}

VirtualProviderIsoNic Server ISO network interface.

type VirtualProviderIsoNicDhcpMode added in v0.6.3

type VirtualProviderIsoNicDhcpMode string

VirtualProviderIsoNicDhcpMode defines model for VirtualProviderIsoNic.Dhcp.Mode.

const (
	VirtualProviderIsoNicDhcpModeAll  VirtualProviderIsoNicDhcpMode = "all"
	VirtualProviderIsoNicDhcpModeIpv4 VirtualProviderIsoNicDhcpMode = "ipv4"
	VirtualProviderIsoNicDhcpModeIpv6 VirtualProviderIsoNicDhcpMode = "ipv6"
	VirtualProviderIsoNicDhcpModeNone VirtualProviderIsoNicDhcpMode = "none"
)

Defines values for VirtualProviderIsoNicDhcpMode.

type VirtualProviderIsoNicStaticFlavor added in v0.6.4

type VirtualProviderIsoNicStaticFlavor struct {
	// GatewayIp An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.
	GatewayIp *IpAddress `json:"gateway_ip,omitempty"`

	// Ip An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.
	Ip *IpAddress `json:"ip,omitempty"`

	// Network A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix.
	// It combines an IP address with a suffix that indicates how many bits are fixed for routing.
	Network Cidr `json:"network"`
}

VirtualProviderIsoNicStaticFlavor The static subconfiguration for ipv4 or ipv6.

type VirtualProviderIsoStateCurrent added in v0.6.3

type VirtualProviderIsoStateCurrent string

VirtualProviderIsoStateCurrent The current state of the environment.

const (
	VirtualProviderIsoStateCurrentBuilding VirtualProviderIsoStateCurrent = "building"
	VirtualProviderIsoStateCurrentDeleted  VirtualProviderIsoStateCurrent = "deleted"
	VirtualProviderIsoStateCurrentDeleting VirtualProviderIsoStateCurrent = "deleting"
	VirtualProviderIsoStateCurrentLive     VirtualProviderIsoStateCurrent = "live"
	VirtualProviderIsoStateCurrentNew      VirtualProviderIsoStateCurrent = "new"
)

Defines values for VirtualProviderIsoStateCurrent.

type VirtualProviderIsoTask added in v0.6.3

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

VirtualProviderIsoTask defines model for VirtualProviderIsoTask.

func (VirtualProviderIsoTask) AsVirtualProviderGenerateIsoAction added in v0.6.3

func (t VirtualProviderIsoTask) AsVirtualProviderGenerateIsoAction() (VirtualProviderGenerateIsoAction, error)

AsVirtualProviderGenerateIsoAction returns the union data inside the VirtualProviderIsoTask as a VirtualProviderGenerateIsoAction

func (VirtualProviderIsoTask) Discriminator added in v0.6.3

func (t VirtualProviderIsoTask) Discriminator() (string, error)

func (*VirtualProviderIsoTask) FromVirtualProviderGenerateIsoAction added in v0.6.3

func (t *VirtualProviderIsoTask) FromVirtualProviderGenerateIsoAction(v VirtualProviderGenerateIsoAction) error

FromVirtualProviderGenerateIsoAction overwrites any union data inside the VirtualProviderIsoTask as the provided VirtualProviderGenerateIsoAction

func (VirtualProviderIsoTask) MarshalJSON added in v0.6.3

func (t VirtualProviderIsoTask) MarshalJSON() ([]byte, error)

func (*VirtualProviderIsoTask) MergeVirtualProviderGenerateIsoAction added in v0.6.3

func (t *VirtualProviderIsoTask) MergeVirtualProviderGenerateIsoAction(v VirtualProviderGenerateIsoAction) error

MergeVirtualProviderGenerateIsoAction performs a merge with any union data inside the VirtualProviderIsoTask, using the provided VirtualProviderGenerateIsoAction

func (*VirtualProviderIsoTask) UnmarshalJSON added in v0.6.3

func (t *VirtualProviderIsoTask) UnmarshalJSON(b []byte) error

func (VirtualProviderIsoTask) ValueByDiscriminator added in v0.6.3

func (t VirtualProviderIsoTask) ValueByDiscriminator() (interface{}, error)

type VolumeSummary

type VolumeSummary struct {
	// Config Configuration settings for container volumes.
	Config ContainerVolume `json:"config"`

	// External The ID of external volume, if applicable.
	External *struct {
		// Id A 24 character hex string used to identify a unique resource.
		Id *ID `json:"id,omitempty"`
	} `json:"external"`

	// Hash A unique hash for the given volume.
	Hash string `json:"hash"`

	// Id A 24 character hex string used to identify a unique resource.
	Id ID `json:"id"`
}

VolumeSummary A summary of relevant volume information.

type VpnEnvironmentService

type VpnEnvironmentService struct {
	// AutoUpdate A boolean representing if this service container is set to autoupdate or not
	AutoUpdate *bool `json:"auto_update,omitempty"`

	// Config The config object for the VPN service.
	Config *struct {
		// AllowInternet If true, routes all traffic through the VPN, even non-Cycle traffic.
		AllowInternet bool `json:"allow_internet"`

		// Auth Auth configuration for the VPN.
		Auth struct {
			// CycleAccounts If true, allows any Cycle account with access to the environment to log in to the VPN using their Cycle email and password.
			CycleAccounts bool `json:"cycle_accounts"`

			// VpnAccounts If true, allows the custom VPN accounts to log in to the VPN.
			VpnAccounts *bool `json:"vpn_accounts,omitempty"`

			// Webhook A webhook endpoint to hit. Will be passed the login credentials provided to the user, and should return a 200 status if the login is permitted.
			Webhook *string `json:"webhook"`
		} `json:"auth"`

		// CustomDirectives Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
		CustomDirectives *string `json:"custom_directives"`
	} `json:"config"`

	// ContainerId The ID of the VPN service container
	ContainerId string `json:"container_id"`

	// Enable Whether or not the VPN service is enabled.
	Enable bool `json:"enable"`
}

VpnEnvironmentService Information about the environments vpn service(s).

type VpnReconfigureAction added in v0.6.1

type VpnReconfigureAction struct {
	// Action The action to take.
	Action VpnReconfigureActionAction `json:"action"`

	// Contents Additional information the platform needs to create this job.
	Contents struct {
		// AutoUpdate A boolean representing if this service container is set to autoupdate or not
		AutoUpdate *bool `json:"auto_update"`

		// Config The config object for the VPN service, in this case without the required fields normally found in a VPN config object.
		Config *struct {
			// AllowInternet If true, routes all traffic through the VPN, even non-Cycle traffic.
			AllowInternet *bool `json:"allow_internet,omitempty"`

			// Auth Auth configuration for the VPN.
			Auth *struct {
				// CycleAccounts If true, allows any Cycle account with access to the environment to log in to the VPN using their Cycle email and password.
				CycleAccounts bool `json:"cycle_accounts"`

				// VpnAccounts If true, allows the custom VPN accounts to log in to the VPN.
				VpnAccounts *bool `json:"vpn_accounts,omitempty"`

				// Webhook A webhook endpoint to hit. Will be passed the login credentials provided to the user, and should return a 200 status if the login is permitted.
				Webhook *string `json:"webhook"`
			} `json:"auth,omitempty"`

			// CustomDirectives Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
			CustomDirectives *string `json:"custom_directives"`
		} `json:"config"`

		// Enable A boolean where true means the VPN service is enabled.
		Enable *bool `json:"enable,omitempty"`

		// HighAvailability A boolean where `true` represents the desire to run the environment vpn service in high availability mode.
		HighAvailability *bool `json:"high_availability"`
	} `json:"contents"`
}

VpnReconfigureAction defines model for VpnReconfigureAction.

type VpnReconfigureActionAction added in v0.6.1

type VpnReconfigureActionAction string

VpnReconfigureActionAction The action to take.

const (
	VpnReconfigureActionActionReconfigure VpnReconfigureActionAction = "reconfigure"
)

Defines values for VpnReconfigureActionAction.

type VpnResetAction added in v0.6.1

type VpnResetAction struct {
	// Action The name of the action to perform.
	Action VpnResetActionAction `json:"action"`
}

VpnResetAction This will reset the VPN certificates and restart the container. Should be done when the certificates expire, every 1000 days. Then, you will need to redownload the VPN config in order to connect.

type VpnResetActionAction added in v0.6.1

type VpnResetActionAction string

VpnResetActionAction The name of the action to perform.

const (
	Reset VpnResetActionAction = "reset"
)

Defines values for VpnResetActionAction.

type VpnTask added in v0.6.1

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

VpnTask defines model for VpnTask.

func (VpnTask) AsVpnReconfigureAction added in v0.6.1

func (t VpnTask) AsVpnReconfigureAction() (VpnReconfigureAction, error)

AsVpnReconfigureAction returns the union data inside the VpnTask as a VpnReconfigureAction

func (VpnTask) AsVpnResetAction added in v0.6.1

func (t VpnTask) AsVpnResetAction() (VpnResetAction, error)

AsVpnResetAction returns the union data inside the VpnTask as a VpnResetAction

func (VpnTask) Discriminator added in v0.6.1

func (t VpnTask) Discriminator() (string, error)

func (*VpnTask) FromVpnReconfigureAction added in v0.6.1

func (t *VpnTask) FromVpnReconfigureAction(v VpnReconfigureAction) error

FromVpnReconfigureAction overwrites any union data inside the VpnTask as the provided VpnReconfigureAction

func (*VpnTask) FromVpnResetAction added in v0.6.1

func (t *VpnTask) FromVpnResetAction(v VpnResetAction) error

FromVpnResetAction overwrites any union data inside the VpnTask as the provided VpnResetAction

func (VpnTask) MarshalJSON added in v0.6.1

func (t VpnTask) MarshalJSON() ([]byte, error)

func (*VpnTask) MergeVpnReconfigureAction added in v0.6.1

func (t *VpnTask) MergeVpnReconfigureAction(v VpnReconfigureAction) error

MergeVpnReconfigureAction performs a merge with any union data inside the VpnTask, using the provided VpnReconfigureAction

func (*VpnTask) MergeVpnResetAction added in v0.6.1

func (t *VpnTask) MergeVpnResetAction(v VpnResetAction) error

MergeVpnResetAction performs a merge with any union data inside the VpnTask, using the provided VpnResetAction

func (*VpnTask) UnmarshalJSON added in v0.6.1

func (t *VpnTask) UnmarshalJSON(b []byte) error

func (VpnTask) ValueByDiscriminator added in v0.6.1

func (t VpnTask) ValueByDiscriminator() (interface{}, error)

type WafConfig

type WafConfig struct {
	Rules []struct {
		// Conditions An array of the specific conditions for the rule.
		Conditions []struct {
			// Operator A string that indicates the range of values relative to the value property.
			Operator WafConfigRulesConditionsOperator `json:"operator"`

			// Type A string that describes the match type for the condition.
			Type WafConfigRulesConditionsType `json:"type"`

			// Value The value corresponding to the condition type.
			Value string `json:"value"`
		} `json:"conditions"`

		// Description Some information about the rule.
		Description string    `json:"description"`
		Expires     *DateTime `json:"expires,omitempty"`

		// Match A string that describes if both attributes need to be true (match all) or if only one of the conditions needs to be true (match any).
		Match WafConfigRulesMatch `json:"match"`

		// Skip A boolean that indicates if the rule should be active or skipped.
		Skip bool `json:"skip"`

		// Type A string that describes if the role should allow or deny traffic based on the conditions.
		Type WafConfigRulesType `json:"type"`
	} `json:"rules"`
}

WafConfig Additional configuration options for the web application firewall.

type WafConfigRulesConditionsOperator

type WafConfigRulesConditionsOperator string

WafConfigRulesConditionsOperator A string that indicates the range of values relative to the value property.

const (
	WafConfigRulesConditionsOperatorEmpty            WafConfigRulesConditionsOperator = "!="
	WafConfigRulesConditionsOperatorEqualEqual       WafConfigRulesConditionsOperator = "=="
	WafConfigRulesConditionsOperatorGreaterThan      WafConfigRulesConditionsOperator = ">"
	WafConfigRulesConditionsOperatorGreaterThanEqual WafConfigRulesConditionsOperator = ">="
	WafConfigRulesConditionsOperatorLessThan         WafConfigRulesConditionsOperator = "<"
	WafConfigRulesConditionsOperatorLessThanEqual    WafConfigRulesConditionsOperator = "<="
)

Defines values for WafConfigRulesConditionsOperator.

type WafConfigRulesConditionsType

type WafConfigRulesConditionsType string

WafConfigRulesConditionsType A string that describes the match type for the condition.

const (
	GeoMatch    WafConfigRulesConditionsType = "geo-match"
	HeaderMatch WafConfigRulesConditionsType = "header-match"
	IpMatch     WafConfigRulesConditionsType = "ip-match"
	MethodMatch WafConfigRulesConditionsType = "method-match"
	UrlMatch    WafConfigRulesConditionsType = "url-match"
)

Defines values for WafConfigRulesConditionsType.

type WafConfigRulesMatch

type WafConfigRulesMatch string

WafConfigRulesMatch A string that describes if both attributes need to be true (match all) or if only one of the conditions needs to be true (match any).

const (
	WafConfigRulesMatchAll   WafConfigRulesMatch = "all"
	WafConfigRulesMatchAny   WafConfigRulesMatch = "any"
	WafConfigRulesMatchEmpty WafConfigRulesMatch = ""
)

Defines values for WafConfigRulesMatch.

type WafConfigRulesType

type WafConfigRulesType string

WafConfigRulesType A string that describes if the role should allow or deny traffic based on the conditions.

const (
	Allow WafConfigRulesType = "allow"
	Deny  WafConfigRulesType = "deny"
)

Defines values for WafConfigRulesType.

type WebhookGetStep

type WebhookGetStep struct {
	// Action The action that the step takes.
	Action  WebhookGetStepAction `json:"action"`
	Details struct {
		// Headers An optional map of headers to send with the request.
		Headers *map[string]string  `json:"headers"`
		Options *WebhookStepOptions `json:"options"`

		// Url The url to submit a POST request to.
		Url string `json:"url"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

WebhookGetStep A pipeline step that will make a GET request to the specified endpoint.

type WebhookGetStepAction

type WebhookGetStepAction string

WebhookGetStepAction The action that the step takes.

const (
	WebhookGet WebhookGetStepAction = "webhook.get"
)

Defines values for WebhookGetStepAction.

type WebhookPostStep

type WebhookPostStep struct {
	// Action The action that the step takes.
	Action  WebhookPostStepAction `json:"action"`
	Details struct {
		// Body An optional POST body to send with the request. Cannot be used with `from“.
		Body *string `json:"body"`

		// From Takes the output from a previous step and uses it as the body for the POST request. Cannot be used with `body`. String format is <stageIdentifier/stepIdentifier>
		From *string `json:"from"`

		// Headers An optional map of headers to send with the request.
		Headers *map[string]string  `json:"headers"`
		Options *WebhookStepOptions `json:"options"`

		// Url The url to submit a POST request to.
		Url string `json:"url"`
	} `json:"details"`

	// Identifier An identifier for the step.
	Identifier *string `json:"identifier,omitempty"`
	Options    *struct {
		Skip *bool `json:"skip,omitempty"`
	} `json:"options,omitempty"`
}

WebhookPostStep A pipeline step that will make a POST request to the specified endpoints. The webhook will post the full body of the resource referenced by the step. For example if you were to reference a step creating a container, you would receive that container object in the post body. You may also specify a custom body instead.

type WebhookPostStepAction

type WebhookPostStepAction string

WebhookPostStepAction The action that the step takes.

const (
	WebhookPost WebhookPostStepAction = "webhook.post"
)

Defines values for WebhookPostStepAction.

type WebhookStepOptions

type WebhookStepOptions struct {
	FailOn *struct {
		// HttpCodes A list of http response codes that will trigger a failure.
		HttpCodes *[]int `json:"http_codes"`

		// Not If true, will fail on any codes NOT defined in the http_codes array.
		Not bool `json:"not"`
	} `json:"fail_on"`

	// Interval How long to wait between retries on wait.
	Interval    *Duration `json:"interval"`
	MaxAttempts *int      `json:"max_attempts"`
	RetryOn     *struct {
		// HttpCodes A list of http response codes that will trigger a retry.
		HttpCodes *[]int `json:"http_codes"`

		// Not If true, will retry on any codes NOT defined in the http_codes array.
		Not bool `json:"not"`
	} `json:"retry_on"`
}

WebhookStepOptions Options for configuring webhook pipeline steps.

type WebhookURL

type WebhookURL = string

WebhookURL A URL describing the destination Cycle should send a POST webhook payload to.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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