Documentation

Google_Service_FirebaseRulesAPI_Resource_ProjectsReleases extends Google_Service_Resource
in package

Application

The "releases" collection of methods.

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

$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_Release: Create a `Release`.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_FirebaseRulesAPI_FirebaserulesEmpty: Delete a `Release` by resource name. (releases.delete)
get() : Google_Service_FirebaseRulesAPI_Release: Get a `Release` by name. (releases.get)
listProjectsReleases() : Google_Service_FirebaseRulesAPI_ListReleasesResponse: List the `Release` values for a project. This list may optionally be filtered by `Release` name or `Ruleset` id or both. (releases.listProjectsReleases)
update() : Google_Service_FirebaseRulesAPI_Release: Update a `Release`.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

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

__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

Return values

Google_Http_Request|expectedClass —

create()

Create a `Release`.


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

Release names should reflect the developer's deployment practices. For example, the release name may include the environment name, application name, application version, or any other name meaningful to the developer. Once a Release refers to a Ruleset, the rules can be enforced by Firebase Rules- enabled services.

More than one Release may be 'live' concurrently. Consider the following three Release names for projects/foo and the Ruleset to which they refer.

Release Name | Ruleset Name --------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/uuid123 projects/foo/releases/prod/beta | projects/foo/rulesets/uuid123 projects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456

The table reflects the Ruleset rollout in progress. The prod and prod/beta releases refer to the same Ruleset. However, prod/v23 refers to a new Ruleset. The Ruleset reference for a Release may be updated using the UpdateRelease method, and the custom Release name may be referenced by specifying the X-Firebase-Rules-Release-Name header. (releases.create)

Parameters

$name : string: Resource name for the project which owns this Release.

Format: projects/{project_id}
$postBody : Google_Service_FirebaseRulesAPI_Release
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseRulesAPI_Release —

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>

Return values

string —

$requestUrl

delete()

Delete a `Release` by resource name. (releases.delete)


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

Parameters

$name : string: Resource name for the Release to delete.

Format: projects/{project_id}/releases/{release_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseRulesAPI_FirebaserulesEmpty —

get()

Get a `Release` by name. (releases.get)


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

Parameters

$name : string: Resource name of the Release.

Format: projects/{project_id}/releases/{release_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseRulesAPI_Release —

listProjectsReleases()

List the `Release` values for a project. This list may optionally be filtered by `Release` name or `Ruleset` id or both. (releases.listProjectsReleases)


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

Parameters

$name : string: Resource name for the project.

Format: projects/{project_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseRulesAPI_ListReleasesResponse —

update()

Update a `Release`.


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

Only updates to the ruleset_name field will be honored. Release rename is not supported. To create a Release use the CreateRelease method instead. (releases.update)

Parameters

$name : string: Resource name for the Release.

Release names may be structured app1/prod/v2 or flat app1_prod_v2 which affords developers a great deal of flexibility in mapping the name to the style that best fits their existing development practices. For example, a name could refer to an environment, an app, a version, or some combination of three.

In the table below, for the project name projects/foo, the following relative release paths show how flat and structured names might be chosen to match a desired development / deployment strategy.

Use Case | Flat Name | Structured Name -------------|---------------------|---------------- Environments | releases/qa | releases/qa Apps | releases/app1_qa | releases/app1/qa Versions | releases/app1_v2_qa | releases/app1/v2/qa

The delimiter between the release name path elements can be almost anything and it should work equally well with the release name list filter, but in many ways the structured paths provide a clearer picture of the relationship between Release instances.

Format: projects/{project_id}/releases/{release_id}
$postBody : Google_Service_FirebaseRulesAPI_Release
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_FirebaseRulesAPI_Release —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —