class ProjectsReleases extends Resource (View source)

The "releases" collection of methods.

Typical usage is:

 $firebaserulesService = new Google\Service\FirebaseRules(...);
 $releases = $firebaserulesService->projects_releases;

Methods

create(string $name, Release $postBody, array $optParams = [])

Create a 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 relationships reflect a 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. (releases.create)

delete(string $name, array $optParams = [])

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

get(string $name, array $optParams = [])

Get a Release by name. (releases.get)

getExecutable(string $name, array $optParams = [])

Get the Release executable to use when enforcing rules.

listProjectsReleases(string $name, array $optParams = [])

List the Release values for a project. This list may optionally be filtered by Release name, Ruleset name, TestSuite name, or any combination thereof. (releases.listProjectsReleases)

patch(string $name, UpdateReleaseRequest $postBody, array $optParams = [])

Update a Release via PATCH. Only updates to ruleset_name will be honored.

Details

Release create(string $name, Release $postBody, array $optParams = [])

Create a 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 relationships reflect a 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. (releases.create)

Parameters

string $name

Required. Resource name for the project which owns this Release. Format: projects/{project_id}

Release $postBody
array $optParams

Optional parameters.

Return Value

Release

Exceptions

Exception

FirebaserulesEmpty delete(string $name, array $optParams = [])

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

Parameters

string $name

Required. Resource name for the Release to delete. Format: projects/{project_id}/releases/{release_id}

array $optParams

Optional parameters.

Return Value

FirebaserulesEmpty

Exceptions

Exception

Release get(string $name, array $optParams = [])

Get a Release by name. (releases.get)

Parameters

string $name

Required. Resource name of the Release. Format: projects/{project_id}/releases/{release_id}

array $optParams

Optional parameters.

Return Value

Release

Exceptions

Exception

GetReleaseExecutableResponse getExecutable(string $name, array $optParams = [])

Get the Release executable to use when enforcing rules.

(releases.getExecutable)

Parameters

string $name

Required. Resource name of the Release. Format: projects/{project_id}/releases/{release_id}

array $optParams

Optional parameters.

Return Value

GetReleaseExecutableResponse

Exceptions

Exception

ListReleasesResponse listProjectsReleases(string $name, array $optParams = [])

List the Release values for a project. This list may optionally be filtered by Release name, Ruleset name, TestSuite name, or any combination thereof. (releases.listProjectsReleases)

Parameters

string $name

Required. Resource name for the project. Format: projects/{project_id}

array $optParams

Optional parameters.

Return Value

ListReleasesResponse

Exceptions

Exception

Release patch(string $name, UpdateReleaseRequest $postBody, array $optParams = [])

Update a Release via PATCH. Only updates to ruleset_name will be honored.

Release rename is not supported. To create a Release use the CreateRelease method. (releases.patch)

Parameters

string $name

Required. Resource name for the project which owns this Release. Format: projects/{project_id}

UpdateReleaseRequest $postBody
array $optParams

Optional parameters.

Return Value

Release

Exceptions

Exception