All URIs are relative to http://localhost:7878
Method | HTTP request | Description |
---|---|---|
DeleteQueue | Delete /api/v3/queue/{id} | |
DeleteQueueBulk | Delete /api/v3/queue/bulk | |
GetQueue | Get /api/v3/queue |
DeleteQueue(ctx, id).RemoveFromClient(removeFromClient).Blocklist(blocklist).SkipRedownload(skipRedownload).ChangeCategory(changeCategory).Execute()
package main
import (
"context"
"fmt"
"os"
radarrClient "github.com/devopsarr/radarr-go/radarr"
)
func main() {
id := int32(56) // int32 |
removeFromClient := true // bool | (optional) (default to true)
blocklist := true // bool | (optional) (default to false)
skipRedownload := true // bool | (optional) (default to false)
changeCategory := true // bool | (optional) (default to false)
configuration := radarrClient.NewConfiguration()
apiClient := radarrClient.NewAPIClient(configuration)
r, err := apiClient.QueueAPI.DeleteQueue(context.Background(), id).RemoveFromClient(removeFromClient).Blocklist(blocklist).SkipRedownload(skipRedownload).ChangeCategory(changeCategory).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QueueAPI.DeleteQueue``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | int32 |
Other parameters are passed through a pointer to a apiDeleteQueueRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
removeFromClient | bool | | [default to true] blocklist | bool | | [default to false] skipRedownload | bool | | [default to false] changeCategory | bool | | [default to false]
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteQueueBulk(ctx).RemoveFromClient(removeFromClient).Blocklist(blocklist).SkipRedownload(skipRedownload).ChangeCategory(changeCategory).QueueBulkResource(queueBulkResource).Execute()
package main
import (
"context"
"fmt"
"os"
radarrClient "github.com/devopsarr/radarr-go/radarr"
)
func main() {
removeFromClient := true // bool | (optional) (default to true)
blocklist := true // bool | (optional) (default to false)
skipRedownload := true // bool | (optional) (default to false)
changeCategory := true // bool | (optional) (default to false)
queueBulkResource := *radarrClient.NewQueueBulkResource() // QueueBulkResource | (optional)
configuration := radarrClient.NewConfiguration()
apiClient := radarrClient.NewAPIClient(configuration)
r, err := apiClient.QueueAPI.DeleteQueueBulk(context.Background()).RemoveFromClient(removeFromClient).Blocklist(blocklist).SkipRedownload(skipRedownload).ChangeCategory(changeCategory).QueueBulkResource(queueBulkResource).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QueueAPI.DeleteQueueBulk``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Other parameters are passed through a pointer to a apiDeleteQueueBulkRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
removeFromClient | bool | [default to true] | |
blocklist | bool | [default to false] | |
skipRedownload | bool | [default to false] | |
changeCategory | bool | [default to false] | |
queueBulkResource | QueueBulkResource |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueResourcePagingResource GetQueue(ctx).Page(page).PageSize(pageSize).SortKey(sortKey).SortDirection(sortDirection).IncludeUnknownMovieItems(includeUnknownMovieItems).IncludeMovie(includeMovie).MovieIds(movieIds).Protocol(protocol).Languages(languages).Quality(quality).Status(status).Execute()
package main
import (
"context"
"fmt"
"os"
radarrClient "github.com/devopsarr/radarr-go/radarr"
)
func main() {
page := int32(56) // int32 | (optional) (default to 1)
pageSize := int32(56) // int32 | (optional) (default to 10)
sortKey := "sortKey_example" // string | (optional)
sortDirection := radarrClient.SortDirection("default") // SortDirection | (optional)
includeUnknownMovieItems := true // bool | (optional) (default to false)
includeMovie := true // bool | (optional) (default to false)
movieIds := []int32{int32(123)} // []int32 | (optional)
protocol := radarrClient.DownloadProtocol("unknown") // DownloadProtocol | (optional)
languages := []int32{int32(123)} // []int32 | (optional)
quality := []int32{int32(123)} // []int32 | (optional)
status := []radarrClient.QueueStatus{radarrClient.QueueStatus("unknown")} // []QueueStatus | (optional)
configuration := radarrClient.NewConfiguration()
apiClient := radarrClient.NewAPIClient(configuration)
resp, r, err := apiClient.QueueAPI.GetQueue(context.Background()).Page(page).PageSize(pageSize).SortKey(sortKey).SortDirection(sortDirection).IncludeUnknownMovieItems(includeUnknownMovieItems).IncludeMovie(includeMovie).MovieIds(movieIds).Protocol(protocol).Languages(languages).Quality(quality).Status(status).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QueueAPI.GetQueue``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetQueue`: QueueResourcePagingResource
fmt.Fprintf(os.Stdout, "Response from `QueueAPI.GetQueue`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiGetQueueRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
page | int32 | [default to 1] | |
pageSize | int32 | [default to 10] | |
sortKey | string | ||
sortDirection | SortDirection | ||
includeUnknownMovieItems | bool | [default to false] | |
includeMovie | bool | [default to false] | |
movieIds | []int32 | ||
protocol | DownloadProtocol | ||
languages | []int32 | ||
quality | []int32 | ||
status | []QueueStatus |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]