Documentation ¶
Overview ¶
Package swarmbucket provides access to the Buildbucket-Swarming integration.
Usage example:
import "github.com/luci/luci-go/common/api/buildbucket/swarmbucket/v1" ... swarmbucketService, err := swarmbucket.New(oauthHttpClient)
Index ¶
- Constants
- type ApiPubSubCallbackMessage
- type ApiPutRequestMessage
- type GetBuildersCall
- func (c *GetBuildersCall) Context(ctx context.Context) *GetBuildersCall
- func (c *GetBuildersCall) Do(opts ...googleapi.CallOption) (*SwarmingSwarmbucketApiGetBuildersResponseMessage, error)
- func (c *GetBuildersCall) Fields(s ...googleapi.Field) *GetBuildersCall
- func (c *GetBuildersCall) Header() http.Header
- func (c *GetBuildersCall) IfNoneMatch(entityTag string) *GetBuildersCall
- type GetTaskDefCall
- func (c *GetTaskDefCall) Context(ctx context.Context) *GetTaskDefCall
- func (c *GetTaskDefCall) Do(opts ...googleapi.CallOption) (*SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage, error)
- func (c *GetTaskDefCall) Fields(s ...googleapi.Field) *GetTaskDefCall
- func (c *GetTaskDefCall) Header() http.Header
- type Service
- type SwarmingSwarmbucketApiBucketMessage
- type SwarmingSwarmbucketApiBuilderMessage
- type SwarmingSwarmbucketApiGetBuildersResponseMessage
- type SwarmingSwarmbucketApiGetTaskDefinitionRequestMessage
- type SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage
Constants ¶
const (
// View your email address
UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
)
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiPubSubCallbackMessage ¶
type ApiPubSubCallbackMessage 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 (*ApiPubSubCallbackMessage) MarshalJSON ¶
func (s *ApiPubSubCallbackMessage) MarshalJSON() ([]byte, error)
type ApiPutRequestMessage ¶
type ApiPutRequestMessage struct { Bucket string `json:"bucket,omitempty"` // Possible values: // "AUTO" // "CANARY" // "PROD" CanaryPreference string `json:"canary_preference,omitempty"` ClientOperationId string `json:"client_operation_id,omitempty"` LeaseExpirationTs int64 `json:"lease_expiration_ts,omitempty,string"` ParametersJson string `json:"parameters_json,omitempty"` PubsubCallback *ApiPubSubCallbackMessage `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 (*ApiPutRequestMessage) MarshalJSON ¶
func (s *ApiPutRequestMessage) MarshalJSON() ([]byte, error)
type GetBuildersCall ¶
type GetBuildersCall struct {
// contains filtered or unexported fields
}
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) (*SwarmingSwarmbucketApiGetBuildersResponseMessage, error)
Do executes the "swarmbucket.get_builders" call. Exactly one of *SwarmingSwarmbucketApiGetBuildersResponseMessage or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SwarmingSwarmbucketApiGetBuildersResponseMessage.ServerResponse.Heade r 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) (*SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage, error)
Do executes the "swarmbucket.get_task_def" call. Exactly one of *SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage.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 (*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 Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment // contains filtered or unexported fields }
func (*Service) GetBuilders ¶
func (s *Service) GetBuilders() *GetBuildersCall
GetBuilders: Returns defined swarmbucket builders. Can be used by code review tool to discover builders.
func (*Service) GetTaskDef ¶
func (s *Service) GetTaskDef(swarmingswarmbucketapigettaskdefinitionrequestmessage *SwarmingSwarmbucketApiGetTaskDefinitionRequestMessage) *GetTaskDefCall
GetTaskDef: Returns a swarming task definition for a build request.
type SwarmingSwarmbucketApiBucketMessage ¶
type SwarmingSwarmbucketApiBucketMessage struct { Builders []*SwarmingSwarmbucketApiBuilderMessage `json:"builders,omitempty"` Name string `json:"name,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 (*SwarmingSwarmbucketApiBucketMessage) MarshalJSON ¶
func (s *SwarmingSwarmbucketApiBucketMessage) MarshalJSON() ([]byte, error)
type SwarmingSwarmbucketApiBuilderMessage ¶
type SwarmingSwarmbucketApiBuilderMessage struct { Category string `json:"category,omitempty"` Name string `json:"name,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 (*SwarmingSwarmbucketApiBuilderMessage) MarshalJSON ¶
func (s *SwarmingSwarmbucketApiBuilderMessage) MarshalJSON() ([]byte, error)
type SwarmingSwarmbucketApiGetBuildersResponseMessage ¶
type SwarmingSwarmbucketApiGetBuildersResponseMessage struct { Buckets []*SwarmingSwarmbucketApiBucketMessage `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 (*SwarmingSwarmbucketApiGetBuildersResponseMessage) MarshalJSON ¶
func (s *SwarmingSwarmbucketApiGetBuildersResponseMessage) MarshalJSON() ([]byte, error)
type SwarmingSwarmbucketApiGetTaskDefinitionRequestMessage ¶
type SwarmingSwarmbucketApiGetTaskDefinitionRequestMessage struct { ApiExplorerLink bool `json:"api_explorer_link,omitempty"` BuildRequest *ApiPutRequestMessage `json:"build_request,omitempty"` // ForceSendFields is a list of field names (e.g. "ApiExplorerLink") 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. "ApiExplorerLink") 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 (*SwarmingSwarmbucketApiGetTaskDefinitionRequestMessage) MarshalJSON ¶
func (s *SwarmingSwarmbucketApiGetTaskDefinitionRequestMessage) MarshalJSON() ([]byte, error)
type SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage ¶
type SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage struct { ApiExplorerLink string `json:"api_explorer_link,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. "ApiExplorerLink") 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. "ApiExplorerLink") 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 (*SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage) MarshalJSON ¶
func (s *SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage) MarshalJSON() ([]byte, error)