Go API client for citrixquickcreate

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: DaaSTechPreview
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import citrixquickcreate "github.com/citrix/citrix-daas-rest-go/citrixquickcreate"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), citrixquickcreate.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), citrixquickcreate.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), citrixquickcreate.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), citrixquickcreate.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.cloud.com/quickcreateservice

Class	Method	HTTP request	Description
AccountQCS	AddAccountAsync	Post /{customerId}/accounts	Add a account
AccountQCS	DeleteCustomerAccountAsync	Delete /{customerId}/accounts/{accountId}	Deletes the account configured for the specified customer
AccountQCS	GetAccountResourcesAsync	Post /{customerId}/accounts/{accountId}/resources/$search	Get the account resources for the specified customer
AccountQCS	GetCustomerAccountAsync	Get /{customerId}/accounts/{accountId}	Get the account configured for the specified customer
AccountQCS	GetCustomerAccountResourcesAsync	Post /{customerId}/accounts/resources/$search	Get the account resources for the specified customer
AccountQCS	GetCustomerAccountTaskAsync	Get /{customerId}/accounts/{accountId}/tasks/{taskId}	Gets account task
AccountQCS	GetCustomerAccountsAsync	Get /{customerId}/accounts	Get the accounts configured for the specified customer
AccountQCS	InititateAccountTaskAsync	Post /{customerId}/accounts/{accountId}/tasks	Registers account BYOL account
AccountQCS	UpdateCustomerAccountAsync	Patch /{customerId}/accounts/{accountId}	Updates the account access keys for the specified customer
ConnectionQCS	AddResourceConnectionAsync	Post /{customerId}/accounts/{accountId}/connections/$initiate	Adds resource connection asyncronously
ConnectionQCS	GetAllResourceConnectionsAsync	Get /{customerId}/connections	Gets all resource connections without specifying account
ConnectionQCS	GetResourceConnectionAsync	Get /{customerId}/accounts/{accountId}/connections/{connectionId}	Gets resource connection
ConnectionQCS	GetResourceConnectionsAsync	Get /{customerId}/accounts/{accountId}/connections	Gets resource connections
ConnectionQCS	ModifyResourceConnectionAsync	Patch /{customerId}/accounts/{accountId}/connections/{connectionId}	Modifies connection
ConnectionQCS	RemoveResourceConnectionAsync	Delete /{customerId}/accounts/{accountId}/connections/{connectionId}	Removes connection
DeploymentQCS	AddMachineAsync	Post /{customerId}/deployments/{deploymentId}/$addMachines	Adds machine to deployment
DeploymentQCS	DeleteDeploymentAsync	Delete /{customerId}/deployments/{deploymentId}	Delete deployment
DeploymentQCS	GetDeploymentAsync	Get /{customerId}/deployments/{deploymentId}	Gets deployment with vdas
DeploymentQCS	GetDeploymentsAsync	Get /{customerId}/deployments	Gets deployments
DeploymentQCS	InitiateDeleteDeploymentAsync	Post /{customerId}/deployments/{deploymentId}/$initiateDelete	Initiate delete deployment
DeploymentQCS	InitiateDeploymentAsync	Post /{customerId}/deployments/$initiate	Initiates deployment
DeploymentQCS	InitiateRemoveMachineAsync	Post /{customerId}/deployments/{deploymentId}/machines/{machineId}/$initiateDelete	Initiate removal of machine from deployment
DeploymentQCS	PatchMachinesAsync	Patch /{customerId}/deployments/{deploymentId}/machines	Turn on or off the deployment mode for deployment machines
DeploymentQCS	RemoveMachineAsync	Delete /{customerId}/deployments/{deploymentId}/machines/{machineId}	Removes machine to deployment
DeploymentQCS	RemoveMachinesAsync	Post /{customerId}/deployments/{deploymentId}/machines/$delete	Removes machines from deployment
DeploymentQCS	RestartMachineAsync	Post /{customerId}/deployments/{deploymentId}/machines/{machineId}/$restart	Restart a machine
DeploymentQCS	SaveAsImageAsync	Post /{customerId}/deployments/{deploymentId}/machines/{machineId}/$saveAsImage	Save image to account
DeploymentQCS	UpdateDeploymentImageAsync	Post /{customerId}/deployments/{deploymentId}/image/$update	Update image for a deployment
DeploymentQCS	UpdateDeploymentPropertiesAsync	Post /{customerId}/deployments/{deploymentId}/$update	Updates deployment properties
DeploymentQCS	UpdateMachineAsync	Post /{customerId}/deployments/{deploymentId}/machines/{machineId}/$update	Updates machine in deployment
ImageQCS	CopyImageAsync	Post /{customerId}/accounts/{accountId}/images/{imageId}/$copy	Makes a copy of a workspace image
ImageQCS	GetImageAsync	Get /{customerId}/accounts/{accountId}/images/{imageId}	Gets image from workspace
ImageQCS	GetImagesAsync	Get /{customerId}/accounts/{accountId}/images	Gets images from workspace
ImageQCS	ImportImageAsync	Post /{customerId}/accounts/{accountId}/images/$import	Imports image to workspace
ImageQCS	RemoveImageAsync	Delete /{customerId}/accounts/{accountId}/images/{imageId}	Removes image to workspace
TasksQCS	GetTaskAsync	Get /{customerId}/tasks/{taskId}	Get the status of a task

Documentation For Models

• Account
• AccountResource
• AccountResources
• AccountResourcesItemsInner
• AccountState
• AccountTask
• AccountTaskOperationType
• AccountType
• AccountWarning
• Accounts
• ActiveConnection
• ActiveTenantUserLicenses
• AddAccount
• AddAwsEdcAccount
• AddAwsEdcDeploymentMachines
• AddAwsEdcDirectoryConnection
• AddAwsEdcWorkspace
• AddDeploymentMachines
• AddResourceConnection
• AllocationType
• AssociatedDeployment
• AssociatedImage
• AssociatedResourceConnection
• AwsAccountResourceType
• AwsEdcAccount
• AwsEdcAccountAuthType
• AwsEdcAccountByolRegistrationTask
• AwsEdcAccountResource
• AwsEdcAccountResourceAmiImage
• AwsEdcAccountResourceByolRegistration
• AwsEdcAccountResourceCidrRange
• AwsEdcAccountResourceDirectory
• AwsEdcAccountResourceEc2InstanceType
• AwsEdcAccountResourceFile
• AwsEdcAccountResourceKeyPair
• AwsEdcAccountResourceRegion
• AwsEdcAccountResourceSecurityGroup
• AwsEdcAccountResourceSubnet
• AwsEdcAccountResourceVpc
• AwsEdcAmiImageArchitecture
• AwsEdcAmiImageBootMode
• AwsEdcAmiImagePlatform
• AwsEdcAmiImageStatus
• AwsEdcAmiImageType
• AwsEdcAmiImageVirtualization
• AwsEdcAmiImportApplications
• AwsEdcDedicatedTenancyState
• AwsEdcDeployment
• AwsEdcDeploymentMachine
• AwsEdcDirectoryConnection
• AwsEdcDirectoryRegistrationStatus
• AwsEdcDirectorySize
• AwsEdcDirectoryStatus
• AwsEdcDirectoryTenancy
• AwsEdcDirectoryType
• AwsEdcImage
• AwsEdcMissingRolePermissions
• AwsEdcMissingRolePermissionsCondition
• AwsEdcRegisterAccount
• AwsEdcSubnetStatus
• AwsEdcVpcState
• AwsEdcVpcTenancy
• AwsEdcWorkspaceCompute
• AwsEdcWorkspaceImageIngestionProcess
• AwsEdcWorkspaceImageState
• AwsEdcWorkspaceImageTenancy
• AwsEdcWorkspaceRunningMode
• AwsEdcWorkspaceState
• AwsWorkspaceRegion
• CommissionTask
• CommissionTaskOperationType
• Compute
• ConditionalExpression
• Connection
• ConnectionState
• ConsentMetadata
• CoreUser
• DeleteMachines
• DeleteMachinesCredentials
• Deployment
• DeploymentCredentials
• DeploymentIdInitiateDeleteBody
• DeploymentIdMachinesBody
• DeploymentMachine
• DeploymentMachines
• DeploymentScaleSettings
• DeploymentState
• DeploymentTask
• DeploymentTaskOperationType
• DeploymentUsers
• DeploymentWarning
• DeploymentWarningType
• Deployments
• ErasureSwitch
• ErrorResponse
• ErrorResponseParameters
• Expression
• GetTaskAsync200Response
• Group
• GroupLicenseErrorDetailsResponse
• GroupLicenseOperationStatus
• GroupLicenseOperationType
• GroupUserErrorResponse
• GroupUsers
• Image
• ImageUpdateBody
• Images
• ImportAwsEdcImage
• ImportImage
• InitiateAccountTask
• InitiateAwsEdcDeployment
• InitiateDeployment
• IpPermission
• IpRange
• Ipv6Range
• LicenseErrorDetailsResponse
• LicenseState
• LicenseUser
• MachineIdInitiateDeleteBody
• MachineIdSaveAsImageBody
• MachinesDeleteBody
• NamingSchemeType
• OperatingSystemType
• PatchMachines
• PowerMode
• PowerResponseCode
• PowerStartResponse
• PowerState
• PrefixListId
• ProvisioningType
• RegisterAccount
• RegisterAwsEdcAccountTask
• RegistrationState
• ResourceConnection
• ResourceConnectionTask
• ResourceConnectionTaskOperationType
• ResourceConnectionWarning
• ResourceConnectionWarningType
• ResourceConnections
• ResponseDetails
• ResponseDetailsGroupLicenseAssignment
• ResponseDetailsLicenseAssignment
• ResponseDetailsLicenseAssignmentEx
• SaveAsImageRequest
• ScaleSettings
• SearchAccountResourceRequest
• SearchAwsEdcAccountResourceRequest
• SessionChangeHostingAction
• SessionState
• SessionSupport
• Tag
• TaskBase
• TaskError
• TaskState
• TaskType
• TaskWarning
• TenancyType
• TenantGroupLicenses
• TenantLicenses
• UpdateAccount
• UpdateAccountName
• UpdateAccountOperationType
• UpdateAwsEdcAccountCredentials
• UpdateAwsEdcDeploymentMachine
• UpdateAwsEdcDeploymentProperties
• UpdateAwsEdcDirectoryConnection
• UpdateCustomerAccountAsyncRequest
• UpdateDeploymentImage
• UpdateDeploymentMachine
• UpdateDeploymentProperties
• UpdatePowerConfigurationModel
• UpdateResourceConnection
• UserIdGroupPair

Documentation For Authorization

Authentication schemes defined for the API:

CWSAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author