orchestrator-swagger-go-client/docs/PlugApi.md

# \PlugApi

All URIs are relative to */api/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**PlugPlugTypePut**](PlugApi.md#PlugPlugTypePut) | **Put** /plug/{plug_type} | Initiates a scraping operation for a user with a specific plug type
[**PlugPlugTypeTaskIdDelete**](PlugApi.md#PlugPlugTypeTaskIdDelete) | **Delete** /plug/{plug_type}/{task_id} | Stops a scraping operation for a user with a specific plug type
[**PlugPlugTypeTaskIdGet**](PlugApi.md#PlugPlugTypeTaskIdGet) | **Get** /plug/{plug_type}/{task_id} | Retrieves the status of a specific task type



## PlugPlugTypePut

> PlugPlugTypePut(ctx, plugType).Request(request).Execute()

Initiates a scraping operation for a user with a specific plug type



### Example

```go
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    plugType := "plugType_example" // string | supported plug type
    request := *openapiclient.NewGitDragseItAnthroveOrchestratorPkgModelsOrchestratorTask("AnthroveUserId_example", false, *openapiclient.NewGitDragseItAnthroveOrchestratorPkgModelsPlugTask("UserId_example")) // GitDragseItAnthroveOrchestratorPkgModelsOrchestratorTask | aa

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PlugApi.PlugPlugTypePut(context.Background(), plugType).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PlugApi.PlugPlugTypePut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}
```

### Path Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**plugType** | **string** | supported plug type | 

### Other Parameters

Other parameters are passed through a pointer to a apiPlugPlugTypePutRequest struct via the builder pattern


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------

 **request** | [**GitDragseItAnthroveOrchestratorPkgModelsOrchestratorTask**](GitDragseItAnthroveOrchestratorPkgModelsOrchestratorTask.md) | aa | 

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)


## PlugPlugTypeTaskIdDelete

> PlugPlugTypeTaskIdDelete(ctx, plugType, taskId).Execute()

Stops a scraping operation for a user with a specific plug type



### Example

```go
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    plugType := "plugType_example" // string | supported plug type
    taskId := "taskId_example" // string | id of task

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PlugApi.PlugPlugTypeTaskIdDelete(context.Background(), plugType, taskId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PlugApi.PlugPlugTypeTaskIdDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}
```

### Path Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**plugType** | **string** | supported plug type | 
**taskId** | **string** | id of task | 

### Other Parameters

Other parameters are passed through a pointer to a apiPlugPlugTypeTaskIdDeleteRequest struct via the builder pattern


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------



### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)


## PlugPlugTypeTaskIdGet

> PlugPlugTypeTaskIdGet(ctx, plugType, taskId).Execute()

Retrieves the status of a specific task type



### Example

```go
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    plugType := "plugType_example" // string | supported plug type
    taskId := "taskId_example" // string | id of task

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PlugApi.PlugPlugTypeTaskIdGet(context.Background(), plugType, taskId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PlugApi.PlugPlugTypeTaskIdGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}
```

### Path Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**plugType** | **string** | supported plug type | 
**taskId** | **string** | id of task | 

### Other Parameters

Other parameters are passed through a pointer to a apiPlugPlugTypeTaskIdGetRequest struct via the builder pattern


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------



### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)