render

package

v0.1.0 Latest Latest Go to latest Published: Oct 24, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/render-oss/sdk

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Client
- func NewClient(options ...ClientOption) (*Client, error)
- func NewSocketClient(unixSocketPath string) (*Client, error)
type ClientOption
- func WithBaseURL(baseURL string) ClientOption
- func WithToken(token string) ClientOption
type CursorParam
type LimitParam
type ListTaskRunsParams
type OwnerIdParam
type RunTask
type SSEEvent
type TaskData
type TaskIdentifier
type TaskRun
type TaskRunDetails
type TaskRunStatus
type TaskRunWithGet
- func (tr *TaskRunWithGet) Get(ctx context.Context) (*TaskRunDetails, error)
type WorkflowsService
- func (w *WorkflowsService) CancelTaskRun(taskRunID string) error
- func (w *WorkflowsService) GetTaskRun(taskRunID string) (*TaskRunDetails, error)
- func (w *WorkflowsService) ListTaskRuns(params *ListTaskRunsParams) ([]TaskRun, error)
- func (w *WorkflowsService) RunTask(taskIdentifier TaskIdentifier, input TaskData) (*TaskRunWithGet, error)

Constants ¶

View Source

const (
	LocalDevURL = "RENDER_LOCAL_DEV_URL"
	UseLocalDev = "RENDER_USE_LOCAL_DEV"
)

View Source

const (
	TaskRunStatusPending   = workflows.Pending
	TaskRunStatusRunning   = workflows.Running
	TaskRunStatusCompleted = workflows.Completed
	TaskRunStatusFailed    = workflows.Failed
)

Constants for TaskRunStatus

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {

	// Service clients
	Workflows *WorkflowsService
	// contains filtered or unexported fields
}

Client represents the Render API client

func NewClient ¶

func NewClient(options ...ClientOption) (*Client, error)

NewClient creates a new Render API client

func NewSocketClient ¶

func NewSocketClient(unixSocketPath string) (*Client, error)

type ClientOption ¶

type ClientOption func(*Client) error

func WithBaseURL ¶

func WithBaseURL(baseURL string) ClientOption

func WithToken ¶

func WithToken(token string) ClientOption

type CursorParam ¶

type CursorParam = client.CursorParam

Types from client package

type LimitParam ¶

type LimitParam = client.LimitParam

Types from client package

type ListTaskRunsParams ¶

type ListTaskRunsParams = client.ListTaskRunsParams

Types from client package

type OwnerIdParam ¶

type OwnerIdParam = client.OwnerIdParam

Types from client package

type RunTask ¶

type RunTask = workflows.RunTask

Types from workflows package

type SSEEvent ¶

type SSEEvent struct {
	ID    string `json:"id,omitempty"`
	Event string `json:"event,omitempty"`
	Data  string `json:"data,omitempty"`
	Retry string `json:"retry,omitempty"`
}

SSEEvent represents a Server-Sent Event

type TaskData ¶

type TaskData = workflows.TaskData

Types from workflows package

type TaskIdentifier ¶

type TaskIdentifier = workflows.TaskIdentifier

Types from workflows package

type TaskRun ¶

type TaskRun = workflows.TaskRun

Types from workflows package

type TaskRunDetails ¶

type TaskRunDetails = workflows.TaskRunDetails

Types from workflows package

type TaskRunStatus ¶

type TaskRunStatus = workflows.TaskRunStatus

Types from workflows package

type TaskRunWithGet ¶

type TaskRunWithGet struct {
	*TaskRun
	// contains filtered or unexported fields
}

TaskRunWithGet extends the base TaskRun with get functionality

func (*TaskRunWithGet) Get ¶

func (tr *TaskRunWithGet) Get(ctx context.Context) (*TaskRunDetails, error)

Get blocks until the task run completes or the context is cancelled

type WorkflowsService ¶

type WorkflowsService struct {
	// contains filtered or unexported fields
}

WorkflowsService handles workflow-related API operations

func (*WorkflowsService) CancelTaskRun ¶

func (w *WorkflowsService) CancelTaskRun(taskRunID string) error

CancelTaskRun cancels a running task DELETE /tasks-runs/{taskRunId}

func (*WorkflowsService) GetTaskRun ¶

func (w *WorkflowsService) GetTaskRun(taskRunID string) (*TaskRunDetails, error)

GetTaskRun gets details about a specific task run GET /tasks-runs/{taskRunId}

func (*WorkflowsService) ListTaskRuns ¶

func (w *WorkflowsService) ListTaskRuns(params *ListTaskRunsParams) ([]TaskRun, error)

ListTaskRuns lists task runs with optional filtering GET /task-runs

func (*WorkflowsService) RunTask ¶

func (w *WorkflowsService) RunTask(taskIdentifier TaskIdentifier, input TaskData) (*TaskRunWithGet, error)

RunTask executes a task using the workflows API POST /task-runs

Source Files ¶

View all Source files

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
internal
client Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/autoscaling Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/blueprints Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/disks Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/events Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/eventtypes Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/jobs Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/logs Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/maintenance Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/metrics Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/notifications Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/postgres Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/webhooks Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.
client/workflows Package client provides primitives to interact with the openapi HTTP API.	Package client provides primitives to interact with the openapi HTTP API.