Class ProjectsResource.BuildsResource
The "builds" collection of methods.
Inherited Members
Namespace: Google.Apis.CloudBuild.v1
Assembly: Google.Apis.CloudBuild.v1.dll
Syntax
public class ProjectsResource.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 long-running operation (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.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.BuildsResource.ApproveRequest |
Cancel(CancelBuildRequest, string, string)
Cancels a build in progress. Note: This method only cancels builds in the "global" region when using the
legacy resource path projects/{project_id}/builds/{id}:cancel. For all regions, use the regional
resource path: projects/{project_id}/locations/{location}/builds/{id}:cancel.
Declaration
public virtual ProjectsResource.BuildsResource.CancelRequest Cancel(CancelBuildRequest body, string projectId, string id)
Parameters
| Type | Name | Description |
|---|---|---|
| CancelBuildRequest | body | The body of the request. |
| string | projectId | Required. ID of the project. |
| string | id | Required. ID of the build. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.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). Note: This method only creates builds in the "global" region when using the legacy
resource path projects/{project_id}/builds. For all regions, use the regional resource path:
projects/{project_id}/locations/{location}/builds.
Declaration
public virtual ProjectsResource.BuildsResource.CreateRequest Create(Build body, string projectId)
Parameters
| Type | Name | Description |
|---|---|---|
| Build | body | The body of the request. |
| string | projectId | Required. ID of the project. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.BuildsResource.CreateRequest |
Get(string, 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. Note: This method only gets builds
in the "global" region when using the legacy resource path projects/{project_id}/builds/{id}. For all
regions, use the regional resource path: projects/{project_id}/locations/{location}/builds/{id}.
Declaration
public virtual ProjectsResource.BuildsResource.GetRequest Get(string projectId, string id)
Parameters
| Type | Name | Description |
|---|---|---|
| string | projectId | Required. ID of the project. |
| string | id | Required. ID of the build. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.BuildsResource.GetRequest |
List(string)
Lists previously requested builds. Previously requested builds may still be in-progress, or may have
finished successfully or unsuccessfully. Note: This method only lists builds in the "global" region when
using the legacy resource path projects/{project_id}/builds. For all regions, use the regional resource
path: projects/{project_id}/locations/{location}/builds.
Declaration
public virtual ProjectsResource.BuildsResource.ListRequest List(string projectId)
Parameters
| Type | Name | Description |
|---|---|---|
| string | projectId | Required. ID of the project. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.BuildsResource.ListRequest |
Retry(RetryBuildRequest, string, string)
Creates a new build based on the specified build. Note: This method only creates builds in the "global"
region when using the legacy resource path projects/{project_id}/builds/{id}:retry. For all regions, use
the regional resource path: projects/{project_id}/locations/{location}/builds/{id}:retry. 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.BuildsResource.RetryRequest Retry(RetryBuildRequest body, string projectId, string id)
Parameters
| Type | Name | Description |
|---|---|---|
| RetryBuildRequest | body | The body of the request. |
| string | projectId | Required. ID of the project. |
| string | id | Required. Build ID of the original build. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.BuildsResource.RetryRequest |