Fix method doc signatures for multiline required parameters (#374)
* Fix method doc signatures for multiline required parameters.
Existing doc generator failed to recognize parameters as required when parameter descriptions
extended over more than one line. Besides presenting incorrect information, resulting
inconsistencies broke checks for automated sample generation.
* Regen docs
diff --git a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
index 1f00d47..d7f372f 100644
--- a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
@@ -78,7 +78,7 @@
<code><a href="#acknowledge">acknowledge(subscription, body, x__xgafv=None)</a></code></p>
<p class="firstline">Acknowledges the messages associated with the `ack_ids` in the</p>
<p class="toc_element">
- <code><a href="#create">create(name=None, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a subscription to a given topic.</p>
<p class="toc_element">
<code><a href="#delete">delete(subscription, x__xgafv=None)</a></code></p>
@@ -87,7 +87,7 @@
<code><a href="#get">get(subscription, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the configuration details of a subscription.</p>
<p class="toc_element">
- <code><a href="#getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</a></code></p>
+ <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource.</p>
<p class="toc_element">
<code><a href="#list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
@@ -105,10 +105,10 @@
<code><a href="#pull">pull(subscription, body, x__xgafv=None)</a></code></p>
<p class="firstline">Pulls messages from the server. Returns an empty list if there are no</p>
<p class="toc_element">
- <code><a href="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
<p class="toc_element">
- <code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<h3>Method Details</h3>
<div class="method">
@@ -154,7 +154,7 @@
</div>
<div class="method">
- <code class="details" id="create">create(name=None, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(name, body, x__xgafv=None)</code>
<pre>Creates a subscription to a given topic.
If the subscription already exists, returns `ALREADY_EXISTS`.
If the corresponding topic doesn't exist, returns `NOT_FOUND`.
@@ -174,95 +174,27 @@
The object takes the form of:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
- # before the subscriber should acknowledge the message. After message
- # delivery but before the ack deadline expires and before the message is
- # acknowledged, it is an outstanding message and will not be delivered
- # again during that time (on a best-effort basis).
- #
- # For pull subscriptions, this value is used as the initial value for the ack
- # deadline. To override this value for a given message, call
- # `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
- # The maximum custom deadline you can specify is 600 seconds (10 minutes).
- #
- # For push delivery, this value is also used to set the request timeout for
- # the call to the push endpoint.
- #
- # If the subscriber never acknowledges the message, the Pub/Sub
- # system will eventually redeliver the message.
- #
- # If this parameter is 0, a default value of 10 seconds is used.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- # The value of this field will be `_deleted-topic_` if the topic has been
- # deleted.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
- # used to configure it. An empty `pushConfig` signifies that the subscriber
- # will pull and ack messages using API methods.
- "attributes": { # Endpoint configuration attributes.
- #
- # Every endpoint has a set of API supported attributes that can be used to
- # control different aspects of the message delivery.
- #
- # The currently supported attribute is `x-goog-version`, which you can
- # use to change the format of the push message. This attribute
- # indicates the version of the data expected by the endpoint. This
- # controls the shape of the envelope (i.e. its fields and metadata).
- # The endpoint version is based on the version of the Pub/Sub
- # API.
- #
- # If not present during the `CreateSubscription` call, it will default to
- # the version of the API used to make such call. If not present during a
- # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
- # calls will always return a valid version, even if the subscription was
- # created without this attribute.
- #
- # The possible values for this attribute are:
- #
- # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
- # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
- "a_key": "A String",
- },
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
- },
- "name": "A String", # The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # A subscription resource.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ # The value of this field will be `_deleted-topic_` if the topic has been
+ # deleted.
"ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
# before the subscriber should acknowledge the message. After message
# delivery but before the ack deadline expires and before the message is
# acknowledged, it is an outstanding message and will not be delivered
# again during that time (on a best-effort basis).
- #
+ #
# For pull subscriptions, this value is used as the initial value for the ack
# deadline. To override this value for a given message, call
# `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
# The maximum custom deadline you can specify is 600 seconds (10 minutes).
- #
+ #
# For push delivery, this value is also used to set the request timeout for
# the call to the push endpoint.
- #
+ #
# If the subscriber never acknowledges the message, the Pub/Sub
# system will eventually redeliver the message.
- #
+ #
# If this parameter is 0, a default value of 10 seconds is used.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- # The value of this field will be `_deleted-topic_` if the topic has been
- # deleted.
"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
# used to configure it. An empty `pushConfig` signifies that the subscriber
# will pull and ack messages using API methods.
@@ -299,7 +231,75 @@
# (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
# plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
# in length, and it must not start with `"goog"`.
- }</pre>
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A subscription resource.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ # The value of this field will be `_deleted-topic_` if the topic has been
+ # deleted.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
+ # before the subscriber should acknowledge the message. After message
+ # delivery but before the ack deadline expires and before the message is
+ # acknowledged, it is an outstanding message and will not be delivered
+ # again during that time (on a best-effort basis).
+ #
+ # For pull subscriptions, this value is used as the initial value for the ack
+ # deadline. To override this value for a given message, call
+ # `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
+ # The maximum custom deadline you can specify is 600 seconds (10 minutes).
+ #
+ # For push delivery, this value is also used to set the request timeout for
+ # the call to the push endpoint.
+ #
+ # If the subscriber never acknowledges the message, the Pub/Sub
+ # system will eventually redeliver the message.
+ #
+ # If this parameter is 0, a default value of 10 seconds is used.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ # used to configure it. An empty `pushConfig` signifies that the subscriber
+ # will pull and ack messages using API methods.
+ "attributes": { # Endpoint configuration attributes.
+ #
+ # Every endpoint has a set of API supported attributes that can be used to
+ # control different aspects of the message delivery.
+ #
+ # The currently supported attribute is `x-goog-version`, which you can
+ # use to change the format of the push message. This attribute
+ # indicates the version of the data expected by the endpoint. This
+ # controls the shape of the envelope (i.e. its fields and metadata).
+ # The endpoint version is based on the version of the Pub/Sub
+ # API.
+ #
+ # If not present during the `CreateSubscription` call, it will default to
+ # the version of the API used to make such call. If not present during a
+ # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
+ # calls will always return a valid version, even if the subscription was
+ # created without this attribute.
+ #
+ # The possible values for this attribute are:
+ #
+ # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
+ # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
+ "a_key": "A String",
+ },
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ },
+ "name": "A String", # The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ }</pre>
</div>
<div class="method">
@@ -347,68 +347,68 @@
An object of the form:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
- # before the subscriber should acknowledge the message. After message
- # delivery but before the ack deadline expires and before the message is
- # acknowledged, it is an outstanding message and will not be delivered
- # again during that time (on a best-effort basis).
- #
- # For pull subscriptions, this value is used as the initial value for the ack
- # deadline. To override this value for a given message, call
- # `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
- # The maximum custom deadline you can specify is 600 seconds (10 minutes).
- #
- # For push delivery, this value is also used to set the request timeout for
- # the call to the push endpoint.
- #
- # If the subscriber never acknowledges the message, the Pub/Sub
- # system will eventually redeliver the message.
- #
- # If this parameter is 0, a default value of 10 seconds is used.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- # The value of this field will be `_deleted-topic_` if the topic has been
- # deleted.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
- # used to configure it. An empty `pushConfig` signifies that the subscriber
- # will pull and ack messages using API methods.
- "attributes": { # Endpoint configuration attributes.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ # The value of this field will be `_deleted-topic_` if the topic has been
+ # deleted.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
+ # before the subscriber should acknowledge the message. After message
+ # delivery but before the ack deadline expires and before the message is
+ # acknowledged, it is an outstanding message and will not be delivered
+ # again during that time (on a best-effort basis).
#
- # Every endpoint has a set of API supported attributes that can be used to
- # control different aspects of the message delivery.
+ # For pull subscriptions, this value is used as the initial value for the ack
+ # deadline. To override this value for a given message, call
+ # `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
+ # The maximum custom deadline you can specify is 600 seconds (10 minutes).
#
- # The currently supported attribute is `x-goog-version`, which you can
- # use to change the format of the push message. This attribute
- # indicates the version of the data expected by the endpoint. This
- # controls the shape of the envelope (i.e. its fields and metadata).
- # The endpoint version is based on the version of the Pub/Sub
- # API.
+ # For push delivery, this value is also used to set the request timeout for
+ # the call to the push endpoint.
#
- # If not present during the `CreateSubscription` call, it will default to
- # the version of the API used to make such call. If not present during a
- # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
- # calls will always return a valid version, even if the subscription was
- # created without this attribute.
+ # If the subscriber never acknowledges the message, the Pub/Sub
+ # system will eventually redeliver the message.
#
- # The possible values for this attribute are:
- #
- # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
- # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
- "a_key": "A String",
+ # If this parameter is 0, a default value of 10 seconds is used.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ # used to configure it. An empty `pushConfig` signifies that the subscriber
+ # will pull and ack messages using API methods.
+ "attributes": { # Endpoint configuration attributes.
+ #
+ # Every endpoint has a set of API supported attributes that can be used to
+ # control different aspects of the message delivery.
+ #
+ # The currently supported attribute is `x-goog-version`, which you can
+ # use to change the format of the push message. This attribute
+ # indicates the version of the data expected by the endpoint. This
+ # controls the shape of the envelope (i.e. its fields and metadata).
+ # The endpoint version is based on the version of the Pub/Sub
+ # API.
+ #
+ # If not present during the `CreateSubscription` call, it will default to
+ # the version of the API used to make such call. If not present during a
+ # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
+ # calls will always return a valid version, even if the subscription was
+ # created without this attribute.
+ #
+ # The possible values for this attribute are:
+ #
+ # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
+ # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
+ "a_key": "A String",
+ },
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
},
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
- },
- "name": "A String", # The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
- }</pre>
+ "name": "A String", # The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</code>
+ <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
<pre>Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy
set.
@@ -526,64 +526,64 @@
# `ListSubscriptionsRequest` to get more subscriptions.
"subscriptions": [ # The subscriptions that match the request.
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
- # before the subscriber should acknowledge the message. After message
- # delivery but before the ack deadline expires and before the message is
- # acknowledged, it is an outstanding message and will not be delivered
- # again during that time (on a best-effort basis).
- #
- # For pull subscriptions, this value is used as the initial value for the ack
- # deadline. To override this value for a given message, call
- # `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
- # The maximum custom deadline you can specify is 600 seconds (10 minutes).
- #
- # For push delivery, this value is also used to set the request timeout for
- # the call to the push endpoint.
- #
- # If the subscriber never acknowledges the message, the Pub/Sub
- # system will eventually redeliver the message.
- #
- # If this parameter is 0, a default value of 10 seconds is used.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- # The value of this field will be `_deleted-topic_` if the topic has been
- # deleted.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
- # used to configure it. An empty `pushConfig` signifies that the subscriber
- # will pull and ack messages using API methods.
- "attributes": { # Endpoint configuration attributes.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ # The value of this field will be `_deleted-topic_` if the topic has been
+ # deleted.
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
+ # before the subscriber should acknowledge the message. After message
+ # delivery but before the ack deadline expires and before the message is
+ # acknowledged, it is an outstanding message and will not be delivered
+ # again during that time (on a best-effort basis).
#
- # Every endpoint has a set of API supported attributes that can be used to
- # control different aspects of the message delivery.
+ # For pull subscriptions, this value is used as the initial value for the ack
+ # deadline. To override this value for a given message, call
+ # `ModifyAckDeadline` with the corresponding `ack_id` if using pull.
+ # The maximum custom deadline you can specify is 600 seconds (10 minutes).
#
- # The currently supported attribute is `x-goog-version`, which you can
- # use to change the format of the push message. This attribute
- # indicates the version of the data expected by the endpoint. This
- # controls the shape of the envelope (i.e. its fields and metadata).
- # The endpoint version is based on the version of the Pub/Sub
- # API.
+ # For push delivery, this value is also used to set the request timeout for
+ # the call to the push endpoint.
#
- # If not present during the `CreateSubscription` call, it will default to
- # the version of the API used to make such call. If not present during a
- # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
- # calls will always return a valid version, even if the subscription was
- # created without this attribute.
+ # If the subscriber never acknowledges the message, the Pub/Sub
+ # system will eventually redeliver the message.
#
- # The possible values for this attribute are:
- #
- # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
- # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
- "a_key": "A String",
+ # If this parameter is 0, a default value of 10 seconds is used.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ # used to configure it. An empty `pushConfig` signifies that the subscriber
+ # will pull and ack messages using API methods.
+ "attributes": { # Endpoint configuration attributes.
+ #
+ # Every endpoint has a set of API supported attributes that can be used to
+ # control different aspects of the message delivery.
+ #
+ # The currently supported attribute is `x-goog-version`, which you can
+ # use to change the format of the push message. This attribute
+ # indicates the version of the data expected by the endpoint. This
+ # controls the shape of the envelope (i.e. its fields and metadata).
+ # The endpoint version is based on the version of the Pub/Sub
+ # API.
+ #
+ # If not present during the `CreateSubscription` call, it will default to
+ # the version of the API used to make such call. If not present during a
+ # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
+ # calls will always return a valid version, even if the subscription was
+ # created without this attribute.
+ #
+ # The possible values for this attribute are:
+ #
+ # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
+ # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
+ "a_key": "A String",
+ },
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
},
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
+ "name": "A String", # The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
},
- "name": "A String", # The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
- },
],
}</pre>
</div>
@@ -621,11 +621,11 @@
# ack deadline will expire 10 seconds after the `ModifyAckDeadline` call
# was made. Specifying zero may immediately make the message available for
# another pull request.
- "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, but not
- # both.
"ackIds": [ # List of acknowledgment IDs.
"A String",
],
+ "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, but not
+ # both.
}
x__xgafv: string, V1 error format.
@@ -776,7 +776,7 @@
</div>
<div class="method">
- <code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
<pre>Sets the access control policy on the specified resource. Replaces any
existing policy.
@@ -955,7 +955,7 @@
</div>
<div class="method">
- <code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
<pre>Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.