ProjectsReleasesListOptions

import type { ProjectsReleasesListOptions } from "https://googleapis.deno.dev/v1/firebaserules:v1.ts";

Additional options for FirebaseRules#projectsReleasesList.

interface ProjectsReleasesListOptions {

filter?: string;

pageSize?: number;

pageToken?: string;

}

§Properties

filter?: string

[src]

Release filter. The list method supports filters with restrictions on the Release.name, and Release.ruleset_name. Example 1: A filter of 'name=prod*' might return Releases with names within 'projects/foo' prefixed with 'prod': Name -> Ruleset Name: * projects/foo/releases/prod -> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v1 -> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v2 -> projects/foo/rulesets/uuid8888 Example 2: A filter of name=prod* ruleset_name=uuid1234 would return only Release instances for 'projects/foo' with names prefixed with 'prod' referring to the same Ruleset name of 'uuid1234': Name -> Ruleset Name: * projects/foo/releases/prod -> projects/foo/rulesets/1234 * projects/foo/releases/prod/v1 -> projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used.

pageSize?: number

[src]

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

pageToken?: string

[src]

Next page token for the next batch of Release instances.