Documentation
¶
Overview ¶
Runner Groups allow you to create dedicated groups of runners for your organization. A private runner is a self-hosted instance that can be registered with StackGuardian to execute tasks and jobs within your organization's environment.
For more details, visit our [Documentation](https://docs.stackguardian.io/docs/organisation_settings/private_runner/overview/).
Index ¶
- type Client
- func (c *Client) CreateNewRunnerGroup(ctx context.Context, org string, request *sgsdkgo.RunnerGroup, ...) (*sgsdkgo.RunnerGroupCreateResponse, error)
- func (c *Client) DeleteRunnerGroup(ctx context.Context, org string, runnerGroup string, ...) (*sgsdkgo.RunnerGroupDeleteResponse, error)
- func (c *Client) DeregisterRunner(ctx context.Context, org string, runnerGroup string, ...) error
- func (c *Client) ReadRunnerGroup(ctx context.Context, org string, runnerGroup string, ...) (*sgsdkgo.RunnerGroupSerializerResponse, error)
- func (c *Client) UpdateRunnerGroup(ctx context.Context, org string, runnerGroup string, ...) (*sgsdkgo.RunnerGroupCreateResponse, error)
- func (c *Client) UpdateRunnerState(ctx context.Context, org string, runnerGroup string, ...) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(opts ...option.RequestOption) *Client
func (*Client) CreateNewRunnerGroup ¶
func (c *Client) CreateNewRunnerGroup( ctx context.Context, org string, request *sgsdkgo.RunnerGroup, opts ...option.RequestOption, ) (*sgsdkgo.RunnerGroupCreateResponse, error)
Creates a new Runner Group in the specified organization.
func (*Client) DeleteRunnerGroup ¶ added in v1.1.0
func (c *Client) DeleteRunnerGroup( ctx context.Context, org string, runnerGroup string, opts ...option.RequestOption, ) (*sgsdkgo.RunnerGroupDeleteResponse, error)
Delete an existing Runner Group.
func (*Client) DeregisterRunner ¶
func (c *Client) DeregisterRunner( ctx context.Context, org string, runnerGroup string, request *sgsdkgo.RunnerDeregister, opts ...option.RequestOption, ) error
Deregisters the runner from the specified runner group.
func (*Client) ReadRunnerGroup ¶
func (c *Client) ReadRunnerGroup( ctx context.Context, org string, runnerGroup string, request *sgsdkgo.ReadRunnerGroupRequest, opts ...option.RequestOption, ) (*sgsdkgo.RunnerGroupSerializerResponse, error)
Retrieves details of an existing runner group.
func (*Client) UpdateRunnerGroup ¶ added in v1.1.0
func (c *Client) UpdateRunnerGroup( ctx context.Context, org string, runnerGroup string, request *sgsdkgo.PatchedRunnerGroup, opts ...option.RequestOption, ) (*sgsdkgo.RunnerGroupCreateResponse, error)
Update an existing Runner Group.
func (*Client) UpdateRunnerState ¶
func (c *Client) UpdateRunnerState( ctx context.Context, org string, runnerGroup string, request *sgsdkgo.RunnerStatus, opts ...option.RequestOption, ) error
Updates the state of a runner in the specified runner group.
Source Files
Click to show internal directories.
Click to hide internal directories.