client

package

v1.1.2 Latest Latest Go to latest Published: Jan 31, 2025 License: Apache-2.0 Imports: 1 Imported by: 0

Details

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

Repository

github.com/render-oss/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package client provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AutoSync ¶

type AutoSync = bool

AutoSync Automatically sync changes to render.yaml

type Blueprint ¶

type Blueprint struct {
	// AutoSync Automatically sync changes to render.yaml
	AutoSync AutoSync    `json:"autoSync"`
	Branch   string      `json:"branch"`
	Id       BlueprintId `json:"id"`
	LastSync *time.Time  `json:"lastSync,omitempty"`
	Name     string      `json:"name"`
	Repo     string      `json:"repo"`
	Status   Status      `json:"status"`
}

Blueprint defines model for blueprint.

type BlueprintDetail ¶

type BlueprintDetail struct {
	// AutoSync Automatically sync changes to render.yaml
	AutoSync  AutoSync      `json:"autoSync"`
	Branch    string        `json:"branch"`
	Id        BlueprintId   `json:"id"`
	LastSync  *time.Time    `json:"lastSync,omitempty"`
	Name      string        `json:"name"`
	Repo      string        `json:"repo"`
	Resources []ResourceRef `json:"resources"`
	Status    Status        `json:"status"`
}

BlueprintDetail defines model for blueprintDetail.

type BlueprintId ¶

type BlueprintId = string

BlueprintId defines model for blueprintId.

type BlueprintPATCH ¶

type BlueprintPATCH struct {
	// AutoSync Automatically sync changes to render.yaml
	AutoSync *AutoSync `json:"autoSync,omitempty"`
	Name     *string   `json:"name,omitempty"`
}

BlueprintPATCH defines model for blueprintPATCH.

type CommitRef ¶

type CommitRef struct {
	Id string `json:"id"`
}

CommitRef defines model for commitRef.

type ResourceRef ¶

type ResourceRef struct {
	Id   string `json:"id"`
	Name string `json:"name"`

	// Type type of the resource (ex. web_service or postgres)
	Type ResourceRefType `json:"type"`
}

ResourceRef defines model for resourceRef.

type ResourceRefType ¶

type ResourceRefType string

ResourceRefType type of the resource (ex. web_service or postgres)

const (
	BackgroundWorker ResourceRefType = "background_worker"
	CronJob          ResourceRefType = "cron_job"
	EnvironmentGroup ResourceRefType = "environment_group"
	Postgres         ResourceRefType = "postgres"
	PrivateService   ResourceRefType = "private_service"
	Redis            ResourceRefType = "redis"
	StaticSite       ResourceRefType = "static_site"
	WebService       ResourceRefType = "web_service"
)

Defines values for ResourceRefType.

type Status ¶

type Status string

Status defines model for status.

const (
	StatusCreated Status = "created"
	StatusError   Status = "error"
	StatusInSync  Status = "in_sync"
	StatusPaused  Status = "paused"
	StatusSyncing Status = "syncing"
)

Defines values for Status.

type Sync ¶

type Sync struct {
	Commit      CommitRef  `json:"commit"`
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	Id          SyncId     `json:"id"`
	StartedAt   *time.Time `json:"startedAt,omitempty"`
	State       SyncState  `json:"state"`
}

Sync defines model for sync.

type SyncId ¶

type SyncId = string

SyncId defines model for syncId.

type SyncState ¶

type SyncState string

SyncState defines model for syncState.

const (
	SyncStateCreated SyncState = "created"
	SyncStateError   SyncState = "error"
	SyncStatePending SyncState = "pending"
	SyncStateRunning SyncState = "running"
	SyncStateSuccess SyncState = "success"
)

Defines values for SyncState.

Source Files ¶

View all Source files

blueprints_gen.go

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