docs: update generated docs (#981)
diff --git a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
index 91012a4..95efa02 100644
--- a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
@@ -174,96 +174,11 @@
The object takes the form of:
{ # 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.
- "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".
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
- # identifies the recipients that the JWT is intended for. The audience
- # value is a single case-sensitive string. Having multiple values (array)
- # for the audience field is not supported. More info about the OIDC JWT
- # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
- # Note: if not specified, the Push endpoint URL will be used.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- },
- "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.
- "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.
"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.
+ "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".
"attributes": { # Endpoint configuration attributes.
#
# Every endpoint has a set of API supported attributes that can be used to
@@ -288,50 +203,135 @@
# * `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".
"oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
# `Authorization` header in the HTTP request for every pushed message.
# [OpenID Connect
# token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
"audience": "A String", # Audience to be used when generating OIDC token. The audience claim
# identifies the recipients that the JWT is intended for. The audience
# value is a single case-sensitive string. Having multiple values (array)
# for the audience field is not supported. More info about the OIDC JWT
# token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
# Note: if not specified, the Push endpoint URL will be used.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
},
},
- "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.
"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>
+ "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.
+ }
+
+ 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.
+ "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.
+ "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".
+ "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",
+ },
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
+ # identifies the recipients that the JWT is intended for. The audience
+ # value is a single case-sensitive string. Having multiple values (array)
+ # for the audience field is not supported. More info about the OIDC JWT
+ # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
+ # Note: if not specified, the Push endpoint URL will be used.
+ },
+ },
+ "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"`.
+ "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.
+ }</pre>
</div>
<div class="method">
@@ -379,80 +379,80 @@
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.
- "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",
+ "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.
+ "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".
+ "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",
+ },
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
+ # identifies the recipients that the JWT is intended for. The audience
+ # value is a single case-sensitive string. Having multiple values (array)
+ # for the audience field is not supported. More info about the OIDC JWT
+ # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
+ # Note: if not specified, the Push endpoint URL will be used.
+ },
},
- "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".
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
- # identifies the recipients that the JWT is intended for. The audience
- # value is a single case-sensitive string. Having multiple values (array)
- # for the audience field is not supported. More info about the OIDC JWT
- # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
- # Note: if not specified, the Push endpoint URL will be used.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- },
- "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.
- "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"`.
+ "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.
+ }</pre>
</div>
<div class="method">
@@ -551,18 +551,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
@@ -587,6 +575,18 @@
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "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.
"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.
@@ -635,8 +635,6 @@
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
@@ -644,6 +642,8 @@
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -714,86 +714,86 @@
An object of the form:
{ # Response for the `ListSubscriptions` method.
- "subscriptions": [ # The subscriptions that match the request.
- { # 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.
- "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".
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
- # identifies the recipients that the JWT is intended for. The audience
- # value is a single case-sensitive string. Having multiple values (array)
- # for the audience field is not supported. More info about the OIDC JWT
- # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
- # Note: if not specified, the Push endpoint URL will be used.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- },
- "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.
- "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"`.
- },
- ],
"nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match
# the request; this value should be passed in a new
# `ListSubscriptionsRequest` to get more subscriptions.
+ "subscriptions": [ # The subscriptions that match the request.
+ { # A subscription resource.
+ "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.
+ "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".
+ "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",
+ },
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
+ # identifies the recipients that the JWT is intended for. The audience
+ # value is a single case-sensitive string. Having multiple values (array)
+ # for the audience field is not supported. More info about the OIDC JWT
+ # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
+ # Note: if not specified, the Push endpoint URL will be used.
+ },
+ },
+ "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"`.
+ "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.
+ },
+ ],
}</pre>
</div>
@@ -825,6 +825,9 @@
The object takes the form of:
{ # Request for the ModifyAckDeadline method.
+ "ackIds": [ # List of acknowledgment IDs.
+ "A String",
+ ],
"ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, but not
# both.
"ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to
@@ -832,9 +835,6 @@
# ack deadline will expire 10 seconds after the `ModifyAckDeadline` call
# was made. Specifying zero may immediately make the message available for
# another pull request.
- "ackIds": [ # List of acknowledgment IDs.
- "A String",
- ],
}
x__xgafv: string, V1 error format.
@@ -878,6 +878,8 @@
# stop pushing messages from the given subscription and allow
# messages to be pulled and acknowledged - effectively pausing
# the subscription if `Pull` is not called.
+ "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".
"attributes": { # Endpoint configuration attributes.
#
# Every endpoint has a set of API supported attributes that can be used to
@@ -902,23 +904,21 @@
# * `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".
"oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
# `Authorization` header in the HTTP request for every pushed message.
# [OpenID Connect
# token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
"audience": "A String", # Audience to be used when generating OIDC token. The audience claim
# identifies the recipients that the JWT is intended for. The audience
# value is a single case-sensitive string. Having multiple values (array)
# for the audience field is not supported. More info about the OIDC JWT
# token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
# Note: if not specified, the Push endpoint URL will be used.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
},
},
}
@@ -987,14 +987,14 @@
# 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
# delivery. It must not be populated by the publisher in a `Publish` call.
- "attributes": { # Optional attributes for this message.
- "a_key": "A String",
- },
+ "data": "A String", # The message payload. For JSON requests, the value of this field must be
+ # [base64-encoded](https://tools.ietf.org/html/rfc4648).
"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 payload. For JSON requests, the value of this field must be
- # [base64-encoded](https://tools.ietf.org/html/rfc4648).
+ "attributes": { # Optional attributes for this message.
+ "a_key": "A String",
+ },
},
"ackId": "A String", # This ID can be used to acknowledge the received message.
},
@@ -1086,18 +1086,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
@@ -1122,6 +1110,18 @@
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "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.
"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.
@@ -1170,8 +1170,6 @@
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
@@ -1179,6 +1177,8 @@
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -1305,18 +1305,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
@@ -1341,6 +1329,18 @@
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "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.
"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.
@@ -1389,8 +1389,6 @@
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
@@ -1398,6 +1396,8 @@
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values: