docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/appengine_v1.apps.firewall.ingressRules.html b/docs/dyn/appengine_v1.apps.firewall.ingressRules.html
index f813c1e..bd2cc49 100644
--- a/docs/dyn/appengine_v1.apps.firewall.ingressRules.html
+++ b/docs/dyn/appengine_v1.apps.firewall.ingressRules.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(appsId, ingressRulesId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified firewall rule.</p>
<p class="toc_element">
- <code><a href="#list">list(appsId, pageSize=None, matchingAddress=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(appsId, pageToken=None, pageSize=None, matchingAddress=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the firewall rules of an application.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -98,7 +98,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchUpdate">batchUpdate(appsId, body=None, x__xgafv=None)</code>
- <pre>Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.
+ <pre>Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.
Args:
appsId: string, Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules. (required)
@@ -106,12 +106,12 @@
The object takes the form of:
{ # Request message for Firewall.BatchUpdateIngressRules.
- "ingressRules": [ # A list of FirewallRules to replace the existing set.
+ "ingressRules": [ # A list of FirewallRules to replace the existing set.
{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
- "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
- "action": "A String", # The action to take on matched requests.
- "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
- "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "action": "A String", # The action to take on matched requests.
+ "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
+ "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
},
],
}
@@ -125,12 +125,12 @@
An object of the form:
{ # Response message for Firewall.UpdateAllIngressRules.
- "ingressRules": [ # The full list of ingress FirewallRules for this application.
+ "ingressRules": [ # The full list of ingress FirewallRules for this application.
{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
- "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
- "action": "A String", # The action to take on matched requests.
- "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
- "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "action": "A String", # The action to take on matched requests.
+ "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
+ "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
},
],
}</pre>
@@ -146,10 +146,10 @@
The object takes the form of:
{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
- "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
- "action": "A String", # The action to take on matched requests.
- "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
- "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "action": "A String", # The action to take on matched requests.
+ "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
+ "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
}
x__xgafv: string, V1 error format.
@@ -161,10 +161,10 @@
An object of the form:
{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
- "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
- "action": "A String", # The action to take on matched requests.
- "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
- "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "action": "A String", # The action to take on matched requests.
+ "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
+ "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
}</pre>
</div>
@@ -207,22 +207,22 @@
An object of the form:
{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
- "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
- "action": "A String", # The action to take on matched requests.
- "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
- "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "action": "A String", # The action to take on matched requests.
+ "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
+ "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(appsId, pageSize=None, matchingAddress=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(appsId, pageToken=None, pageSize=None, matchingAddress=None, x__xgafv=None)</code>
<pre>Lists the firewall rules of an application.
Args:
appsId: string, Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules. (required)
+ pageToken: string, Continuation token for fetching the next page of results.
pageSize: integer, Maximum results to return per page.
matchingAddress: string, A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.
- pageToken: string, Continuation token for fetching the next page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -232,15 +232,15 @@
An object of the form:
{ # Response message for Firewall.ListIngressRules.
- "nextPageToken": "A String", # Continuation token for fetching the next page of results.
- "ingressRules": [ # The ingress FirewallRules for this application.
+ "ingressRules": [ # The ingress FirewallRules for this application.
{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
- "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
- "action": "A String", # The action to take on matched requests.
- "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
- "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "action": "A String", # The action to take on matched requests.
+ "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
+ "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
},
],
+ "nextPageToken": "A String", # Continuation token for fetching the next page of results.
}</pre>
</div>
@@ -253,7 +253,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -269,10 +269,10 @@
The object takes the form of:
{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
- "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
- "action": "A String", # The action to take on matched requests.
- "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
- "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "action": "A String", # The action to take on matched requests.
+ "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
+ "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
}
updateMask: string, Standard field mask for the set of fields to be updated.
@@ -285,10 +285,10 @@
An object of the form:
{ # A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
- "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
- "action": "A String", # The action to take on matched requests.
- "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
- "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "action": "A String", # The action to take on matched requests.
+ "description": "A String", # An optional string description of this rule. This field has a maximum length of 100 characters.
+ "sourceRange": "A String", # IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
+ "priority": 42, # A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
}</pre>
</div>