# Go API client for dm

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

## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 6.0.0
- Package version: 1.0.0
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen

## Installation

Install the following dependencies:

```sh
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:

```go
import dm "github.com/GIT_USER_ID/GIT_REPO_ID"
```

To use a proxy, set the environment variable `HTTP_PROXY`:

```go
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 `dm.ContextServerIndex` of type `int`.

```go
ctx := context.WithValue(context.Background(), dm.ContextServerIndex, 1)
```

### Templated Server URL

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

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

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

## Documentation for API Endpoints

All URIs are relative to *https://you.domain.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ClusterAPI* | [**DMAPIGetClusterInfo**](docs/ClusterAPI.md#dmapigetclusterinfo) | **Get** /api/v1/cluster/info | get cluster info such as cluster id
*ClusterAPI* | [**DMAPIGetClusterMasterList**](docs/ClusterAPI.md#dmapigetclustermasterlist) | **Get** /api/v1/cluster/masters | get cluster master node list
*ClusterAPI* | [**DMAPIGetClusterWorkerList**](docs/ClusterAPI.md#dmapigetclusterworkerlist) | **Get** /api/v1/cluster/workers | get cluster worker node list
*ClusterAPI* | [**DMAPIOfflineMasterNode**](docs/ClusterAPI.md#dmapiofflinemasternode) | **Delete** /api/v1/cluster/masters/{master-name} | offline master node
*ClusterAPI* | [**DMAPIOfflineWorkerNode**](docs/ClusterAPI.md#dmapiofflineworkernode) | **Delete** /api/v1/cluster/workers/{worker-name} | offline worker node
*ClusterAPI* | [**DMAPIUpdateClusterInfo**](docs/ClusterAPI.md#dmapiupdateclusterinfo) | **Put** /api/v1/cluster/info | update cluster info.
*DocAPI* | [**GetDocHTML**](docs/DocAPI.md#getdochtml) | **Get** /api/v1/docs | get doc html
*DocAPI* | [**GetDocJSON**](docs/DocAPI.md#getdocjson) | **Get** /api/v1/dm.json | get doc json
*SourceAPI* | [**DMAPICreateSource**](docs/SourceAPI.md#dmapicreatesource) | **Post** /api/v1/sources | create and enable a new data source
*SourceAPI* | [**DMAPIDeleteSource**](docs/SourceAPI.md#dmapideletesource) | **Delete** /api/v1/sources/{source-name} | delete a data source
*SourceAPI* | [**DMAPIDisableRelay**](docs/SourceAPI.md#dmapidisablerelay) | **Post** /api/v1/sources/{source-name}/relay/disable | disable relay log function for the data source
*SourceAPI* | [**DMAPIDisableSource**](docs/SourceAPI.md#dmapidisablesource) | **Post** /api/v1/sources/{source-name}/disable | disable a data source
*SourceAPI* | [**DMAPIEnableRelay**](docs/SourceAPI.md#dmapienablerelay) | **Post** /api/v1/sources/{source-name}/relay/enable | enable relay log function for the data source
*SourceAPI* | [**DMAPIEnableSource**](docs/SourceAPI.md#dmapienablesource) | **Post** /api/v1/sources/{source-name}/enable | enable a data source
*SourceAPI* | [**DMAPIGetSource**](docs/SourceAPI.md#dmapigetsource) | **Get** /api/v1/sources/{source-name} | get source
*SourceAPI* | [**DMAPIGetSourceList**](docs/SourceAPI.md#dmapigetsourcelist) | **Get** /api/v1/sources | get data source list
*SourceAPI* | [**DMAPIGetSourceSchemaList**](docs/SourceAPI.md#dmapigetsourceschemalist) | **Get** /api/v1/sources/{source-name}/schemas | get source schema list
*SourceAPI* | [**DMAPIGetSourceStatus**](docs/SourceAPI.md#dmapigetsourcestatus) | **Get** /api/v1/sources/{source-name}/status | get the current status of the data source
*SourceAPI* | [**DMAPIGetSourceTableList**](docs/SourceAPI.md#dmapigetsourcetablelist) | **Get** /api/v1/sources/{source-name}/schemas/{schema-name} | get source table list
*SourceAPI* | [**DMAPIPurgeRelay**](docs/SourceAPI.md#dmapipurgerelay) | **Post** /api/v1/sources/{source-name}/relay/purge | purge relay log
*SourceAPI* | [**DMAPITransferSource**](docs/SourceAPI.md#dmapitransfersource) | **Post** /api/v1/sources/{source-name}/transfer | transfer source to a free worker
*SourceAPI* | [**DMAPIUpdateSource**](docs/SourceAPI.md#dmapiupdatesource) | **Put** /api/v1/sources/{source-name} | update a data source
*TaskAPI* | [**DMAPIConvertTask**](docs/TaskAPI.md#dmapiconverttask) | **Post** /api/v1/tasks/converters | Turn task into the format of a configuration file or vice versa.
*TaskAPI* | [**DMAPICreateTask**](docs/TaskAPI.md#dmapicreatetask) | **Post** /api/v1/tasks | create a task
*TaskAPI* | [**DMAPICreateTaskTemplate**](docs/TaskAPI.md#dmapicreatetasktemplate) | **Post** /api/v1/tasks/templates | create task template
*TaskAPI* | [**DMAPIDeleteTableStructure**](docs/TaskAPI.md#dmapideletetablestructure) | **Delete** /api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}/{table-name} | delete task source table structure
*TaskAPI* | [**DMAPIDeleteTask**](docs/TaskAPI.md#dmapideletetask) | **Delete** /api/v1/tasks/{task-name} | delete a task
*TaskAPI* | [**DMAPIDeleteTaskTemplate**](docs/TaskAPI.md#dmapideletetasktemplate) | **Delete** /api/v1/tasks/templates/{task-name} | delete task template template
*TaskAPI* | [**DMAPIGetSchemaListByTaskAndSource**](docs/TaskAPI.md#dmapigetschemalistbytaskandsource) | **Get** /api/v1/tasks/{task-name}/sources/{source-name}/schemas | get task source schema list
*TaskAPI* | [**DMAPIGetTableListByTaskAndSource**](docs/TaskAPI.md#dmapigettablelistbytaskandsource) | **Get** /api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name} | get task source table list
*TaskAPI* | [**DMAPIGetTableStructure**](docs/TaskAPI.md#dmapigettablestructure) | **Get** /api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}/{table-name} | get task source table structure
*TaskAPI* | [**DMAPIGetTask**](docs/TaskAPI.md#dmapigettask) | **Get** /api/v1/tasks/{task-name} | get a task
*TaskAPI* | [**DMAPIGetTaskList**](docs/TaskAPI.md#dmapigettasklist) | **Get** /api/v1/tasks | get task list
*TaskAPI* | [**DMAPIGetTaskMigrateTargets**](docs/TaskAPI.md#dmapigettaskmigratetargets) | **Get** /api/v1/tasks/{task-name}/sources/{source-name}/migrate_targets | get task source table and target table route relation
*TaskAPI* | [**DMAPIGetTaskStatus**](docs/TaskAPI.md#dmapigettaskstatus) | **Get** /api/v1/tasks/{task-name}/status | get task status
*TaskAPI* | [**DMAPIGetTaskTemplate**](docs/TaskAPI.md#dmapigettasktemplate) | **Get** /api/v1/tasks/templates/{task-name} | get task template template
*TaskAPI* | [**DMAPIGetTaskTemplateList**](docs/TaskAPI.md#dmapigettasktemplatelist) | **Get** /api/v1/tasks/templates | get task template list
*TaskAPI* | [**DMAPIImportTaskTemplate**](docs/TaskAPI.md#dmapiimporttasktemplate) | **Post** /api/v1/tasks/templates/import | import task template
*TaskAPI* | [**DMAPIOperateTableStructure**](docs/TaskAPI.md#dmapioperatetablestructure) | **Put** /api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}/{table-name} | operate task source table structure
*TaskAPI* | [**DMAPIStartTask**](docs/TaskAPI.md#dmapistarttask) | **Post** /api/v1/tasks/{task-name}/start | start a task
*TaskAPI* | [**DMAPIStopTask**](docs/TaskAPI.md#dmapistoptask) | **Post** /api/v1/tasks/{task-name}/stop | stop a task
*TaskAPI* | [**DMAPIUpdateTask**](docs/TaskAPI.md#dmapiupdatetask) | **Put** /api/v1/tasks/{task-name} | update a task
*TaskAPI* | [**DMAPUpdateTaskTemplate**](docs/TaskAPI.md#dmapupdatetasktemplate) | **Put** /api/v1/tasks/templates/{task-name} | update task template template


## Documentation For Models

 - [AlertManagerTopology](docs/AlertManagerTopology.md)
 - [ClusterMaster](docs/ClusterMaster.md)
 - [ClusterTopology](docs/ClusterTopology.md)
 - [ClusterWorker](docs/ClusterWorker.md)
 - [ConverterTaskRequest](docs/ConverterTaskRequest.md)
 - [ConverterTaskResponse](docs/ConverterTaskResponse.md)
 - [CreateSourceRequest](docs/CreateSourceRequest.md)
 - [CreateTaskRequest](docs/CreateTaskRequest.md)
 - [DisableRelayRequest](docs/DisableRelayRequest.md)
 - [DumpStatus](docs/DumpStatus.md)
 - [EnableRelayRequest](docs/EnableRelayRequest.md)
 - [ErrorWithMessage](docs/ErrorWithMessage.md)
 - [GetClusterInfoResponse](docs/GetClusterInfoResponse.md)
 - [GetClusterMasterListResponse](docs/GetClusterMasterListResponse.md)
 - [GetClusterWorkerListResponse](docs/GetClusterWorkerListResponse.md)
 - [GetSourceListResponse](docs/GetSourceListResponse.md)
 - [GetSourceStatusResponse](docs/GetSourceStatusResponse.md)
 - [GetTaskListResponse](docs/GetTaskListResponse.md)
 - [GetTaskMigrateTargetsResponse](docs/GetTaskMigrateTargetsResponse.md)
 - [GetTaskStatusResponse](docs/GetTaskStatusResponse.md)
 - [GetTaskTableStructureResponse](docs/GetTaskTableStructureResponse.md)
 - [GrafanaTopology](docs/GrafanaTopology.md)
 - [LoadStatus](docs/LoadStatus.md)
 - [MasterTopology](docs/MasterTopology.md)
 - [OperateTaskResponse](docs/OperateTaskResponse.md)
 - [OperateTaskTableStructureRequest](docs/OperateTaskTableStructureRequest.md)
 - [PrometheusTopology](docs/PrometheusTopology.md)
 - [Purge](docs/Purge.md)
 - [PurgeRelayRequest](docs/PurgeRelayRequest.md)
 - [RelayConfig](docs/RelayConfig.md)
 - [RelayStatus](docs/RelayStatus.md)
 - [Security](docs/Security.md)
 - [ShardingGroup](docs/ShardingGroup.md)
 - [Source](docs/Source.md)
 - [SourceStatus](docs/SourceStatus.md)
 - [StartTaskRequest](docs/StartTaskRequest.md)
 - [StopTaskRequest](docs/StopTaskRequest.md)
 - [SubTaskStatus](docs/SubTaskStatus.md)
 - [SyncStatus](docs/SyncStatus.md)
 - [Task](docs/Task.md)
 - [TaskBinLogFilterRule](docs/TaskBinLogFilterRule.md)
 - [TaskFullMigrateConf](docs/TaskFullMigrateConf.md)
 - [TaskFullMigrateConfAnalyze](docs/TaskFullMigrateConfAnalyze.md)
 - [TaskFullMigrateConfImportMode](docs/TaskFullMigrateConfImportMode.md)
 - [TaskFullMigrateConfOnDuplicateLogical](docs/TaskFullMigrateConfOnDuplicateLogical.md)
 - [TaskFullMigrateConfOnDuplicatePhysical](docs/TaskFullMigrateConfOnDuplicatePhysical.md)
 - [TaskIncrMigrateConf](docs/TaskIncrMigrateConf.md)
 - [TaskMigrateTarget](docs/TaskMigrateTarget.md)
 - [TaskOnDuplicate](docs/TaskOnDuplicate.md)
 - [TaskShardMode](docs/TaskShardMode.md)
 - [TaskSourceConf](docs/TaskSourceConf.md)
 - [TaskSourceConfig](docs/TaskSourceConfig.md)
 - [TaskStage](docs/TaskStage.md)
 - [TaskTableMigrateRule](docs/TaskTableMigrateRule.md)
 - [TaskTableMigrateRuleSource](docs/TaskTableMigrateRuleSource.md)
 - [TaskTableMigrateRuleTarget](docs/TaskTableMigrateRuleTarget.md)
 - [TaskTargetDataBase](docs/TaskTargetDataBase.md)
 - [TaskTaskMode](docs/TaskTaskMode.md)
 - [TaskTemplateRequest](docs/TaskTemplateRequest.md)
 - [TaskTemplateResponse](docs/TaskTemplateResponse.md)
 - [TaskTemplateResponseFailedTaskListInner](docs/TaskTemplateResponseFailedTaskListInner.md)
 - [UpdateSourceRequest](docs/UpdateSourceRequest.md)
 - [UpdateTaskRequest](docs/UpdateTaskRequest.md)
 - [WorkerNameRequest](docs/WorkerNameRequest.md)
 - [WorkerTopology](docs/WorkerTopology.md)


## Documentation For Authorization

Endpoints do not require authorization.


## 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