devopsrunner

package
v1.28.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 30, 2024 License: Apache-2.0 Imports: 33 Imported by: 4

Documentation

Overview

Package devopsrunner provides the API client, operations, and parameter types for the API.

Index

Constants

View Source 
const ServiceAPIVersion = "v1"
View Source 
const ServiceID = "devopsrunner"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type Client 

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

Client provides the API client to make operations call for the API.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg nifcloud.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateRunner 

func (c *Client) CreateRunner(ctx context.Context, params *CreateRunnerInput, optFns ...func(*Options)) (*CreateRunnerOutput, error)

func (*Client) CreateRunnerParameterGroup 

func (c *Client) CreateRunnerParameterGroup(ctx context.Context, params *CreateRunnerParameterGroupInput, optFns ...func(*Options)) (*CreateRunnerParameterGroupOutput, error)

func (*Client) DeleteRunner 

func (c *Client) DeleteRunner(ctx context.Context, params *DeleteRunnerInput, optFns ...func(*Options)) (*DeleteRunnerOutput, error)

func (*Client) DeleteRunnerParameterGroup 

func (c *Client) DeleteRunnerParameterGroup(ctx context.Context, params *DeleteRunnerParameterGroupInput, optFns ...func(*Options)) (*DeleteRunnerParameterGroupOutput, error)

func (*Client) GetRunner 

func (c *Client) GetRunner(ctx context.Context, params *GetRunnerInput, optFns ...func(*Options)) (*GetRunnerOutput, error)

func (*Client) GetRunnerParameterGroup 

func (c *Client) GetRunnerParameterGroup(ctx context.Context, params *GetRunnerParameterGroupInput, optFns ...func(*Options)) (*GetRunnerParameterGroupOutput, error)

func (*Client) ListRunnerParameterGroups 

func (c *Client) ListRunnerParameterGroups(ctx context.Context, params *ListRunnerParameterGroupsInput, optFns ...func(*Options)) (*ListRunnerParameterGroupsOutput, error)

func (*Client) ListRunnerRegistrations 

func (c *Client) ListRunnerRegistrations(ctx context.Context, params *ListRunnerRegistrationsInput, optFns ...func(*Options)) (*ListRunnerRegistrationsOutput, error)

func (*Client) ListRunners 

func (c *Client) ListRunners(ctx context.Context, params *ListRunnersInput, optFns ...func(*Options)) (*ListRunnersOutput, error)

func (*Client) ModifyRunnerInstanceType 

func (c *Client) ModifyRunnerInstanceType(ctx context.Context, params *ModifyRunnerInstanceTypeInput, optFns ...func(*Options)) (*ModifyRunnerInstanceTypeOutput, error)

func (*Client) RegisterRunner 

func (c *Client) RegisterRunner(ctx context.Context, params *RegisterRunnerInput, optFns ...func(*Options)) (*RegisterRunnerOutput, error)

func (*Client) UnregisterRunner 

func (c *Client) UnregisterRunner(ctx context.Context, params *UnregisterRunnerInput, optFns ...func(*Options)) (*UnregisterRunnerOutput, error)

func (*Client) UpdateRunner 

func (c *Client) UpdateRunner(ctx context.Context, params *UpdateRunnerInput, optFns ...func(*Options)) (*UpdateRunnerOutput, error)

func (*Client) UpdateRunnerParameter 

func (c *Client) UpdateRunnerParameter(ctx context.Context, params *UpdateRunnerParameterInput, optFns ...func(*Options)) (*UpdateRunnerParameterOutput, error)

func (*Client) UpdateRunnerParameterGroup 

func (c *Client) UpdateRunnerParameterGroup(ctx context.Context, params *UpdateRunnerParameterGroupInput, optFns ...func(*Options)) (*UpdateRunnerParameterGroupOutput, error)

func (*Client) UpdateRunnerRegistration 

func (c *Client) UpdateRunnerRegistration(ctx context.Context, params *UpdateRunnerRegistrationInput, optFns ...func(*Options)) (*UpdateRunnerRegistrationOutput, error)

type CreateRunnerInput 

type CreateRunnerInput struct {

	// This member is required.
	InstanceType types.InstanceTypeOfCreateRunnerRequest

	// This member is required.
	RunnerName *string

	AvailabilityZone types.AvailabilityZoneOfCreateRunnerRequest

	Concurrent *int32

	Description *string

	NetworkConfig *types.RequestNetworkConfig
	// contains filtered or unexported fields
}

type CreateRunnerOutput 

type CreateRunnerOutput struct {
	Runner *types.Runner

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRunnerParameterGroupInput 

type CreateRunnerParameterGroupInput struct {

	// This member is required.
	ParameterGroupName *string

	Description *string
	// contains filtered or unexported fields
}

type CreateRunnerParameterGroupOutput 

type CreateRunnerParameterGroupOutput struct {
	ParameterGroup *types.ParameterGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRunnerInput 

type DeleteRunnerInput struct {

	// This member is required.
	RunnerName *string
	// contains filtered or unexported fields
}

type DeleteRunnerOutput 

type DeleteRunnerOutput struct {
	Runner *types.Runner

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRunnerParameterGroupInput 

type DeleteRunnerParameterGroupInput struct {

	// This member is required.
	ParameterGroupName *string
	// contains filtered or unexported fields
}

type DeleteRunnerParameterGroupOutput 

type DeleteRunnerParameterGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetRunnerInput 

type GetRunnerInput struct {

	// This member is required.
	RunnerName *string
	// contains filtered or unexported fields
}

type GetRunnerOutput 

type GetRunnerOutput struct {
	Runner *types.Runner

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRunnerParameterGroupInput 

type GetRunnerParameterGroupInput struct {

	// This member is required.
	ParameterGroupName *string
	// contains filtered or unexported fields
}

type GetRunnerParameterGroupOutput 

type GetRunnerParameterGroupOutput struct {
	ParameterGroup *types.ParameterGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListRunnerParameterGroupsInput 

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

type ListRunnerParameterGroupsOutput 

type ListRunnerParameterGroupsOutput struct {
	ParameterGroups []types.ParameterGroups

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRunnerRegistrationsInput 

type ListRunnerRegistrationsInput struct {

	// This member is required.
	RunnerName *string
	// contains filtered or unexported fields
}

type ListRunnerRegistrationsOutput 

type ListRunnerRegistrationsOutput struct {
	Registrations []types.Registrations

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRunnersInput 

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

type ListRunnersOutput 

type ListRunnersOutput struct {
	Runners []types.Runners

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ModifyRunnerInstanceTypeInput 

type ModifyRunnerInstanceTypeInput struct {

	// This member is required.
	InstanceType types.InstanceTypeOfModifyRunnerInstanceTypeRequest

	// This member is required.
	RunnerName *string
	// contains filtered or unexported fields
}

type ModifyRunnerInstanceTypeOutput 

type ModifyRunnerInstanceTypeOutput struct {
	Runner *types.Runner

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type RegisterRunnerInput 

type RegisterRunnerInput struct {

	// This member is required.
	AuthenticationToken *string

	// This member is required.
	GitlabUrl *string

	// This member is required.
	RunnerName *string

	DefaultDockerImage *string

	ExtraHosts []types.RequestExtraHosts

	ParameterGroupName *string

	Privileged *bool
	// contains filtered or unexported fields
}

type RegisterRunnerOutput 

type RegisterRunnerOutput struct {
	Runner *types.Runner

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type UnregisterRunnerInput 

type UnregisterRunnerInput struct {

	// This member is required.
	RegistrationId *string

	// This member is required.
	RunnerName *string

	DisableTokenRevocation *bool
	// contains filtered or unexported fields
}

type UnregisterRunnerOutput 

type UnregisterRunnerOutput struct {
	Runner *types.Runner

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRunnerInput 

type UpdateRunnerInput struct {

	// This member is required.
	RunnerName *string

	ChangedRunnerName *string

	Concurrent *int32

	Description *string
	// contains filtered or unexported fields
}

type UpdateRunnerOutput 

type UpdateRunnerOutput struct {
	Runner *types.Runner

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRunnerParameterGroupInput 

type UpdateRunnerParameterGroupInput struct {

	// This member is required.
	ParameterGroupName *string

	ChangedParameterGroupName *string

	Description *string
	// contains filtered or unexported fields
}

type UpdateRunnerParameterGroupOutput 

type UpdateRunnerParameterGroupOutput struct {
	ParameterGroup *types.ParameterGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRunnerParameterInput 

type UpdateRunnerParameterInput struct {

	// This member is required.
	ParameterGroupName *string

	DockerParameters *types.RequestDockerParameters
	// contains filtered or unexported fields
}

type UpdateRunnerParameterOutput 

type UpdateRunnerParameterOutput struct {
	ParameterGroup *types.ParameterGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRunnerRegistrationInput 

type UpdateRunnerRegistrationInput struct {

	// This member is required.
	ParameterGroupName *string

	// This member is required.
	RegistrationId *string

	// This member is required.
	RunnerName *string
	// contains filtered or unexported fields
}

type UpdateRunnerRegistrationOutput 

type UpdateRunnerRegistrationOutput struct {
	Runner *types.Runner

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.