rpc CreateTopic(Topic) returns (Topic)

Creates the given topic with the given name. See theresource 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 theAuthentication Overview.

rpc DeleteTopic(DeleteTopicRequest) returns (Empty)

Deletes the topic with the given name. ReturnsNOT_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 theirtopic 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 theAuthentication Overview.

rpc DetachSubscription(DetachSubscriptionRequest) returns (DetachSubscriptionResponse)

Detaches a subscription from this topic. All messages retained in the subscription are dropped. SubsequentPull andStreamingPull 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 theAuthentication Overview.

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 theAuthentication Overview.

rpc ListTopicSnapshots(ListTopicSnapshotsRequest) returns (ListTopicSnapshotsResponse)

Lists the names of the snapshots on this topic. Snapshots are used inSeek 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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

rpc Publish(PublishRequest) returns (PublishResponse)

Adds one or more messages to the topic. ReturnsNOT_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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

rpc Acknowledge(AcknowledgeRequest) returns (Empty)

Acknowledges the messages associated with theack_ids in theAcknowledgeRequest. 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 theAuthentication Overview.

rpc CreateSnapshot(CreateSnapshotRequest) returns (Snapshot)

Creates a snapshot from the requested subscription. Snapshots are used inSeek 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, returnsALREADY_EXISTS. If the requested subscription doesn't exist, returnsNOT_FOUND. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- thenFAILED_PRECONDITION is returned. See also theSnapshot.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 theresource 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 theAuthentication Overview.

rpc CreateSubscription(Subscription) returns (Subscription)

Creates a subscription to a given topic. See theresource name rules. If the subscription already exists, returnsALREADY_EXISTS. If the corresponding topic doesn't exist, returnsNOT_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 theresource 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 theAuthentication Overview.

rpc DeleteSnapshot(DeleteSnapshotRequest) returns (Empty)

Removes an existing snapshot. Snapshots are used inSeek 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 theAuthentication Overview.

rpc DeleteSubscription(DeleteSubscriptionRequest) returns (Empty)

Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls toPull after deletion will returnNOT_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 theAuthentication Overview.

rpc GetSnapshot(GetSnapshotRequest) returns (Snapshot)

Gets the configuration details of a snapshot. Snapshots are used inSeek 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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 theAuthentication Overview.

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-levelackDeadlineSeconds 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 theAuthentication Overview.

rpc ModifyPushConfig(ModifyPushConfigRequest) returns (Empty)

Modifies thePushConfig for a specified subscription.

This may be used to change a push subscription to a pull one (signified by an emptyPushConfig) 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 thePushConfig.

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 theAuthentication Overview.

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 theAuthentication Overview.

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 inSeek 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 theAuthentication Overview.

rpc StreamingPull(StreamingPullRequest) returns (StreamingPullResponse)

Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgments 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 statusUNAVAILABLE 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 theAuthentication Overview.

rpc UpdateSnapshot(UpdateSnapshotRequest) returns (Snapshot)

Updates an existing snapshot by updating the fields specified in the update mask. Snapshots are used inSeek 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 theAuthentication Overview.

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 theAuthentication Overview.

string

Required. The subscription whose message is being acknowledged. Format isprojects/{project}/subscriptions/{sub}.

string

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

string

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

bool

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

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.

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

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

bool

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

string

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

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 thebucket naming requirements.

string

Optional. User-provided prefix for Cloud Storage filename. See theobject naming requirements.

string

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

string

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

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 acknowledgment deadline.

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.

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

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

string

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

TextConfig

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

AvroConfig

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

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.

bool

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

string

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

Schema

Required. The schema revision to commit.

string

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

Schema

Required. The schema object to create.

This schema'sname parameter is ignored. The schema object returned by CreateSchema will have aname made using the givenparent andschema_id.

string

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

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

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 theresource name rules. Format isprojects/{project}/snapshots/{snap}.

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

map<string, string>

Optional. SeeCreating and managing labels.

string

Optional. The name of the topic to which dead letter messages should be published. Format isprojects/{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.

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

string

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

string

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

Example:projects/123/schemas/my-schema@c7cfa2a8

string

string

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

string

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

string

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

string

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

Duration

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

string

Required. The name of the schema to get. Format isprojects/{project}/schemas/{schema}.

SchemaView

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

string

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

string

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

string

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

PlatformLogsSettings

Optional. Platform Logs settings. If unset, no Platform Logs will be generated.

AwsKinesis

Optional. Amazon Kinesis Data Streams.

CloudStorage

Optional. Cloud Storage.

AzureEventHubs

Optional. Azure Event Hubs.

AwsMsk

Optional. Amazon MSK.

ConfluentCloud

Optional. Confluent Cloud.

State

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

string

Required. The Kinesis stream ARN to ingest data from.

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.

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.

string

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

State

Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.

string

Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.

string

Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.

string

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

string

Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via aAssumeRoleWithWebIdentity call for the provided role). Theaws_role_arn must be set up withaccounts.google.com:sub equals to this service account number.

State

Output only. An output-only field that indicates the state of the Event Hubs ingestion source.

string

Optional. Name of the resource group within the azure subscription.

string

Optional. The name of the Event Hubs namespace.

string

Optional. The name of the Event Hub.

string

Optional. The client id of the Azure application that is being used to authenticate Pub/Sub.

string

Optional. The tenant id of the Azure application that is being used to authenticate Pub/Sub.

string

Optional. The Azure subscription id.

string

Optional. The GCP service account to be used for Federated Identity authentication.

State

Output only. An output-only field that indicates the state of the Cloud Storage ingestion source.

string

Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See thebucket naming requirements.

Timestamp

Optional. Only objects with a larger or equal creation timestamp will be ingested.

string

Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will be ingested. See thesupported patterns.

TextFormat

Optional. Data from Cloud Storage will be interpreted as text.

AvroFormat

Optional. Data from Cloud Storage will be interpreted in Avro format.

PubSubAvroFormat

Optional. It will be assumed data from Cloud Storage was written viaCloud Storage subscriptions.

string

Optional. When unset, '\n' is used.

State

Output only. An output-only field that indicates the state of the Confluent Cloud ingestion source.

string

Required. The address of the bootstrap server. The format is url:port.

string

Required. The id of the cluster.

string

Required. The name of the topic in the Confluent Cloud cluster that Pub/Sub will import from.

string

Required. The id of the identity pool to be used for Federated Identity authentication with Confluent Cloud. Seehttps://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.

string

Required. The GCP service account to be used for Federated Identity authentication withidentity_pool_id.

string

Required. Name of the JavasScript function that should applied to Pub/Sub messages.

string

Required. JavaScript code that contains a functionfunction_name with the below signature:

  /**  * Transforms a Pub/Sub message.  * @return {(Object<string, (string | Object<string, string>)>|null)} - To  * filter a message, return `null`. To transform a message return a map  * with the following keys:  *   - (required) 'data' : {string}  *   - (optional) 'attributes' : {Object<string, string>}  * Returning empty `attributes` will remove all attributes from the  * message.  *  * @param  {(Object<string, (string | Object<string, string>)>} Pub/Sub  * message. Keys:  *   - (required) 'data' : {string}  *   - (required) 'attributes' : {Object<string, string>}  *  * @param  {Object<string, any>} metadata - Pub/Sub message metadata.  * Keys:  *   - (optional) 'message_id'  : {string}  *   - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format  *   - (optional) 'ordering_key': {string}  */  function <function_name>(message, metadata) {  }

string

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

SchemaView

The set of Schema fields to return in the response. If not set, returns Schemas withname andtype, but notdefinition. Set toFULL to retrieve all fields.

int32

The maximum number of revisions to return per page.

string

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

Schema

The revisions of the schema.

string

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

string

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

SchemaView

The set of Schema fields to return in the response. If not set, returns Schemas withname andtype, but notdefinition. Set toFULL to retrieve all fields.

int32

Maximum number of schemas to return.

string

The value returned by the lastListSchemasResponse; indicates that this is a continuation of a priorListSchemas call, and that the system should return the next page of data.

Schema

The resulting schemas.

string

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

string

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

int32

Optional. Maximum number of snapshots to return.

string

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

Snapshot

Optional. The resulting snapshots.

string

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

string

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

int32

Optional. Maximum number of subscriptions to return.

string

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

Subscription

Optional. The subscriptions that match the request.

string

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

string

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

int32

Optional. Maximum number of snapshot names to return.

string

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

string

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

string

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

string

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

int32

Optional. Maximum number of subscription names to return.

string

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

string

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

string

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

string

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

int32

Optional. Maximum number of topics to return.

string

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

Topic

Optional. The resulting topics.

string

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

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.

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

bool

bool

Optional. If true, the transform is disabled and will not be applied to messages. Defaults tofalse.

JavaScriptUDF

Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a uniquefunction_name.

string

Required. The name of the subscription. Format isprojects/{project}/subscriptions/{sub}.

string

Required. List of acknowledgment IDs.

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 theModifyAckDeadline 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).

string

Required. The name of the subscription. Format isprojects/{project}/subscriptions/{sub}.

PushConfig

Required. The push configuration for future deliveries.

An emptypushConfig 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 ifPull orStreamingPull is not called.

Severity

Optional. The minimum severity level of Platform Logs that will be written.

string

Required. The messages in the request will be published on this topic. Format isprojects/{project}/topics/{topic}.

PubsubMessage

Required. The messages to publish.

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.

bytes

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

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.

string

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

Timestamp

The time at which the message was published, populated by the server when it receives thePublish call. It must not be populated by the publisher in aPublish call.

string

Optional. If non-empty, identifies related messages for which publish order should be respected. If aSubscription hasenable_message_ordering set totrue, messages published with the same non-emptyordering_key value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. AllPubsubMessages published in a givenPublishRequest must specify the sameordering_key value. For more information, seeordering messages.

string

Required. The subscription from which messages should be pulled. Format isprojects/{project}/subscriptions/{sub}.

bool

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.

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 themaxMessages requested even if there are more messages available in the backlog.

string

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

map<string, string>

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

The only currently supported attribute isx-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 theCreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfig call, its value will not be changed.GetSubscription calls will always return a valid version, even if the subscription was created without this attribute.

The only supported values for thex-goog-version attribute are:

• v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.
• v1 orv1beta2: uses the push format defined in the v1 Pub/Sub API.

For example:attributes { "x-goog-version": "v1" }

OidcToken

Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as anAuthorization header in the HTTP request for every pushed message.

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

NoWrapper

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

bool

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

string

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

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.

string

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

PubsubMessage

Optional. The message.

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.

Duration

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

Duration

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

string

Required. The schema being rolled back with revision id.

string

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

Example: c7cfa2a8

string

Required. Name of the schema. Format isprojects/{project}/schemas/{schema}.

Type

The type of the schema 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 intype.

string

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

Timestamp

Output only. The timestamp that the revision was created.

string

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

Encoding

Optional. The encoding of messages validated againstschema.

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.

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.

string

Required. The subscription to affect.

Union fieldtarget.

target can be only one of the following:

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 ofmessage_retention_duration andretain_acked_messages). For example, iftime 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.

string

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

string

Optional. The name of the snapshot.

string

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

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

map<string, string>

Optional. SeeCreating and managing labels.

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 isprojects/{project}/subscriptions/{sub}.

string

Optional. List of acknowledgment 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 acknowledgment ID is malformed, the stream will be aborted with statusINVALID_ARGUMENT.

int32

Optional. The list of new ack deadlines for the IDs listed inmodify_deadline_ack_ids. The size of this list must be the same as the size ofmodify_deadline_ack_ids. If it differs the stream will be aborted withINVALID_ARGUMENT. Each element in this list is applied to the element in the same position inmodify_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 statusINVALID_ARGUMENT.

string

Optional. List of acknowledgment IDs whose deadline will be modified based on the corresponding element inmodify_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.

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

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.

int64

Optional. Flow control settings for the maximum number of outstanding messages. When there aremax_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 statusINVALID_ARGUMENT.

int64

Optional. Flow control settings for the maximum number of outstanding bytes. When there aremax_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 statusINVALID_ARGUMENT.

ReceivedMessage

Optional. Received Pub/Sub messages.

AcknowledgeConfirmation

Optional. This field will only be set ifenable_exactly_once_delivery is set totrue and is not guaranteed to be populated.

ModifyAckDeadlineConfirmation

Optional. This field will only be set ifenable_exactly_once_delivery is set totrue and is not guaranteed to be populated.

SubscriptionProperties

Optional. Properties associated with this subscription.

string

Optional. Successfully processed acknowledgment IDs.

string

Optional. List of acknowledgment IDs that were malformed or whose acknowledgment deadline has expired.

string

Optional. List of acknowledgment IDs that were out of order.

string

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

string

Optional. Successfully processed acknowledgment IDs.

string

Optional. List of acknowledgment IDs that were malformed or whose acknowledgment deadline has expired.

string

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

bool

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

bool

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

string

Required. Name of the subscription. Format isprojects/{project}/subscriptions/{sub}.

string

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

PushConfig

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

BigQueryConfig

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

CloudStorageConfig

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

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 beoutstanding. 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, callModifyAckDeadline with the correspondingack_id if using non-streaming pull or send theack_id in aStreamingModifyAckDeadlineRequest 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.

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

Duration

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

map<string, string>

Optional. SeeCreating and managing labels.

bool

Optional. If true, messages published with the sameordering_key inPubsubMessage 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.

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. Ifexpiration_policy is not set, adefault policy withttl of 31 days will be used. The minimum allowed value forexpiration_policy.ttl is 1 day. Ifexpiration_policy is set, butexpiration_policy.ttl is not set, the subscription never expires.

string

Optional. An expression written in the Pub/Subfilter language. If non-empty, then onlyPubsubMessages whoseattributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.

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.

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 acknowledgment deadline exceeded events for a given message.

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 andStreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.

bool

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

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

Note that subscribers may still receive multiple copies of a message whenenable_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 distinctmessage_id values.

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

State

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

AnalyticsHubSubscriptionInfo

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

MessageTransform

Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.

string

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

string

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

string

Required. Name of the topic. Format isprojects/{project}/topics/{topic}.

map<string, string>

Optional. SeeCreating and managing labels.

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.

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 isprojects/*/locations/*/keyRings/*/cryptoKeys/*.

SchemaSettings

Optional. Settings for validating messages published against a schema.

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.

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 lastmessage_retention_duration are always available to subscribers. For instance, it allows any attached subscription toseek to a timestamp that is up tomessage_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

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

IngestionDataSourceSettings

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

MessageTransform

Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.

Snapshot

Required. The updated snapshot object.

FieldMask

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

Subscription

Required. The updated subscription object.

FieldMask

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

Topic

Required. The updated topic object.

FieldMask

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

string

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

bytes

Message to validate against the providedschema_spec.

Encoding

The encoding expected for messages

Union fieldschema_spec.

schema_spec can be only one of the following:

string

Name of the schema against which to validate.

Format isprojects/{project}/schemas/{schema}.

Schema

Ad-hoc schema against which to validate

string

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

Schema

Required. The schema object to validate.