Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(774)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: generated/googleapis/lib/firebaserules/v1.dart

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « generated/googleapis/lib/firebaseremoteconfig/v1.dart ('k') | generated/googleapis/lib/fitness/v1.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: generated/googleapis/lib/firebaserules/v1.dart
diff --git a/generated/googleapis/lib/firebaserules/v1.dart b/generated/googleapis/lib/firebaserules/v1.dart
index f7045998fbd394bcc40564d2a27a72c0ce980ff5..e7596322e8c770bd214dad00d8ae2c3d3355e077 100644
--- a/generated/googleapis/lib/firebaserules/v1.dart
+++ b/generated/googleapis/lib/firebaserules/v1.dart
@@ -9,90 +9,93 @@ import 'dart:convert' as convert;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
-export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
- ApiRequestError, DetailedApiRequestError;
+export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
+ show ApiRequestError, DetailedApiRequestError;
const core.String USER_AGENT = 'dart-api-client firebaserules/v1';
-/**
- * Creates and manages rules that determine when a Firebase Rules-enabled
- * service should permit a request.
- */
+/// Creates and manages rules that determine when a Firebase Rules-enabled
+/// service should permit a request.
class FirebaserulesApi {
- /** View and manage your data across Google Cloud Platform services */
- static const CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform";
+ /// View and manage your data across Google Cloud Platform services
+ static const CloudPlatformScope =
+ "https://www.googleapis.com/auth/cloud-platform";
- /** View and administer all your Firebase data and settings */
+ /// View and administer all your Firebase data and settings
static const FirebaseScope = "https://www.googleapis.com/auth/firebase";
- /** View all your Firebase data and settings */
- static const FirebaseReadonlyScope = "https://www.googleapis.com/auth/firebase.readonly";
-
+ /// View all your Firebase data and settings
+ static const FirebaseReadonlyScope =
+ "https://www.googleapis.com/auth/firebase.readonly";
final commons.ApiRequester _requester;
ProjectsResourceApi get projects => new ProjectsResourceApi(_requester);
- FirebaserulesApi(http.Client client, {core.String rootUrl: "https://firebaserules.googleapis.com/", core.String servicePath: ""}) :
- _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
+ FirebaserulesApi(http.Client client,
+ {core.String rootUrl: "https://firebaserules.googleapis.com/",
+ core.String servicePath: ""})
+ : _requester =
+ new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
}
-
class ProjectsResourceApi {
final commons.ApiRequester _requester;
- ProjectsReleasesResourceApi get releases => new ProjectsReleasesResourceApi(_requester);
- ProjectsRulesetsResourceApi get rulesets => new ProjectsRulesetsResourceApi(_requester);
-
- ProjectsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Test `Source` for syntactic and semantic correctness. Issues present, if
- * any, will be returned to the caller with a description, severity, and
- * source location.
- *
- * The test method may be executed with `Source` or a `Ruleset` name.
- * Passing `Source` is useful for unit testing new rules. Passing a `Ruleset`
- * name is useful for regression testing an existing rule.
- *
- * The following is an example of `Source` that permits users to upload images
- * to a bucket bearing their user id and matching the correct metadata:
- *
- * _*Example*_
- *
- * // Users are allowed to subscribe and unsubscribe to the blog.
- * service firebase.storage {
- * match /users/{userId}/images/{imageName} {
- * allow write: if userId == request.auth.uid
- * && (imageName.matches('*.png$')
- * || imageName.matches('*.jpg$'))
- * && resource.mimeType.matches('^image/')
- * }
- * }
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [name] - Tests may either provide `source` or a `Ruleset` resource name.
- *
- * For tests against `source`, the resource name must refer to the project:
- * Format: `projects/{project_id}`
- *
- * For tests against a `Ruleset`, this must be the `Ruleset` resource name:
- * Format: `projects/{project_id}/rulesets/{ruleset_id}`
- * Value must have pattern "^projects/.+$".
- *
- * Completes with a [TestRulesetResponse].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<TestRulesetResponse> test(TestRulesetRequest request, core.String name) {
+ ProjectsReleasesResourceApi get releases =>
+ new ProjectsReleasesResourceApi(_requester);
+ ProjectsRulesetsResourceApi get rulesets =>
+ new ProjectsRulesetsResourceApi(_requester);
+
+ ProjectsResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Test `Source` for syntactic and semantic correctness. Issues present, if
+ /// any, will be returned to the caller with a description, severity, and
+ /// source location.
+ ///
+ /// The test method may be executed with `Source` or a `Ruleset` name.
+ /// Passing `Source` is useful for unit testing new rules. Passing a
+ /// `Ruleset`
+ /// name is useful for regression testing an existing rule.
+ ///
+ /// The following is an example of `Source` that permits users to upload
+ /// images
+ /// to a bucket bearing their user id and matching the correct metadata:
+ ///
+ /// _*Example*_
+ ///
+ /// // Users are allowed to subscribe and unsubscribe to the blog.
+ /// service firebase.storage {
+ /// match /users/{userId}/images/{imageName} {
+ /// allow write: if userId == request.auth.uid
+ /// && (imageName.matches('*.png$')
+ /// || imageName.matches('*.jpg$'))
+ /// && resource.mimeType.matches('^image/')
+ /// }
+ /// }
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Tests may either provide `source` or a `Ruleset` resource name.
+ ///
+ /// For tests against `source`, the resource name must refer to the project:
+ /// Format: `projects/{project_id}`
+ ///
+ /// For tests against a `Ruleset`, this must be the `Ruleset` resource name:
+ /// Format: `projects/{project_id}/rulesets/{ruleset_id}`
+ /// Value must have pattern "^projects/.+$".
+ ///
+ /// Completes with a [TestRulesetResponse].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<TestRulesetResponse> test(
+ TestRulesetRequest request, core.String name) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -109,66 +112,62 @@ class ProjectsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':test';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new TestRulesetResponse.fromJson(data));
}
-
}
-
class ProjectsReleasesResourceApi {
final commons.ApiRequester _requester;
- ProjectsReleasesResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * 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 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.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [name] - Resource name for the project which owns this `Release`.
- *
- * Format: `projects/{project_id}`
- * Value must have pattern "^projects/[^/]+$".
- *
- * Completes with a [Release].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ ProjectsReleasesResourceApi(commons.ApiRequester client)
+ : _requester = client;
+
+ /// 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 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.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Resource name for the project which owns this `Release`.
+ ///
+ /// Format: `projects/{project_id}`
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// Completes with a [Release].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<Release> create(Release request, core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -186,34 +185,31 @@ class ProjectsReleasesResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + '/releases';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Release.fromJson(data));
}
- /**
- * Delete a `Release` by resource name.
- *
- * Request parameters:
- *
- * [name] - Resource name for the `Release` to delete.
- *
- * Format: `projects/{project_id}/releases/{release_id}`
- * Value must have pattern "^projects/[^/]+/releases/.+$".
- *
- * Completes with a [Empty].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ /// Delete a `Release` by resource name.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Resource name for the `Release` to delete.
+ ///
+ /// Format: `projects/{project_id}/releases/{release_id}`
+ /// Value must have pattern "^projects/[^/]+/releases/.+$".
+ ///
+ /// Completes with a [Empty].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<Empty> delete(core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -228,34 +224,31 @@ class ProjectsReleasesResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "DELETE",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "DELETE",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Empty.fromJson(data));
}
- /**
- * Get a `Release` by name.
- *
- * Request parameters:
- *
- * [name] - Resource name of the `Release`.
- *
- * Format: `projects/{project_id}/releases/{release_id}`
- * Value must have pattern "^projects/[^/]+/releases/.+$".
- *
- * Completes with a [Release].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ /// Get a `Release` by name.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Resource name of the `Release`.
+ ///
+ /// Format: `projects/{project_id}/releases/{release_id}`
+ /// Value must have pattern "^projects/[^/]+/releases/.+$".
+ ///
+ /// Completes with a [Release].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<Release> get(core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -270,71 +263,71 @@ class ProjectsReleasesResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Release.fromJson(data));
}
- /**
- * List the `Release` values for a project. This list may optionally be
- * filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any
- * combination thereof.
- *
- * Request parameters:
- *
- * [name] - Resource name for the project.
- *
- * Format: `projects/{project_id}`
- * Value must have pattern "^projects/[^/]+$".
- *
- * [filter] - `Release` filter. The list method supports filters with
- * restrictions on the
- * `Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.
- *
- * Example 1: A filter of 'name=prod*' might return `Release`s 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. e.g.
- * `test_suite_name=projects/foo/testsuites/uuid1`
- *
- * [pageToken] - Next page token for the next batch of `Release` instances.
- *
- * [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 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.
- *
- * Completes with a [ListReleasesResponse].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<ListReleasesResponse> list(core.String name, {core.String filter, core.String pageToken, core.int pageSize}) {
+ /// List the `Release` values for a project. This list may optionally be
+ /// filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any
+ /// combination thereof.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Resource name for the project.
+ ///
+ /// Format: `projects/{project_id}`
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// [filter] - `Release` filter. The list method supports filters with
+ /// restrictions on the
+ /// `Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.
+ ///
+ /// Example 1: A filter of 'name=prod*' might return `Release`s 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. e.g.
+ /// `test_suite_name=projects/foo/testsuites/uuid1`
+ ///
+ /// [pageToken] - Next page token for the next batch of `Release` instances.
+ ///
+ /// [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 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.
+ ///
+ /// Completes with a [ListReleasesResponse].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<ListReleasesResponse> list(core.String name,
+ {core.String filter, core.String pageToken, core.int pageSize}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -357,61 +350,59 @@ class ProjectsReleasesResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + '/releases';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new ListReleasesResponse.fromJson(data));
}
- /**
- * Update a `Release`.
- *
- * Only updates to the `ruleset_name` and `test_suite_name` fields will be
- * honored. `Release` rename is not supported. To create a `Release` use the
- * CreateRelease method.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [name] - 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}`
- * Value must have pattern "^projects/[^/]+/releases/.+$".
- *
- * Completes with a [Release].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ /// Update a `Release`.
+ ///
+ /// Only updates to the `ruleset_name` and `test_suite_name` fields will be
+ /// honored. `Release` rename is not supported. To create a `Release` use the
+ /// CreateRelease method.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - 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}`
+ /// Value must have pattern "^projects/[^/]+/releases/.+$".
+ ///
+ /// Completes with a [Release].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<Release> update(Release request, core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -429,50 +420,47 @@ class ProjectsReleasesResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "PUT",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "PUT",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Release.fromJson(data));
}
-
}
-
class ProjectsRulesetsResourceApi {
final commons.ApiRequester _requester;
- ProjectsRulesetsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Create a `Ruleset` from `Source`.
- *
- * 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.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [name] - Resource name for Project which owns this `Ruleset`.
- *
- * Format: `projects/{project_id}`
- * Value must have pattern "^projects/[^/]+$".
- *
- * Completes with a [Ruleset].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ ProjectsRulesetsResourceApi(commons.ApiRequester client)
+ : _requester = client;
+
+ /// Create a `Ruleset` from `Source`.
+ ///
+ /// 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.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Resource name for Project which owns this `Ruleset`.
+ ///
+ /// Format: `projects/{project_id}`
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// Completes with a [Ruleset].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<Ruleset> create(Ruleset request, core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -490,36 +478,33 @@ class ProjectsRulesetsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + '/rulesets';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Ruleset.fromJson(data));
}
- /**
- * Delete a `Ruleset` by resource name.
- *
- * If the `Ruleset` is referenced by a `Release` the operation will fail.
- *
- * Request parameters:
- *
- * [name] - Resource name for the ruleset to delete.
- *
- * Format: `projects/{project_id}/rulesets/{ruleset_id}`
- * Value must have pattern "^projects/[^/]+/rulesets/[^/]+$".
- *
- * Completes with a [Empty].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ /// Delete a `Ruleset` by resource name.
+ ///
+ /// If the `Ruleset` is referenced by a `Release` the operation will fail.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Resource name for the ruleset to delete.
+ ///
+ /// Format: `projects/{project_id}/rulesets/{ruleset_id}`
+ /// Value must have pattern "^projects/[^/]+/rulesets/[^/]+$".
+ ///
+ /// Completes with a [Empty].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<Empty> delete(core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -534,34 +519,31 @@ class ProjectsRulesetsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "DELETE",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "DELETE",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Empty.fromJson(data));
}
- /**
- * Get a `Ruleset` by name including the full `Source` contents.
- *
- * Request parameters:
- *
- * [name] - Resource name for the ruleset to get.
- *
- * Format: `projects/{project_id}/rulesets/{ruleset_id}`
- * Value must have pattern "^projects/[^/]+/rulesets/[^/]+$".
- *
- * Completes with a [Ruleset].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ /// Get a `Ruleset` by name including the full `Source` contents.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Resource name for the ruleset to get.
+ ///
+ /// Format: `projects/{project_id}/rulesets/{ruleset_id}`
+ /// Value must have pattern "^projects/[^/]+/rulesets/[^/]+$".
+ ///
+ /// Completes with a [Ruleset].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
async.Future<Ruleset> get(core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -576,56 +558,55 @@ class ProjectsRulesetsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Ruleset.fromJson(data));
}
- /**
- * List `Ruleset` metadata only and optionally filter the results by `Ruleset`
- * name.
- *
- * The full `Source` contents of a `Ruleset` may be retrieved with
- * GetRuleset.
- *
- * Request parameters:
- *
- * [name] - Resource name for the project.
- *
- * Format: `projects/{project_id}`
- * Value must have pattern "^projects/[^/]+$".
- *
- * [pageToken] - Next page token for loading the next batch of `Ruleset`
- * instances.
- *
- * [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.
- *
- * [filter] - `Ruleset` filter. The list method supports filters with
- * restrictions on
- * `Ruleset.name`.
- *
- * Filters on `Ruleset.create_time` should use the `date` function which
- * parses strings that conform to the RFC 3339 date/time specifications.
- *
- * Example: `create_time > date("2017-01-01") AND name=UUID-*`
- *
- * Completes with a [ListRulesetsResponse].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<ListRulesetsResponse> list(core.String name, {core.String pageToken, core.int pageSize, core.String filter}) {
+ /// List `Ruleset` metadata only and optionally filter the results by
+ /// `Ruleset`
+ /// name.
+ ///
+ /// The full `Source` contents of a `Ruleset` may be retrieved with
+ /// GetRuleset.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Resource name for the project.
+ ///
+ /// Format: `projects/{project_id}`
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// [filter] - `Ruleset` filter. The list method supports filters with
+ /// restrictions on
+ /// `Ruleset.name`.
+ ///
+ /// Filters on `Ruleset.create_time` should use the `date` function which
+ /// parses strings that conform to the RFC 3339 date/time specifications.
+ ///
+ /// Example: `create_time > date("2017-01-01") AND name=UUID-*`
+ ///
+ /// [pageToken] - Next page token for loading the next batch of `Ruleset`
+ /// instances.
+ ///
+ /// [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.
+ ///
+ /// Completes with a [ListRulesetsResponse].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<ListRulesetsResponse> list(core.String name,
+ {core.String filter, core.String pageToken, core.int pageSize}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -636,42 +617,37 @@ class ProjectsRulesetsResourceApi {
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
+ if (filter != null) {
+ _queryParams["filter"] = [filter];
+ }
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
- if (filter != null) {
- _queryParams["filter"] = [filter];
- }
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + '/rulesets';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new ListRulesetsResponse.fromJson(data));
}
-
}
-
-
-/** Arg matchers for the mock function. */
+/// Arg matchers for the mock function.
class Arg {
- /** Argument matches any value provided. */
+ /// Argument matches any value provided.
Empty anyValue;
- /**
- * Argument exactly matches value provided.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// Argument exactly matches value provided.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Object exactValue;
Arg();
@@ -686,7 +662,8 @@ class Arg {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (anyValue != null) {
_json["anyValue"] = (anyValue).toJson();
}
@@ -697,44 +674,44 @@ class Arg {
}
}
-/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance:
- *
- * service Foo {
- * rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
- * }
- *
- * The JSON representation for `Empty` is empty JSON object `{}`.
- */
+/// A generic empty message that you can re-use to avoid defining duplicated
+/// empty messages in your APIs. A typical example is to use it as the request
+/// or the response type of an API method. For instance:
+///
+/// service Foo {
+/// rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+/// }
+///
+/// The JSON representation for `Empty` is empty JSON object `{}`.
class Empty {
-
Empty();
- Empty.fromJson(core.Map _json) {
- }
+ Empty.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
return _json;
}
}
-/** `File` containing source content. */
+/// `File` containing source content.
class File {
- /** Textual Content. */
+ /// Textual Content.
core.String content;
- /** Fingerprint (e.g. github sha) associated with the `File`. */
+
+ /// Fingerprint (e.g. github sha) associated with the `File`.
core.String fingerprint;
core.List<core.int> get fingerprintAsBytes {
return convert.BASE64.decode(fingerprint);
}
void set fingerprintAsBytes(core.List<core.int> _bytes) {
- fingerprint = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
+ fingerprint =
+ convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
- /** File name. */
+
+ /// File name.
core.String name;
File();
@@ -752,7 +729,8 @@ class File {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (content != null) {
_json["content"] = content;
}
@@ -766,19 +744,16 @@ class File {
}
}
-/**
- * Represents a service-defined function call that was invoked during test
- * execution.
- */
+/// Represents a service-defined function call that was invoked during test
+/// execution.
class FunctionCall {
- /**
- * The arguments that were provided to the function.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+ /// The arguments that were provided to the function.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.List<core.Object> args;
- /** Name of the function invoked. */
+
+ /// Name of the function invoked.
core.String function;
FunctionCall();
@@ -793,7 +768,8 @@ class FunctionCall {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (args != null) {
_json["args"] = args;
}
@@ -804,32 +780,28 @@ class FunctionCall {
}
}
-/**
- * Mock function definition.
- *
- * Mocks must refer to a function declared by the target service. The type of
- * the function args and result will be inferred at test time. If either the
- * arg or result values are not compatible with function type declaration, the
- * request will be considered invalid.
- *
- * More than one `FunctionMock` may be provided for a given function name so
- * long as the `Arg` matchers are distinct. There may be only one function
- * for a given overload where all `Arg` values are `Arg.any_value`.
- */
+/// Mock function definition.
+///
+/// Mocks must refer to a function declared by the target service. The type of
+/// the function args and result will be inferred at test time. If either the
+/// arg or result values are not compatible with function type declaration, the
+/// request will be considered invalid.
+///
+/// More than one `FunctionMock` may be provided for a given function name so
+/// long as the `Arg` matchers are distinct. There may be only one function
+/// for a given overload where all `Arg` values are `Arg.any_value`.
class FunctionMock {
- /**
- * The list of `Arg` values to match. The order in which the arguments are
- * provided is the order in which they must appear in the function
- * invocation.
- */
+ /// The list of `Arg` values to match. The order in which the arguments are
+ /// provided is the order in which they must appear in the function
+ /// invocation.
core.List<Arg> args;
- /**
- * The name of the function.
- *
- * The function name must match one provided by a service declaration.
- */
+
+ /// The name of the function.
+ ///
+ /// The function name must match one provided by a service declaration.
core.String function;
- /** The mock result of the function call. */
+
+ /// The mock result of the function call.
Result result;
FunctionMock();
@@ -847,7 +819,8 @@ class FunctionMock {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (args != null) {
_json["args"] = args.map((value) => (value).toJson()).toList();
}
@@ -861,23 +834,23 @@ class FunctionMock {
}
}
-/** Issues include warnings, errors, and deprecation notices. */
+/// Issues include warnings, errors, and deprecation notices.
class Issue {
- /** Short error description. */
+ /// Short error description.
core.String description;
- /**
- * The severity of the issue.
- * Possible string values are:
- * - "SEVERITY_UNSPECIFIED" : An unspecified severity.
- * - "DEPRECATION" : Deprecation issue for statements and method that may no
- * longer be
- * supported or maintained.
- * - "WARNING" : Warnings such as: unused variables.
- * - "ERROR" : Errors such as: unmatched curly braces or variable
- * redefinition.
- */
+
+ /// The severity of the issue.
+ /// Possible string values are:
+ /// - "SEVERITY_UNSPECIFIED" : An unspecified severity.
+ /// - "DEPRECATION" : Deprecation issue for statements and method that may no
+ /// longer be
+ /// supported or maintained.
+ /// - "WARNING" : Warnings such as: unused variables.
+ /// - "ERROR" : Errors such as: unmatched curly braces or variable
+ /// redefinition.
core.String severity;
- /** Position of the issue in the `Source`. */
+
+ /// Position of the issue in the `Source`.
SourcePosition sourcePosition;
Issue();
@@ -895,7 +868,8 @@ class Issue {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (description != null) {
_json["description"] = description;
}
@@ -909,14 +883,14 @@ class Issue {
}
}
-/** The response for FirebaseRulesService.ListReleases. */
+/// The response for FirebaseRulesService.ListReleases.
class ListReleasesResponse {
- /**
- * The pagination token to retrieve the next page of results. If the value is
- * empty, no further results remain.
- */
+ /// The pagination token to retrieve the next page of results. If the value
+ /// is
+ /// empty, no further results remain.
core.String nextPageToken;
- /** List of `Release` instances. */
+
+ /// List of `Release` instances.
core.List<Release> releases;
ListReleasesResponse();
@@ -926,12 +900,15 @@ class ListReleasesResponse {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("releases")) {
- releases = _json["releases"].map((value) => new Release.fromJson(value)).toList();
+ releases = _json["releases"]
+ .map((value) => new Release.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
@@ -942,14 +919,14 @@ class ListReleasesResponse {
}
}
-/** The response for FirebaseRulesService.ListRulesets. */
+/// The response for FirebaseRulesService.ListRulesets.
class ListRulesetsResponse {
- /**
- * The pagination token to retrieve the next page of results. If the value is
- * empty, no further results remain.
- */
+ /// The pagination token to retrieve the next page of results. If the value
+ /// is
+ /// empty, no further results remain.
core.String nextPageToken;
- /** List of `Ruleset` instances. */
+
+ /// List of `Ruleset` instances.
core.List<Ruleset> rulesets;
ListRulesetsResponse();
@@ -959,12 +936,15 @@ class ListRulesetsResponse {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("rulesets")) {
- rulesets = _json["rulesets"].map((value) => new Ruleset.fromJson(value)).toList();
+ rulesets = _json["rulesets"]
+ .map((value) => new Ruleset.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
@@ -975,52 +955,46 @@ class ListRulesetsResponse {
}
}
-/**
- * `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
- * `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
- */
+/// `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
+/// `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
class Release {
- /**
- * Time the release was created.
- * Output only.
- */
+ /// Time the release was created.
+ /// Output only.
core.String createTime;
- /**
- * 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}`
- */
+
+ /// 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}`
core.String name;
- /**
- * Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
- * exist the `Release` to be created.
- */
+
+ /// Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
+ /// exist the `Release` to be created.
core.String rulesetName;
- /**
- * Time the release was updated.
- * Output only.
- */
+
+ /// Time the release was updated.
+ /// Output only.
core.String updateTime;
Release();
@@ -1041,7 +1015,8 @@ class Release {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (createTime != null) {
_json["createTime"] = createTime;
}
@@ -1058,17 +1033,16 @@ class Release {
}
}
-/** Possible result values from the function mock invocation. */
+/// Possible result values from the function mock invocation.
class Result {
- /** The result is undefined, meaning the result could not be computed. */
+ /// The result is undefined, meaning the result could not be computed.
Empty undefined;
- /**
- * The result is an actual value. The type of the value must match that
- * of the type declared by the service.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// The result is an actual value. The type of the value must match that
+ /// of the type declared by the service.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Object value;
Result();
@@ -1083,7 +1057,8 @@ class Result {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (undefined != null) {
_json["undefined"] = (undefined).toJson();
}
@@ -1094,23 +1069,20 @@ class Result {
}
}
-/**
- * `Ruleset` is an immutable copy of `Source` with a globally unique identifier
- * and a creation time.
- */
+/// `Ruleset` is an immutable copy of `Source` with a globally unique
+/// identifier
+/// and a creation time.
class Ruleset {
- /**
- * Time the `Ruleset` was created.
- * Output only.
- */
+ /// Time the `Ruleset` was created.
+ /// Output only.
core.String createTime;
- /**
- * Name of the `Ruleset`. The ruleset_id is auto generated by the service.
- * Format: `projects/{project_id}/rulesets/{ruleset_id}`
- * Output only.
- */
+
+ /// Name of the `Ruleset`. The ruleset_id is auto generated by the service.
+ /// Format: `projects/{project_id}/rulesets/{ruleset_id}`
+ /// Output only.
core.String name;
- /** `Source` for the `Ruleset`. */
+
+ /// `Source` for the `Ruleset`.
Source source;
Ruleset();
@@ -1128,7 +1100,8 @@ class Ruleset {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (createTime != null) {
_json["createTime"] = createTime;
}
@@ -1142,11 +1115,9 @@ class Ruleset {
}
}
-/**
- * `Source` is one or more `File` messages comprising a logical set of rules.
- */
+/// `Source` is one or more `File` messages comprising a logical set of rules.
class Source {
- /** `File` set constituting the `Source` bundle. */
+ /// `File` set constituting the `Source` bundle.
core.List<File> files;
Source();
@@ -1158,7 +1129,8 @@ class Source {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (files != null) {
_json["files"] = files.map((value) => (value).toJson()).toList();
}
@@ -1166,16 +1138,16 @@ class Source {
}
}
-/**
- * Position in the `Source` content including its line, column number, and an
- * index of the `File` in the `Source` message. Used for debug purposes.
- */
+/// Position in the `Source` content including its line, column number, and an
+/// index of the `File` in the `Source` message. Used for debug purposes.
class SourcePosition {
- /** First column on the source line associated with the source fragment. */
+ /// First column on the source line associated with the source fragment.
core.int column;
- /** Name of the `File`. */
+
+ /// Name of the `File`.
core.String fileName;
- /** Line number of the source fragment. 1-based. */
+
+ /// Line number of the source fragment. 1-based.
core.int line;
SourcePosition();
@@ -1193,7 +1165,8 @@ class SourcePosition {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (column != null) {
_json["column"] = column;
}
@@ -1207,66 +1180,59 @@ class SourcePosition {
}
}
-/**
- * `TestCase` messages provide the request context and an expectation as to
- * whether the given context will be allowed or denied. Test cases may specify
- * the `request`, `resource`, and `function_mocks` to mock a function call to
- * a service-provided function.
- *
- * The `request` object represents context present at request-time.
- *
- * The `resource` is the value of the target resource as it appears in
- * persistent storage before the request is executed.
- */
+/// `TestCase` messages provide the request context and an expectation as to
+/// whether the given context will be allowed or denied. Test cases may specify
+/// the `request`, `resource`, and `function_mocks` to mock a function call to
+/// a service-provided function.
+///
+/// The `request` object represents context present at request-time.
+///
+/// The `resource` is the value of the target resource as it appears in
+/// persistent storage before the request is executed.
class TestCase {
- /**
- * Test expectation.
- * Possible string values are:
- * - "EXPECTATION_UNSPECIFIED" : Unspecified expectation.
- * - "ALLOW" : Expect an allowed result.
- * - "DENY" : Expect a denied result.
- */
+ /// Test expectation.
+ /// Possible string values are:
+ /// - "EXPECTATION_UNSPECIFIED" : Unspecified expectation.
+ /// - "ALLOW" : Expect an allowed result.
+ /// - "DENY" : Expect a denied result.
core.String expectation;
- /**
- * Optional function mocks for service-defined functions. If not set, any
- * service defined function is expected to return an error, which may or may
- * not influence the test outcome.
- */
+
+ /// Optional function mocks for service-defined functions. If not set, any
+ /// service defined function is expected to return an error, which may or may
+ /// not influence the test outcome.
core.List<FunctionMock> functionMocks;
- /**
- * Request context.
- *
- * The exact format of the request context is service-dependent. See the
- * appropriate service documentation for information about the supported
- * fields and types on the request. Minimally, all services support the
- * following fields and types:
- *
- * Request field | Type
- * ---------------|-----------------
- * auth.uid | `string`
- * auth.token | `map<string, string>`
- * headers | `map<string, string>`
- * method | `string`
- * params | `map<string, string>`
- * path | `string`
- * time | `google.protobuf.Timestamp`
- *
- * If the request value is not well-formed for the service, the request will
- * be rejected as an invalid argument.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// Request context.
+ ///
+ /// The exact format of the request context is service-dependent. See the
+ /// appropriate service documentation for information about the supported
+ /// fields and types on the request. Minimally, all services support the
+ /// following fields and types:
+ ///
+ /// Request field | Type
+ /// ---------------|-----------------
+ /// auth.uid | `string`
+ /// auth.token | `map<string, string>`
+ /// headers | `map<string, string>`
+ /// method | `string`
+ /// params | `map<string, string>`
+ /// path | `string`
+ /// time | `google.protobuf.Timestamp`
+ ///
+ /// If the request value is not well-formed for the service, the request will
+ /// be rejected as an invalid argument.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Object request;
- /**
- * Optional resource value as it appears in persistent storage before the
- * request is fulfilled.
- *
- * The resource type depends on the `request.path` value.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// Optional resource value as it appears in persistent storage before the
+ /// request is fulfilled.
+ ///
+ /// The resource type depends on the `request.path` value.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Object resource;
TestCase();
@@ -1276,7 +1242,9 @@ class TestCase {
expectation = _json["expectation"];
}
if (_json.containsKey("functionMocks")) {
- functionMocks = _json["functionMocks"].map((value) => new FunctionMock.fromJson(value)).toList();
+ functionMocks = _json["functionMocks"]
+ .map((value) => new FunctionMock.fromJson(value))
+ .toList();
}
if (_json.containsKey("request")) {
request = _json["request"];
@@ -1287,12 +1255,14 @@ class TestCase {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (expectation != null) {
_json["expectation"] = expectation;
}
if (functionMocks != null) {
- _json["functionMocks"] = functionMocks.map((value) => (value).toJson()).toList();
+ _json["functionMocks"] =
+ functionMocks.map((value) => (value).toJson()).toList();
}
if (request != null) {
_json["request"] = request;
@@ -1304,47 +1274,40 @@ class TestCase {
}
}
-/**
- * Test result message containing the state of the test as well as a
- * description and source position for test failures.
- */
+/// Test result message containing the state of the test as well as a
+/// description and source position for test failures.
class TestResult {
- /**
- * Debug messages related to test execution issues encountered during
- * evaluation.
- *
- * Debug messages may be related to too many or too few invocations of
- * function mocks or to runtime errors that occur during evaluation.
- *
- * For example: ```Unable to read variable [name: "resource"]```
- */
+ /// Debug messages related to test execution issues encountered during
+ /// evaluation.
+ ///
+ /// Debug messages may be related to too many or too few invocations of
+ /// function mocks or to runtime errors that occur during evaluation.
+ ///
+ /// For example: ```Unable to read variable [name: "resource"]```
core.List<core.String> debugMessages;
- /**
- * Position in the `Source` or `Ruleset` where the principle runtime error
- * occurs.
- *
- * Evaluation of an expression may result in an error. Rules are deny by
- * default, so a `DENY` expectation when an error is generated is valid.
- * When there is a `DENY` with an error, the `SourcePosition` is returned.
- *
- * E.g. `error_position { line: 19 column: 37 }`
- */
+
+ /// Position in the `Source` or `Ruleset` where the principle runtime error
+ /// occurs.
+ ///
+ /// Evaluation of an expression may result in an error. Rules are deny by
+ /// default, so a `DENY` expectation when an error is generated is valid.
+ /// When there is a `DENY` with an error, the `SourcePosition` is returned.
+ ///
+ /// E.g. `error_position { line: 19 column: 37 }`
SourcePosition errorPosition;
- /**
- * The set of function calls made to service-defined methods.
- *
- * Function calls are included in the order in which they are encountered
- * during evaluation, are provided for both mocked and unmocked functions,
- * and included on the response regardless of the test `state`.
- */
+
+ /// The set of function calls made to service-defined methods.
+ ///
+ /// Function calls are included in the order in which they are encountered
+ /// during evaluation, are provided for both mocked and unmocked functions,
+ /// and included on the response regardless of the test `state`.
core.List<FunctionCall> functionCalls;
- /**
- * State of the test.
- * Possible string values are:
- * - "STATE_UNSPECIFIED" : Test state is not set.
- * - "SUCCESS" : Test is a success.
- * - "FAILURE" : Test is a failure.
- */
+
+ /// State of the test.
+ /// Possible string values are:
+ /// - "STATE_UNSPECIFIED" : Test state is not set.
+ /// - "SUCCESS" : Test is a success.
+ /// - "FAILURE" : Test is a failure.
core.String state;
TestResult();
@@ -1357,7 +1320,9 @@ class TestResult {
errorPosition = new SourcePosition.fromJson(_json["errorPosition"]);
}
if (_json.containsKey("functionCalls")) {
- functionCalls = _json["functionCalls"].map((value) => new FunctionCall.fromJson(value)).toList();
+ functionCalls = _json["functionCalls"]
+ .map((value) => new FunctionCall.fromJson(value))
+ .toList();
}
if (_json.containsKey("state")) {
state = _json["state"];
@@ -1365,7 +1330,8 @@ class TestResult {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (debugMessages != null) {
_json["debugMessages"] = debugMessages;
}
@@ -1373,7 +1339,8 @@ class TestResult {
_json["errorPosition"] = (errorPosition).toJson();
}
if (functionCalls != null) {
- _json["functionCalls"] = functionCalls.map((value) => (value).toJson()).toList();
+ _json["functionCalls"] =
+ functionCalls.map((value) => (value).toJson()).toList();
}
if (state != null) {
_json["state"] = state;
@@ -1382,15 +1349,14 @@ class TestResult {
}
}
-/** The request for FirebaseRulesService.TestRuleset. */
+/// The request for FirebaseRulesService.TestRuleset.
class TestRulesetRequest {
- /**
- * Optional `Source` to be checked for correctness.
- *
- * This field must not be set when the resource name refers to a `Ruleset`.
- */
+ /// Optional `Source` to be checked for correctness.
+ ///
+ /// This field must not be set when the resource name refers to a `Ruleset`.
Source source;
- /** Inline `TestSuite` to run. */
+
+ /// Inline `TestSuite` to run.
TestSuite testSuite;
TestRulesetRequest();
@@ -1405,7 +1371,8 @@ class TestRulesetRequest {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (source != null) {
_json["source"] = (source).toJson();
}
@@ -1416,63 +1383,69 @@ class TestRulesetRequest {
}
}
-/** The response for FirebaseRulesService.TestRuleset. */
+/// The response for FirebaseRulesService.TestRuleset.
class TestRulesetResponse {
- /**
- * Syntactic and semantic `Source` issues of varying severity. Issues of
- * `ERROR` severity will prevent tests from executing.
- */
+ /// Syntactic and semantic `Source` issues of varying severity. Issues of
+ /// `ERROR` severity will prevent tests from executing.
core.List<Issue> issues;
- /**
- * The set of test results given the test cases in the `TestSuite`.
- * The results will appear in the same order as the test cases appear in the
- * `TestSuite`.
- */
+
+ /// The set of test results given the test cases in the `TestSuite`.
+ /// The results will appear in the same order as the test cases appear in the
+ /// `TestSuite`.
core.List<TestResult> testResults;
TestRulesetResponse();
TestRulesetResponse.fromJson(core.Map _json) {
if (_json.containsKey("issues")) {
- issues = _json["issues"].map((value) => new Issue.fromJson(value)).toList();
+ issues =
+ _json["issues"].map((value) => new Issue.fromJson(value)).toList();
}
if (_json.containsKey("testResults")) {
- testResults = _json["testResults"].map((value) => new TestResult.fromJson(value)).toList();
+ testResults = _json["testResults"]
+ .map((value) => new TestResult.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (issues != null) {
_json["issues"] = issues.map((value) => (value).toJson()).toList();
}
if (testResults != null) {
- _json["testResults"] = testResults.map((value) => (value).toJson()).toList();
+ _json["testResults"] =
+ testResults.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/**
- * `TestSuite` is a collection of `TestCase` instances that validate the logical
- * correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within
- * a `TestRuleset` invocation or as part of a `Release` object as a pre-release
- * check.
- */
+/// `TestSuite` is a collection of `TestCase` instances that validate the
+/// logical
+/// correctness of a `Ruleset`. The `TestSuite` may be referenced in-line
+/// within
+/// a `TestRuleset` invocation or as part of a `Release` object as a
+/// pre-release
+/// check.
class TestSuite {
- /** Collection of test cases associated with the `TestSuite`. */
+ /// Collection of test cases associated with the `TestSuite`.
core.List<TestCase> testCases;
TestSuite();
TestSuite.fromJson(core.Map _json) {
if (_json.containsKey("testCases")) {
- testCases = _json["testCases"].map((value) => new TestCase.fromJson(value)).toList();
+ testCases = _json["testCases"]
+ .map((value) => new TestCase.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (testCases != null) {
_json["testCases"] = testCases.map((value) => (value).toJson()).toList();
}
« no previous file with comments | « generated/googleapis/lib/firebaseremoteconfig/v1.dart ('k') | generated/googleapis/lib/fitness/v1.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698