Package google.pubsub.v1

Index

Publisher

The service that an application uses to manipulate topics, and to send messages to a topic.

CreateTopic

rpc CreateTopic(Topic) returns (Topic)

Creates the given topic with the given name. See the resource name rules.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteTopic

rpc DeleteTopic(DeleteTopicRequest) returns (Empty)

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_.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DetachSubscription

rpc DetachSubscription(DetachSubscriptionRequest) returns (DetachSubscriptionResponse)

Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetTopic

rpc GetTopic(GetTopicRequest) returns (Topic)

Gets the configuration of a topic.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListTopicSnapshots

rpc ListTopicSnapshots(ListTopicSnapshotsRequest) returns (ListTopicSnapshotsResponse)

Lists the names of the snapshots on this topic. 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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListTopicSubscriptions

rpc ListTopicSubscriptions(ListTopicSubscriptionsRequest) returns (ListTopicSubscriptionsResponse)

Lists the names of the attached subscriptions on this topic.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListTopics

rpc ListTopics(ListTopicsRequest) returns (ListTopicsResponse)

Lists matching topics.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
Publish

rpc Publish(PublishRequest) returns (PublishResponse)

Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateTopic

rpc UpdateTopic(UpdateTopicRequest) returns (Topic)

Updates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SchemaService

Service for doing schema-related operations.

CommitSchema

rpc CommitSchema(CommitSchemaRequest) returns (Schema)

Commits a new schema revision to an existing schema.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateSchema

rpc CreateSchema(CreateSchemaRequest) returns (Schema)

Creates a schema.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteSchema

rpc DeleteSchema(DeleteSchemaRequest) returns (Empty)

Deletes a schema.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteSchemaRevision

rpc DeleteSchemaRevision(DeleteSchemaRevisionRequest) returns (Schema)

Deletes a specific schema revision.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetSchema

rpc GetSchema(GetSchemaRequest) returns (Schema)

Gets a schema.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListSchemaRevisions

rpc ListSchemaRevisions(ListSchemaRevisionsRequest) returns (ListSchemaRevisionsResponse)

Lists all schema revisions for the named schema.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListSchemas

rpc ListSchemas(ListSchemasRequest) returns (ListSchemasResponse)

Lists schemas in a project.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
RollbackSchema

rpc RollbackSchema(RollbackSchemaRequest) returns (Schema)

Creates a new schema revision that is a copy of the provided revision_id.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ValidateMessage

rpc ValidateMessage(ValidateMessageRequest) returns (ValidateMessageResponse)

Validates a message against a schema.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ValidateSchema

rpc ValidateSchema(ValidateSchemaRequest) returns (ValidateSchemaResponse)

Validates a schema.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Subscriber

The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the Pull method or by establishing a bi-directional stream using the StreamingPull method.

Acknowledge

rpc Acknowledge(AcknowledgeRequest) returns (Empty)

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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateSnapshot

rpc CreateSnapshot(CreateSnapshotRequest) returns (Snapshot)

Creates a snapshot from the requested subscription. 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. If the snapshot already exists, returns ALREADY_EXISTS. If the requested subscription doesn't exist, returns NOT_FOUND. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then FAILED_PRECONDITION is returned. See also the Snapshot.expire_time field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the resource name format. The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateSubscription

rpc CreateSubscription(Subscription) returns (Subscription)

Creates a subscription to a given topic. See the resource name rules. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND.

If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteSnapshot

rpc DeleteSnapshot(DeleteSnapshotRequest) returns (Empty)

Removes an existing snapshot. 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. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteSubscription

rpc DeleteSubscription(DeleteSubscriptionRequest) returns (Empty)

Deletes an existing subscription. All messages retained 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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetSnapshot

rpc GetSnapshot(GetSnapshotRequest) returns (Snapshot)

Gets the configuration details of a snapshot. 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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetSubscription

rpc GetSubscription(GetSubscriptionRequest) returns (Subscription)

Gets the configuration details of a subscription.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListSnapshots

rpc ListSnapshots(ListSnapshotsRequest) returns (ListSnapshotsResponse)

Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) 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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListSubscriptions

rpc ListSubscriptions(ListSubscriptionsRequest) returns (ListSubscriptionsResponse)

Lists matching subscriptions.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ModifyAckDeadline

rpc ModifyAckDeadline(ModifyAckDeadlineRequest) returns (Empty)

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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ModifyPushConfig

rpc ModifyPushConfig(ModifyPushConfigRequest) returns (Empty)

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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
Pull

rpc Pull(PullRequest) returns (PullResponse)

Pulls messages from the server.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
Seek

rpc Seek(SeekRequest) returns (SeekResponse)

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. 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. Note that both the subscription and the snapshot must be on the same topic.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
StreamingPull

rpc StreamingPull(StreamingPullRequest) returns (StreamingPullResponse)

Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgements and ack deadline modifications back to the server. The server will close the stream and return the status on any error. The server may close the stream with status UNAVAILABLE to reassign server-side resources, in which case, the client should re-establish the stream. Flow control can be achieved by configuring the underlying RPC channel.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateSnapshot

rpc UpdateSnapshot(UpdateSnapshotRequest) returns (Snapshot)

Updates an existing snapshot by updating the fields specified in the update mask. 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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateSubscription

rpc UpdateSubscription(UpdateSubscriptionRequest) returns (Subscription)

Updates an existing subscription by updating the fields specified in the update mask. Note that certain properties of a subscription, such as its topic, are not modifiable.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

AcknowledgeRequest

Request for the Acknowledge method.

Fields
subscription

string

Required. The subscription whose message is being acknowledged. Format is projects/{project}/subscriptions/{sub}.
ack_ids[]

string

Required. The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the Pull response. Must not be empty.

BigQueryConfig

Configuration for a BigQuery subscription.

Fields
table

string

Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
use_topic_schema

bool

Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. use_topic_schema and use_table_schema cannot be enabled at the same time.
write_metadata

bool

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
drop_unknown_fields

bool

Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
state

State

Output only. An output-only field that indicates whether or not the subscription can receive messages.
use_table_schema

bool

Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery. use_table_schema and use_topic_schema cannot be enabled at the same time.
service_account_email

string

Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

State

Possible states for a BigQuery subscription.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
ACTIVE The subscription can actively send messages to BigQuery
PERMISSION_DENIED Cannot write to the BigQuery table because of permission denied errors. This can happen if - Pub/Sub SA has not been granted the appropriate BigQuery IAM permissions - bigquery.googleapis.com API is not enabled for the project (instructions)
NOT_FOUND Cannot write to the BigQuery table because it does not exist.
SCHEMA_MISMATCH Cannot write to the BigQuery table due to a schema mismatch.
IN_TRANSIT_LOCATION_RESTRICTION Cannot write to the destination because enforce_in_transit is set to true and the destination locations are not in the allowed regions.

CloudStorageConfig

Configuration for a Cloud Storage subscription.

Fields
bucket

string

Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.
filename_prefix

string

Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
filename_suffix

string

Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
filename_datetime_format

string

Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the datetime format guidance.
max_duration

Duration

Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
max_bytes

int64

Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
max_messages

int64

Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
state

State

Output only. An output-only field that indicates whether or not the subscription can receive messages.
service_account_email

string

Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
Union field output_format. Defaults to text format. output_format can be only one of the following:
text_config

TextConfig

Optional. If set, message data will be written to Cloud Storage in text format.
avro_config

AvroConfig

Optional. If set, message data will be written to Cloud Storage in Avro format.

AvroConfig

Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.

Fields
write_metadata

bool

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
use_topic_schema

bool

Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.

State

Possible states for a Cloud Storage subscription.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
ACTIVE The subscription can actively send messages to Cloud Storage.
PERMISSION_DENIED Cannot write to the Cloud Storage bucket because of permission denied errors.
NOT_FOUND Cannot write to the Cloud Storage bucket because it does not exist.
IN_TRANSIT_LOCATION_RESTRICTION Cannot write to the destination because enforce_in_transit is set to true and the destination locations are not in the allowed regions.
SCHEMA_MISMATCH Cannot write to the Cloud Storage bucket due to an incompatibility between the topic schema and subscription settings.

TextConfig

This type has no fields.

Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline.

CommitSchemaRequest

Request for CommitSchema method.

Fields
name

string

Required. The name of the schema we are revising. Format is projects/{project}/schemas/{schema}.
schema

Schema

Required. The schema revision to commit.

CreateSchemaRequest

Request for the CreateSchema method.

Fields
parent

string

Required. The name of the project in which to create the schema. Format is projects/{project-id}.
schema

Schema

Required. The schema object to create.

This schema's name parameter is ignored. The schema object returned by CreateSchema will have a name made using the given parent and schema_id.
schema_id

string

The ID to use for the schema, which will become the final component of the schema's resource name.

See https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names for resource name constraints.

CreateSnapshotRequest

Request for the CreateSnapshot method.

Fields
name

string

Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is projects/{project}/snapshots/{snap}.
subscription

string

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 CreateSnapshot request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is projects/{project}/subscriptions/{sub}.
labels

map<string, string>

Optional. See Creating and managing labels.

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
dead_letter_topic

string

Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic.

The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
max_delivery_attempts

int32

Optional. 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.

DeleteSchemaRequest

Request for the DeleteSchema method.

Fields
name

string

Required. Name of the schema to delete. Format is projects/{project}/schemas/{schema}.

DeleteSchemaRevisionRequest

Request for the DeleteSchemaRevision method.

Fields
name

string

Required. The name of the schema revision to be deleted, with a revision ID explicitly included.

Example: projects/123/schemas/my-schema@c7cfa2a8
revision_id
(deprecated)

string

Optional. This field is deprecated and should not be used for specifying the revision ID. The revision ID should be specified via the name parameter.

DeleteSnapshotRequest

Request for the DeleteSnapshot method.

Fields
snapshot

string

Required. The name of the snapshot to delete. Format is projects/{project}/snapshots/{snap}.

DeleteSubscriptionRequest

Request for the DeleteSubscription method.

Fields
subscription

string

Required. The subscription to delete. Format is projects/{project}/subscriptions/{sub}.

DeleteTopicRequest

Request for the DeleteTopic method.

Fields
topic

string

Required. Name of the topic to delete. Format is projects/{project}/topics/{topic}.

DetachSubscriptionRequest

Request for the DetachSubscription method.

Fields
subscription

string

Required. The subscription to detach. Format is projects/{project}/subscriptions/{subscription}.

DetachSubscriptionResponse

This type has no fields.

Response for the DetachSubscription method. Reserved for future use.

Encoding

Possible encoding types for messages.

Enums
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.

ExpirationPolicy

A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).

Fields
ttl

Duration

Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

GetSchemaRequest

Request for the GetSchema method.

Fields
name

string

Required. The name of the schema to get. Format is projects/{project}/schemas/{schema}.
view

SchemaView

The set of fields to return in the response. If not set, returns a Schema with all fields filled out. Set to BASIC to omit the definition.

GetSnapshotRequest

Request for the GetSnapshot method.

Fields
snapshot

string

Required. The name of the snapshot to get. Format is projects/{project}/snapshots/{snap}.

GetSubscriptionRequest

Request for the GetSubscription method.

Fields
subscription

string

Required. The name of the subscription to get. Format is projects/{project}/subscriptions/{sub}.

GetTopicRequest

Request for the GetTopic method.

Fields
topic

string

Required. The name of the topic to get. Format is projects/{project}/topics/{topic}.

IngestionDataSourceSettings

Settings for an ingestion data source on a topic.

Fields
Union field source. Only one source type can have settings set. source can be only one of the following:
aws_kinesis

AwsKinesis

Optional. Amazon Kinesis Data Streams.

AwsKinesis

Ingestion settings for Amazon Kinesis Data Streams.

Fields
state

State

Output only. An output-only field that indicates the state of the Kinesis ingestion source.
stream_arn

string

Required. The Kinesis stream ARN to ingest data from.
consumer_arn

string

Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.
aws_role_arn

string

Required. AWS role ARN to be used for Federated Identity authentication with Kinesis. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.
gcp_service_account

string

Required. The GCP service account to be used for Federated Identity authentication with Kinesis (via a AssumeRoleWithWebIdentity call for the provided role). The aws_role_arn must be set up with accounts.google.com:sub equals to this service account number.

State

Possible states for ingestion from Amazon Kinesis Data Streams.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
ACTIVE Ingestion is active.
KINESIS_PERMISSION_DENIED Permission denied encountered while consuming data from Kinesis. This can happen if: - The provided aws_role_arn does not exist or does not have the appropriate permissions attached. - The provided aws_role_arn is not set up properly for Identity Federation using gcp_service_account. - The Pub/Sub SA is not granted the iam.serviceAccounts.getOpenIdToken permission on gcp_service_account.
PUBLISH_PERMISSION_DENIED Permission denied encountered while publishing to the topic. This can happen if the Pub/Sub SA has not been granted the appropriate publish permissions
STREAM_NOT_FOUND The Kinesis stream does not exist.
CONSUMER_NOT_FOUND The Kinesis consumer does not exist.

ListSchemaRevisionsRequest

Request for the ListSchemaRevisions method.

Fields
name

string

Required. The name of the schema to list revisions for.
view

SchemaView

The set of Schema fields to return in the response. If not set, returns Schemas with name and type, but not definition. Set to FULL to retrieve all fields.
page_size

int32

The maximum number of revisions to return per page.
page_token

string

The page token, received from a previous ListSchemaRevisions call. Provide this to retrieve the subsequent page.

ListSchemaRevisionsResponse

Response for the ListSchemaRevisions method.

Fields
schemas[]

Schema

The revisions of the schema.
next_page_token

string

A token that can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

ListSchemasRequest

Request for the ListSchemas method.

Fields
parent

string

Required. The name of the project in which to list schemas. Format is projects/{project-id}.
view

SchemaView

The set of Schema fields to return in the response. If not set, returns Schemas with name and type, but not definition. Set to FULL to retrieve all fields.
page_size

int32

Maximum number of schemas to return.
page_token

string

The value returned by the last ListSchemasResponse; indicates that this is a continuation of a prior ListSchemas call, and that the system should return the next page of data.

ListSchemasResponse

Response for the ListSchemas method.

Fields
schemas[]

Schema

The resulting schemas.
next_page_token

string

If not empty, indicates that there may be more schemas that match the request; this value should be passed in a new ListSchemasRequest.

ListSnapshotsRequest

Request for the ListSnapshots method.

Fields
project

string

Required. The name of the project in which to list snapshots. Format is projects/{project-id}.
page_size

int32

Optional. Maximum number of snapshots to return.
page_token

string

Optional. The value returned by the last ListSnapshotsResponse; indicates that this is a continuation of a prior ListSnapshots call, and that the system should return the next page of data.

ListSnapshotsResponse

Response for the ListSnapshots method.

Fields
snapshots[]

Snapshot

Optional. The resulting snapshots.
next_page_token

string

Optional. If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new ListSnapshotsRequest.

ListSubscriptionsRequest

Request for the ListSubscriptions method.

Fields
project

string

Required. The name of the project in which to list subscriptions. Format is projects/{project-id}.
page_size

int32

Optional. Maximum number of subscriptions to return.
page_token

string

Optional. The value returned by the last ListSubscriptionsResponse; indicates that this is a continuation of a prior ListSubscriptions call, and that the system should return the next page of data.

ListSubscriptionsResponse

Response for the ListSubscriptions method.

Fields
subscriptions[]

Subscription

Optional. The subscriptions that match the request.
next_page_token

string

Optional. 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.

ListTopicSnapshotsRequest

Request for the ListTopicSnapshots method.

Fields
topic

string

Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}.
page_size

int32

Optional. Maximum number of snapshot names to return.
page_token

string

Optional. The value returned by the last ListTopicSnapshotsResponse; indicates that this is a continuation of a prior ListTopicSnapshots call, and that the system should return the next page of data.

ListTopicSnapshotsResponse

Response for the ListTopicSnapshots method.

Fields
snapshots[]

string

Optional. The names of the snapshots that match the request.
next_page_token

string

Optional. If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new ListTopicSnapshotsRequest to get more snapshots.

ListTopicSubscriptionsRequest

Request for the ListTopicSubscriptions method.

Fields
topic

string

Required. The name of the topic that subscriptions are attached to. Format is projects/{project}/topics/{topic}.
page_size

int32

Optional. Maximum number of subscription names to return.
page_token

string

Optional. The value returned by the last ListTopicSubscriptionsResponse; indicates that this is a continuation of a prior ListTopicSubscriptions call, and that the system should return the next page of data.

ListTopicSubscriptionsResponse

Response for the ListTopicSubscriptions method.

Fields
subscriptions[]

string

Optional. The names of subscriptions attached to the topic specified in the request.
next_page_token

string

Optional. If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListTopicSubscriptionsRequest to get more subscriptions.

ListTopicsRequest

Request for the ListTopics method.

Fields
project

string

Required. The name of the project in which to list topics. Format is projects/{project-id}.
page_size

int32

Optional. Maximum number of topics to return.
page_token

string

Optional. The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior ListTopics call, and that the system should return the next page of data.

ListTopicsResponse

Response for the ListTopics method.

Fields
topics[]

Topic

Optional. The resulting topics.
next_page_token

string

Optional. If not empty, indicates that there may be more topics that match the request; this value should be passed in a new ListTopicsRequest.

MessageStoragePolicy

A policy constraining the storage of messages published to the topic.

Fields
allowed_persistence_regions[]

string

Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
enforce_in_transit

bool

Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.

ModifyAckDeadlineRequest

Request for the ModifyAckDeadline method.

Fields
subscription

string

Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.
ack_ids[]

string

Required. List of acknowledgment IDs.
ack_deadline_seconds

int32

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 ModifyAckDeadline call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify in a single request is 600 seconds (10 minutes).

ModifyPushConfigRequest

Request for the ModifyPushConfig method.

Fields
subscription

string

Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.
push_config

PushConfig

Required. The push configuration for future deliveries.

An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull or StreamingPull is not called.

PublishRequest

Request for the Publish method.

Fields
topic

string

Required. The messages in the request will be published on this topic. Format is projects/{project}/topics/{topic}.
messages[]

PubsubMessage

Required. The messages to publish.

PublishResponse

Response for the Publish method.

Fields
message_ids[]

string

Optional. 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
data

bytes

Optional. The message data field. If this field is empty, the message must contain at least one attribute.
attributes

map<string, string>

Optional. 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.
message_id

string

ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by the publisher in a Publish call.
publish_time

Timestamp

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.
ordering_key

string

Optional. If non-empty, identifies related messages for which publish order should be respected. If a Subscription has enable_message_ordering set to true, messages published with the same non-empty ordering_key value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All PubsubMessages published in a given PublishRequest must specify the same ordering_key value. For more information, see ordering messages.

PullRequest

Request for the Pull method.

Fields
subscription

string

Required. The subscription from which messages should be pulled. Format is projects/{project}/subscriptions/{sub}.
return_immediately
(deprecated)

bool

Optional. If this field set to true, the system will respond immediately even if it there are no messages available to return in the Pull response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages. Warning: setting this field to true is discouraged because it adversely impacts the performance of Pull operations. We recommend that users do not set this field.
max_messages

int32

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.

PullResponse

Response for the Pull method.

Fields
received_messages[]

ReceivedMessage

Optional. Received Pub/Sub messages. The list will be empty if there are no more messages available in the backlog, or if no messages could be returned before the request timeout. For JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the maxMessages requested even if there are more messages available in the backlog.

PushConfig

Configuration for a push delivery endpoint.

Fields
push_endpoint

string

Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
attributes

map<string, string>

Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery.

The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata).

If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the x-goog-version 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.

For example: attributes { "x-goog-version": "v1" }
Union field authentication_method. An authentication method used by push endpoints to verify the source of push requests. This can be used with push endpoints that are private by default to allow requests only from the Pub/Sub system, for example. This field is optional and should be set only by users interested in authenticated push. authentication_method can be only one of the following:
oidc_token

OidcToken

Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
Union field wrapper. The format of the delivered message to the push endpoint is defined by the chosen wrapper. When unset, PubsubWrapper is used. wrapper can be only one of the following:
pubsub_wrapper

PubsubWrapper

Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
no_wrapper

NoWrapper

Optional. When set, the payload to the push endpoint is not wrapped.

NoWrapper

Sets the data field as the HTTP body for delivery.

Fields
write_metadata

bool

Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-<KEY>:<VAL> headers of the HTTP request. Writes the Pub/Sub message attributes to <KEY>:<VAL> headers of the HTTP request.

OidcToken

Contains information needed for generating an OpenID Connect token.

Fields
service_account_email

string

Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
audience

string

Optional. 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.

PubsubWrapper

This type has no fields.

The payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

ReceivedMessage

A message and its corresponding acknowledgment ID.

Fields
ack_id

string

Optional. This ID can be used to acknowledge the received message.
message

PubsubMessage

Optional. The message.
delivery_attempt

int32

Optional. The approximate number of times that 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, delivery_attempt will have a value of 1. The value is calculated at best effort and is approximate.

If a DeadLetterPolicy is not set on the subscription, this will be 0.

RetryPolicy

A policy that specifies how 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
minimum_backoff

Duration

Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
maximum_backoff

Duration

Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.

RollbackSchemaRequest

Request for the RollbackSchema method.

Fields
name

string

Required. The schema being rolled back with revision id.
revision_id

string

Required. The revision ID to roll back to. It must be a revision of the same schema.

Example: c7cfa2a8

Schema

A schema resource.

Fields
name

string

Required. Name of the schema. Format is projects/{project}/schemas/{schema}.
type

Type

The type of the schema definition.
definition

string

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 type.
revision_id

string

Output only. Immutable. The revision ID of the schema.
revision_create_time

Timestamp

Output only. The timestamp that the revision was created.

Type

Possible schema definition types.

Enums
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
schema

string

Required. The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
encoding

Encoding

Optional. The encoding of messages validated against schema.
first_revision_id

string

Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
last_revision_id

string

Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.

SchemaView

View of Schema object fields to be returned by GetSchema and ListSchemas.

Enums
SCHEMA_VIEW_UNSPECIFIED The default / unset value. The API will default to the BASIC view.
BASIC Include the name and type of the schema, but not the definition.
FULL Include all Schema object fields.

SeekRequest

Request for the Seek method.

Fields
subscription

string

Required. The subscription to affect.

Union field target.

target can be only one of the following:
time

Timestamp

Optional. 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 message_retention_duration and retain_acked_messages). For example, if time corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored.
snapshot

string

Optional. The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is projects/{project}/snapshots/{snap}.

SeekResponse

This type has no fields.

Response for the Seek method (this response is empty).

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
name

string

Optional. The name of the snapshot.
topic

string

Optional. The name of the topic from which this snapshot is retaining messages.
expire_time

Timestamp

Optional. 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 7 days - (age of oldest unacked message in the subscription). For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.
labels

map<string, string>

Optional. See Creating and managing labels.

StreamingPullRequest

Request for the StreamingPull streaming RPC method. This request is used to establish the initial stream as well as to stream acknowledgements and ack deadline modifications from the client to the server.

Fields
subscription

string

Required. The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server. Format is projects/{project}/subscriptions/{sub}.
ack_ids[]

string

Optional. List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream). If an ack ID has expired, the corresponding message may be redelivered later. Acknowledging a message more than once will not result in an error. If the acknowledgement ID is malformed, the stream will be aborted with status INVALID_ARGUMENT.
modify_deadline_seconds[]

int32

Optional. The list of new ack deadlines for the IDs listed in modify_deadline_ack_ids. The size of this list must be the same as the size of modify_deadline_ack_ids. If it differs the stream will be aborted with INVALID_ARGUMENT. Each element in this list is applied to the element in the same position in modify_deadline_ack_ids. The new ack deadline is 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 this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with status INVALID_ARGUMENT.
modify_deadline_ack_ids[]

string

Optional. List of acknowledgement IDs whose deadline will be modified based on the corresponding element in modify_deadline_seconds. This field can be used 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.
stream_ack_deadline_seconds

int32

Required. The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
client_id

string

Optional. A unique identifier that is used to distinguish client instances from each other. Only needs to be provided on the initial request. When a stream disconnects and reconnects for the same stream, the client_id should be set to the same value so that state associated with the old stream can be transferred to the new stream. The same client_id should not be used for different client instances.
max_outstanding_messages

int64

Optional. Flow control settings for the maximum number of outstanding messages. When there are max_outstanding_messages currently sent to the streaming pull client that have not yet been acked or nacked, the server stops sending more messages. The sending of messages resumes once the number of outstanding messages is less than this value. If the value is <= 0, there is no limit to the number of outstanding messages. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with status INVALID_ARGUMENT.
max_outstanding_bytes

int64

Optional. Flow control settings for the maximum number of outstanding bytes. When there are max_outstanding_bytes or more worth of messages currently sent to the streaming pull client that have not yet been acked or nacked, the server will stop sending more messages. The sending of messages resumes once the number of outstanding bytes is less than this value. If the value is <= 0, there is no limit to the number of outstanding bytes. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with status INVALID_ARGUMENT.

StreamingPullResponse

Response for the StreamingPull method. This response is used to stream messages from the server to the client.

Fields
received_messages[]

ReceivedMessage

Optional. Received Pub/Sub messages. This will not be empty.
acknowledge_confirmation

AcknowledgeConfirmation

Optional. This field will only be set if enable_exactly_once_delivery is set to true.
modify_ack_deadline_confirmation

ModifyAckDeadlineConfirmation

Optional. This field will only be set if enable_exactly_once_delivery is set to true.
subscription_properties

SubscriptionProperties

Optional. Properties associated with this subscription.

AcknowledgeConfirmation

Acknowledgement IDs sent in one or more previous requests to acknowledge a previously received message.

Fields
ack_ids[]

string

Optional. Successfully processed acknowledgement IDs.
invalid_ack_ids[]

string

Optional. List of acknowledgement IDs that were malformed or whose acknowledgement deadline has expired.
unordered_ack_ids[]

string

Optional. List of acknowledgement IDs that were out of order.
temporary_failed_ack_ids[]

string

Optional. List of acknowledgement IDs that failed processing with temporary issues.

ModifyAckDeadlineConfirmation

Acknowledgement IDs sent in one or more previous requests to modify the deadline for a specific message.

Fields
ack_ids[]

string

Optional. Successfully processed acknowledgement IDs.
invalid_ack_ids[]

string

Optional. List of acknowledgement IDs that were malformed or whose acknowledgement deadline has expired.
temporary_failed_ack_ids[]

string

Optional. List of acknowledgement IDs that failed processing with temporary issues.

SubscriptionProperties

Subscription properties sent as part of the response.

Fields
exactly_once_delivery_enabled

bool

Optional. True iff exactly once delivery is enabled for this subscription.
message_ordering_enabled

bool

Optional. True iff message ordering is enabled for this subscription.

Subscription

A subscription resource. If none of push_config, bigquery_config, or cloud_storage_config is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.

Fields
name

string

Required. Name of the subscription. Format is projects/{project}/subscriptions/{sub}.
topic

string

Required. The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.
push_config

PushConfig

Optional. If push delivery is used with this subscription, this field is used to configure it.
bigquery_config

BigQueryConfig

Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
cloud_storage_config

CloudStorageConfig

Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
ack_deadline_seconds

int32

Optional. 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 ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used.

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.
retain_acked_messages

bool

Optional. 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 message_retention_duration window. This must be true if you would like to Seek to a timestamp in the past to replay previously-acknowledged messages.
message_retention_duration

Duration

Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If retain_acked_messages is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes.
labels

map<string, string>

Optional. See Creating and managing labels.
enable_message_ordering

bool

Optional. If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.
expiration_policy

ExpirationPolicy

Optional. 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 expiration_policy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day. If expiration_policy is set, but expiration_policy.ttl is not set, the subscription never expires.
filter

string

Optional. An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
dead_letter_policy

DeadLetterPolicy

Optional. 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 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.
retry_policy

RetryPolicy

Optional. 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.
detached

bool

Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
enable_exactly_once_delivery

bool

Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of message_id on this subscription:

  • The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.
  • An acknowledged message will not be resent to a subscriber.

Note that subscribers may still receive multiple copies of a message when enable_exactly_once_delivery is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct message_id values.
topic_message_retention_duration

Duration

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 topic_message_retention_duration are always available to subscribers. See the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.
state

State

Output only. An output-only field indicating whether or not the subscription can receive messages.
analytics_hub_subscription_info

AnalyticsHubSubscriptionInfo

Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub.

AnalyticsHubSubscriptionInfo

Information about an associated Analytics Hub subscription (https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions).

Fields
listing

string

Optional. The name of the associated Analytics Hub listing resource. Pattern: "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}"
subscription

string

Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project}/locations/{location}/subscriptions/{subscription}"

State

Possible states for a subscription.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
ACTIVE The subscription can actively receive messages
RESOURCE_ERROR The subscription cannot receive messages because of an error with the resource to which it pushes messages. See the more detailed error state in the corresponding configuration.

Topic

A topic resource.

Fields
name

string

Required. Name of the topic. Format is projects/{project}/topics/{topic}.
labels

map<string, string>

Optional. See Creating and managing labels.
message_storage_policy

MessageStoragePolicy

Optional. 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.
kms_key_name

string

Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.

The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
schema_settings

SchemaSettings

Optional. Settings for validating messages published against a schema.
satisfies_pzs

bool

Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
message_retention_duration

Duration

Optional. 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 message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
state

State

Output only. An output-only field indicating the state of the topic.
ingestion_data_source_settings

IngestionDataSourceSettings

Optional. Settings for ingestion from a data source into this topic.

State

The state of the topic.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
ACTIVE The topic does not have any persistent errors.
INGESTION_RESOURCE_ERROR Ingestion from the data source has encountered a permanent error. See the more detailed error state in the corresponding ingestion source configuration.

UpdateSnapshotRequest

Request for the UpdateSnapshot method.

Fields
snapshot

Snapshot

Required. The updated snapshot object.
update_mask

FieldMask

Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.

UpdateSubscriptionRequest

Request for the UpdateSubscription method.

Fields
subscription

Subscription

Required. The updated subscription object.
update_mask

FieldMask

Required. Indicates which fields in the provided subscription to update. Must be specified and non-empty.

UpdateTopicRequest

Request for the UpdateTopic method.

Fields
topic

Topic

Required. The updated topic object.
update_mask

FieldMask

Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if update_mask contains "message_storage_policy" but the message_storage_policy is not set in the topic provided above, then the updated value is determined by the policy configured at the project or organization level.

ValidateMessageRequest

Request for the ValidateMessage method.

Fields
parent

string

Required. The name of the project in which to validate schemas. Format is projects/{project-id}.
message

bytes

Message to validate against the provided schema_spec.
encoding

Encoding

The encoding expected for messages

Union field schema_spec.

schema_spec can be only one of the following:
name

string

Name of the schema against which to validate.

Format is projects/{project}/schemas/{schema}.
schema

Schema

Ad-hoc schema against which to validate

ValidateMessageResponse

This type has no fields.

Response for the ValidateMessage method. Empty for now.

ValidateSchemaRequest

Request for the ValidateSchema method.

Fields
parent

string

Required. The name of the project in which to validate schemas. Format is projects/{project-id}.
schema

Schema

Required. The schema object to validate.

ValidateSchemaResponse

This type has no fields.

Response for the ValidateSchema method. Empty for now.