mirror of
https://github.com/GlueOps/autoglue.git
synced 2026-02-13 21:00:06 +01:00
feat: adding background jobs ui page and apis - requires user is_admin to be set to true
This commit is contained in:
@@ -4,14 +4,157 @@ All URIs are relative to *http://localhost:8080/api/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**CreateAnnotation**](AnnotationsAPI.md#CreateAnnotation) | **Post** /annotations | Create annotation (org scoped)
|
||||
[**DeleteAnnotation**](AnnotationsAPI.md#DeleteAnnotation) | **Delete** /annotations/{id} | Delete annotation (org scoped)
|
||||
[**GetAnnotation**](AnnotationsAPI.md#GetAnnotation) | **Get** /annotations/{id} | Get annotation by ID (org scoped)
|
||||
[**ListAnnotations**](AnnotationsAPI.md#ListAnnotations) | **Get** /annotations | List annotations (org scoped)
|
||||
[**UpdateAnnotation**](AnnotationsAPI.md#UpdateAnnotation) | **Patch** /annotations/{id} | Update annotation (org scoped)
|
||||
|
||||
|
||||
|
||||
## CreateAnnotation
|
||||
|
||||
> DtoAnnotationResponse CreateAnnotation(ctx).Body(body).XOrgID(xOrgID).Execute()
|
||||
|
||||
Create annotation (org scoped)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
body := *openapiclient.NewDtoCreateAnnotationRequest() // DtoCreateAnnotationRequest | Annotation payload
|
||||
xOrgID := "xOrgID_example" // string | Organization UUID (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.AnnotationsAPI.CreateAnnotation(context.Background()).Body(body).XOrgID(xOrgID).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `AnnotationsAPI.CreateAnnotation``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `CreateAnnotation`: DtoAnnotationResponse
|
||||
fmt.Fprintf(os.Stdout, "Response from `AnnotationsAPI.CreateAnnotation`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiCreateAnnotationRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**DtoCreateAnnotationRequest**](DtoCreateAnnotationRequest.md) | Annotation payload |
|
||||
**xOrgID** | **string** | Organization UUID |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoAnnotationResponse**](DtoAnnotationResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
|
||||
## DeleteAnnotation
|
||||
|
||||
> string DeleteAnnotation(ctx, id).XOrgID(xOrgID).Execute()
|
||||
|
||||
Delete annotation (org scoped)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
id := "id_example" // string | Annotation ID (UUID)
|
||||
xOrgID := "xOrgID_example" // string | Organization UUID (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.AnnotationsAPI.DeleteAnnotation(context.Background(), id).XOrgID(xOrgID).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `AnnotationsAPI.DeleteAnnotation``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `DeleteAnnotation`: string
|
||||
fmt.Fprintf(os.Stdout, "Response from `AnnotationsAPI.DeleteAnnotation`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string** | Annotation ID (UUID) |
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiDeleteAnnotationRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xOrgID** | **string** | Organization UUID |
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
|
||||
## GetAnnotation
|
||||
|
||||
> DtoAnnotationResponse GetAnnotation(ctx, id).XOrgID(xOrgID).Include(include).Execute()
|
||||
> DtoAnnotationResponse GetAnnotation(ctx, id).XOrgID(xOrgID).Execute()
|
||||
|
||||
Get annotation by ID (org scoped)
|
||||
|
||||
@@ -32,11 +175,10 @@ import (
|
||||
func main() {
|
||||
id := "id_example" // string | Annotation ID (UUID)
|
||||
xOrgID := "xOrgID_example" // string | Organization UUID (optional)
|
||||
include := "include_example" // string | Optional: node_pools (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.AnnotationsAPI.GetAnnotation(context.Background(), id).XOrgID(xOrgID).Include(include).Execute()
|
||||
resp, r, err := apiClient.AnnotationsAPI.GetAnnotation(context.Background(), id).XOrgID(xOrgID).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `AnnotationsAPI.GetAnnotation``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
@@ -63,7 +205,6 @@ Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xOrgID** | **string** | Organization UUID |
|
||||
**include** | **string** | Optional: node_pools |
|
||||
|
||||
### Return type
|
||||
|
||||
@@ -154,3 +295,77 @@ Name | Type | Description | Notes
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## UpdateAnnotation
|
||||
|
||||
> DtoAnnotationResponse UpdateAnnotation(ctx, id).Body(body).XOrgID(xOrgID).Execute()
|
||||
|
||||
Update annotation (org scoped)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
id := "id_example" // string | Annotation ID (UUID)
|
||||
body := *openapiclient.NewDtoUpdateAnnotationRequest() // DtoUpdateAnnotationRequest | Fields to update
|
||||
xOrgID := "xOrgID_example" // string | Organization UUID (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.AnnotationsAPI.UpdateAnnotation(context.Background(), id).Body(body).XOrgID(xOrgID).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `AnnotationsAPI.UpdateAnnotation``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `UpdateAnnotation`: DtoAnnotationResponse
|
||||
fmt.Fprintf(os.Stdout, "Response from `AnnotationsAPI.UpdateAnnotation`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string** | Annotation ID (UUID) |
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiUpdateAnnotationRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**body** | [**DtoUpdateAnnotationRequest**](DtoUpdateAnnotationRequest.md) | Fields to update |
|
||||
**xOrgID** | **string** | Organization UUID |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoAnnotationResponse**](DtoAnnotationResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
|
||||
354
sdk/go/docs/ArcherAdminAPI.md
Normal file
354
sdk/go/docs/ArcherAdminAPI.md
Normal file
@@ -0,0 +1,354 @@
|
||||
# \ArcherAdminAPI
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**AdminCancelArcherJob**](ArcherAdminAPI.md#AdminCancelArcherJob) | **Post** /admin/archer/jobs/{id}/cancel | Cancel an Archer job (admin)
|
||||
[**AdminEnqueueArcherJob**](ArcherAdminAPI.md#AdminEnqueueArcherJob) | **Post** /admin/archer/jobs | Enqueue a new Archer job (admin)
|
||||
[**AdminListArcherJobs**](ArcherAdminAPI.md#AdminListArcherJobs) | **Get** /admin/archer/jobs | List Archer jobs (admin)
|
||||
[**AdminListArcherQueues**](ArcherAdminAPI.md#AdminListArcherQueues) | **Get** /admin/archer/queues | List Archer queues (admin)
|
||||
[**AdminRetryArcherJob**](ArcherAdminAPI.md#AdminRetryArcherJob) | **Post** /admin/archer/jobs/{id}/retry | Retry a failed/canceled Archer job (admin)
|
||||
|
||||
|
||||
|
||||
## AdminCancelArcherJob
|
||||
|
||||
> DtoJob AdminCancelArcherJob(ctx, id).Execute()
|
||||
|
||||
Cancel an Archer job (admin)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
id := "id_example" // string | Job ID
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.ArcherAdminAPI.AdminCancelArcherJob(context.Background(), id).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `ArcherAdminAPI.AdminCancelArcherJob``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AdminCancelArcherJob`: DtoJob
|
||||
fmt.Fprintf(os.Stdout, "Response from `ArcherAdminAPI.AdminCancelArcherJob`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string** | Job ID |
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAdminCancelArcherJobRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoJob**](DtoJob.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
|
||||
## AdminEnqueueArcherJob
|
||||
|
||||
> DtoJob AdminEnqueueArcherJob(ctx).Body(body).Execute()
|
||||
|
||||
Enqueue a new Archer job (admin)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
body := map[string]interface{}{ ... } // map[string]interface{} | Job parameters
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.ArcherAdminAPI.AdminEnqueueArcherJob(context.Background()).Body(body).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `ArcherAdminAPI.AdminEnqueueArcherJob``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AdminEnqueueArcherJob`: DtoJob
|
||||
fmt.Fprintf(os.Stdout, "Response from `ArcherAdminAPI.AdminEnqueueArcherJob`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAdminEnqueueArcherJobRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | **map[string]interface{}** | Job parameters |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoJob**](DtoJob.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
|
||||
## AdminListArcherJobs
|
||||
|
||||
> DtoPageJob AdminListArcherJobs(ctx).Status(status).Queue(queue).Q(q).Page(page).PageSize(pageSize).Execute()
|
||||
|
||||
List Archer jobs (admin)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
status := "status_example" // string | Filter by status (optional)
|
||||
queue := "queue_example" // string | Filter by queue name / worker name (optional)
|
||||
q := "q_example" // string | Free-text search (optional)
|
||||
page := int32(56) // int32 | Page number (optional) (default to 1)
|
||||
pageSize := int32(56) // int32 | Items per page (optional) (default to 25)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.ArcherAdminAPI.AdminListArcherJobs(context.Background()).Status(status).Queue(queue).Q(q).Page(page).PageSize(pageSize).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `ArcherAdminAPI.AdminListArcherJobs``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AdminListArcherJobs`: DtoPageJob
|
||||
fmt.Fprintf(os.Stdout, "Response from `ArcherAdminAPI.AdminListArcherJobs`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAdminListArcherJobsRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**status** | **string** | Filter by status |
|
||||
**queue** | **string** | Filter by queue name / worker name |
|
||||
**q** | **string** | Free-text search |
|
||||
**page** | **int32** | Page number | [default to 1]
|
||||
**pageSize** | **int32** | Items per page | [default to 25]
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoPageJob**](DtoPageJob.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
|
||||
## AdminListArcherQueues
|
||||
|
||||
> []DtoQueueInfo AdminListArcherQueues(ctx).Execute()
|
||||
|
||||
List Archer queues (admin)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.ArcherAdminAPI.AdminListArcherQueues(context.Background()).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `ArcherAdminAPI.AdminListArcherQueues``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AdminListArcherQueues`: []DtoQueueInfo
|
||||
fmt.Fprintf(os.Stdout, "Response from `ArcherAdminAPI.AdminListArcherQueues`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAdminListArcherQueuesRequest struct via the builder pattern
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]DtoQueueInfo**](DtoQueueInfo.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
|
||||
## AdminRetryArcherJob
|
||||
|
||||
> DtoJob AdminRetryArcherJob(ctx, id).Execute()
|
||||
|
||||
Retry a failed/canceled Archer job (admin)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
id := "id_example" // string | Job ID
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.ArcherAdminAPI.AdminRetryArcherJob(context.Background(), id).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `ArcherAdminAPI.AdminRetryArcherJob``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AdminRetryArcherJob`: DtoJob
|
||||
fmt.Fprintf(os.Stdout, "Response from `ArcherAdminAPI.AdminRetryArcherJob`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string** | Job ID |
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAdminRetryArcherJobRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoJob**](DtoJob.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
82
sdk/go/docs/DtoCreateAnnotationRequest.md
Normal file
82
sdk/go/docs/DtoCreateAnnotationRequest.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# DtoCreateAnnotationRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Key** | Pointer to **string** | | [optional]
|
||||
**Value** | Pointer to **string** | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewDtoCreateAnnotationRequest
|
||||
|
||||
`func NewDtoCreateAnnotationRequest() *DtoCreateAnnotationRequest`
|
||||
|
||||
NewDtoCreateAnnotationRequest instantiates a new DtoCreateAnnotationRequest object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewDtoCreateAnnotationRequestWithDefaults
|
||||
|
||||
`func NewDtoCreateAnnotationRequestWithDefaults() *DtoCreateAnnotationRequest`
|
||||
|
||||
NewDtoCreateAnnotationRequestWithDefaults instantiates a new DtoCreateAnnotationRequest object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetKey
|
||||
|
||||
`func (o *DtoCreateAnnotationRequest) GetKey() string`
|
||||
|
||||
GetKey returns the Key field if non-nil, zero value otherwise.
|
||||
|
||||
### GetKeyOk
|
||||
|
||||
`func (o *DtoCreateAnnotationRequest) GetKeyOk() (*string, bool)`
|
||||
|
||||
GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetKey
|
||||
|
||||
`func (o *DtoCreateAnnotationRequest) SetKey(v string)`
|
||||
|
||||
SetKey sets Key field to given value.
|
||||
|
||||
### HasKey
|
||||
|
||||
`func (o *DtoCreateAnnotationRequest) HasKey() bool`
|
||||
|
||||
HasKey returns a boolean if a field has been set.
|
||||
|
||||
### GetValue
|
||||
|
||||
`func (o *DtoCreateAnnotationRequest) GetValue() string`
|
||||
|
||||
GetValue returns the Value field if non-nil, zero value otherwise.
|
||||
|
||||
### GetValueOk
|
||||
|
||||
`func (o *DtoCreateAnnotationRequest) GetValueOk() (*string, bool)`
|
||||
|
||||
GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetValue
|
||||
|
||||
`func (o *DtoCreateAnnotationRequest) SetValue(v string)`
|
||||
|
||||
SetValue sets Value field to given value.
|
||||
|
||||
### HasValue
|
||||
|
||||
`func (o *DtoCreateAnnotationRequest) HasValue() bool`
|
||||
|
||||
HasValue returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
316
sdk/go/docs/DtoJob.md
Normal file
316
sdk/go/docs/DtoJob.md
Normal file
@@ -0,0 +1,316 @@
|
||||
# DtoJob
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Attempts** | Pointer to **int32** | example: 0 | [optional]
|
||||
**CreatedAt** | Pointer to **string** | example: 2025-11-04T09:30:00Z | [optional]
|
||||
**Id** | Pointer to **string** | example: 01HF7SZK8Z8WG1M3J7S2Z8M2N6 | [optional]
|
||||
**LastError** | Pointer to **string** | example: dial tcp: i/o timeout | [optional]
|
||||
**MaxAttempts** | Pointer to **int32** | example: 3 | [optional]
|
||||
**Payload** | Pointer to **map[string]interface{}** | arbitrary JSON payload | [optional]
|
||||
**Queue** | Pointer to **string** | example: default | [optional]
|
||||
**RunAt** | Pointer to **string** | example: 2025-11-05T08:00:00Z | [optional]
|
||||
**Status** | Pointer to [**DtoJobStatus**](DtoJobStatus.md) | enum: queued,running,succeeded,failed,canceled,retrying,scheduled example: queued | [optional]
|
||||
**Type** | Pointer to **string** | example: email.send | [optional]
|
||||
**UpdatedAt** | Pointer to **string** | example: 2025-11-04T09:31:00Z | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewDtoJob
|
||||
|
||||
`func NewDtoJob() *DtoJob`
|
||||
|
||||
NewDtoJob instantiates a new DtoJob object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewDtoJobWithDefaults
|
||||
|
||||
`func NewDtoJobWithDefaults() *DtoJob`
|
||||
|
||||
NewDtoJobWithDefaults instantiates a new DtoJob object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetAttempts
|
||||
|
||||
`func (o *DtoJob) GetAttempts() int32`
|
||||
|
||||
GetAttempts returns the Attempts field if non-nil, zero value otherwise.
|
||||
|
||||
### GetAttemptsOk
|
||||
|
||||
`func (o *DtoJob) GetAttemptsOk() (*int32, bool)`
|
||||
|
||||
GetAttemptsOk returns a tuple with the Attempts field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetAttempts
|
||||
|
||||
`func (o *DtoJob) SetAttempts(v int32)`
|
||||
|
||||
SetAttempts sets Attempts field to given value.
|
||||
|
||||
### HasAttempts
|
||||
|
||||
`func (o *DtoJob) HasAttempts() bool`
|
||||
|
||||
HasAttempts returns a boolean if a field has been set.
|
||||
|
||||
### GetCreatedAt
|
||||
|
||||
`func (o *DtoJob) GetCreatedAt() string`
|
||||
|
||||
GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise.
|
||||
|
||||
### GetCreatedAtOk
|
||||
|
||||
`func (o *DtoJob) GetCreatedAtOk() (*string, bool)`
|
||||
|
||||
GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetCreatedAt
|
||||
|
||||
`func (o *DtoJob) SetCreatedAt(v string)`
|
||||
|
||||
SetCreatedAt sets CreatedAt field to given value.
|
||||
|
||||
### HasCreatedAt
|
||||
|
||||
`func (o *DtoJob) HasCreatedAt() bool`
|
||||
|
||||
HasCreatedAt returns a boolean if a field has been set.
|
||||
|
||||
### GetId
|
||||
|
||||
`func (o *DtoJob) GetId() string`
|
||||
|
||||
GetId returns the Id field if non-nil, zero value otherwise.
|
||||
|
||||
### GetIdOk
|
||||
|
||||
`func (o *DtoJob) GetIdOk() (*string, bool)`
|
||||
|
||||
GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetId
|
||||
|
||||
`func (o *DtoJob) SetId(v string)`
|
||||
|
||||
SetId sets Id field to given value.
|
||||
|
||||
### HasId
|
||||
|
||||
`func (o *DtoJob) HasId() bool`
|
||||
|
||||
HasId returns a boolean if a field has been set.
|
||||
|
||||
### GetLastError
|
||||
|
||||
`func (o *DtoJob) GetLastError() string`
|
||||
|
||||
GetLastError returns the LastError field if non-nil, zero value otherwise.
|
||||
|
||||
### GetLastErrorOk
|
||||
|
||||
`func (o *DtoJob) GetLastErrorOk() (*string, bool)`
|
||||
|
||||
GetLastErrorOk returns a tuple with the LastError field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetLastError
|
||||
|
||||
`func (o *DtoJob) SetLastError(v string)`
|
||||
|
||||
SetLastError sets LastError field to given value.
|
||||
|
||||
### HasLastError
|
||||
|
||||
`func (o *DtoJob) HasLastError() bool`
|
||||
|
||||
HasLastError returns a boolean if a field has been set.
|
||||
|
||||
### GetMaxAttempts
|
||||
|
||||
`func (o *DtoJob) GetMaxAttempts() int32`
|
||||
|
||||
GetMaxAttempts returns the MaxAttempts field if non-nil, zero value otherwise.
|
||||
|
||||
### GetMaxAttemptsOk
|
||||
|
||||
`func (o *DtoJob) GetMaxAttemptsOk() (*int32, bool)`
|
||||
|
||||
GetMaxAttemptsOk returns a tuple with the MaxAttempts field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetMaxAttempts
|
||||
|
||||
`func (o *DtoJob) SetMaxAttempts(v int32)`
|
||||
|
||||
SetMaxAttempts sets MaxAttempts field to given value.
|
||||
|
||||
### HasMaxAttempts
|
||||
|
||||
`func (o *DtoJob) HasMaxAttempts() bool`
|
||||
|
||||
HasMaxAttempts returns a boolean if a field has been set.
|
||||
|
||||
### GetPayload
|
||||
|
||||
`func (o *DtoJob) GetPayload() map[string]interface{}`
|
||||
|
||||
GetPayload returns the Payload field if non-nil, zero value otherwise.
|
||||
|
||||
### GetPayloadOk
|
||||
|
||||
`func (o *DtoJob) GetPayloadOk() (*map[string]interface{}, bool)`
|
||||
|
||||
GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetPayload
|
||||
|
||||
`func (o *DtoJob) SetPayload(v map[string]interface{})`
|
||||
|
||||
SetPayload sets Payload field to given value.
|
||||
|
||||
### HasPayload
|
||||
|
||||
`func (o *DtoJob) HasPayload() bool`
|
||||
|
||||
HasPayload returns a boolean if a field has been set.
|
||||
|
||||
### GetQueue
|
||||
|
||||
`func (o *DtoJob) GetQueue() string`
|
||||
|
||||
GetQueue returns the Queue field if non-nil, zero value otherwise.
|
||||
|
||||
### GetQueueOk
|
||||
|
||||
`func (o *DtoJob) GetQueueOk() (*string, bool)`
|
||||
|
||||
GetQueueOk returns a tuple with the Queue field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetQueue
|
||||
|
||||
`func (o *DtoJob) SetQueue(v string)`
|
||||
|
||||
SetQueue sets Queue field to given value.
|
||||
|
||||
### HasQueue
|
||||
|
||||
`func (o *DtoJob) HasQueue() bool`
|
||||
|
||||
HasQueue returns a boolean if a field has been set.
|
||||
|
||||
### GetRunAt
|
||||
|
||||
`func (o *DtoJob) GetRunAt() string`
|
||||
|
||||
GetRunAt returns the RunAt field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRunAtOk
|
||||
|
||||
`func (o *DtoJob) GetRunAtOk() (*string, bool)`
|
||||
|
||||
GetRunAtOk returns a tuple with the RunAt field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRunAt
|
||||
|
||||
`func (o *DtoJob) SetRunAt(v string)`
|
||||
|
||||
SetRunAt sets RunAt field to given value.
|
||||
|
||||
### HasRunAt
|
||||
|
||||
`func (o *DtoJob) HasRunAt() bool`
|
||||
|
||||
HasRunAt returns a boolean if a field has been set.
|
||||
|
||||
### GetStatus
|
||||
|
||||
`func (o *DtoJob) GetStatus() DtoJobStatus`
|
||||
|
||||
GetStatus returns the Status field if non-nil, zero value otherwise.
|
||||
|
||||
### GetStatusOk
|
||||
|
||||
`func (o *DtoJob) GetStatusOk() (*DtoJobStatus, bool)`
|
||||
|
||||
GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetStatus
|
||||
|
||||
`func (o *DtoJob) SetStatus(v DtoJobStatus)`
|
||||
|
||||
SetStatus sets Status field to given value.
|
||||
|
||||
### HasStatus
|
||||
|
||||
`func (o *DtoJob) HasStatus() bool`
|
||||
|
||||
HasStatus returns a boolean if a field has been set.
|
||||
|
||||
### GetType
|
||||
|
||||
`func (o *DtoJob) GetType() string`
|
||||
|
||||
GetType returns the Type field if non-nil, zero value otherwise.
|
||||
|
||||
### GetTypeOk
|
||||
|
||||
`func (o *DtoJob) GetTypeOk() (*string, bool)`
|
||||
|
||||
GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetType
|
||||
|
||||
`func (o *DtoJob) SetType(v string)`
|
||||
|
||||
SetType sets Type field to given value.
|
||||
|
||||
### HasType
|
||||
|
||||
`func (o *DtoJob) HasType() bool`
|
||||
|
||||
HasType returns a boolean if a field has been set.
|
||||
|
||||
### GetUpdatedAt
|
||||
|
||||
`func (o *DtoJob) GetUpdatedAt() string`
|
||||
|
||||
GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise.
|
||||
|
||||
### GetUpdatedAtOk
|
||||
|
||||
`func (o *DtoJob) GetUpdatedAtOk() (*string, bool)`
|
||||
|
||||
GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetUpdatedAt
|
||||
|
||||
`func (o *DtoJob) SetUpdatedAt(v string)`
|
||||
|
||||
SetUpdatedAt sets UpdatedAt field to given value.
|
||||
|
||||
### HasUpdatedAt
|
||||
|
||||
`func (o *DtoJob) HasUpdatedAt() bool`
|
||||
|
||||
HasUpdatedAt returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
23
sdk/go/docs/DtoJobStatus.md
Normal file
23
sdk/go/docs/DtoJobStatus.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# DtoJobStatus
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `StatusQueued` (value: `"queued"`)
|
||||
|
||||
* `StatusRunning` (value: `"running"`)
|
||||
|
||||
* `StatusSucceeded` (value: `"succeeded"`)
|
||||
|
||||
* `StatusFailed` (value: `"failed"`)
|
||||
|
||||
* `StatusCanceled` (value: `"canceled"`)
|
||||
|
||||
* `StatusRetrying` (value: `"retrying"`)
|
||||
|
||||
* `StatusScheduled` (value: `"scheduled"`)
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
134
sdk/go/docs/DtoPageJob.md
Normal file
134
sdk/go/docs/DtoPageJob.md
Normal file
@@ -0,0 +1,134 @@
|
||||
# DtoPageJob
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Items** | Pointer to [**[]DtoJob**](DtoJob.md) | | [optional]
|
||||
**Page** | Pointer to **int32** | example: 1 | [optional]
|
||||
**PageSize** | Pointer to **int32** | example: 25 | [optional]
|
||||
**Total** | Pointer to **int32** | example: 120 | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewDtoPageJob
|
||||
|
||||
`func NewDtoPageJob() *DtoPageJob`
|
||||
|
||||
NewDtoPageJob instantiates a new DtoPageJob object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewDtoPageJobWithDefaults
|
||||
|
||||
`func NewDtoPageJobWithDefaults() *DtoPageJob`
|
||||
|
||||
NewDtoPageJobWithDefaults instantiates a new DtoPageJob object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetItems
|
||||
|
||||
`func (o *DtoPageJob) GetItems() []DtoJob`
|
||||
|
||||
GetItems returns the Items field if non-nil, zero value otherwise.
|
||||
|
||||
### GetItemsOk
|
||||
|
||||
`func (o *DtoPageJob) GetItemsOk() (*[]DtoJob, bool)`
|
||||
|
||||
GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetItems
|
||||
|
||||
`func (o *DtoPageJob) SetItems(v []DtoJob)`
|
||||
|
||||
SetItems sets Items field to given value.
|
||||
|
||||
### HasItems
|
||||
|
||||
`func (o *DtoPageJob) HasItems() bool`
|
||||
|
||||
HasItems returns a boolean if a field has been set.
|
||||
|
||||
### GetPage
|
||||
|
||||
`func (o *DtoPageJob) GetPage() int32`
|
||||
|
||||
GetPage returns the Page field if non-nil, zero value otherwise.
|
||||
|
||||
### GetPageOk
|
||||
|
||||
`func (o *DtoPageJob) GetPageOk() (*int32, bool)`
|
||||
|
||||
GetPageOk returns a tuple with the Page field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetPage
|
||||
|
||||
`func (o *DtoPageJob) SetPage(v int32)`
|
||||
|
||||
SetPage sets Page field to given value.
|
||||
|
||||
### HasPage
|
||||
|
||||
`func (o *DtoPageJob) HasPage() bool`
|
||||
|
||||
HasPage returns a boolean if a field has been set.
|
||||
|
||||
### GetPageSize
|
||||
|
||||
`func (o *DtoPageJob) GetPageSize() int32`
|
||||
|
||||
GetPageSize returns the PageSize field if non-nil, zero value otherwise.
|
||||
|
||||
### GetPageSizeOk
|
||||
|
||||
`func (o *DtoPageJob) GetPageSizeOk() (*int32, bool)`
|
||||
|
||||
GetPageSizeOk returns a tuple with the PageSize field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetPageSize
|
||||
|
||||
`func (o *DtoPageJob) SetPageSize(v int32)`
|
||||
|
||||
SetPageSize sets PageSize field to given value.
|
||||
|
||||
### HasPageSize
|
||||
|
||||
`func (o *DtoPageJob) HasPageSize() bool`
|
||||
|
||||
HasPageSize returns a boolean if a field has been set.
|
||||
|
||||
### GetTotal
|
||||
|
||||
`func (o *DtoPageJob) GetTotal() int32`
|
||||
|
||||
GetTotal returns the Total field if non-nil, zero value otherwise.
|
||||
|
||||
### GetTotalOk
|
||||
|
||||
`func (o *DtoPageJob) GetTotalOk() (*int32, bool)`
|
||||
|
||||
GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetTotal
|
||||
|
||||
`func (o *DtoPageJob) SetTotal(v int32)`
|
||||
|
||||
SetTotal sets Total field to given value.
|
||||
|
||||
### HasTotal
|
||||
|
||||
`func (o *DtoPageJob) HasTotal() bool`
|
||||
|
||||
HasTotal returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
160
sdk/go/docs/DtoQueueInfo.md
Normal file
160
sdk/go/docs/DtoQueueInfo.md
Normal file
@@ -0,0 +1,160 @@
|
||||
# DtoQueueInfo
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Failed** | Pointer to **int32** | example: 5 | [optional]
|
||||
**Name** | Pointer to **string** | example: default | [optional]
|
||||
**Pending** | Pointer to **int32** | example: 42 | [optional]
|
||||
**Running** | Pointer to **int32** | example: 3 | [optional]
|
||||
**Scheduled** | Pointer to **int32** | example: 7 | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewDtoQueueInfo
|
||||
|
||||
`func NewDtoQueueInfo() *DtoQueueInfo`
|
||||
|
||||
NewDtoQueueInfo instantiates a new DtoQueueInfo object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewDtoQueueInfoWithDefaults
|
||||
|
||||
`func NewDtoQueueInfoWithDefaults() *DtoQueueInfo`
|
||||
|
||||
NewDtoQueueInfoWithDefaults instantiates a new DtoQueueInfo object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetFailed
|
||||
|
||||
`func (o *DtoQueueInfo) GetFailed() int32`
|
||||
|
||||
GetFailed returns the Failed field if non-nil, zero value otherwise.
|
||||
|
||||
### GetFailedOk
|
||||
|
||||
`func (o *DtoQueueInfo) GetFailedOk() (*int32, bool)`
|
||||
|
||||
GetFailedOk returns a tuple with the Failed field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetFailed
|
||||
|
||||
`func (o *DtoQueueInfo) SetFailed(v int32)`
|
||||
|
||||
SetFailed sets Failed field to given value.
|
||||
|
||||
### HasFailed
|
||||
|
||||
`func (o *DtoQueueInfo) HasFailed() bool`
|
||||
|
||||
HasFailed returns a boolean if a field has been set.
|
||||
|
||||
### GetName
|
||||
|
||||
`func (o *DtoQueueInfo) GetName() string`
|
||||
|
||||
GetName returns the Name field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNameOk
|
||||
|
||||
`func (o *DtoQueueInfo) GetNameOk() (*string, bool)`
|
||||
|
||||
GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetName
|
||||
|
||||
`func (o *DtoQueueInfo) SetName(v string)`
|
||||
|
||||
SetName sets Name field to given value.
|
||||
|
||||
### HasName
|
||||
|
||||
`func (o *DtoQueueInfo) HasName() bool`
|
||||
|
||||
HasName returns a boolean if a field has been set.
|
||||
|
||||
### GetPending
|
||||
|
||||
`func (o *DtoQueueInfo) GetPending() int32`
|
||||
|
||||
GetPending returns the Pending field if non-nil, zero value otherwise.
|
||||
|
||||
### GetPendingOk
|
||||
|
||||
`func (o *DtoQueueInfo) GetPendingOk() (*int32, bool)`
|
||||
|
||||
GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetPending
|
||||
|
||||
`func (o *DtoQueueInfo) SetPending(v int32)`
|
||||
|
||||
SetPending sets Pending field to given value.
|
||||
|
||||
### HasPending
|
||||
|
||||
`func (o *DtoQueueInfo) HasPending() bool`
|
||||
|
||||
HasPending returns a boolean if a field has been set.
|
||||
|
||||
### GetRunning
|
||||
|
||||
`func (o *DtoQueueInfo) GetRunning() int32`
|
||||
|
||||
GetRunning returns the Running field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRunningOk
|
||||
|
||||
`func (o *DtoQueueInfo) GetRunningOk() (*int32, bool)`
|
||||
|
||||
GetRunningOk returns a tuple with the Running field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRunning
|
||||
|
||||
`func (o *DtoQueueInfo) SetRunning(v int32)`
|
||||
|
||||
SetRunning sets Running field to given value.
|
||||
|
||||
### HasRunning
|
||||
|
||||
`func (o *DtoQueueInfo) HasRunning() bool`
|
||||
|
||||
HasRunning returns a boolean if a field has been set.
|
||||
|
||||
### GetScheduled
|
||||
|
||||
`func (o *DtoQueueInfo) GetScheduled() int32`
|
||||
|
||||
GetScheduled returns the Scheduled field if non-nil, zero value otherwise.
|
||||
|
||||
### GetScheduledOk
|
||||
|
||||
`func (o *DtoQueueInfo) GetScheduledOk() (*int32, bool)`
|
||||
|
||||
GetScheduledOk returns a tuple with the Scheduled field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetScheduled
|
||||
|
||||
`func (o *DtoQueueInfo) SetScheduled(v int32)`
|
||||
|
||||
SetScheduled sets Scheduled field to given value.
|
||||
|
||||
### HasScheduled
|
||||
|
||||
`func (o *DtoQueueInfo) HasScheduled() bool`
|
||||
|
||||
HasScheduled returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
82
sdk/go/docs/DtoUpdateAnnotationRequest.md
Normal file
82
sdk/go/docs/DtoUpdateAnnotationRequest.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# DtoUpdateAnnotationRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Key** | Pointer to **string** | | [optional]
|
||||
**Value** | Pointer to **string** | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewDtoUpdateAnnotationRequest
|
||||
|
||||
`func NewDtoUpdateAnnotationRequest() *DtoUpdateAnnotationRequest`
|
||||
|
||||
NewDtoUpdateAnnotationRequest instantiates a new DtoUpdateAnnotationRequest object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewDtoUpdateAnnotationRequestWithDefaults
|
||||
|
||||
`func NewDtoUpdateAnnotationRequestWithDefaults() *DtoUpdateAnnotationRequest`
|
||||
|
||||
NewDtoUpdateAnnotationRequestWithDefaults instantiates a new DtoUpdateAnnotationRequest object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetKey
|
||||
|
||||
`func (o *DtoUpdateAnnotationRequest) GetKey() string`
|
||||
|
||||
GetKey returns the Key field if non-nil, zero value otherwise.
|
||||
|
||||
### GetKeyOk
|
||||
|
||||
`func (o *DtoUpdateAnnotationRequest) GetKeyOk() (*string, bool)`
|
||||
|
||||
GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetKey
|
||||
|
||||
`func (o *DtoUpdateAnnotationRequest) SetKey(v string)`
|
||||
|
||||
SetKey sets Key field to given value.
|
||||
|
||||
### HasKey
|
||||
|
||||
`func (o *DtoUpdateAnnotationRequest) HasKey() bool`
|
||||
|
||||
HasKey returns a boolean if a field has been set.
|
||||
|
||||
### GetValue
|
||||
|
||||
`func (o *DtoUpdateAnnotationRequest) GetValue() string`
|
||||
|
||||
GetValue returns the Value field if non-nil, zero value otherwise.
|
||||
|
||||
### GetValueOk
|
||||
|
||||
`func (o *DtoUpdateAnnotationRequest) GetValueOk() (*string, bool)`
|
||||
|
||||
GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetValue
|
||||
|
||||
`func (o *DtoUpdateAnnotationRequest) SetValue(v string)`
|
||||
|
||||
SetValue sets Value field to given value.
|
||||
|
||||
### HasValue
|
||||
|
||||
`func (o *DtoUpdateAnnotationRequest) HasValue() bool`
|
||||
|
||||
HasValue returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
||||
**DisplayName** | Pointer to **string** | | [optional]
|
||||
**Emails** | Pointer to [**[]ModelsUserEmail**](ModelsUserEmail.md) | | [optional]
|
||||
**Id** | Pointer to **string** | example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 | [optional]
|
||||
**IsAdmin** | Pointer to **bool** | | [optional]
|
||||
**IsDisabled** | Pointer to **bool** | | [optional]
|
||||
**Organizations** | Pointer to [**[]ModelsOrganization**](ModelsOrganization.md) | | [optional]
|
||||
**PrimaryEmail** | Pointer to **string** | | [optional]
|
||||
@@ -158,6 +159,31 @@ SetId sets Id field to given value.
|
||||
|
||||
HasId returns a boolean if a field has been set.
|
||||
|
||||
### GetIsAdmin
|
||||
|
||||
`func (o *HandlersMeResponse) GetIsAdmin() bool`
|
||||
|
||||
GetIsAdmin returns the IsAdmin field if non-nil, zero value otherwise.
|
||||
|
||||
### GetIsAdminOk
|
||||
|
||||
`func (o *HandlersMeResponse) GetIsAdminOk() (*bool, bool)`
|
||||
|
||||
GetIsAdminOk returns a tuple with the IsAdmin field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetIsAdmin
|
||||
|
||||
`func (o *HandlersMeResponse) SetIsAdmin(v bool)`
|
||||
|
||||
SetIsAdmin sets IsAdmin field to given value.
|
||||
|
||||
### HasIsAdmin
|
||||
|
||||
`func (o *HandlersMeResponse) HasIsAdmin() bool`
|
||||
|
||||
HasIsAdmin returns a boolean if a field has been set.
|
||||
|
||||
### GetIsDisabled
|
||||
|
||||
`func (o *HandlersMeResponse) GetIsDisabled() bool`
|
||||
|
||||
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
||||
**CreatedAt** | Pointer to **time.Time** | | [optional]
|
||||
**DisplayName** | Pointer to **string** | | [optional]
|
||||
**Id** | Pointer to **string** | example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 | [optional]
|
||||
**IsAdmin** | Pointer to **bool** | | [optional]
|
||||
**IsDisabled** | Pointer to **bool** | | [optional]
|
||||
**PrimaryEmail** | Pointer to **string** | | [optional]
|
||||
**UpdatedAt** | Pointer to **time.Time** | | [optional]
|
||||
@@ -131,6 +132,31 @@ SetId sets Id field to given value.
|
||||
|
||||
HasId returns a boolean if a field has been set.
|
||||
|
||||
### GetIsAdmin
|
||||
|
||||
`func (o *ModelsUser) GetIsAdmin() bool`
|
||||
|
||||
GetIsAdmin returns the IsAdmin field if non-nil, zero value otherwise.
|
||||
|
||||
### GetIsAdminOk
|
||||
|
||||
`func (o *ModelsUser) GetIsAdminOk() (*bool, bool)`
|
||||
|
||||
GetIsAdminOk returns a tuple with the IsAdmin field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetIsAdmin
|
||||
|
||||
`func (o *ModelsUser) SetIsAdmin(v bool)`
|
||||
|
||||
SetIsAdmin sets IsAdmin field to given value.
|
||||
|
||||
### HasIsAdmin
|
||||
|
||||
`func (o *ModelsUser) HasIsAdmin() bool`
|
||||
|
||||
HasIsAdmin returns a boolean if a field has been set.
|
||||
|
||||
### GetIsDisabled
|
||||
|
||||
`func (o *ModelsUser) GetIsDisabled() bool`
|
||||
|
||||
Reference in New Issue
Block a user