Documentation

Google_Service_CloudBuild_Resource_ProjectsLocationsBuilds extends Google_Service_Resource
in package

Application

The "builds" collection of methods.

Typical usage is: $cloudbuildService = new Google_Service_CloudBuild(...); $builds = $cloudbuildService->builds;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
cancel() : Google_Service_CloudBuild_Build: Cancels a build in progress. (builds.cancel)
create() : Google_Service_CloudBuild_Operation: 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`).
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_CloudBuild_Build: Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. (builds.get)
listProjectsLocationsBuilds() : Google_Service_CloudBuild_ListBuildsResponse: Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
retry() : Google_Service_CloudBuild_Operation: 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.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

cancel()

Cancels a build in progress. (builds.cancel)


    public
                cancel(string $name, Google_Service_CloudBuild_CancelBuildRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudBuild_Build

Parameters

$name : string: The name of the Build to retrieve. Format: projects/{project}/locations/{location}/builds/{build}
$postBody : Google_Service_CloudBuild_CancelBuildRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudBuild_Build —

create()

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`).


    public
                create(string $parent, Google_Service_CloudBuild_Build $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudBuild_Operation

(builds.create)

Parameters

$parent : string: The parent resource where this build will be created. Format: projects/{project}/locations/{location}
$postBody : Google_Service_CloudBuild_Build
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudBuild_Operation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

get()

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


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudBuild_Build

Parameters

$name : string: The name of the Build to retrieve. Format: projects/{project}/locations/{location}/builds/{build}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudBuild_Build —

listProjectsLocationsBuilds()

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


    public
                listProjectsLocationsBuilds(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudBuild_ListBuildsResponse

(builds.listProjectsLocationsBuilds)

Parameters

$parent : string: The parent of the collection of Builds. Format: projects/{project}/locations/location
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudBuild_ListBuildsResponse —

retry()

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.


    public
                retry(string $name, Google_Service_CloudBuild_RetryBuildRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudBuild_Operation

For builds that specify StorageSource: * If the original build pulled source from Google 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. (builds.retry)

Parameters

$name : string: The name of the Build to retry. Format: projects/{project}/locations/{location}/builds/{build}
$postBody : Google_Service_CloudBuild_RetryBuildRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudBuild_Operation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —