Google Cloud Access Approval V1 Client - Class ListApprovalRequestsMessage (2.0.0)

Reference documentation and code samples for the Google Cloud Access Approval V1 Client class ListApprovalRequestsMessage.

Request to list approval requests.

Generated from protobuf message google.cloud.accessapproval.v1.ListApprovalRequestsMessage

Namespace

Google \ Cloud \ AccessApproval \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".

↳ filter string

A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.

↳ page_size int

Requested page size.

↳ page_token string

A token identifying the page of results to return.

getParent

The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".

Returns
Type Description
string

setParent

The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

A filter on the type of approval requests to retrieve. Must be one of the following values:

  • [not set]: Requests that are pending or have active approvals.
  • ALL: All requests.
    • PENDING: Only pending requests.
    • ACTIVE: Only active (i.e. currently approved) requests.
    • DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration.
    • EXPIRED: Only requests that have been approved, and the approval has expired.
    • HISTORY: Active, dismissed and expired requests.
Returns
Type Description
string

setFilter

A filter on the type of approval requests to retrieve. Must be one of the following values:

  • [not set]: Requests that are pending or have active approvals.
  • ALL: All requests.
    • PENDING: Only pending requests.
    • ACTIVE: Only active (i.e. currently approved) requests.
    • DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration.
    • EXPIRED: Only requests that have been approved, and the approval has expired.
    • HISTORY: Active, dismissed and expired requests.
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Requested page size.

Returns
Type Description
int

setPageSize

Requested page size.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A token identifying the page of results to return.

Returns
Type Description
string

setPageToken

A token identifying the page of results to return.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".

Returns
Type Description
Google\Cloud\AccessApproval\V1\ListApprovalRequestsMessage