Back to godoc.org

Package swarmbucket

v0.0.0-...-d4769a7
Latest Go to latest

The latest major version is .

Published: Aug 1, 2020 | License: Apache-2.0 | Module: github.com/luci/luci-go

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

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

OAuth2 scopes used by this API.

type GetBuildersCall

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

func (*GetBuildersCall) Bucket

func (c *GetBuildersCall) Bucket(bucket ...string) *GetBuildersCall

Bucket sets the optional parameter "bucket":

func (*GetBuildersCall) Context

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

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 (*GetBuildersCall) Do

func (c *GetBuildersCall) Do(opts ...googleapi.CallOption) (*LegacySwarmbucketApiGetBuildersResponseMessage, error)

Do executes the "swarmbucket.get_builders" call. Exactly one of *LegacySwarmbucketApiGetBuildersResponseMessage or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *LegacySwarmbucketApiGetBuildersResponseMessage.ServerResponse.Header 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 (*GetBuildersCall) Fields

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

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

func (*GetBuildersCall) Header

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

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

func (*GetBuildersCall) IfNoneMatch

func (c *GetBuildersCall) IfNoneMatch(entityTag string) *GetBuildersCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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 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 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 LegacySwarmbucketApiBucketMessage

type LegacySwarmbucketApiBucketMessage struct {
	Builders []*LegacySwarmbucketApiBuilderMessage `json:"builders,omitempty"`

	Name string `json:"name,omitempty"`

	SwarmingHostname string `json:"swarming_hostname,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Builders") to
	// unconditionally include in API requests. By default, fields with
	// empty 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. "Builders") 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 (*LegacySwarmbucketApiBucketMessage) MarshalJSON

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

type LegacySwarmbucketApiBuilderMessage

type LegacySwarmbucketApiBuilderMessage struct {
	Category string `json:"category,omitempty"`

	Name string `json:"name,omitempty"`

	PropertiesJson string `json:"properties_json,omitempty"`

	SwarmingDimensions []string `json:"swarming_dimensions,omitempty"`

	SwarmingHostname string `json:"swarming_hostname,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Category") to
	// unconditionally include in API requests. By default, fields with
	// empty 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. "Category") 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 (*LegacySwarmbucketApiBuilderMessage) MarshalJSON

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

type LegacySwarmbucketApiGetBuildersResponseMessage

type LegacySwarmbucketApiGetBuildersResponseMessage struct {
	Buckets []*LegacySwarmbucketApiBucketMessage `json:"buckets,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "Buckets") to
	// unconditionally include in API requests. By default, fields with
	// empty 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. "Buckets") 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 (*LegacySwarmbucketApiGetBuildersResponseMessage) MarshalJSON

func (s *LegacySwarmbucketApiGetBuildersResponseMessage) 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 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 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 LegacySwarmbucketApiSetNextBuildNumberRequest

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

	Builder string `json:"builder,omitempty"`

	NextNumber int64 `json:"next_number,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "Bucket") to
	// unconditionally include in API requests. By default, fields with
	// empty 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 (*LegacySwarmbucketApiSetNextBuildNumberRequest) MarshalJSON

func (s *LegacySwarmbucketApiSetNextBuildNumberRequest) 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) GetBuilders

func (s *Service) GetBuilders() *GetBuildersCall

GetBuilders: Returns defined swarmbucket builders. Returns legacy bucket names, e.g. "luci.chromium.try", not "chromium/try". Can be used to discover builders.

func (*Service) GetTaskDef

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

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

func (*Service) SetNextBuildNumber

func (s *Service) SetNextBuildNumber(legacyswarmbucketapisetnextbuildnumberrequest *LegacySwarmbucketApiSetNextBuildNumberRequest) *SetNextBuildNumberCall

SetNextBuildNumber: Sets the build number that will be used for the next build.

type SetNextBuildNumberCall

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

func (*SetNextBuildNumberCall) Context

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

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 (*SetNextBuildNumberCall) Do

func (c *SetNextBuildNumberCall) Do(opts ...googleapi.CallOption) error

Do executes the "swarmbucket.set_next_build_number" call.

func (*SetNextBuildNumberCall) Fields

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

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

func (*SetNextBuildNumberCall) Header

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

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

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier