\OutputsApi

All URIs are relative to https://api.lab5e.com

Method	HTTP request	Description
CreateOutput	Post /span/collections/{collectionId}/outputs	Create output
DeleteOutput	Delete /span/collections/{collectionId}/outputs/{outputId}	Delete output
ListOutputs	Get /span/collections/{collectionId}/outputs	List outputs
Logs	Get /span/collections/{collectionId}/outputs/{outputId}/logs	Output logs
RetrieveOutput	Get /span/collections/{collectionId}/outputs/{outputId}	Retrieve output
RetrieveOutputStats	Get /span/collections/{collectionId}/outputs/{outputId}/stats	Retrieve output statistics
Status	Get /span/collections/{collectionId}/outputs/{outputId}/status	Output status
UpdateOutput	Patch /span/collections/{existingCollectionId}/outputs/{outputId}	Update output

CreateOutput

Output CreateOutput(ctx, collectionId).Body(body).Execute()

Create output

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    body := *openapiclient.NewCreateOutputBody() // CreateOutputBody | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OutputsApi.CreateOutput(context.Background(), collectionId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OutputsApi.CreateOutput``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateOutput`: Output
    fmt.Fprintf(os.Stdout, "Response from `OutputsApi.CreateOutput`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string

Other Parameters

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

Name	Type	Description	Notes

body | CreateOutputBody | |

Return type

Output

Authorization

APIToken

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteOutput

Output DeleteOutput(ctx, collectionId, outputId).Execute()

Delete output

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    outputId := "outputId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OutputsApi.DeleteOutput(context.Background(), collectionId, outputId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OutputsApi.DeleteOutput``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteOutput`: Output
    fmt.Fprintf(os.Stdout, "Response from `OutputsApi.DeleteOutput`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string
outputId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

Output

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListOutputs

ListOutputResponse ListOutputs(ctx, collectionId).Execute()

List outputs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OutputsApi.ListOutputs(context.Background(), collectionId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OutputsApi.ListOutputs``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListOutputs`: ListOutputResponse
    fmt.Fprintf(os.Stdout, "Response from `OutputsApi.ListOutputs`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

ListOutputResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Logs

OutputLogResponse Logs(ctx, collectionId, outputId).Execute()

Output logs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    outputId := "outputId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OutputsApi.Logs(context.Background(), collectionId, outputId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OutputsApi.Logs``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Logs`: OutputLogResponse
    fmt.Fprintf(os.Stdout, "Response from `OutputsApi.Logs`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string
outputId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

OutputLogResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrieveOutput

Output RetrieveOutput(ctx, collectionId, outputId).Execute()

Retrieve output

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    outputId := "outputId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OutputsApi.RetrieveOutput(context.Background(), collectionId, outputId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OutputsApi.RetrieveOutput``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RetrieveOutput`: Output
    fmt.Fprintf(os.Stdout, "Response from `OutputsApi.RetrieveOutput`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string
outputId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

Output

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrieveOutputStats

OutputStats RetrieveOutputStats(ctx, collectionId, outputId).Execute()

Retrieve output statistics

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    outputId := "outputId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OutputsApi.RetrieveOutputStats(context.Background(), collectionId, outputId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OutputsApi.RetrieveOutputStats``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RetrieveOutputStats`: OutputStats
    fmt.Fprintf(os.Stdout, "Response from `OutputsApi.RetrieveOutputStats`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string
outputId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

OutputStats

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Status

OutputStatusResponse Status(ctx, collectionId, outputId).Execute()

Output status

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | 
    outputId := "outputId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OutputsApi.Status(context.Background(), collectionId, outputId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OutputsApi.Status``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Status`: OutputStatusResponse
    fmt.Fprintf(os.Stdout, "Response from `OutputsApi.Status`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string
outputId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

OutputStatusResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateOutput

Output UpdateOutput(ctx, existingCollectionId, outputId).Body(body).Execute()

Update output

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    existingCollectionId := "existingCollectionId_example" // string | 
    outputId := "outputId_example" // string | 
    body := *openapiclient.NewUpdateOutputBody() // UpdateOutputBody | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OutputsApi.UpdateOutput(context.Background(), existingCollectionId, outputId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OutputsApi.UpdateOutput``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateOutput`: Output
    fmt.Fprintf(os.Stdout, "Response from `OutputsApi.UpdateOutput`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
existingCollectionId	string
outputId	string

Other Parameters

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

Name	Type	Description	Notes

body | UpdateOutputBody | |

Return type

Output

Authorization

APIToken

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

OutputsApi.md

Latest commit

History

OutputsApi.md

File metadata and controls

\OutputsApi

CreateOutput

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteOutput

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListOutputs

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Logs

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RetrieveOutput

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RetrieveOutputStats

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Status

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateOutput

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers