Google Cloud Run V2 Client - Class ListInstancesRequest (1.12.0)

Reference documentation and code samples for the Google Cloud Run V2 Client class ListInstancesRequest.

Request message for retrieving a list of Instances.

Generated from protobuf message google.cloud.run.v2.ListInstancesRequest

Namespace

Google \ Cloud \ Run \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number.

↳ page_size int

Optional. Maximum number of Instances to return in this call.

↳ page_token string

Optional. A page token received from a previous call to ListInstances. All other parameters must match.

↳ show_deleted bool

Optional. If true, returns deleted (but unexpired) resources along with active ones.

getParent

Required. The location and project to list resources on.

Format: projects/{project}/locations/{location}, where {project} can be project id or number.

Returns
Type Description
string

setParent

Required. The location and project to list resources on.

Format: projects/{project}/locations/{location}, where {project} can be project id or number.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Maximum number of Instances to return in this call.

Returns
Type Description
int

setPageSize

Optional. Maximum number of Instances to return in this call.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token received from a previous call to ListInstances.

All other parameters must match.

Returns
Type Description
string

setPageToken

Optional. A page token received from a previous call to ListInstances.

All other parameters must match.

Parameter
Name Description
var string
Returns
Type Description
$this

getShowDeleted

Optional. If true, returns deleted (but unexpired) resources along with active ones.

Returns
Type Description
bool

setShowDeleted

Optional. If true, returns deleted (but unexpired) resources along with active ones.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Please see InstancesClient::locationName() for help formatting this field.

Returns
Type Description
ListInstancesRequest