Documentation

Google_Service_FirebaseRulesAPI_Resource_ProjectsRulesets extends Google_Service_Resource
in package

The "rulesets" collection of methods.

Typical usage is: $firebaserulesService = new Google_Service_FirebaseRulesAPI(...); $rulesets = $firebaserulesService->rulesets;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_FirebaseRulesAPI_Ruleset
Create a `Ruleset` from `Source`.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_FirebaseRulesAPI_FirebaserulesEmpty
Delete a `Ruleset` by resource name.
get()  : Google_Service_FirebaseRulesAPI_Ruleset
Get a `Ruleset` by name including the full `Source` contents. (rulesets.get)
listProjectsRulesets()  : Google_Service_FirebaseRulesAPI_ListRulesetsResponse
List `Ruleset` metadata only and optionally filter the results by Ruleset name.
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 —

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 —

create()

Create a `Ruleset` from `Source`.

public create(string $name, Google_Service_FirebaseRulesAPI_Ruleset $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseRulesAPI_Ruleset

The Ruleset is given a unique generated name which is returned to the caller. Source containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of Source issues, use TestRuleset. (rulesets.create)

Parameters
$name : string

Resource name for Project which owns this Ruleset.

Format: projects/{project_id}

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

Optional parameters.

Return values
Google_Service_FirebaseRulesAPI_Ruleset —

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

delete()

Delete a `Ruleset` by resource name.

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseRulesAPI_FirebaserulesEmpty

If the Ruleset is referenced by a Release the operation will fail. (rulesets.delete)

Parameters
$name : string

Resource name for the ruleset to delete.

Format: projects/{project_id}/rulesets/{ruleset_id}

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

Optional parameters.

Return values
Google_Service_FirebaseRulesAPI_FirebaserulesEmpty —

listProjectsRulesets()

List `Ruleset` metadata only and optionally filter the results by Ruleset name.

public listProjectsRulesets(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseRulesAPI_ListRulesetsResponse

The full Source contents of a Ruleset may be retrieved with GetRuleset. (rulesets.listProjectsRulesets)

Parameters
$name : string

Resource name for the project.

Format: projects/{project_id}

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

Optional parameters.

Tags
opt_param

int pageSize Page size to load. Maximum of 100. Defaults to 10. Note: page_size is just a hint and the service may choose to load less than page_size due to the size of the output. To traverse all of the releases, caller should iterate until the page_token is empty.

opt_param

string pageToken Next page token for loading the next batch of Ruleset instances.

Return values
Google_Service_FirebaseRulesAPI_ListRulesetsResponse —

convertToArrayAndStripNulls()

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

Search results