AcknowledgeRequest
Request for the Acknowledge method.Fields | |
---|---|
ackIds[] |
Required. The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the
|
Binding
Associatesmembers
with a role
.
Fields | |
---|---|
condition |
The condition that is associated with this binding. If the condition evaluates to
|
members[] |
Specifies the identities requesting access for a Cloud Platform resource.
|
role |
Role that is assigned to
|
CreateSnapshotRequest
Request for theCreateSnapshot
method.
Fields | |
---|---|
labels |
See Creating and managing labels.
|
subscription |
Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the
|
DeadLetterPolicy
Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times. If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.Fields | |
---|---|
deadLetterTopic |
The name of the topic to which dead letter messages should be published. Format is
|
maxDeliveryAttempts |
The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
|
ExpirationPolicy
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).Fields | |
---|---|
ttl |
Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of
|
Expr
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.Fields | |
---|---|
description |
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
|
expression |
Textual representation of an expression in Common Expression Language syntax.
|
location |
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
|
title |
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.
|
ListSchemasResponse
Response for theListSchemas
method.
Fields | |
---|---|
nextPageToken |
If not empty, indicates that there may be more schemas that match the request; this value should be passed in a new
|
schemas[] |
The resulting schemas.
|
ListSnapshotsResponse
Response for theListSnapshots
method.
Fields | |
---|---|
nextPageToken |
If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new
|
snapshots[] |
The resulting snapshots.
|
ListSubscriptionsResponse
Response for theListSubscriptions
method.
Fields | |
---|---|
nextPageToken |
If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new
|
subscriptions[] |
The subscriptions that match the request.
|
ListTopicSnapshotsResponse
Response for theListTopicSnapshots
method.
Fields | |
---|---|
nextPageToken |
If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new
|
snapshots[] |
The names of the snapshots that match the request.
|
ListTopicSubscriptionsResponse
Response for theListTopicSubscriptions
method.
Fields | |
---|---|
nextPageToken |
If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new
|
subscriptions[] |
The names of subscriptions attached to the topic specified in the request.
|
ListTopicsResponse
Response for theListTopics
method.
Fields | |
---|---|
nextPageToken |
If not empty, indicates that there may be more topics that match the request; this value should be passed in a new
|
topics[] |
The resulting topics.
|
MessageStoragePolicy
A policy constraining the storage of messages published to the topic.Fields | |
---|---|
allowedPersistenceRegions[] |
A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
|
ModifyAckDeadlineRequest
Request for the ModifyAckDeadline method.Fields | |
---|---|
ackDeadlineSeconds |
Required. The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the
|
ackIds[] |
Required. List of acknowledgment IDs.
|
ModifyPushConfigRequest
Request for the ModifyPushConfig method.Fields | |
---|---|
pushConfig |
Required. The push configuration for future deliveries. An empty
|
OidcToken
Contains information needed for generating an OpenID Connect token.Fields | |
---|---|
audience |
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 |
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.
|
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. APolicy
is a collection of bindings
. A binding
binds one or more members
to a single role
. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role
is a named list of permissions; each role
can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding
can also specify a condition
, which is a logical expression that allows access to a resource only if the expression evaluates to true
. 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.
Fields | |
---|---|
bindings[] |
Associates a list of
|
etag |
|
version |
Specifies the format of the policy. Valid values are
|
PublishRequest
Request for the Publish method.Fields | |
---|---|
messages[] |
Required. The messages to publish.
|
PublishResponse
Response for thePublish
method.
Fields | |
---|---|
messageIds[] |
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.
|
PubsubMessage
A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See quotas and limits for more information about message limits.Fields | |
---|---|
attributes |
Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.
|
data |
The message data field. If this field is empty, the message must contain at least one attribute.
|
messageId |
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
|
orderingKey |
If non-empty, identifies related messages for which publish order should be respected. If a
|
publishTime |
The time at which the message was published, populated by the server when it receives the
|
PullRequest
Request for thePull
method.
Fields | |
---|---|
maxMessages |
Required. The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified.
|
returnImmediately |
Optional. If this field set to true, the system will respond immediately even if it there are no messages available to return in the
|
PullResponse
Response for thePull
method.
Fields | |
---|---|
receivedMessages[] |
Received Pub/Sub messages. The list will be empty if there are no more messages available in the backlog. For JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the
|
PushConfig
Configuration for a push delivery endpoint.Fields | |
---|---|
attributes |
Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is
|
oidcToken |
If specified, Pub/Sub will generate and attach an OIDC JWT token as an
|
pushEndpoint |
A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use
|
ReceivedMessage
A message and its corresponding acknowledgment ID.Fields | |
---|---|
ackId |
This ID can be used to acknowledge the received message.
|
deliveryAttempt |
The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber. More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message. A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library. Upon the first delivery of a given message,
|
message |
The message.
|
RetryPolicy
A policy that specifies how Cloud Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.Fields | |
---|---|
maximumBackoff |
The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
|
minimumBackoff |
The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
|
Schema
A schema resource.Fields | |
---|---|
definition |
The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in
|
name |
Required. Name of the schema. Format is
|
type |
The type of the schema definition.
|
Enum type. Can be one of the following: | |
TYPE_UNSPECIFIED |
Default value. This value is unused. |
PROTOCOL_BUFFER |
A Protocol Buffer schema definition. |
AVRO |
An Avro schema definition. |
SchemaSettings
Settings for validating messages published against a schema.Fields | |
---|---|
encoding |
The encoding of messages validated against
|
Enum type. Can be one of the following: | |
ENCODING_UNSPECIFIED |
Unspecified |
JSON |
JSON encoding |
BINARY |
Binary encoding, as defined by the schema type. For some schema types, binary encoding may not be available. |
schema |
Required. The name of the schema that messages published should be validated against. Format is
|
SeekRequest
Request for theSeek
method.
Fields | |
---|---|
snapshot |
The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is
|
time |
The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of
|
SetIamPolicyRequest
Request message forSetIamPolicy
method.
Fields | |
---|---|
policy |
REQUIRED: The complete policy to be applied to the
|
Snapshot
A snapshot resource. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.Fields | |
---|---|
expireTime |
The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is
|
labels |
See Creating and managing labels.
|
name |
The name of the snapshot.
|
topic |
The name of the topic from which this snapshot is retaining messages.
|
Subscription
A subscription resource.Fields | |
---|---|
ackDeadlineSeconds |
The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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
|
deadLetterPolicy |
A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
|
detached |
Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog.
|
enableMessageOrdering |
If true, messages published with the same
|
expirationPolicy |
A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If
|
filter |
An expression written in the Pub/Sub filter language. If non-empty, then only
|
labels |
See Creating and managing labels.
|
messageRetentionDuration |
How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If
|
name |
Required. The name of the subscription. It must have the format
|
pushConfig |
If push delivery is used with this subscription, this field is used to configure it. An empty
|
retainAckedMessages |
Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the
|
retryPolicy |
A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
|
topic |
Required. The name of the topic from which this subscription is receiving messages. Format is
|
topicMessageRetentionDuration |
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last
|
TestIamPermissionsRequest
Request message forTestIamPermissions
method.
Fields | |
---|---|
permissions[] |
The set of permissions to check for the
|
TestIamPermissionsResponse
Response message forTestIamPermissions
method.
Fields | |
---|---|
permissions[] |
A subset of
|
Topic
A topic resource.Fields | |
---|---|
kmsKeyName |
The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is
|
labels |
See Creating and managing labels.
|
messageRetentionDuration |
Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last
|
messageStoragePolicy |
Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
|
name |
Required. The name of the topic. It must have the format
|
satisfiesPzs |
Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
|
schemaSettings |
Settings for validating messages published against a schema.
|
UpdateSnapshotRequest
Request for the UpdateSnapshot method.Fields | |
---|---|
snapshot |
Required. The updated snapshot object.
|
updateMask |
Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.
|
UpdateSubscriptionRequest
Request for the UpdateSubscription method.Fields | |
---|---|
subscription |
Required. The updated subscription object.
|
updateMask |
Required. Indicates which fields in the provided subscription to update. Must be specified and non-empty.
|
UpdateTopicRequest
Request for the UpdateTopic method.Fields | |
---|---|
topic |
Required. The updated topic object.
|
updateMask |
Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if
|
ValidateMessageRequest
Request for theValidateMessage
method.
Fields | |
---|---|
encoding |
The encoding expected for messages
|
Enum type. Can be one of the following: | |
ENCODING_UNSPECIFIED |
Unspecified |
JSON |
JSON encoding |
BINARY |
Binary encoding, as defined by the schema type. For some schema types, binary encoding may not be available. |
message |
Message to validate against the provided
|
name |
Name of the schema against which to validate. Format is
|
schema |
Ad-hoc schema against which to validate
|
ValidateSchemaRequest
Request for theValidateSchema
method.
Fields | |
---|---|
schema |
Required. The schema object to validate.
|