Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.BuildsResource

The "builds" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.BuildsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudBuild.v1
Assembly: Google.Apis.CloudBuild.v1.dll
Syntax
public class ProjectsResource.LocationsResource.BuildsResource

Constructors

BuildsResource(IClientService)

Constructs a new resource.

Declaration
public BuildsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Approve(ApproveBuildRequest, string)

Approves or rejects a pending build. If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done.

Declaration
public virtual ProjectsResource.LocationsResource.BuildsResource.ApproveRequest Approve(ApproveBuildRequest body, string name)
Parameters
Type Name Description
ApproveBuildRequest body

The body of the request.

string name

Required. Name of the target build. For example: "projects/{$project_id}/builds/{$build_id}"

Returns
Type Description
ProjectsResource.LocationsResource.BuildsResource.ApproveRequest

Cancel(CancelBuildRequest, string)

Cancels a build in progress.

Declaration
public virtual ProjectsResource.LocationsResource.BuildsResource.CancelRequest Cancel(CancelBuildRequest body, string name)
Parameters
Type Name Description
CancelBuildRequest body

The body of the request.

string name

The name of the Build to cancel. Format: projects/{project}/locations/{location}/builds/{build}

Returns
Type Description
ProjectsResource.LocationsResource.BuildsResource.CancelRequest

Create(Build, string)

Starts a build with the specified configuration. This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Declaration
public virtual ProjectsResource.LocationsResource.BuildsResource.CreateRequest Create(Build body, string parent)
Parameters
Type Name Description
Build body

The body of the request.

string parent

The parent resource where this build will be created. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.BuildsResource.CreateRequest

Get(string)

Returns information about a previously requested build. The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

Declaration
public virtual ProjectsResource.LocationsResource.BuildsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

The name of the Build to retrieve. Format: projects/{project}/locations/{location}/builds/{build}

Returns
Type Description
ProjectsResource.LocationsResource.BuildsResource.GetRequest

List(string)

Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Declaration
public virtual ProjectsResource.LocationsResource.BuildsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

The parent of the collection of Builds. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.BuildsResource.ListRequest

Retry(RetryBuildRequest, string)

Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify RepoSource: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify StorageSource: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.

Declaration
public virtual ProjectsResource.LocationsResource.BuildsResource.RetryRequest Retry(RetryBuildRequest body, string name)
Parameters
Type Name Description
RetryBuildRequest body

The body of the request.

string name

The name of the Build to retry. Format: projects/{project}/locations/{location}/builds/{build}

Returns
Type Description
ProjectsResource.LocationsResource.BuildsResource.RetryRequest
In this article
Back to top Generated by DocFX