docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/pubsub_v1.projects.topics.html b/docs/dyn/pubsub_v1.projects.topics.html
index db7b271..4971881 100644
--- a/docs/dyn/pubsub_v1.projects.topics.html
+++ b/docs/dyn/pubsub_v1.projects.topics.html
@@ -132,6 +132,12 @@
The object takes the form of:
{ # A topic resource.
+ "name": "A String", # Required. The name of the topic. It must have the format
+ # `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.
"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access
# to messages published on this topic.
#
@@ -151,12 +157,6 @@
"A String",
],
},
- "name": "A String", # Required. The name of the topic. It must have the format
- # `"projects/{project}/topics/{topic}"`. `{topic}` 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.
@@ -168,6 +168,12 @@
An object of the form:
{ # A topic resource.
+ "name": "A String", # Required. The name of the topic. It must have the format
+ # `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.
"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access
# to messages published on this topic.
#
@@ -187,12 +193,6 @@
"A String",
],
},
- "name": "A String", # Required. The name of the topic. It must have the format
- # `"projects/{project}/topics/{topic}"`. `{topic}` 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>
@@ -243,6 +243,12 @@
An object of the form:
{ # A topic resource.
+ "name": "A String", # Required. The name of the topic. It must have the format
+ # `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.
"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access
# to messages published on this topic.
#
@@ -262,12 +268,6 @@
"A String",
],
},
- "name": "A String", # Required. The name of the topic. It must have the format
- # `"projects/{project}/topics/{topic}"`. `{topic}` 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>
@@ -367,42 +367,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
@@ -508,6 +472,42 @@
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
@@ -531,8 +531,16 @@
An object of the form:
{ # Response for the `ListTopics` method.
+ "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the
+ # request; this value should be passed in a new `ListTopicsRequest`.
"topics": [ # The resulting topics.
{ # A topic resource.
+ "name": "A String", # Required. The name of the topic. It must have the format
+ # `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.
"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access
# to messages published on this topic.
#
@@ -552,16 +560,8 @@
"A String",
],
},
- "name": "A String", # Required. The name of the topic. It must have the format
- # `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.
},
],
- "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the
- # request; this value should be passed in a new `ListTopicsRequest`.
}</pre>
</div>
@@ -601,6 +601,12 @@
# the `topic` provided above, then the updated value is determined by the
# policy configured at the project or organization level.
"topic": { # A topic resource. # Required. The updated topic object.
+ "name": "A String", # Required. The name of the topic. It must have the format
+ # `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.
"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access
# to messages published on this topic.
#
@@ -620,12 +626,6 @@
"A String",
],
},
- "name": "A String", # Required. The name of the topic. It must have the format
- # `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.
},
}
@@ -638,6 +638,12 @@
An object of the form:
{ # A topic resource.
+ "name": "A String", # Required. The name of the topic. It must have the format
+ # `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.
"kmsKeyName": "A String", # The resource name of the Cloud KMS CryptoKey to be used to protect access
# to messages published on this topic.
#
@@ -657,12 +663,6 @@
"A String",
],
},
- "name": "A String", # Required. The name of the topic. It must have the format
- # `"projects/{project}/topics/{topic}"`. `{topic}` 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>
@@ -687,6 +687,11 @@
# library documentation</a> for more information. See
# <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a>
# for more information about message limits.
+ "publishTime": "A String", # The time at which the message was published, populated by the server when
+ # it receives the `Publish` call. It must not be populated by the
+ # publisher in a `Publish` call.
+ "data": "A String", # The message data field. If this field is empty, the message must contain
+ # at least one attribute.
"messageId": "A String", # ID of this message, assigned by the server when the message is published.
# Guaranteed to be unique within the topic. This value may be read by a
# subscriber that receives a `PubsubMessage` via a `Pull` call or a push
@@ -695,11 +700,6 @@
# contain non-empty data.
"a_key": "A String",
},
- "publishTime": "A String", # The time at which the message was published, populated by the server when
- # it receives the `Publish` call. It must not be populated by the
- # publisher in a `Publish` call.
- "data": "A String", # The message data field. If this field is empty, the message must contain
- # at least one attribute.
},
],
}
@@ -805,42 +805,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
@@ -946,6 +910,42 @@
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -1024,42 +1024,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
@@ -1165,6 +1129,42 @@
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>