Documentation ¶
Overview ¶
Package cloudbuild provides access to the Google Cloud Container Builder API.
See https://cloud.google.com/container-builder/docs/
Usage example:
import "google.golang.org/api/cloudbuild/v1" ... cloudbuildService, err := cloudbuild.New(oauthHttpClient)
Index ¶
- Constants
- type Build
- type BuildOperationMetadata
- type BuildOptions
- type BuildStep
- type BuildTrigger
- type BuiltImage
- type CancelBuildRequest
- type Empty
- type FileHashes
- type Hash
- type ListBuildTriggersResponse
- type ListBuildsResponse
- type ListOperationsResponse
- type Operation
- type OperationMetadata
- type OperationResponse
- type OperationsGetCall
- func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
- func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
- func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
- type OperationsListCall
- func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
- func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
- func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
- func (c *OperationsListCall) Filter(filter string) *OperationsListCall
- func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
- func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
- func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
- func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
- type OperationsService
- type ProjectsBuildsCancelCall
- type ProjectsBuildsCreateCall
- type ProjectsBuildsGetCall
- func (c *ProjectsBuildsGetCall) Context(ctx context.Context) *ProjectsBuildsGetCall
- func (c *ProjectsBuildsGetCall) Do(opts ...googleapi.CallOption) (*Build, error)
- func (c *ProjectsBuildsGetCall) Fields(s ...googleapi.Field) *ProjectsBuildsGetCall
- func (c *ProjectsBuildsGetCall) IfNoneMatch(entityTag string) *ProjectsBuildsGetCall
- type ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) Context(ctx context.Context) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) Do(opts ...googleapi.CallOption) (*ListBuildsResponse, error)
- func (c *ProjectsBuildsListCall) Fields(s ...googleapi.Field) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) IfNoneMatch(entityTag string) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) PageSize(pageSize int64) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) PageToken(pageToken string) *ProjectsBuildsListCall
- func (c *ProjectsBuildsListCall) Pages(ctx context.Context, f func(*ListBuildsResponse) error) error
- type ProjectsBuildsService
- func (r *ProjectsBuildsService) Cancel(projectId string, id string, cancelbuildrequest *CancelBuildRequest) *ProjectsBuildsCancelCall
- func (r *ProjectsBuildsService) Create(projectId string, build *Build) *ProjectsBuildsCreateCall
- func (r *ProjectsBuildsService) Get(projectId string, id string) *ProjectsBuildsGetCall
- func (r *ProjectsBuildsService) List(projectId string) *ProjectsBuildsListCall
- type ProjectsService
- type ProjectsTriggersCreateCall
- type ProjectsTriggersDeleteCall
- type ProjectsTriggersGetCall
- func (c *ProjectsTriggersGetCall) Context(ctx context.Context) *ProjectsTriggersGetCall
- func (c *ProjectsTriggersGetCall) Do(opts ...googleapi.CallOption) (*BuildTrigger, error)
- func (c *ProjectsTriggersGetCall) Fields(s ...googleapi.Field) *ProjectsTriggersGetCall
- func (c *ProjectsTriggersGetCall) IfNoneMatch(entityTag string) *ProjectsTriggersGetCall
- type ProjectsTriggersListCall
- func (c *ProjectsTriggersListCall) Context(ctx context.Context) *ProjectsTriggersListCall
- func (c *ProjectsTriggersListCall) Do(opts ...googleapi.CallOption) (*ListBuildTriggersResponse, error)
- func (c *ProjectsTriggersListCall) Fields(s ...googleapi.Field) *ProjectsTriggersListCall
- func (c *ProjectsTriggersListCall) IfNoneMatch(entityTag string) *ProjectsTriggersListCall
- type ProjectsTriggersPatchCall
- type ProjectsTriggersService
- func (r *ProjectsTriggersService) Create(projectId string, buildtrigger *BuildTrigger) *ProjectsTriggersCreateCall
- func (r *ProjectsTriggersService) Delete(projectId string, triggerId string) *ProjectsTriggersDeleteCall
- func (r *ProjectsTriggersService) Get(projectId string, triggerId string) *ProjectsTriggersGetCall
- func (r *ProjectsTriggersService) List(projectId string) *ProjectsTriggersListCall
- func (r *ProjectsTriggersService) Patch(projectId string, triggerId string, buildtrigger *BuildTrigger) *ProjectsTriggersPatchCall
- type RepoSource
- type Results
- type Service
- type Source
- type SourceProvenance
- type Status
- type StatusDetails
- type StorageSource
Constants ¶
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Build ¶
type Build struct { // CreateTime: Time at which the build was created. // @OutputOnly CreateTime string `json:"createTime,omitempty"` // FinishTime: Time at which execution of the build was // finished. // @OutputOnly FinishTime string `json:"finishTime,omitempty"` // Id: Unique identifier of the build. // @OutputOnly Id string `json:"id,omitempty"` // Images: List of images expected to be built and pushed to Google // Container // Registry. If an image is listed here and the image is not produced // by // one of the build steps, the build will fail. Any images present // when // the build steps are complete will be pushed to Container Registry. Images []string `json:"images,omitempty"` // LogUrl: URL to logs for this build in Google Cloud // Logging. // @OutputOnly LogUrl string `json:"logUrl,omitempty"` // LogsBucket: Google Cloud Storage bucket where logs should be written // (see // [Bucket // Name // Requirements](https://cloud.google.com/storage/docs/bucket-naming // #requirements)). // Logs file names will be of the format // `${logs_bucket}/log-${build_id}.txt`. LogsBucket string `json:"logsBucket,omitempty"` // Options: Special options for this build. Options *BuildOptions `json:"options,omitempty"` // ProjectId: ID of the project. // @OutputOnly. ProjectId string `json:"projectId,omitempty"` // Results: Results of the build. // @OutputOnly Results *Results `json:"results,omitempty"` // Source: Describes where to find the source files to build. Source *Source `json:"source,omitempty"` // SourceProvenance: A permanent fixed identifier for // source. // @OutputOnly SourceProvenance *SourceProvenance `json:"sourceProvenance,omitempty"` // StartTime: Time at which execution of the build was // started. // @OutputOnly StartTime string `json:"startTime,omitempty"` // Status: Status of the build. // @OutputOnly // // Possible values: // "STATUS_UNKNOWN" - Status of the build is unknown. // "QUEUING" - Build has been received and is being queued. // "QUEUED" - Build is queued; work has not yet begun. // "WORKING" - Build is being executed. // "SUCCESS" - Build finished successfully. // "FAILURE" - Build failed to complete successfully. // "INTERNAL_ERROR" - Build failed due to an internal cause. // "TIMEOUT" - Build took longer than was allowed. // "CANCELLED" - Build was canceled by a user. Status string `json:"status,omitempty"` // StatusDetail: Customer-readable message about the current // status. // @OutputOnly StatusDetail string `json:"statusDetail,omitempty"` // Steps: Describes the operations to be performed on the workspace. Steps []*BuildStep `json:"steps,omitempty"` // Timeout: Amount of time that this build should be allowed to run, to // second // granularity. If this amount of time elapses, work on the build will // cease // and the build status will be TIMEOUT. // // Default time is ten minutes. Timeout string `json:"timeout,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "CreateTime") 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:"-"` }
Build: A build resource in the Container Builder API.
At a high level, a Build describes where to find source code, how to build it (for example, the builder image to run on the source), and what tag to apply to the built image when it is pushed to Google Container Registry.
func (*Build) MarshalJSON ¶
type BuildOperationMetadata ¶
type BuildOperationMetadata struct { // Build: The build that the operation is tracking. Build *Build `json:"build,omitempty"` // ForceSendFields is a list of field names (e.g. "Build") 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:"-"` }
BuildOperationMetadata: Metadata for build operations.
func (*BuildOperationMetadata) MarshalJSON ¶
func (s *BuildOperationMetadata) MarshalJSON() ([]byte, error)
type BuildOptions ¶
type BuildOptions struct { // RequestedVerifyOption: Options for a verifiable build with details // uploaded to the Analysis API. // // Possible values: // "NOT_VERIFIED" - Not a verifiable build. (default) // "VERIFIED" - Verified build. RequestedVerifyOption string `json:"requestedVerifyOption,omitempty"` // SourceProvenanceHash: Requested hash for SourceProvenance. // // Possible values: // "NONE" - No hash requested. // "SHA256" - Use a sha256 hash. SourceProvenanceHash []string `json:"sourceProvenanceHash,omitempty"` // ForceSendFields is a list of field names (e.g. // "RequestedVerifyOption") 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:"-"` }
BuildOptions: Optional arguments to enable specific features of builds.
func (*BuildOptions) MarshalJSON ¶
func (s *BuildOptions) MarshalJSON() ([]byte, error)
type BuildStep ¶
type BuildStep struct { // Args: Command-line arguments to use when running this step's // container. Args []string `json:"args,omitempty"` // Dir: Working directory (relative to project source root) to use when // running // this operation's container. Dir string `json:"dir,omitempty"` // Env: Additional environment variables to set for this step's // container. Env []string `json:"env,omitempty"` // Id: Optional unique identifier for this build step, used in wait_for // to // reference this build step as a dependency. Id string `json:"id,omitempty"` // Name: Name of the container image to use for creating this stage in // the // pipeline, as presented to `docker pull`. Name string `json:"name,omitempty"` // WaitFor: The ID(s) of the step(s) that this build step depends // on. // This build step will not start until all the build steps in // wait_for // have completed successfully. If wait_for is empty, this build step // will // start when all previous build steps in the Build.Steps list have // completed // successfully. WaitFor []string `json:"waitFor,omitempty"` // ForceSendFields is a list of field names (e.g. "Args") 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:"-"` }
BuildStep: BuildStep describes a step to perform in the build pipeline.
func (*BuildStep) MarshalJSON ¶
type BuildTrigger ¶
type BuildTrigger struct { // Build: Contents of the build template. Build *Build `json:"build,omitempty"` // CreateTime: Time when the trigger was created. // // @OutputOnly CreateTime string `json:"createTime,omitempty"` // Id: Unique identifier of the trigger. // // @OutputOnly Id string `json:"id,omitempty"` // TriggerTemplate: Template describing the types of source changes to // trigger a build. // // Branch and tag names in trigger templates are interpreted as // regular // expressions. Any branch or tag change that matches that regular // expression // will trigger a build. TriggerTemplate *RepoSource `json:"triggerTemplate,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Build") 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:"-"` }
BuildTrigger: Configuration for an automated build in response to source repository changes.
func (*BuildTrigger) MarshalJSON ¶
func (s *BuildTrigger) MarshalJSON() ([]byte, error)
type BuiltImage ¶
type BuiltImage struct { // Digest: Docker Registry 2.0 digest. Digest string `json:"digest,omitempty"` // Name: Name used to push the container image to Google Container // Registry, as // presented to `docker push`. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Digest") 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:"-"` }
BuiltImage: BuiltImage describes an image built by the pipeline.
func (*BuiltImage) MarshalJSON ¶
func (s *BuiltImage) MarshalJSON() ([]byte, error)
type CancelBuildRequest ¶
type CancelBuildRequest struct { }
CancelBuildRequest: Request to cancel an ongoing build.
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
service Foo { rpc Bar(google.protobuf.Empty) returns
(google.protobuf.Empty);
}
The JSON representation for `Empty` is empty JSON object `{}`.
type FileHashes ¶
type FileHashes struct { // FileHash: Collection of file hashes. FileHash []*Hash `json:"fileHash,omitempty"` // ForceSendFields is a list of field names (e.g. "FileHash") 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:"-"` }
FileHashes: Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
func (*FileHashes) MarshalJSON ¶
func (s *FileHashes) MarshalJSON() ([]byte, error)
type Hash ¶
type Hash struct { // Type: The type of hash that was performed. // // Possible values: // "NONE" - No hash requested. // "SHA256" - Use a sha256 hash. Type string `json:"type,omitempty"` // Value: The hash value. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Type") 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:"-"` }
Hash: Container message for hash values.
func (*Hash) MarshalJSON ¶
type ListBuildTriggersResponse ¶
type ListBuildTriggersResponse struct { // Triggers: BuildTriggers for the project, sorted by create_time // descending. Triggers []*BuildTrigger `json:"triggers,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Triggers") 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:"-"` }
ListBuildTriggersResponse: Response containing existing BuildTriggers.
func (*ListBuildTriggersResponse) MarshalJSON ¶
func (s *ListBuildTriggersResponse) MarshalJSON() ([]byte, error)
type ListBuildsResponse ¶
type ListBuildsResponse struct { // Builds: Builds will be sorted by create_time, descending. Builds []*Build `json:"builds,omitempty"` // NextPageToken: Token to receive the next page of results. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Builds") 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:"-"` }
ListBuildsResponse: Response including listed builds.
func (*ListBuildsResponse) MarshalJSON ¶
func (s *ListBuildsResponse) MarshalJSON() ([]byte, error)
type ListOperationsResponse ¶
type ListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in // the request. Operations []*Operation `json:"operations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") 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:"-"` }
ListOperationsResponse: The response message for Operations.ListOperations.
func (*ListOperationsResponse) MarshalJSON ¶
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
type Operation ¶
type Operation struct { // Done: If the value is `false`, it means the operation is still in // progress. // If true, the operation is completed, and either `error` or `response` // is // available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure. Error *Status `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. // It typically // contains progress information and common metadata such as create // time. // Some services might not provide such metadata. Any method that // returns a // long-running operation should document the metadata type, if any. Metadata OperationMetadata `json:"metadata,omitempty"` // Name: The server-assigned name, which is only unique within the same // service that // originally returns it. If you use the default HTTP mapping, // the // `name` should have the format of `operations/some/unique/name`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. // If the original // method returns no data on success, such as `Delete`, the response // is // `google.protobuf.Empty`. If the original method is // standard // `Get`/`Create`/`Update`, the response should be the resource. For // other // methods, the response should have the type `XxxResponse`, where // `Xxx` // is the original method name. For example, if the original method // name // is `TakeSnapshot()`, the inferred response type // is // `TakeSnapshotResponse`. Response OperationResponse `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") 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:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶
type OperationMetadata ¶
type OperationMetadata interface{}
type OperationResponse ¶
type OperationResponse interface{}
type OperationsGetCall ¶
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (*OperationsGetCall) Context ¶
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
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 (*OperationsGetCall) Do ¶
func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudbuild.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*OperationsGetCall) Fields ¶
func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsGetCall) IfNoneMatch ¶
func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
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 OperationsListCall ¶
type OperationsListCall struct {
// contains filtered or unexported fields
}
func (*OperationsListCall) Context ¶
func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
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 (*OperationsListCall) Do ¶
func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "cloudbuild.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.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 (*OperationsListCall) Fields ¶
func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsListCall) Filter ¶
func (c *OperationsListCall) Filter(filter string) *OperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*OperationsListCall) IfNoneMatch ¶
func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
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.
func (*OperationsListCall) PageSize ¶
func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*OperationsListCall) PageToken ¶
func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*OperationsListCall) Pages ¶
func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type OperationsService ¶
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService ¶
func NewOperationsService(s *Service) *OperationsService
func (*OperationsService) Get ¶
func (r *OperationsService) Get(name string) *OperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
func (*OperationsService) List ¶
func (r *OperationsService) List(name string) *OperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.
type ProjectsBuildsCancelCall ¶
type ProjectsBuildsCancelCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBuildsCancelCall) Context ¶
func (c *ProjectsBuildsCancelCall) Context(ctx context.Context) *ProjectsBuildsCancelCall
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 (*ProjectsBuildsCancelCall) Do ¶
func (c *ProjectsBuildsCancelCall) Do(opts ...googleapi.CallOption) (*Build, error)
Do executes the "cloudbuild.projects.builds.cancel" call. Exactly one of *Build or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Build.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 (*ProjectsBuildsCancelCall) Fields ¶
func (c *ProjectsBuildsCancelCall) Fields(s ...googleapi.Field) *ProjectsBuildsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsBuildsCreateCall ¶
type ProjectsBuildsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBuildsCreateCall) Context ¶
func (c *ProjectsBuildsCreateCall) Context(ctx context.Context) *ProjectsBuildsCreateCall
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 (*ProjectsBuildsCreateCall) Do ¶
func (c *ProjectsBuildsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudbuild.projects.builds.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*ProjectsBuildsCreateCall) Fields ¶
func (c *ProjectsBuildsCreateCall) Fields(s ...googleapi.Field) *ProjectsBuildsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsBuildsGetCall ¶
type ProjectsBuildsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBuildsGetCall) Context ¶
func (c *ProjectsBuildsGetCall) Context(ctx context.Context) *ProjectsBuildsGetCall
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 (*ProjectsBuildsGetCall) Do ¶
func (c *ProjectsBuildsGetCall) Do(opts ...googleapi.CallOption) (*Build, error)
Do executes the "cloudbuild.projects.builds.get" call. Exactly one of *Build or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Build.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 (*ProjectsBuildsGetCall) Fields ¶
func (c *ProjectsBuildsGetCall) Fields(s ...googleapi.Field) *ProjectsBuildsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBuildsGetCall) IfNoneMatch ¶
func (c *ProjectsBuildsGetCall) IfNoneMatch(entityTag string) *ProjectsBuildsGetCall
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 ProjectsBuildsListCall ¶
type ProjectsBuildsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsBuildsListCall) Context ¶
func (c *ProjectsBuildsListCall) Context(ctx context.Context) *ProjectsBuildsListCall
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 (*ProjectsBuildsListCall) Do ¶
func (c *ProjectsBuildsListCall) Do(opts ...googleapi.CallOption) (*ListBuildsResponse, error)
Do executes the "cloudbuild.projects.builds.list" call. Exactly one of *ListBuildsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBuildsResponse.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 (*ProjectsBuildsListCall) Fields ¶
func (c *ProjectsBuildsListCall) Fields(s ...googleapi.Field) *ProjectsBuildsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsBuildsListCall) IfNoneMatch ¶
func (c *ProjectsBuildsListCall) IfNoneMatch(entityTag string) *ProjectsBuildsListCall
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.
func (*ProjectsBuildsListCall) PageSize ¶
func (c *ProjectsBuildsListCall) PageSize(pageSize int64) *ProjectsBuildsListCall
PageSize sets the optional parameter "pageSize": Number of results to return in the list.
func (*ProjectsBuildsListCall) PageToken ¶
func (c *ProjectsBuildsListCall) PageToken(pageToken string) *ProjectsBuildsListCall
PageToken sets the optional parameter "pageToken": Token to provide to skip to a particular spot in the list.
func (*ProjectsBuildsListCall) Pages ¶
func (c *ProjectsBuildsListCall) Pages(ctx context.Context, f func(*ListBuildsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsBuildsService ¶
type ProjectsBuildsService struct {
// contains filtered or unexported fields
}
func NewProjectsBuildsService ¶
func NewProjectsBuildsService(s *Service) *ProjectsBuildsService
func (*ProjectsBuildsService) Cancel ¶
func (r *ProjectsBuildsService) Cancel(projectId string, id string, cancelbuildrequest *CancelBuildRequest) *ProjectsBuildsCancelCall
Cancel: Cancels a requested build in progress.
func (*ProjectsBuildsService) Create ¶
func (r *ProjectsBuildsService) Create(projectId string, build *Build) *ProjectsBuildsCreateCall
Create: Starts a build with the specified configuration.
The long-running Operation returned by this method will include the ID of the build, which can be passed to GetBuild to determine its status (e.g., success or failure).
func (*ProjectsBuildsService) Get ¶
func (r *ProjectsBuildsService) Get(projectId string, id string) *ProjectsBuildsGetCall
Get: Returns information about a previously requested build.
The Build that is returned includes its status (e.g., success or failure, or in-progress), and timing information.
func (*ProjectsBuildsService) List ¶
func (r *ProjectsBuildsService) List(projectId string) *ProjectsBuildsListCall
List: Lists previously requested builds.
Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
type ProjectsService ¶
type ProjectsService struct { Builds *ProjectsBuildsService Triggers *ProjectsTriggersService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type ProjectsTriggersCreateCall ¶
type ProjectsTriggersCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersCreateCall) Context ¶
func (c *ProjectsTriggersCreateCall) Context(ctx context.Context) *ProjectsTriggersCreateCall
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 (*ProjectsTriggersCreateCall) Do ¶
func (c *ProjectsTriggersCreateCall) Do(opts ...googleapi.CallOption) (*BuildTrigger, error)
Do executes the "cloudbuild.projects.triggers.create" call. Exactly one of *BuildTrigger or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BuildTrigger.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 (*ProjectsTriggersCreateCall) Fields ¶
func (c *ProjectsTriggersCreateCall) Fields(s ...googleapi.Field) *ProjectsTriggersCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsTriggersDeleteCall ¶
type ProjectsTriggersDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersDeleteCall) Context ¶
func (c *ProjectsTriggersDeleteCall) Context(ctx context.Context) *ProjectsTriggersDeleteCall
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 (*ProjectsTriggersDeleteCall) Do ¶
func (c *ProjectsTriggersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudbuild.projects.triggers.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsTriggersDeleteCall) Fields ¶
func (c *ProjectsTriggersDeleteCall) Fields(s ...googleapi.Field) *ProjectsTriggersDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsTriggersGetCall ¶
type ProjectsTriggersGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersGetCall) Context ¶
func (c *ProjectsTriggersGetCall) Context(ctx context.Context) *ProjectsTriggersGetCall
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 (*ProjectsTriggersGetCall) Do ¶
func (c *ProjectsTriggersGetCall) Do(opts ...googleapi.CallOption) (*BuildTrigger, error)
Do executes the "cloudbuild.projects.triggers.get" call. Exactly one of *BuildTrigger or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BuildTrigger.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 (*ProjectsTriggersGetCall) Fields ¶
func (c *ProjectsTriggersGetCall) Fields(s ...googleapi.Field) *ProjectsTriggersGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTriggersGetCall) IfNoneMatch ¶
func (c *ProjectsTriggersGetCall) IfNoneMatch(entityTag string) *ProjectsTriggersGetCall
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 ProjectsTriggersListCall ¶
type ProjectsTriggersListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersListCall) Context ¶
func (c *ProjectsTriggersListCall) Context(ctx context.Context) *ProjectsTriggersListCall
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 (*ProjectsTriggersListCall) Do ¶
func (c *ProjectsTriggersListCall) Do(opts ...googleapi.CallOption) (*ListBuildTriggersResponse, error)
Do executes the "cloudbuild.projects.triggers.list" call. Exactly one of *ListBuildTriggersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBuildTriggersResponse.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 (*ProjectsTriggersListCall) Fields ¶
func (c *ProjectsTriggersListCall) Fields(s ...googleapi.Field) *ProjectsTriggersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTriggersListCall) IfNoneMatch ¶
func (c *ProjectsTriggersListCall) IfNoneMatch(entityTag string) *ProjectsTriggersListCall
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 ProjectsTriggersPatchCall ¶
type ProjectsTriggersPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTriggersPatchCall) Context ¶
func (c *ProjectsTriggersPatchCall) Context(ctx context.Context) *ProjectsTriggersPatchCall
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 (*ProjectsTriggersPatchCall) Do ¶
func (c *ProjectsTriggersPatchCall) Do(opts ...googleapi.CallOption) (*BuildTrigger, error)
Do executes the "cloudbuild.projects.triggers.patch" call. Exactly one of *BuildTrigger or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BuildTrigger.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 (*ProjectsTriggersPatchCall) Fields ¶
func (c *ProjectsTriggersPatchCall) Fields(s ...googleapi.Field) *ProjectsTriggersPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsTriggersService ¶
type ProjectsTriggersService struct {
// contains filtered or unexported fields
}
func NewProjectsTriggersService ¶
func NewProjectsTriggersService(s *Service) *ProjectsTriggersService
func (*ProjectsTriggersService) Create ¶
func (r *ProjectsTriggersService) Create(projectId string, buildtrigger *BuildTrigger) *ProjectsTriggersCreateCall
Create: Creates a new BuildTrigger.
This API is experimental.
func (*ProjectsTriggersService) Delete ¶
func (r *ProjectsTriggersService) Delete(projectId string, triggerId string) *ProjectsTriggersDeleteCall
Delete: Deletes an BuildTrigger by its project ID and trigger ID.
This API is experimental.
func (*ProjectsTriggersService) Get ¶
func (r *ProjectsTriggersService) Get(projectId string, triggerId string) *ProjectsTriggersGetCall
Get: Gets information about a BuildTrigger.
This API is experimental.
func (*ProjectsTriggersService) List ¶
func (r *ProjectsTriggersService) List(projectId string) *ProjectsTriggersListCall
List: Lists existing BuildTrigger.
This API is experimental.
func (*ProjectsTriggersService) Patch ¶
func (r *ProjectsTriggersService) Patch(projectId string, triggerId string, buildtrigger *BuildTrigger) *ProjectsTriggersPatchCall
Patch: Updates an BuildTrigger by its project ID and trigger ID.
This API is experimental.
type RepoSource ¶
type RepoSource struct { // BranchName: Name of the branch to build. BranchName string `json:"branchName,omitempty"` // CommitSha: Explicit commit SHA to build. CommitSha string `json:"commitSha,omitempty"` // ProjectId: ID of the project that owns the repo. If omitted, the // project ID requesting // the build is assumed. ProjectId string `json:"projectId,omitempty"` // RepoName: Name of the repo. If omitted, the name "default" is // assumed. RepoName string `json:"repoName,omitempty"` // TagName: Name of the tag to build. TagName string `json:"tagName,omitempty"` // ForceSendFields is a list of field names (e.g. "BranchName") 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:"-"` }
RepoSource: RepoSource describes the location of the source in a Google Cloud Source Repository.
func (*RepoSource) MarshalJSON ¶
func (s *RepoSource) MarshalJSON() ([]byte, error)
type Results ¶
type Results struct { // BuildStepImages: List of build step digests, in order corresponding // to build step indices. BuildStepImages []string `json:"buildStepImages,omitempty"` // Images: Images that were built as a part of the build. Images []*BuiltImage `json:"images,omitempty"` // ForceSendFields is a list of field names (e.g. "BuildStepImages") 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:"-"` }
Results: Results describes the artifacts created by the build pipeline.
func (*Results) MarshalJSON ¶
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Operations *OperationsService Projects *ProjectsService // contains filtered or unexported fields }
type Source ¶
type Source struct { // RepoSource: If provided, get source from this location in a Cloud // Repo. RepoSource *RepoSource `json:"repoSource,omitempty"` // StorageSource: If provided, get the source from this location in in // Google Cloud // Storage. StorageSource *StorageSource `json:"storageSource,omitempty"` // ForceSendFields is a list of field names (e.g. "RepoSource") 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:"-"` }
Source: Source describes the location of the source in a supported storage service.
func (*Source) MarshalJSON ¶
type SourceProvenance ¶
type SourceProvenance struct { // FileHashes: Hash(es) of the build source, which can be used to verify // that the original // source integrity was maintained in the build. Note that FileHashes // will // only be populated if BuildOptions has requested a // SourceProvenanceHash. // // The keys to this map are file paths used as build source and the // values // contain the hash values for those files. // // If the build source came in a single package such as a gzipped // tarfile // (.tar.gz), the FileHash will be for the single path to that // file. // @OutputOnly FileHashes map[string]FileHashes `json:"fileHashes,omitempty"` // ResolvedRepoSource: A copy of the build's source.repo_source, if // exists, with any // revisions resolved. ResolvedRepoSource *RepoSource `json:"resolvedRepoSource,omitempty"` // ResolvedStorageSource: A copy of the build's source.storage_source, // if exists, with any // generations resolved. ResolvedStorageSource *StorageSource `json:"resolvedStorageSource,omitempty"` // ForceSendFields is a list of field names (e.g. "FileHashes") 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:"-"` }
SourceProvenance: Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
func (*SourceProvenance) MarshalJSON ¶
func (s *SourceProvenance) MarshalJSON() ([]byte, error)
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There will // be a // common set of message types for APIs to use. Details []StatusDetails `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any // user-facing error message should be localized and sent in // the // google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") 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:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:
- Simple to use and understand for most users - Flexible enough to meet unexpected needs
Overview ¶
The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions.
Language mapping ¶
The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.
Other uses ¶
The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.
Example uses of this error model include:
- Partial errors. If a service needs to return partial errors to the client,
it may embed the `Status` in the normal response to indicate the
partial
errors.
- Workflow errors. A typical workflow has multiple steps. Each step may
have a `Status` message for error reporting purpose.
- Batch operations. If a client uses batch request and batch response, the
`Status` message should be used directly inside batch response,
one for
each error sub-response.
- Asynchronous operations. If an API call embeds asynchronous operation
results in its response, the status of those operations should
be
represented directly using the `Status` message.
- Logging. If some API errors are stored in logs, the message `Status` could
be used directly after any stripping needed for security/privacy
reasons.
func (*Status) MarshalJSON ¶
type StatusDetails ¶
type StatusDetails interface{}
type StorageSource ¶
type StorageSource struct { // Bucket: Google Cloud Storage bucket containing source (see // [Bucket // Name // Requirements](https://cloud.google.com/storage/docs/bucket-naming // #requirements)). Bucket string `json:"bucket,omitempty"` // Generation: Google Cloud Storage generation for the object. If the // generation is // omitted, the latest generation will be used. Generation int64 `json:"generation,omitempty,string"` // Object: Google Cloud Storage object containing source. // // This object must be a gzipped archive file (.tar.gz) containing // source to // build. Object string `json:"object,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:"-"` }
StorageSource: StorageSource describes the location of the source in an archive file in Google Cloud Storage.
func (*StorageSource) MarshalJSON ¶
func (s *StorageSource) MarshalJSON() ([]byte, error)