Google Cloud Build V1 Client - Class ListBuildsRequest (0.9.0)

Reference documentation and code samples for the Google Cloud Build V1 Client class ListBuildsRequest.

Request to list builds.

Generated from protobuf message google.devtools.cloudbuild.v1.ListBuildsRequest

Namespace

Google \ Cloud \ Build \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ project_id string

Required. ID of the project.

↳ page_size int

Number of results to return in the list.

↳ page_token string

The page token for the next page of Builds. If unspecified, the first page of results is returned. If the token is rejected for any reason, INVALID_ARGUMENT will be thrown. In this case, the token should be discarded, and pagination should be restarted from the first page of results. See https://google.aip.dev/158 for more.

↳ filter string

The raw filter text to constrain the results.

getParent

The parent of the collection of Builds.

Format: projects/{project}/locations/{location}

Returns
TypeDescription
string

setParent

The parent of the collection of Builds.

Format: projects/{project}/locations/{location}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProjectId

Required. ID of the project.

Returns
TypeDescription
string

setProjectId

Required. ID of the project.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Number of results to return in the list.

Returns
TypeDescription
int

setPageSize

Number of results to return in the list.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The page token for the next page of Builds.

If unspecified, the first page of results is returned. If the token is rejected for any reason, INVALID_ARGUMENT will be thrown. In this case, the token should be discarded, and pagination should be restarted from the first page of results. See https://google.aip.dev/158 for more.

Returns
TypeDescription
string

setPageToken

The page token for the next page of Builds.

If unspecified, the first page of results is returned. If the token is rejected for any reason, INVALID_ARGUMENT will be thrown. In this case, the token should be discarded, and pagination should be restarted from the first page of results. See https://google.aip.dev/158 for more.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

The raw filter text to constrain the results.

Returns
TypeDescription
string

setFilter

The raw filter text to constrain the results.

Parameter
NameDescription
var string
Returns
TypeDescription
$this