Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

apiv1

package

Go to main page

Versions in this module

v1

v1.13.0

Apr 16, 2024

v1.12.0

Apr 16, 2024

v1.11.0

Apr 11, 2024

v1.10.1

Apr 11, 2024

v1.10.0

Apr 9, 2024

v1.9.0

Apr 3, 2024

v1.8.3

Apr 3, 2024

v1.8.2

Apr 3, 2024

v1.8.1

Apr 2, 2024

v1.8.0

Apr 2, 2024

v1.7.1

Feb 29, 2024

v1.7.0

Feb 29, 2024

Changes in this version

+ var File_api_v1_auth_proto protoreflect.FileDescriptor

+ var File_api_v1_logs_proto protoreflect.FileDescriptor

+ var File_api_v1_plans_proto protoreflect.FileDescriptor

+ var File_api_v1_run_proto protoreflect.FileDescriptor

+ var File_api_v1_workspaces_proto protoreflect.FileDescriptor

+ type GenerateRunnerTokenRequest struct

+ OrganizationId string

+ RunId string

+ WorkspaceId string

+ func (*GenerateRunnerTokenRequest) Descriptor() ([]byte, []int)

+ func (*GenerateRunnerTokenRequest) ProtoMessage()

+ func (x *GenerateRunnerTokenRequest) GetOrganizationId() string

+ func (x *GenerateRunnerTokenRequest) GetRunId() string

+ func (x *GenerateRunnerTokenRequest) GetWorkspaceId() string

+ func (x *GenerateRunnerTokenRequest) ProtoReflect() protoreflect.Message

+ func (x *GenerateRunnerTokenRequest) Reset()

+ func (x *GenerateRunnerTokenRequest) String() string

+ type GenerateRunnerTokenResponse struct

+ Token string

+ func (*GenerateRunnerTokenResponse) Descriptor() ([]byte, []int)

+ func (*GenerateRunnerTokenResponse) ProtoMessage()

+ func (x *GenerateRunnerTokenResponse) GetToken() string

+ func (x *GenerateRunnerTokenResponse) ProtoReflect() protoreflect.Message

+ func (x *GenerateRunnerTokenResponse) Reset()

+ func (x *GenerateRunnerTokenResponse) String() string

+ type GetRunRequest struct

+ RunId string

+ func (*GetRunRequest) Descriptor() ([]byte, []int)

+ func (*GetRunRequest) ProtoMessage()

+ func (x *GetRunRequest) GetRunId() string

+ func (x *GetRunRequest) ProtoReflect() protoreflect.Message

+ func (x *GetRunRequest) Reset()

+ func (x *GetRunRequest) String() string

+ type GetVariablesRequest struct

+ WorkspaceId string

+ func (*GetVariablesRequest) Descriptor() ([]byte, []int)

+ func (*GetVariablesRequest) ProtoMessage()

+ func (x *GetVariablesRequest) GetWorkspaceId() string

+ func (x *GetVariablesRequest) ProtoReflect() protoreflect.Message

+ func (x *GetVariablesRequest) Reset()

+ func (x *GetVariablesRequest) String() string

+ type GetVariablesResponse struct

+ Variables []*Variable

+ func (*GetVariablesResponse) Descriptor() ([]byte, []int)

+ func (*GetVariablesResponse) ProtoMessage()

+ func (x *GetVariablesResponse) GetVariables() []*Variable

+ func (x *GetVariablesResponse) ProtoReflect() protoreflect.Message

+ func (x *GetVariablesResponse) Reset()

+ func (x *GetVariablesResponse) String() string

+ type GetVcsConnectionRequest struct

+ ConnectionId string

+ WorkspaceId string

+ func (*GetVcsConnectionRequest) Descriptor() ([]byte, []int)

+ func (*GetVcsConnectionRequest) ProtoMessage()

+ func (x *GetVcsConnectionRequest) GetConnectionId() string

+ func (x *GetVcsConnectionRequest) GetWorkspaceId() string

+ func (x *GetVcsConnectionRequest) ProtoReflect() protoreflect.Message

+ func (x *GetVcsConnectionRequest) Reset()

+ func (x *GetVcsConnectionRequest) String() string

+ type GetVcsConnectionResponse struct

+ Token string

+ func (*GetVcsConnectionResponse) Descriptor() ([]byte, []int)

+ func (*GetVcsConnectionResponse) ProtoMessage()

+ func (x *GetVcsConnectionResponse) GetToken() string

+ func (x *GetVcsConnectionResponse) ProtoReflect() protoreflect.Message

+ func (x *GetVcsConnectionResponse) Reset()

+ func (x *GetVcsConnectionResponse) String() string

+ type GetWorkspaceRequest struct

+ Id string

+ func (*GetWorkspaceRequest) Descriptor() ([]byte, []int)

+ func (*GetWorkspaceRequest) ProtoMessage()

+ func (x *GetWorkspaceRequest) GetId() string

+ func (x *GetWorkspaceRequest) ProtoReflect() protoreflect.Message

+ func (x *GetWorkspaceRequest) Reset()

+ func (x *GetWorkspaceRequest) String() string

+ type GetWorkspaceResponse struct

+ Workspace *Workspace

+ func (*GetWorkspaceResponse) Descriptor() ([]byte, []int)

+ func (*GetWorkspaceResponse) ProtoMessage()

+ func (x *GetWorkspaceResponse) GetWorkspace() *Workspace

+ func (x *GetWorkspaceResponse) ProtoReflect() protoreflect.Message

+ func (x *GetWorkspaceResponse) Reset()

+ func (x *GetWorkspaceResponse) String() string

+ type ListRunsRequest struct

+ AgentId string

+ func (*ListRunsRequest) Descriptor() ([]byte, []int)

+ func (*ListRunsRequest) ProtoMessage()

+ func (x *ListRunsRequest) GetAgentId() string

+ func (x *ListRunsRequest) ProtoReflect() protoreflect.Message

+ func (x *ListRunsRequest) Reset()

+ func (x *ListRunsRequest) String() string

+ type ListRunsResponse struct

+ Runs []*Run

+ func (*ListRunsResponse) Descriptor() ([]byte, []int)

+ func (*ListRunsResponse) ProtoMessage()

+ func (x *ListRunsResponse) GetRuns() []*Run

+ func (x *ListRunsResponse) ProtoReflect() protoreflect.Message

+ func (x *ListRunsResponse) Reset()

+ func (x *ListRunsResponse) String() string

+ type Run struct

+ Id string

+ Operation string

+ WorkspaceId string

+ func (*Run) Descriptor() ([]byte, []int)

+ func (*Run) ProtoMessage()

+ func (x *Run) GetId() string

+ func (x *Run) GetOperation() string

+ func (x *Run) GetWorkspaceId() string

+ func (x *Run) ProtoReflect() protoreflect.Message

+ func (x *Run) Reset()

+ func (x *Run) String() string

+ type StreamLogsRequest struct

+ Content string

+ RunId string

+ func (*StreamLogsRequest) Descriptor() ([]byte, []int)

+ func (*StreamLogsRequest) ProtoMessage()

+ func (x *StreamLogsRequest) GetContent() string

+ func (x *StreamLogsRequest) GetRunId() string

+ func (x *StreamLogsRequest) ProtoReflect() protoreflect.Message

+ func (x *StreamLogsRequest) Reset()

+ func (x *StreamLogsRequest) String() string

+ type StreamLogsResponse struct

+ Success bool

+ func (*StreamLogsResponse) Descriptor() ([]byte, []int)

+ func (*StreamLogsResponse) ProtoMessage()

+ func (x *StreamLogsResponse) GetSuccess() bool

+ func (x *StreamLogsResponse) ProtoReflect() protoreflect.Message

+ func (x *StreamLogsResponse) Reset()

+ func (x *StreamLogsResponse) String() string

+ type UpdateRunRequest struct

+ Add int32

+ Change int32

+ Id string

+ Remove int32

+ Status string

+ func (*UpdateRunRequest) Descriptor() ([]byte, []int)

+ func (*UpdateRunRequest) ProtoMessage()

+ func (x *UpdateRunRequest) GetAdd() int32

+ func (x *UpdateRunRequest) GetChange() int32

+ func (x *UpdateRunRequest) GetId() string

+ func (x *UpdateRunRequest) GetRemove() int32

+ func (x *UpdateRunRequest) GetStatus() string

+ func (x *UpdateRunRequest) ProtoReflect() protoreflect.Message

+ func (x *UpdateRunRequest) Reset()

+ func (x *UpdateRunRequest) String() string

+ type UploadLogsRequest struct

+ Content string

+ RunId string

+ func (*UploadLogsRequest) Descriptor() ([]byte, []int)

+ func (*UploadLogsRequest) ProtoMessage()

+ func (x *UploadLogsRequest) GetContent() string

+ func (x *UploadLogsRequest) GetRunId() string

+ func (x *UploadLogsRequest) ProtoReflect() protoreflect.Message

+ func (x *UploadLogsRequest) Reset()

+ func (x *UploadLogsRequest) String() string

+ type UploadLogsResponse struct

+ Success bool

+ func (*UploadLogsResponse) Descriptor() ([]byte, []int)

+ func (*UploadLogsResponse) ProtoMessage()

+ func (x *UploadLogsResponse) GetSuccess() bool

+ func (x *UploadLogsResponse) ProtoReflect() protoreflect.Message

+ func (x *UploadLogsResponse) Reset()

+ func (x *UploadLogsResponse) String() string

+ type UploadPlanRequest struct

+ Content string

+ RunId string

+ func (*UploadPlanRequest) Descriptor() ([]byte, []int)

+ func (*UploadPlanRequest) ProtoMessage()

+ func (x *UploadPlanRequest) GetContent() string

+ func (x *UploadPlanRequest) GetRunId() string

+ func (x *UploadPlanRequest) ProtoReflect() protoreflect.Message

+ func (x *UploadPlanRequest) Reset()

+ func (x *UploadPlanRequest) String() string

+ type UploadPlanResponse struct

+ Success bool

+ func (*UploadPlanResponse) Descriptor() ([]byte, []int)

+ func (*UploadPlanResponse) ProtoMessage()

+ func (x *UploadPlanResponse) GetSuccess() bool

+ func (x *UploadPlanResponse) ProtoReflect() protoreflect.Message

+ func (x *UploadPlanResponse) Reset()

+ func (x *UploadPlanResponse) String() string

+ type Variable struct

+ Key string

+ Type string

+ Value string

+ func (*Variable) Descriptor() ([]byte, []int)

+ func (*Variable) ProtoMessage()

+ func (x *Variable) GetKey() string

+ func (x *Variable) GetType() string

+ func (x *Variable) GetValue() string

+ func (x *Variable) ProtoReflect() protoreflect.Message

+ func (x *Variable) Reset()

+ func (x *Variable) String() string

+ type WatchRunsRequest struct

+ AgentId string

+ func (*WatchRunsRequest) Descriptor() ([]byte, []int)

+ func (*WatchRunsRequest) ProtoMessage()

+ func (x *WatchRunsRequest) GetAgentId() string

+ func (x *WatchRunsRequest) ProtoReflect() protoreflect.Message

+ func (x *WatchRunsRequest) Reset()

+ func (x *WatchRunsRequest) String() string

+ type Workspace struct

+ Id string

+ Locked bool

+ Name string

+ Vcs *WorkspaceVcs

+ func (*Workspace) Descriptor() ([]byte, []int)

+ func (*Workspace) ProtoMessage()

+ func (x *Workspace) GetId() string

+ func (x *Workspace) GetLocked() bool

+ func (x *Workspace) GetName() string

+ func (x *Workspace) GetVcs() *WorkspaceVcs

+ func (x *Workspace) ProtoReflect() protoreflect.Message

+ func (x *Workspace) Reset()

+ func (x *Workspace) String() string

+ type WorkspaceVcs struct

+ Branch string

+ ConnectionId string

+ Patterns []string

+ Prefixes []string

+ Source string

+ WorkingDirectory string

+ func (*WorkspaceVcs) Descriptor() ([]byte, []int)

+ func (*WorkspaceVcs) ProtoMessage()

+ func (x *WorkspaceVcs) GetBranch() string

+ func (x *WorkspaceVcs) GetConnectionId() string

+ func (x *WorkspaceVcs) GetPatterns() []string

+ func (x *WorkspaceVcs) GetPrefixes() []string

+ func (x *WorkspaceVcs) GetSource() string

+ func (x *WorkspaceVcs) GetWorkingDirectory() string

+ func (x *WorkspaceVcs) ProtoReflect() protoreflect.Message

+ func (x *WorkspaceVcs) Reset()

+ func (x *WorkspaceVcs) String() string