Documentation

Google_Service_AccessApproval_Resource_FoldersApprovalRequests extends Google_Service_Resource
in package

The "approvalRequests" collection of methods.

Typical usage is: $accessapprovalService = new Google_Service_AccessApproval(...); $approvalRequests = $accessapprovalService->approvalRequests;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
approve()  : Google_Service_AccessApproval_ApprovalRequest
Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. (approvalRequests.approve)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
dismiss()  : Google_Service_AccessApproval_ApprovalRequest
Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. (approvalRequests.dismiss)
get()  : Google_Service_AccessApproval_ApprovalRequest
Gets an approval request. Returns NOT_FOUND if the request does not exist.
listFoldersApprovalRequests()  : Google_Service_AccessApproval_ListApprovalRequestsResponse
Lists approval requests associated with a project, folder, or organization.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

approve()

Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. (approvalRequests.approve)

public approve(string $name, Google_Service_AccessApproval_ApproveApprovalRequestMessage $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AccessApproval_ApprovalRequest
Parameters
$name : string

Name of the approval request to approve.

$postBody : Google_Service_AccessApproval_ApproveApprovalRequestMessage
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AccessApproval_ApprovalRequest —

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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

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>
Tags
static
Return values
string —

$requestUrl

dismiss()

Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. (approvalRequests.dismiss)

public dismiss(string $name, Google_Service_AccessApproval_DismissApprovalRequestMessage $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AccessApproval_ApprovalRequest
Parameters
$name : string

Name of the ApprovalRequest to dismiss.

$postBody : Google_Service_AccessApproval_DismissApprovalRequestMessage
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AccessApproval_ApprovalRequest —

listFoldersApprovalRequests()

Lists approval requests associated with a project, folder, or organization.

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

Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. (approvalRequests.listFoldersApprovalRequests)

Parameters
$parent : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken A token identifying the page of results to return.

opt_param

int pageSize Requested page size.

opt_param

string filter 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 dismissed (including expired) requests. * HISTORY: Active and dismissed (including expired) requests.

Return values
Google_Service_AccessApproval_ListApprovalRequestsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results