swarmbucket

Documentation

Overview

Package swarmbucket provides access to the Buildbucket-Swarming integration.

Creating a client

Usage example:

import "go.chromium.org/luci/common/api/buildbucket/swarmbucket/v1"
...
ctx := context.Background()
swarmbucketService, err := swarmbucket.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

swarmbucketService, err := swarmbucket.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
swarmbucketService, err := swarmbucket.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

• Constants
• type GetTaskDefCall
  • func (c *GetTaskDefCall) Context(ctx context.Context) *GetTaskDefCall
  • func (c *GetTaskDefCall) Do(opts ...googleapi.CallOption) (*LegacySwarmbucketApiGetTaskDefinitionResponseMessage, error)
  • func (c *GetTaskDefCall) Fields(s ...googleapi.Field) *GetTaskDefCall
  • func (c *GetTaskDefCall) Header() http.Header
• type LegacyApiPubSubCallbackMessage
  • func (s *LegacyApiPubSubCallbackMessage) MarshalJSON() ([]byte, error)
• type LegacyApiPutRequestMessage
  • func (s *LegacyApiPutRequestMessage) MarshalJSON() ([]byte, error)
• type LegacySwarmbucketApiGetTaskDefinitionRequestMessage
  • func (s *LegacySwarmbucketApiGetTaskDefinitionRequestMessage) MarshalJSON() ([]byte, error)
• type LegacySwarmbucketApiGetTaskDefinitionResponseMessage
  • func (s *LegacySwarmbucketApiGetTaskDefinitionResponseMessage) MarshalJSON() ([]byte, error)
• type Service
  • func New(client *http.Client) (*Service, error)
  • func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
  • func (s *Service) GetTaskDef(...) *GetTaskDefCall

Constants

const (
	// https://www.googleapis.com/auth/userinfo.email
	UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
)

OAuth2 scopes used by this API.

Types

type GetTaskDefCall

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

func (*GetTaskDefCall) Context

func (c *GetTaskDefCall) Context(ctx context.Context) *GetTaskDefCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GetTaskDefCall) Do

func (c *GetTaskDefCall) Do(opts ...googleapi.CallOption) (*LegacySwarmbucketApiGetTaskDefinitionResponseMessage, error)

Do executes the "swarmbucket.get_task_def" call. Exactly one of *LegacySwarmbucketApiGetTaskDefinitionResponseMessage or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *LegacySwarmbucketApiGetTaskDefinitionResponseMessage.ServerResponse.H eader or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GetTaskDefCall) Fields

func (c *GetTaskDefCall) Fields(s ...googleapi.Field) *GetTaskDefCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GetTaskDefCall) Header

func (c *GetTaskDefCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type LegacyApiPubSubCallbackMessage

type LegacyApiPubSubCallbackMessage struct {
	AuthToken string `json:"auth_token,omitempty"`

	Topic string `json:"topic,omitempty"`

	UserData string `json:"user_data,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AuthToken") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AuthToken") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*LegacyApiPubSubCallbackMessage) MarshalJSON

func (s *LegacyApiPubSubCallbackMessage) MarshalJSON() ([]byte, error)

type LegacyApiPutRequestMessage

type LegacyApiPutRequestMessage struct {
	Bucket string `json:"bucket,omitempty"`

	// Possible values:
	//   "AUTO"
	//   "CANARY"
	//   "PROD"
	CanaryPreference string `json:"canary_preference,omitempty"`

	ClientOperationId string `json:"client_operation_id,omitempty"`

	Experimental bool `json:"experimental,omitempty"`

	LeaseExpirationTs int64 `json:"lease_expiration_ts,omitempty,string"`

	ParametersJson string `json:"parameters_json,omitempty"`

	PubsubCallback *LegacyApiPubSubCallbackMessage `json:"pubsub_callback,omitempty"`

	Tags []string `json:"tags,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Bucket") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Bucket") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*LegacyApiPutRequestMessage) MarshalJSON

func (s *LegacyApiPutRequestMessage) MarshalJSON() ([]byte, error)

type LegacySwarmbucketApiGetTaskDefinitionRequestMessage

type LegacySwarmbucketApiGetTaskDefinitionRequestMessage struct {
	BuildRequest *LegacyApiPutRequestMessage `json:"build_request,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BuildRequest") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BuildRequest") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*LegacySwarmbucketApiGetTaskDefinitionRequestMessage) MarshalJSON

func (s *LegacySwarmbucketApiGetTaskDefinitionRequestMessage) MarshalJSON() ([]byte, error)

type LegacySwarmbucketApiGetTaskDefinitionResponseMessage

type LegacySwarmbucketApiGetTaskDefinitionResponseMessage struct {
	SwarmingHost string `json:"swarming_host,omitempty"`

	TaskDefinition string `json:"task_definition,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "SwarmingHost") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "SwarmingHost") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*LegacySwarmbucketApiGetTaskDefinitionResponseMessage) MarshalJSON

func (s *LegacySwarmbucketApiGetTaskDefinitionResponseMessage) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment
	// contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

func (*Service) GetTaskDef

func (s *Service) GetTaskDef(legacyswarmbucketapigettaskdefinitionrequestmessage *LegacySwarmbucketApiGetTaskDefinitionRequestMessage) *GetTaskDefCall

GetTaskDef: Returns a swarming task definition for a build request.