Google Cloud Resource Manager V3 Client - Class ListProjectsRequest (0.5.0)

Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class ListProjectsRequest.

The request sent to the ListProjects method.

Generated from protobuf message google.cloud.resourcemanager.v3.ListProjectsRequest

Methods

build

Parameter
NameDescription
parent string

Required. The name of the parent resource whose projects are being listed. Only children of this parent resource are listed; descendants are not listed.

If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

Returns
TypeDescription
Google\Cloud\ResourceManager\V3\ListProjectsRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The name of the parent resource whose projects are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

↳ page_token string

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

↳ page_size int

Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.

↳ show_deleted bool

Optional. Indicate that projects in the DELETE_REQUESTED state should also be returned. Normally only ACTIVE projects are returned.

getParent

Required. The name of the parent resource whose projects are being listed.

Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

Returns
TypeDescription
string

setParent

Required. The name of the parent resource whose projects are being listed.

Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageToken

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

Returns
TypeDescription
string

setPageToken

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. The maximum number of projects to return in the response.

The server can return fewer projects than requested. If unspecified, server picks an appropriate default.

Returns
TypeDescription
int

setPageSize

Optional. The maximum number of projects to return in the response.

The server can return fewer projects than requested. If unspecified, server picks an appropriate default.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getShowDeleted

Optional. Indicate that projects in the DELETE_REQUESTED state should also be returned. Normally only ACTIVE projects are returned.

Returns
TypeDescription
bool

setShowDeleted

Optional. Indicate that projects in the DELETE_REQUESTED state should also be returned. Normally only ACTIVE projects are returned.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this