Go API client for pds

Portworx Data Services API Server

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: 121
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/oauth2
go get golang.org/x/net/context

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

import pds "github.com/GIT_USER_ID/GIT_REPO_ID"

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(), pds.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(), pds.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(), pds.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), pds.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
APIVersionApi	ApiVersionGet	Get /api/version	Get version information
AccountRoleBindingsApi	ApiAccountsIdInvitationsPost	Post /api/accounts/{id}/invitations	Create Invitation
AccountRoleBindingsApi	ApiAccountsIdRoleBindingsDelete	Delete /api/accounts/{id}/role-bindings	Delete AccountRoleBinding
AccountRoleBindingsApi	ApiAccountsIdRoleBindingsGet	Get /api/accounts/{id}/role-bindings	List AccountRoleBinding
AccountRoleBindingsApi	ApiAccountsIdRoleBindingsPut	Put /api/accounts/{id}/role-bindings	Create/Update AccountRoleBinding
AccountRoleBindingsApi	ApiUsersIdAccountRoleBindingsGet	Get /api/users/{id}/account-role-bindings	List User's AccountRoleBindings
AccountsApi	ApiAccountsGet	Get /api/accounts	List Accounts
AccountsApi	ApiAccountsIdAccountRoleInvitationsGet	Get /api/accounts/{id}/account-role-invitations	List Account Role Invitations
AccountsApi	ApiAccountsIdEulaPut	Put /api/accounts/{id}/eula	Accept EULA
AccountsApi	ApiAccountsIdGet	Get /api/accounts/{id}	Get Account
AccountsApi	ApiAccountsIdGlobalConfigPut	Put /api/accounts/{id}/global-config	Update AccountGlobalConfig
AccountsApi	ApiAccountsIdPatch	Patch /api/accounts/{id}	Update Account
AccountsApi	ApiAccountsIdUsersGet	Get /api/accounts/{id}/users	List Account Users
AccountsApi	ApiAccountsPost	Post /api/accounts	Create Account
AccountsDNSApi	ApiAccountsIdDnsDetailsPut	Put /api/accounts/{id}/dns-details	Update DNS Details
AccountsMAASDetailsApi	ApiAccountsIdMaasDetailsGet	Get /api/accounts/{id}/maas-details	Get MAAS details
AccountsMAASDetailsApi	ApiAccountsIdMaasDetailsPut	Put /api/accounts/{id}/maas-details	Update MAAS details
AccountsRoleInvitationsApi	ApiAccountRoleInvitationsIdDelete	Delete /api/account-role-invitations/{id}	Delete AccountRoleInvitation
AccountsRoleInvitationsApi	ApiAccountRoleInvitationsIdPatch	Patch /api/account-role-invitations/{id}	Patch AccountRoleInvitation role_name
ApplicationConfigurationTemplatesApi	ApiApplicationConfigurationTemplatesIdDelete	Delete /api/application-configuration-templates/{id}	Delete ApplicationConfigurationTemplates
ApplicationConfigurationTemplatesApi	ApiApplicationConfigurationTemplatesIdGet	Get /api/application-configuration-templates/{id}	Get ApplicationConfigurationTemplate
ApplicationConfigurationTemplatesApi	ApiApplicationConfigurationTemplatesIdPut	Put /api/application-configuration-templates/{id}	Update ApplicationConfigurationTemplate
ApplicationConfigurationTemplatesApi	ApiTenantsIdApplicationConfigurationTemplatesGet	Get /api/tenants/{id}/application-configuration-templates	List ApplicationConfigurationTemplates
ApplicationConfigurationTemplatesApi	ApiTenantsIdApplicationConfigurationTemplatesPost	Post /api/tenants/{id}/application-configuration-templates	Create ApplicationConfigurationTemplate
AuthenticationApi	AuthAuthorizationCodePost	Post /auth/authorization-code	Authorization code exchange
AuthenticationApi	AuthOidcInfoGet	Get /auth/oidc-info	OIDC info
AuthenticationApi	AuthRefreshTokenPost	Post /auth/refresh-token	Use refresh token to generate new tokens.
AuthorizerApi	ApiAuthorizerPost	Post /api/authorizer	Authorize operation
BackupCredentialsApi	ApiBackupCredentialsIdCredentialsGet	Get /api/backup-credentials/{id}/credentials	Get cloud configuration for BackupCredentials
BackupCredentialsApi	ApiBackupCredentialsIdDelete	Delete /api/backup-credentials/{id}	Delete BackupCredentials
BackupCredentialsApi	ApiBackupCredentialsIdGet	Get /api/backup-credentials/{id}	Get BackupCredentials
BackupCredentialsApi	ApiBackupCredentialsIdPut	Put /api/backup-credentials/{id}	Update BackupCredentials
BackupCredentialsApi	ApiTenantsIdBackupCredentialsGet	Get /api/tenants/{id}/backup-credentials	List BackupCredentials
BackupCredentialsApi	ApiTenantsIdBackupCredentialsPost	Post /api/tenants/{id}/backup-credentials	Create BackupCredentials
BackupJobsApi	ApiBackupJobsIdDelete	Delete /api/backup-jobs/{id}	Delete BackupJob
BackupJobsApi	ApiBackupJobsIdGet	Get /api/backup-jobs/{id}	Get BackupJob
BackupJobsApi	ApiBackupJobsIdPut	Put /api/backup-jobs/{id}	Upsert BackupJob
BackupJobsApi	ApiBackupsIdJobsGet	Get /api/backups/{id}/jobs	List Backup's Jobs
BackupJobsApi	ApiProjectsIdBackupJobsGet	Get /api/projects/{id}/backup-jobs	List Project's BackupJobs
BackupPoliciesApi	ApiBackupPoliciesIdDelete	Delete /api/backup-policies/{id}	Delete BackupPolicies
BackupPoliciesApi	ApiBackupPoliciesIdGet	Get /api/backup-policies/{id}	Get BackupPolicy
BackupPoliciesApi	ApiBackupPoliciesIdPut	Put /api/backup-policies/{id}	Update BackupPolicy
BackupPoliciesApi	ApiTenantsIdBackupPoliciesGet	Get /api/tenants/{id}/backup-policies	List BackupPolicies
BackupPoliciesApi	ApiTenantsIdBackupPoliciesPost	Post /api/tenants/{id}/backup-policies	Create BackupPolicy
BackupTargetsApi	ApiBackupTargetsIdDelete	Delete /api/backup-targets/{id}	Delete BackupTargets
BackupTargetsApi	ApiBackupTargetsIdGet	Get /api/backup-targets/{id}	Get BackupTarget
BackupTargetsApi	ApiBackupTargetsIdPut	Put /api/backup-targets/{id}	Update BackupTarget
BackupTargetsApi	ApiBackupTargetsIdRetryPost	Post /api/backup-targets/{id}/retry	Retry sync of a BackupTarget
BackupTargetsApi	ApiBackupTargetsIdStatesGet	Get /api/backup-targets/{id}/states	List BackupTarget's BackupTargetStates
BackupTargetsApi	ApiProjectsIdBackupTargetsGet	Get /api/projects/{id}/backup-targets	List Project's BackupTargets
BackupTargetsApi	ApiTenantsIdBackupTargetsGet	Get /api/tenants/{id}/backup-targets	List Tenant's BackupTargets
BackupTargetsApi	ApiTenantsIdBackupTargetsPost	Post /api/tenants/{id}/backup-targets	Create BackupTarget
BackupsApi	ApiBackupTargetsIdBackupsGet	Get /api/backup-targets/{id}/backups	List BackupTarget's Backups
BackupsApi	ApiBackupsIdDelete	Delete /api/backups/{id}	Delete Backup
BackupsApi	ApiBackupsIdGet	Get /api/backups/{id}	Get Backup
BackupsApi	ApiBackupsIdJobsNameDelete	Delete /api/backups/{id}/jobs/{name}	Delete Backup jobs
BackupsApi	ApiBackupsIdPut	Put /api/backups/{id}	Update Backup
BackupsApi	ApiDeploymentsIdBackupsGet	Get /api/deployments/{id}/backups	List Deployment's Backups
BackupsApi	ApiDeploymentsIdBackupsPost	Post /api/deployments/{id}/backups	Create Backup
CopilotApi	ApiCopilotSearchPost	Post /api/copilot/search	Search Database query
DataServicesApi	ApiDataServicesGet	Get /api/data-services	List Data Services
DataServicesApi	ApiDataServicesIdGet	Get /api/data-services/{id}	Get Data Service
DeploymentManifestsApi	ApiDeploymentsIdUpdateManifestPost	Post /api/deployments/{id}/update-manifest	Post DeploymentManifest
DeploymentTargetsApi	ApiDeploymentTargetsIdAgentMetadataPatch	Patch /api/deployment-targets/{id}/agent-metadata	Patch DeploymentTarget agent-metadata
DeploymentTargetsApi	ApiDeploymentTargetsIdConfigGet	Get /api/deployment-targets/{id}/config	Get configuration values for a DeploymentTarget
DeploymentTargetsApi	ApiDeploymentTargetsIdCredentialsGet	Get /api/deployment-targets/{id}/credentials	Get join credentials of a DeploymentTarget
DeploymentTargetsApi	ApiDeploymentTargetsIdDelete	Delete /api/deployment-targets/{id}	Delete DeploymentTarget
DeploymentTargetsApi	ApiDeploymentTargetsIdGet	Get /api/deployment-targets/{id}	Get DeploymentTarget
DeploymentTargetsApi	ApiDeploymentTargetsIdHeartbeatPost	Post /api/deployment-targets/{id}/heartbeat	Make DeploymentTarget heart beat request
DeploymentTargetsApi	ApiDeploymentTargetsIdMetadataPost	Post /api/deployment-targets/{id}/metadata	Update DeploymentTarget metadata
DeploymentTargetsApi	ApiDeploymentTargetsIdOperatorHeartbeatPost	Post /api/deployment-targets/{id}/operator-heartbeat	Make DeploymentTarget operator heart beat request
DeploymentTargetsApi	ApiDeploymentTargetsIdOperatorMetadataPatch	Patch /api/deployment-targets/{id}/operator-metadata	Update target operator metadata
DeploymentTargetsApi	ApiDeploymentTargetsIdPatch	Patch /api/deployment-targets/{id}	Patch DeploymentTarget
DeploymentTargetsApi	ApiDeploymentTargetsIdPut	Put /api/deployment-targets/{id}	Update DeploymentTarget
DeploymentTargetsApi	ApiDeploymentTargetsIdUpdateCapabilitiesPost	Post /api/deployment-targets/{id}/update-capabilities	Update target capabilities
DeploymentTargetsApi	ApiProjectsIdDeploymentTargetsGet	Get /api/projects/{id}/deployment-targets	List Project's DeploymentTargets
DeploymentTargetsApi	ApiTenantsIdDeploymentTargetsGet	Get /api/tenants/{id}/deployment-targets	List Tenant's DeploymentTargets
DeploymentTargetsApi	ApiTenantsIdDeploymentTargetsPost	Post /api/tenants/{id}/deployment-targets	Create DeploymentTarget
DeploymentsApi	ApiDeploymentsIdConnectionInfoGet	Get /api/deployments/{id}/connection-info	Deployment Connection Information
DeploymentsApi	ApiDeploymentsIdCredentialsGet	Get /api/deployments/{id}/credentials	Deployment Credentials
DeploymentsApi	ApiDeploymentsIdDelete	Delete /api/deployments/{id}	Delete Deployment
DeploymentsApi	ApiDeploymentsIdGet	Get /api/deployments/{id}	Get Deployment
DeploymentsApi	ApiDeploymentsIdPut	Put /api/deployments/{id}	Update Deployment
DeploymentsApi	ApiDeploymentsIdStatusGet	Get /api/deployments/{id}/status	Get Deployment Status
DeploymentsApi	ApiDeploymentsPost	Post /api/deployments	Create Deployment
DeploymentsApi	ApiProjectsIdDeploymentsGet	Get /api/projects/{id}/deployments	List Project's Deployments
DeploymentsApi	ApiProjectsIdDeploymentsPost	Post /api/projects/{id}/deployments	Create Deployment
EventsApi	ApiDeploymentTargetsIdDeploymentEventsPost	Post /api/deployment-targets/{id}/deployment/events	Adds k8s generated events for a deployment
EventsApi	ApiDeploymentTargetsIdEventsLastSyncedTimeGet	Get /api/deployment-targets/{id}/events/last-synced-time	Get the timestamp of the latest event
EventsApi	ApiDeploymentsIdEventsGet	Get /api/deployments/{id}/events	Get Deployment Events
GlobalRoleBindingsApi	ApiGlobalRoleBindingsDelete	Delete /api/global-role-bindings	Delete GlobalRoleBinding
GlobalRoleBindingsApi	ApiGlobalRoleBindingsGet	Get /api/global-role-bindings	List GlobalRoleBindings
GlobalRoleBindingsApi	ApiGlobalRoleBindingsPut	Put /api/global-role-bindings	Set GlobalRoleBinding
IAMApi	ApiAccountsIdIamActorIdDelete	Delete /api/accounts/{id}/iam/{actor-id}	Delete IAM
IAMApi	ApiAccountsIdIamActorIdGet	Get /api/accounts/{id}/iam/{actor-id}	Get IAM
IAMApi	ApiAccountsIdIamGet	Get /api/accounts/{id}/iam	List IAM
IAMApi	ApiAccountsIdIamPost	Post /api/accounts/{id}/iam	Create IAM
IAMApi	ApiAccountsIdIamPut	Put /api/accounts/{id}/iam	Update IAM
ImagesApi	ApiImagesGet	Get /api/images	List Images
ImagesApi	ApiImagesIdGet	Get /api/images/{id}	Get Image
ImagesApi	ApiVersionsIdImagesGet	Get /api/versions/{id}/images	List Version's Images
MetadataApi	ApiMetadataGet	Get /api/metadata	Get metadata information
NamespacesApi	ApiDeploymentTargetsIdNamespacesGet	Get /api/deployment-targets/{id}/namespaces	List DeploymentTarget's Namespaces
NamespacesApi	ApiDeploymentTargetsIdNamespacesPost	Post /api/deployment-targets/{id}/namespaces	Create Namespace
NamespacesApi	ApiNamespacesIdDelete	Delete /api/namespaces/{id}	Delete Namespace
NamespacesApi	ApiNamespacesIdGet	Get /api/namespaces/{id}	Get Namespace
NamespacesApi	ApiNamespacesIdPut	Put /api/namespaces/{id}	Update namespace
ProjectRoleBindingsApi	ApiProjectsIdRoleBindingsDelete	Delete /api/projects/{id}/role-bindings	Delete ProjectRoleBinding
ProjectRoleBindingsApi	ApiProjectsIdRoleBindingsGet	Get /api/projects/{id}/role-bindings	List ProjectRoleBindings
ProjectRoleBindingsApi	ApiProjectsIdRoleBindingsPut	Put /api/projects/{id}/role-bindings	Create ProjectRoleBinding
ProjectsApi	ApiProjectsIdGet	Get /api/projects/{id}	Get Project
ProjectsApi	ApiTenantsIdProjectsGet	Get /api/tenants/{id}/projects	List Tenant's Projects
ResourceSettingsTemplatesApi	ApiResourceSettingsTemplatesIdDelete	Delete /api/resource-settings-templates/{id}	Delete ResourceSettingsTemplates
ResourceSettingsTemplatesApi	ApiResourceSettingsTemplatesIdGet	Get /api/resource-settings-templates/{id}	Get ResourceSettingsTemplate
ResourceSettingsTemplatesApi	ApiResourceSettingsTemplatesIdPut	Put /api/resource-settings-templates/{id}	Update ResourceSettingsTemplate
ResourceSettingsTemplatesApi	ApiTenantsIdResourceSettingsTemplatesGet	Get /api/tenants/{id}/resource-settings-templates	List ResourceSettingsTemplates
ResourceSettingsTemplatesApi	ApiTenantsIdResourceSettingsTemplatesPost	Post /api/tenants/{id}/resource-settings-templates	Create ResourceSettingsTemplate
RestoresApi	ApiBackupJobsIdRestorePost	Post /api/backup-jobs/{id}/restore	Start Restore
RestoresApi	ApiRestoresIdGet	Get /api/restores/{id}	Get Restore
RestoresApi	ApiRestoresIdRetryPost	Post /api/restores/{id}/retry	Retry Restore
RestoresApi	ApiRestoresIdUpdatePost	Post /api/restores/{id}/update	Update Restore
RestoresApi	ApiRestoresRestorabilityMatrixGet	Get /api/restores/restorability-matrix	Restorability Matrix
RolesApi	ApiRolesGet	Get /api/roles	List Roles
SampleTemplatesApi	ApiDefaultTemplatesApplicationConfigurationGet	Get /api/default-templates/application-configuration	List ApplicationConfigurationSamples
SampleTemplatesApi	ApiDefaultTemplatesBackupPoliciesGet	Get /api/default-templates/backup-policies	List BackupPolicySamples
SampleTemplatesApi	ApiDefaultTemplatesResourceSettingsGet	Get /api/default-templates/resource-settings	List ResourceSettingsSamples
SampleTemplatesApi	ApiDefaultTemplatesStorageOptionsGet	Get /api/default-templates/storage-options	List StorageOptionsSamples
ServiceAccountsApi	ApiServiceAccountsIdDelete	Delete /api/service-accounts/{id}	Delete ServiceAccounts
ServiceAccountsApi	ApiServiceAccountsIdGet	Get /api/service-accounts/{id}	Get ServiceAccounts
ServiceAccountsApi	ApiServiceAccountsIdTokenGet	Get /api/service-accounts/{id}/token	Get token of a ServiceAccount
ServiceAccountsApi	ApiTenantsIdServiceAccountsGet	Get /api/tenants/{id}/service-accounts	List Tenant's ServiceAccounts
ServiceAccountsApi	ApiTenantsIdServiceAccountsPost	Post /api/tenants/{id}/service-accounts	Create ServiceAccounts
ServiceIdentityApi	ApiAccountsIdServiceIdentityGet	Get /api/accounts/{id}/service-identity	List Service Identity
ServiceIdentityApi	ApiAccountsIdServiceIdentityPost	Post /api/accounts/{id}/service-identity	Create a Service Identity
ServiceIdentityApi	ApiServiceIdentityIdDelete	Delete /api/service-identity/{id}	Delete service identity
ServiceIdentityApi	ApiServiceIdentityIdGet	Get /api/service-identity/{id}	Get service identity by ID
ServiceIdentityApi	ApiServiceIdentityIdPut	Put /api/service-identity/{id}	Update service identity
ServiceIdentityApi	ApiServiceIdentityIdRegenerateGet	Get /api/service-identity/{id}/regenerate	Regenerate service identity credentials
ServiceIdentityApi	ServiceIdentityGenerateTokenPost	Post /service-identity/generate-token	Generate JWT token for service identity
StorageOptionsTemplatesApi	ApiStorageOptionsTemplatesIdDelete	Delete /api/storage-options-templates/{id}	Delete StorageOptionsTemplates
StorageOptionsTemplatesApi	ApiStorageOptionsTemplatesIdGet	Get /api/storage-options-templates/{id}	Get StorageOptionsTemplate
StorageOptionsTemplatesApi	ApiStorageOptionsTemplatesIdPut	Put /api/storage-options-templates/{id}	Update StorageOptionsTemplate
StorageOptionsTemplatesApi	ApiTenantsIdStorageOptionsTemplatesGet	Get /api/tenants/{id}/storage-options-templates	List StorageOptionsTemplates
StorageOptionsTemplatesApi	ApiTenantsIdStorageOptionsTemplatesPost	Post /api/tenants/{id}/storage-options-templates	Create StorageOptionsTemplate
TasksApi	ApiDbTasksIdGet	Get /api/db-tasks/{id}	Get Task
TeamsApi	ApiTeamsIdGet	Get /api/teams/{id}	Get Team
TenantRoleBindingsApi	ApiTenantsIdRoleBindingsDelete	Delete /api/tenants/{id}/role-bindings	Delete TenantRoleBinding
TenantRoleBindingsApi	ApiTenantsIdRoleBindingsGet	Get /api/tenants/{id}/role-bindings	List TenantRoleBindings
TenantRoleBindingsApi	ApiTenantsIdRoleBindingsPut	Put /api/tenants/{id}/role-bindings	Create TenantRoleBinding
TenantsApi	ApiAccountsIdTenantsGet	Get /api/accounts/{id}/tenants	List Account's Tenants
TenantsApi	ApiTenantsIdDnsDetailsGet	Get /api/tenants/{id}/dns-details	Get DNS details for Tenant
TenantsApi	ApiTenantsIdGet	Get /api/tenants/{id}	Get Tenant
UserAPIKeyApi	ApiUserApiKeyGet	Get /api/user-api-key	List UserAPIKeys
UserAPIKeyApi	ApiUserApiKeyIdDelete	Delete /api/user-api-key/{id}	Delete UserAPIKey
UserAPIKeyApi	ApiUserApiKeyIdGet	Get /api/user-api-key/{id}	Get UserAPIKey
UserAPIKeyApi	ApiUserApiKeyIdPatch	Patch /api/user-api-key/{id}	Patch UserAPIKey
UserAPIKeyApi	ApiUserApiKeyPost	Post /api/user-api-key	Create UserAPIKey
UsersApi	ApiUsersIdGet	Get /api/users/{id}	Get User
VersionsApi	ApiCompatibleVersionsGet	Get /api/compatible-versions	List compatible versions
VersionsApi	ApiDataServicesIdVersionsGet	Get /api/data-services/{id}/versions	List Data Service's Versions
VersionsApi	ApiVersionsIdGet	Get /api/versions/{id}	Get Version
WhoAmIApi	ApiWhoamiGet	Get /api/whoami	Get Current Actor

Documentation For Models

Documentation For Authorization

ApiKeyAuth

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.

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

# README