# Packages

No description provided by the author

# README

Go API client for fleet

REST API for Omnistrate Fleet

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: 2022-09-01-00
  • Package version: 1.0.0
  • Generator version: 7.10.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 fleet "github.com/omnistrate-oss/omnistrate-sdk-go/fleet"

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 fleet.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), fleet.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 fleet.ContextOperationServerIndices and fleet.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://api.omnistrate.cloud

ClassMethodHTTP requestDescription
AuditEventsApiAPIAuditEventsApiAuditEventsGet /2022-09-01-00/fleet/audit-eventsAuditEvents audit-events-api
CustomerOnboardingsApiAPICustomerOnboardingsApiCreateCustomerOnboardingPost /2022-09-01-00/fleet/customer-onboardingCreateCustomerOnboarding customer-onboardings-api
CustomerOnboardingsApiAPICustomerOnboardingsApiDeleteCustomerOnboardingDelete /2022-09-01-00/fleet/customer-onboarding/{id}DeleteCustomerOnboarding customer-onboardings-api
CustomerOnboardingsApiAPICustomerOnboardingsApiDescribeCustomerOnboardingGet /2022-09-01-00/fleet/customer-onboarding/{id}DescribeCustomerOnboarding customer-onboardings-api
CustomerOnboardingsApiAPICustomerOnboardingsApiListCustomerOnboardingStagesGet /2022-09-01-00/fleet/customer-onboarding-stagesListCustomerOnboardingStages customer-onboardings-api
CustomerOnboardingsApiAPICustomerOnboardingsApiListCustomerOnboardingsGet /2022-09-01-00/fleet/customer-onboardingListCustomerOnboardings customer-onboardings-api
CustomerOnboardingsApiAPICustomerOnboardingsApiUpdateCustomerOnboardingPatch /2022-09-01-00/fleet/customer-onboarding/{id}UpdateCustomerOnboarding customer-onboardings-api
EventsApiAPIEventsApiAcknowledgeEventDelete /2022-09-01-00/fleet/events/{id}AcknowledgeEvent events-api
EventsApiAPIEventsApiListEventsGet /2022-09-01-00/fleet/eventsListEvents events-api
FleetCustomNetworkApiAPIFleetCustomNetworkApiCreateCustomNetworkPost /2022-09-01-00/fleet/custom-networkCreateCustomNetwork fleet-custom-network-api
FleetCustomNetworkApiAPIFleetCustomNetworkApiDeleteCustomNetworkDelete /2022-09-01-00/fleet/custom-network/{id}DeleteCustomNetwork fleet-custom-network-api
FleetCustomNetworkApiAPIFleetCustomNetworkApiDescribeCustomNetworkGet /2022-09-01-00/fleet/custom-network/{id}DescribeCustomNetwork fleet-custom-network-api
FleetCustomNetworkApiAPIFleetCustomNetworkApiListCustomNetworksGet /2022-09-01-00/fleet/custom-networkListCustomNetworks fleet-custom-network-api
FleetCustomNetworkApiAPIFleetCustomNetworkApiUpdateCustomNetworkPatch /2022-09-01-00/fleet/custom-network/{id}UpdateCustomNetwork fleet-custom-network-api
FleetFeaturesApiAPIFleetFeaturesApiDescribeFleetFeatureGet /2022-09-01-00/fleet/feature/{feature}DescribeFleetFeature fleet-features-api
FleetFeaturesApiAPIFleetFeaturesApiDisableFleetFeatureDelete /2022-09-01-00/fleet/featureDisableFleetFeature fleet-features-api
FleetFeaturesApiAPIFleetFeaturesApiEnableFleetFeaturePut /2022-09-01-00/fleet/featureEnableFleetFeature fleet-features-api
FleetFeaturesApiAPIFleetFeaturesApiListFleetFeaturesGet /2022-09-01-00/fleet/featuresListFleetFeatures fleet-features-api
FleetWorkflowsApiAPIFleetWorkflowsApiDescribeServiceWorkflowGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/service-workflows/{id}DescribeServiceWorkflow fleet-workflows-api
FleetWorkflowsApiAPIFleetWorkflowsApiDescribeServiceWorkflowSummaryGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/service-workflows-summaryDescribeServiceWorkflowSummary fleet-workflows-api
FleetWorkflowsApiAPIFleetWorkflowsApiGetWorkflowEventsGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/service-workflows/{id}/eventsGetWorkflowEvents fleet-workflows-api
FleetWorkflowsApiAPIFleetWorkflowsApiListServiceWorkflowsGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/service-workflowsListServiceWorkflows fleet-workflows-api
FleetWorkflowsApiAPIFleetWorkflowsApiTerminateServiceWorkflowDelete /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/service-workflows/{id}TerminateServiceWorkflow fleet-workflows-api
FleetWorkflowsApiAPIFleetWorkflowsApiUpdateServiceWorkflowPatch /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/service-workflows/{id}UpdateServiceWorkflow fleet-workflows-api
HelmPackageApiAPIHelmPackageApiListHelmPackageInstallationsGet /2022-09-01-00/fleet/helm-package-installationsListHelmPackageInstallations helm-package-api
HostclusterApiAPIHostclusterApiListHostClustersGet /2022-09-01-00/fleet/host-clustersListHostClusters hostcluster-api
InventoryApiAPIInventoryApiAddCapacityToResourceInstancePost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/add-capacityAddCapacityToResourceInstance inventory-api
InventoryApiAPIInventoryApiAddCustomDNSToResourceInstancePost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/{resourceKey}/instance/{instanceId}/custom-dnsAddCustomDNSToResourceInstance inventory-api
InventoryApiAPIInventoryApiApproveSubscriptionRequestPut /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/subscription/request/{id}ApproveSubscriptionRequest inventory-api
InventoryApiAPIInventoryApiCancelUpgradePathPost /2022-09-01-00/fleet/service/{serviceId}/productTier/{productTierId}/upgrade-path/{upgradePathId}/cancelCancelUpgradePath inventory-api
InventoryApiAPIInventoryApiCreateConsumptionUserPost /2022-09-01-00/fleet/userCreateConsumptionUser inventory-api
InventoryApiAPIInventoryApiCreateProxyResourceInstancePost /2022-09-01-00/fleet/proxy-resource-instance/{serviceProviderId}/{serviceKey}/{serviceAPIVersion}/{serviceEnvironmentKey}/{serviceModelKey}/{productTierKey}/{sourceResourceKey}CreateProxyResourceInstance inventory-api
InventoryApiAPIInventoryApiCreateResourceInstancePost /2022-09-01-00/fleet/resource-instance/{serviceProviderId}/{serviceKey}/{serviceAPIVersion}/{serviceEnvironmentKey}/{serviceModelKey}/{productTierKey}/{resourceKey}CreateResourceInstance inventory-api
InventoryApiAPIInventoryApiCreateResourceInstanceSnapshotPost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/snapshotCreateResourceInstanceSnapshot inventory-api
InventoryApiAPIInventoryApiCreateServicesOrchestrationPost /2022-09-01-00/fleet/services-orchestrationCreateServicesOrchestration inventory-api
InventoryApiAPIInventoryApiCreateUpgradePathPost /2022-09-01-00/fleet/service/{serviceId}/productTier/{productTierId}/upgrade-pathCreateUpgradePath inventory-api
InventoryApiAPIInventoryApiDeleteProxyResourceInstanceDelete /2022-09-01-00/fleet/proxy-resource-instance/{serviceProviderId}/{serviceKey}/{serviceAPIVersion}/{serviceEnvironmentKey}/{serviceModelKey}/{productTierKey}/{id}DeleteProxyResourceInstance inventory-api
InventoryApiAPIInventoryApiDeleteResourceInstanceDelete /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}DeleteResourceInstance inventory-api
InventoryApiAPIInventoryApiDeleteResourceInstanceSnapshotDelete /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/snapshot/{snapshotId}DeleteResourceInstanceSnapshot inventory-api
InventoryApiAPIInventoryApiDeleteServicesOrchestrationDelete /2022-09-01-00/fleet/services-orchestration/{id}DeleteServicesOrchestration inventory-api
InventoryApiAPIInventoryApiDeleteUserDelete /2022-09-01-00/fleet/user/{userId}DeleteUser inventory-api
InventoryApiAPIInventoryApiDenySubscriptionRequestDelete /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/subscription/request/{id}DenySubscriptionRequest inventory-api
InventoryApiAPIInventoryApiDescribeHostClusterGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/host-cluster/{id}DescribeHostCluster inventory-api
InventoryApiAPIInventoryApiDescribeInstanceEventGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/event/{id}DescribeInstanceEvent inventory-api
InventoryApiAPIInventoryApiDescribeInventorySummaryGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/service-inventory-summaryDescribeInventorySummary inventory-api
InventoryApiAPIInventoryApiDescribeOrgUserGet /2022-09-01-00/fleet/user/{userId}DescribeOrgUser inventory-api
InventoryApiAPIInventoryApiDescribeOrganizationGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/organization/{organizationId}DescribeOrganization inventory-api
InventoryApiAPIInventoryApiDescribeResourceGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/model/{serviceModelId}/productTier/{productTierId}/resource/{resourceId}DescribeResource inventory-api
InventoryApiAPIInventoryApiDescribeResourceInstanceGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}DescribeResourceInstance inventory-api
InventoryApiAPIInventoryApiDescribeResourceInstanceSnapshotFromTimeGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/restoreDescribeResourceInstanceSnapshotFromTime inventory-api
InventoryApiAPIInventoryApiDescribeServiceOfferingGet /2022-09-01-00/fleet/service-offering/{serviceId}DescribeServiceOffering inventory-api
InventoryApiAPIInventoryApiDescribeServiceOfferingResourceGet /2022-09-01-00/fleet/service-offering/{serviceId}/resource/{resourceId}/instance/{instanceId}DescribeServiceOfferingResource inventory-api
InventoryApiAPIInventoryApiDescribeServicesOrchestrationGet /2022-09-01-00/fleet/services-orchestration/{id}DescribeServicesOrchestration inventory-api
InventoryApiAPIInventoryApiDescribeSubscriptionGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/subscription/{id}DescribeSubscription inventory-api
InventoryApiAPIInventoryApiDescribeSubscriptionRequestGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/subscription/request/{id}DescribeSubscriptionRequest inventory-api
InventoryApiAPIInventoryApiDescribeUpgradePathGet /2022-09-01-00/fleet/service/{serviceId}/productTier/{productTierId}/upgrade-path/{upgradePathId}DescribeUpgradePath inventory-api
InventoryApiAPIInventoryApiDescribeUserGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/user/{userId}DescribeUser inventory-api
InventoryApiAPIInventoryApiFailoverResourceInstancePost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/failoverFailoverResourceInstance inventory-api
InventoryApiAPIInventoryApiGenerateTokenForHostClusterDashboardPost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/host-cluster/{id}/dashboard/tokenGenerateTokenForHostClusterDashboard inventory-api
InventoryApiAPIInventoryApiListActiveOrganizationsGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/organizationsListActiveOrganizations inventory-api
InventoryApiAPIInventoryApiListAllUsersGet /2022-09-01-00/fleet/usersListAllUsers inventory-api
InventoryApiAPIInventoryApiListDependentComponentsGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/dependent-componentsListDependentComponents inventory-api
InventoryApiAPIInventoryApiListEligibleInstancesPerUpgradeGet /2022-09-01-00/fleet/service/{serviceId}/productTier/{productTierId}/upgrade-path/{upgradePathId}/eligible-instancesListEligibleInstancesPerUpgrade inventory-api
InventoryApiAPIInventoryApiListHostClustersGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/host-clustersListHostClusters inventory-api
InventoryApiAPIInventoryApiListInstanceEventsGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/eventsListInstanceEvents inventory-api
InventoryApiAPIInventoryApiListLinkedInstancesGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/linked-instancesListLinkedInstances inventory-api
InventoryApiAPIInventoryApiListResourceInstanceSnapshotsGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/snapshotListResourceInstanceSnapshots inventory-api
InventoryApiAPIInventoryApiListResourceInstancesGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instances/ListResourceInstances inventory-api
InventoryApiAPIInventoryApiListResourcesGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/model/{serviceModelId}/productTier/{productTierId}/resourcesListResources inventory-api
InventoryApiAPIInventoryApiListServiceOfferingsGet /2022-09-01-00/fleet/service-offeringListServiceOfferings inventory-api
InventoryApiAPIInventoryApiListServicesOrchestrationsGet /2022-09-01-00/fleet/services-orchestrationListServicesOrchestrations inventory-api
InventoryApiAPIInventoryApiListSubscriptionGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/subscriptionListSubscription inventory-api
InventoryApiAPIInventoryApiListSubscriptionRequestsGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/subscription/requestListSubscriptionRequests inventory-api
InventoryApiAPIInventoryApiListUpgradePathsGet /2022-09-01-00/fleet/service/{serviceId}/productTier/{productTierId}/upgrade-pathsListUpgradePaths inventory-api
InventoryApiAPIInventoryApiListUsersGet /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/usersListUsers inventory-api
InventoryApiAPIInventoryApiModifyServicesOrchestrationPatch /2022-09-01-00/fleet/services-orchestration/{id}ModifyServicesOrchestration inventory-api
InventoryApiAPIInventoryApiRemoveCapacityFromResourceInstancePost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/remove-capacityRemoveCapacityFromResourceInstance inventory-api
InventoryApiAPIInventoryApiRemoveCustomDNSFromResourceInstanceDelete /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/{resourceKey}/instance/{instanceId}/custom-dnsRemoveCustomDNSFromResourceInstance inventory-api
InventoryApiAPIInventoryApiRestartResourceInstancePost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/restartRestartResourceInstance inventory-api
InventoryApiAPIInventoryApiRestoreResourceInstancePost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/restoreRestoreResourceInstance inventory-api
InventoryApiAPIInventoryApiRestoreResourceInstanceFromSnapshotPost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/snapshot/{snapshotId}/restoreRestoreResourceInstanceFromSnapshot inventory-api
InventoryApiAPIInventoryApiResumeSubscriptionPut /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/subscription/{id}/resumeResumeSubscription inventory-api
InventoryApiAPIInventoryApiSearchInventoryPost /2022-09-01-00/fleet/search-inventorySearchInventory inventory-api
InventoryApiAPIInventoryApiSearchServiceInventoryPost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/search-inventorySearchServiceInventory inventory-api
InventoryApiAPIInventoryApiStartResourceInstancePost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/startStartResourceInstance inventory-api
InventoryApiAPIInventoryApiStopResourceInstancePost /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}/stopStopResourceInstance inventory-api
InventoryApiAPIInventoryApiSuspendSubscriptionPut /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/subscription/{id}/suspendSuspendSubscription inventory-api
InventoryApiAPIInventoryApiSuspendUserPut /2022-09-01-00/fleet/user/{userId}/suspendSuspendUser inventory-api
InventoryApiAPIInventoryApiTerminateSubscriptionDelete /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/subscription/{id}TerminateSubscription inventory-api
InventoryApiAPIInventoryApiUnsuspendUserPut /2022-09-01-00/fleet/user/{userId}/unsuspendUnsuspendUser inventory-api
InventoryApiAPIInventoryApiUpdateResourceInstancePatch /2022-09-01-00/fleet/service/{serviceId}/environment/{environmentId}/instance/{instanceId}UpdateResourceInstance inventory-api
NotificationsApiAPINotificationsApiCreateNotificationChannelPost /2022-09-01-00/fleet/notification-channelCreateNotificationChannel notifications-api
NotificationsApiAPINotificationsApiDeleteNotificationChannelDelete /2022-09-01-00/fleet/notification-channel/{id}DeleteNotificationChannel notifications-api
NotificationsApiAPINotificationsApiDescribeNotificationChannelGet /2022-09-01-00/fleet/notification-channel/{id}DescribeNotificationChannel notifications-api
NotificationsApiAPINotificationsApiListNotificationChannelsGet /2022-09-01-00/fleet/notification-channelListNotificationChannels notifications-api
NotificationsApiAPINotificationsApiUpdateNotificationChannelPatch /2022-09-01-00/fleet/notification-channel/{id}UpdateNotificationChannel notifications-api
OperationsApiAPIOperationsApiDeploymentCellHealthGet /2022-09-01-00/fleet/operations/deployment-cell-healthDeploymentCellHealth operations-api
OperationsApiAPIOperationsApiListEventsGet /2022-09-01-00/fleet/operations/eventsListEvents operations-api
OperationsApiAPIOperationsApiServiceHealthGet /2022-09-01-00/fleet/operations/service-healthServiceHealth operations-api
WebhooksApiAPIWebhooksApiReceiveWebhookPost /2022-09-01-00/fleet/hooks/{id}ReceiveWebhook webhooks-api

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api_key_header_Authorization

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), fleet.ContextAccessToken, "BEARER_TOKEN_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