@datafire/google_pubsub
Client library for Cloud Pub/Sub API
Installation and Usage
npm install --save @datafire/google_pubsub
let google_pubsub = require('@datafire/google_pubsub').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Provides reliable, many-to-many, asynchronous messaging between applications.
Actions
oauthCallback
Exchange the code passed to your redirect URI for an access_token
google_pubsub.oauthCallback({
"code": ""
}, context)
Input
- input
object
- code required
string
- code required
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
oauthRefresh
Exchange a refresh_token for an access_token
google_pubsub.oauthRefresh(null, context)
Input
This action has no parameters
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
pubsub.projects.topics.create
Creates the given topic with the given name.
google_pubsub.pubsub.projects.topics.create({
"name": ""
}, context)
Input
- input
object
- name required
string
: 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"
. - body Topic
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- name required
Output
- output Topic
pubsub.projects.subscriptions.list
Lists matching subscriptions.
google_pubsub.pubsub.projects.subscriptions.list({
"project": ""
}, context)
Input
- input
object
- project required
string
: The name of the cloud project that subscriptions belong to. - pageSize
integer
: Maximum number of subscriptions to return. - pageToken
string
: The value returned by the lastListSubscriptionsResponse
; indicates that this is a continuation of a priorListSubscriptions
call, and that the system should return the next page of data. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- project required
Output
- output ListSubscriptionsResponse
pubsub.projects.topics.list
Lists matching topics.
google_pubsub.pubsub.projects.topics.list({
"project": ""
}, context)
Input
- input
object
- project required
string
: The name of the cloud project that topics belong to. - pageSize
integer
: Maximum number of topics to return. - pageToken
string
: The value returned by the lastListTopicsResponse
; indicates that this is a continuation of a priorListTopics
call, and that the system should return the next page of data. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- project required
Output
- output ListTopicsResponse
pubsub.projects.topics.getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
google_pubsub.pubsub.projects.topics.getIamPolicy({
"resource": ""
}, context)
Input
- input
object
- resource required
string
: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - options.requestedPolicyVersion
integer
: Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- resource required
Output
- output Policy
pubsub.projects.topics.setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
google_pubsub.pubsub.projects.topics.setIamPolicy({
"resource": ""
}, context)
Input
- input
object
- resource required
string
: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. - body SetIamPolicyRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- resource required
Output
- output Policy
pubsub.projects.topics.testIamPermissions
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. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
google_pubsub.pubsub.projects.topics.testIamPermissions({
"resource": ""
}, context)
Input
- input
object
- resource required
string
: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. - body TestIamPermissionsRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- resource required
Output
- output TestIamPermissionsResponse
pubsub.projects.subscriptions.delete
Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull
after deletion will return NOT_FOUND
. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.
google_pubsub.pubsub.projects.subscriptions.delete({
"subscription": ""
}, context)
Input
- input
object
- subscription required
string
: The subscription to delete. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- subscription required
Output
- output Empty
pubsub.projects.subscriptions.get
Gets the configuration details of a subscription.
google_pubsub.pubsub.projects.subscriptions.get({
"subscription": ""
}, context)
Input
- input
object
- subscription required
string
: The name of the subscription to get. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- subscription required
Output
- output Subscription
pubsub.projects.subscriptions.acknowledge
Acknowledges the messages associated with the ack_ids
in the AcknowledgeRequest
. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.
google_pubsub.pubsub.projects.subscriptions.acknowledge({
"subscription": ""
}, context)
Input
- input
object
- subscription required
string
: The subscription whose message is being acknowledged. - body AcknowledgeRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- subscription required
Output
- output Empty
pubsub.projects.subscriptions.modifyAckDeadline
Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level ackDeadlineSeconds
used for subsequent messages.
google_pubsub.pubsub.projects.subscriptions.modifyAckDeadline({
"subscription": ""
}, context)
Input
- input
object
- subscription required
string
: The name of the subscription. - body ModifyAckDeadlineRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- subscription required
Output
- output Empty
pubsub.projects.subscriptions.modifyPushConfig
Modifies the PushConfig
for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty PushConfig
) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig
.
google_pubsub.pubsub.projects.subscriptions.modifyPushConfig({
"subscription": ""
}, context)
Input
- input
object
- subscription required
string
: The name of the subscription. - body ModifyPushConfigRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- subscription required
Output
- output Empty
pubsub.projects.subscriptions.pull
Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return UNAVAILABLE
if there are too many concurrent pull requests pending for the given subscription.
google_pubsub.pubsub.projects.subscriptions.pull({
"subscription": ""
}, context)
Input
- input
object
- subscription required
string
: The subscription from which messages should be pulled. - body PullRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- subscription required
Output
- output PullResponse
pubsub.projects.topics.delete
Deletes the topic with the given name. Returns NOT_FOUND
if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their topic
field is set to _deleted-topic_
.
google_pubsub.pubsub.projects.topics.delete({
"topic": ""
}, context)
Input
- input
object
- topic required
string
: Name of the topic to delete. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- topic required
Output
- output Empty
pubsub.projects.topics.get
Gets the configuration of a topic.
google_pubsub.pubsub.projects.topics.get({
"topic": ""
}, context)
Input
- input
object
- topic required
string
: The name of the topic to get. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- topic required
Output
- output Topic
pubsub.projects.topics.subscriptions.list
Lists the name of the subscriptions for this topic.
google_pubsub.pubsub.projects.topics.subscriptions.list({
"topic": ""
}, context)
Input
- input
object
- topic required
string
: The name of the topic that subscriptions are attached to. - pageSize
integer
: Maximum number of subscription names to return. - pageToken
string
: The value returned by the lastListTopicSubscriptionsResponse
; indicates that this is a continuation of a priorListTopicSubscriptions
call, and that the system should return the next page of data. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- topic required
Output
pubsub.projects.topics.publish
Adds one or more messages to the topic. Returns NOT_FOUND
if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
google_pubsub.pubsub.projects.topics.publish({
"topic": ""
}, context)
Input
- input
object
- topic required
string
: The messages in the request will be published on this topic. - body PublishRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - oauth_token
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- topic required
Output
- output PublishResponse
Definitions
AcknowledgeRequest
- AcknowledgeRequest
object
: Request for the Acknowledge method.- ackIds
array
: The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in thePull
response. Must not be empty.- items
string
- items
- ackIds
Binding
- Binding
object
: Associatesmembers
with arole
.- condition Expr
- members
array
: Specifies the identities requesting access for a Cloud Platform resource.members
can have the following values: *allUsers
: A special identifier that represents anyone who is on the internet; with or without a Google account. *allAuthenticatedUsers
: A special identifier that represents anyone who is authenticated with a Google account or a service account. *user:{emailid}
: An email address that represents a specific Google account. For example,alice@example.com
. *serviceAccount:{emailid}
: An email address that represents a service account. For example,my-other-app@appspot.gserviceaccount.com
. *group:{emailid}
: An email address that represents a Google group. For example,admins@example.com
. *deleted:user:{emailid}?uid={uniqueid}
: An email address (plus unique identifier) representing a user that has been recently deleted. For example,alice@example.com?uid=123456789012345678901
. If the user is recovered, this value reverts touser:{emailid}
and the recovered user retains the role in the binding. *deleted:serviceAccount:{emailid}?uid={uniqueid}
: An email address (plus unique identifier) representing a service account that has been recently deleted. For example,my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901
. If the service account is undeleted, this value reverts toserviceAccount:{emailid}
and the undeleted service account retains the role in the binding. *deleted:group:{emailid}?uid={uniqueid}
: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example,admins@example.com?uid=123456789012345678901
. If the group is recovered, this value reverts togroup:{emailid}
and the recovered group retains the role in the binding. *domain:{domain}
: The G Suite domain (primary) that represents all the users of that domain. For example,google.com
orexample.com
.- items
string
- items
- role
string
: Role that is assigned tomembers
. For example,roles/viewer
,roles/editor
, orroles/owner
.
Empty
- Empty
object
: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation forEmpty
is empty JSON object{}
.
Expr
- Expr
object
: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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.- description
string
: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - expression
string
: Textual representation of an expression in Common Expression Language syntax. - location
string
: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - title
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.
- description
ListSubscriptionsResponse
- ListSubscriptionsResponse
object
: Response for theListSubscriptions
method.- nextPageToken
string
: If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a newListSubscriptionsRequest
to get more subscriptions. - subscriptions
array
: The subscriptions that match the request.- items Subscription
- nextPageToken
ListTopicSubscriptionsResponse
- ListTopicSubscriptionsResponse
object
: Response for theListTopicSubscriptions
method.- nextPageToken
string
: If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a newListTopicSubscriptionsRequest
to get more subscriptions. - subscriptions
array
: The names of the subscriptions that match the request.- items
string
- items
- nextPageToken
ListTopicsResponse
- ListTopicsResponse
object
: Response for theListTopics
method.- nextPageToken
string
: If not empty, indicates that there may be more topics that match the request; this value should be passed in a newListTopicsRequest
. - topics
array
: The resulting topics.- items Topic
- nextPageToken
ModifyAckDeadlineRequest
- ModifyAckDeadlineRequest
object
: Request for the ModifyAckDeadline method.- ackDeadlineSeconds
integer
: The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after theModifyAckDeadline
call was made. Specifying zero may immediately make the message available for another pull request. - ackId
string
: The acknowledgment ID. Either this or ack_ids must be populated, but not both. - ackIds
array
: List of acknowledgment IDs.- items
string
- items
- ackDeadlineSeconds
ModifyPushConfigRequest
- ModifyPushConfigRequest
object
: Request for the ModifyPushConfig method.- pushConfig PushConfig
OidcToken
- OidcToken
object
: Contains information needed for generating an OpenID Connect token.- audience
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
string
: Service account email 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
Policy
- Policy
object
: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. APolicy
is a collection ofbindings
. Abinding
binds one or moremembers
to a singlerole
. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). Arole
is a named list of permissions; eachrole
can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, abinding
can also specify acondition
, which is a logical expression that allows access to a resource only if the expression evaluates totrue
. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.- bindings
array
: Associates a list ofmembers
to arole
. Optionally, may specify acondition
that determines how and when thebindings
are applied. Each of thebindings
must contain at least one member.- items Binding
- etag
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 theetag
in the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetag
is returned in the response togetIamPolicy
, and systems are expected to put that etag in the request tosetIamPolicy
to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include theetag
field whenever you callsetIamPolicy
. If you omit this field, then IAM allows you to overwrite a version3
policy with a version1
policy, and all of the conditions in the version3
policy are lost. - version
integer
: Specifies the format of the policy. Valid values are0
,1
, and3
. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version3
. 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 theetag
field whenever you callsetIamPolicy
. If you omit this field, then IAM allows you to overwrite a version3
policy with a version1
policy, and all of the conditions in the version3
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.
- bindings
PublishRequest
- PublishRequest
object
: Request for the Publish method.- messages
array
: The messages to publish.- items PubsubMessage
- messages
PublishResponse
- PublishResponse
object
: Response for thePublish
method.- messageIds
array
: The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.- items
string
- items
- messageIds
PubsubMessage
- PubsubMessage
object
: A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.- attributes
object
: Optional attributes for this message. - data
string
: The message payload. For JSON requests, the value of this field must be base64-encoded. - messageId
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 aPubsubMessage
via aPull
call or a push delivery. It must not be populated by the publisher in aPublish
call. - publishTime
string
: The time at which the message was published, populated by the server when it receives thePublish
call. It must not be populated by the publisher in aPublish
call.
- attributes
PullRequest
- PullRequest
object
: Request for thePull
method.- maxMessages
integer
: The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified. - returnImmediately
boolean
: Optional. If this is specified as true the system will respond immediately even if it is not able to return a message in thePull
response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response. Warning: setting this field totrue
is discouraged because it adversely impacts the performance ofPull
operations. We recommend that users do not set this field.
- maxMessages
PullResponse
- PullResponse
object
: Response for thePull
method.- receivedMessages
array
: Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than themaxMessages
requested even if there are more messages available in the backlog.- items ReceivedMessage
- receivedMessages
PushConfig
- PushConfig
object
: Configuration for a push delivery endpoint.- attributes
object
: 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 isx-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 theCreateSubscription
call, it will default to the version of the API used to make such call. If not present during aModifyPushConfig
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
orv1beta2
: uses the push format defined in the v1 Pub/Sub API. - oidcToken OidcToken
- pushEndpoint
string
: A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
- attributes
ReceivedMessage
- ReceivedMessage
object
: A message and its corresponding acknowledgment ID.- ackId
string
: This ID can be used to acknowledge the received message. - message PubsubMessage
- ackId
SetIamPolicyRequest
- SetIamPolicyRequest
object
: Request message forSetIamPolicy
method.- policy Policy
Subscription
- Subscription
object
: A subscription resource.- ackDeadlineSeconds
integer
: 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, callModifyAckDeadline
with the correspondingack_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
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"
. - pushConfig PushConfig
- topic
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
TestIamPermissionsRequest
- TestIamPermissionsRequest
object
: Request message forTestIamPermissions
method.- permissions
array
: The set of permissions to check for theresource
. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.- items
string
- items
- permissions
TestIamPermissionsResponse
- TestIamPermissionsResponse
object
: Response message forTestIamPermissions
method.- permissions
array
: A subset ofTestPermissionsRequest.permissions
that the caller is allowed.- items
string
- items
- permissions
Topic
- Topic
object
: A topic resource.- name
string
: 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"
.
- name