chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/firebaserules_v1.projects.releases.html b/docs/dyn/firebaserules_v1.projects.releases.html
index 53581ed..f08a7ea 100644
--- a/docs/dyn/firebaserules_v1.projects.releases.html
+++ b/docs/dyn/firebaserules_v1.projects.releases.html
@@ -90,7 +90,7 @@
<code><a href="#getExecutable">getExecutable(name, executableVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get the `Release` executable to use when enforcing rules.</p>
<p class="toc_element">
- <code><a href="#list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List the `Release` values for a project. This list may optionally be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any combination thereof.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -114,10 +114,10 @@
The object takes the form of:
{ # `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`.
- "createTime": "A String", # Time the release was created. Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
- "updateTime": "A String", # Time the release was updated. Output only.
"name": "A 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}`
+ "updateTime": "A String", # Time the release was updated. Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
+ "createTime": "A String", # Time the release was created. Output only.
}
x__xgafv: string, V1 error format.
@@ -129,10 +129,10 @@
An object of the form:
{ # `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`.
- "createTime": "A String", # Time the release was created. Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
- "updateTime": "A String", # Time the release was updated. Output only.
"name": "A 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}`
+ "updateTime": "A String", # Time the release was updated. Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
+ "createTime": "A String", # Time the release was created. Output only.
}</pre>
</div>
@@ -169,10 +169,10 @@
An object of the form:
{ # `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`.
- "createTime": "A String", # Time the release was created. Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
- "updateTime": "A String", # Time the release was updated. Output only.
"name": "A 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}`
+ "updateTime": "A String", # Time the release was updated. Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
+ "createTime": "A String", # Time the release was created. Output only.
}</pre>
</div>
@@ -196,24 +196,24 @@
An object of the form:
{ # The response for FirebaseRulesService.GetReleaseExecutable
- "rulesetName": "A String", # `Ruleset` name associated with the `Release` executable.
- "executableVersion": "A String", # The Rules runtime version of the executable.
- "updateTime": "A String", # Timestamp for the most recent `Release.update_time`.
"executable": "A String", # Executable view of the `Ruleset` referenced by the `Release`.
- "syncTime": "A String", # Optional, indicates the freshness of the result. The response is guaranteed to be the latest within an interval up to the sync_time (inclusive).
+ "executableVersion": "A String", # The Rules runtime version of the executable.
+ "rulesetName": "A String", # `Ruleset` name associated with the `Release` executable.
"language": "A String", # `Language` used to generate the executable bytes.
+ "syncTime": "A String", # Optional, indicates the freshness of the result. The response is guaranteed to be the latest within an interval up to the sync_time (inclusive).
+ "updateTime": "A String", # Timestamp for the most recent `Release.update_time`.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List the `Release` values for a project. This list may optionally be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any combination thereof.
Args:
name: string, Resource name for the project. Format: `projects/{project_id}` (required)
filter: string, `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: string, Next page token for the next batch of `Release` instances.
pageSize: integer, 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, Next page token for the next batch of `Release` instances.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -223,15 +223,15 @@
An object of the form:
{ # The response for FirebaseRulesService.ListReleases.
- "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
"releases": [ # List of `Release` instances.
{ # `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`.
- "createTime": "A String", # Time the release was created. Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
- "updateTime": "A String", # Time the release was updated. Output only.
"name": "A 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}`
+ "updateTime": "A String", # Time the release was updated. Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
+ "createTime": "A String", # Time the release was created. Output only.
},
],
+ "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
}</pre>
</div>
@@ -260,10 +260,10 @@
{ # The request for FirebaseRulesService.UpdateReleasePatch.
"release": { # `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` to update.
- "createTime": "A String", # Time the release was created. Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
- "updateTime": "A String", # Time the release was updated. Output only.
"name": "A 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}`
+ "updateTime": "A String", # Time the release was updated. Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
+ "createTime": "A String", # Time the release was created. Output only.
},
"updateMask": "A String", # Specifies which fields to update.
}
@@ -277,10 +277,10 @@
An object of the form:
{ # `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`.
- "createTime": "A String", # Time the release was created. Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
- "updateTime": "A String", # Time the release was updated. Output only.
"name": "A 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}`
+ "updateTime": "A String", # Time the release was updated. Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
+ "createTime": "A String", # Time the release was created. Output only.
}</pre>
</div>