queueposition.go

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

package nvidiacloudfunctions

import (
	"context"
	"errors"
	"fmt"
	"net/http"

	"github.com/brevdev/nvcf-go/internal/apijson"
	"github.com/brevdev/nvcf-go/internal/requestconfig"
	"github.com/brevdev/nvcf-go/option"
)

// QueuePositionService contains methods and other services that help with
// interacting with the nvidia-cloud-functions API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewQueuePositionService] method instead.
type QueuePositionService struct {
	Options []option.RequestOption
}

// NewQueuePositionService generates a new service that applies the given options
// to each request. These options are applied after the parent client's options (if
// there is one), and before any request-specific options.
func NewQueuePositionService(opts ...option.RequestOption) (r *QueuePositionService) {
	r = &QueuePositionService{}
	r.Options = opts
	return
}

// Using the specified function invocation request id, returns the estimated
// position of the corresponding message up to 1000 in the queue. Requires a bearer
// token or an api-key with 'queue_details' scope in the HTTP Authorization header.
func (r *QueuePositionService) Get(ctx context.Context, requestID string, opts ...option.RequestOption) (res *GetPositionInQueueResponse, err error) {
	opts = append(r.Options[:], opts...)
	if requestID == "" {
		err = errors.New("missing required requestId parameter")
		return
	}
	path := fmt.Sprintf("v2/nvcf/queues/%s/position", requestID)
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
	return
}

// Request position in queue for invocation request
type GetPositionInQueueResponse struct {
	// Function id
	FunctionID string `json:"functionId,required" format:"uuid"`
	// Function version id
	FunctionVersionID string `json:"functionVersionId,required" format:"uuid"`
	// Position of request in queue
	PositionInQueue int64                          `json:"positionInQueue"`
	JSON            getPositionInQueueResponseJSON `json:"-"`
}

// getPositionInQueueResponseJSON contains the JSON metadata for the struct
// [GetPositionInQueueResponse]
type getPositionInQueueResponseJSON struct {
	FunctionID        apijson.Field
	FunctionVersionID apijson.Field
	PositionInQueue   apijson.Field
	raw               string
	ExtraFields       map[string]apijson.Field
}

func (r *GetPositionInQueueResponse) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r getPositionInQueueResponseJSON) RawJSON() string {
	return r.raw
}