pubsub library

Classes

AvroConfig
Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.
AvroConfigResponse
Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.
BigQueryConfig
Configuration for a BigQuery subscription.
BigQueryConfigResponse
Configuration for a BigQuery subscription.
Binding
Associates members, or principals, with a role.
BindingPubsubV1beta2
Associates members, or principals, with a role.
BindingResponse
Associates members, or principals, with a role.
BindingResponsePubsubV1beta2
Associates members, or principals, with a role.
CloudStorageConfig
Configuration for a Cloud Storage subscription.
CloudStorageConfigResponse
Configuration for a Cloud Storage subscription.
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.
DeadLetterPolicyResponse
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.
ExpirationPolicy
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
ExpirationPolicyResponse
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExprPubsubV1beta2
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExprResponse
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExprResponsePubsubV1beta2
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
GetSchemaArgs
Arguments for getSchema. Arguments for getSchema.
GetSchemaIamPolicyArgs
Arguments for getSchemaIamPolicy. Arguments for getSchemaIamPolicy.
GetSchemaIamPolicyResult
Result data returned by getSchemaIamPolicy.
GetSchemaResult
Result data returned by getSchema.
GetSnapshotArgs
Arguments for getSnapshot. Arguments for getSnapshot.
GetSnapshotIamPolicyArgs
Arguments for getSnapshotIamPolicy. Arguments for getSnapshotIamPolicy.
GetSnapshotIamPolicyResult
Result data returned by getSnapshotIamPolicy.
GetSnapshotResult
Result data returned by getSnapshot.
GetSubscriptionArgs
Arguments for getSubscription. Arguments for getSubscription.
GetSubscriptionIamPolicyArgs
Arguments for getSubscriptionIamPolicy. Arguments for getSubscriptionIamPolicy.
GetSubscriptionIamPolicyPubsubV1beta2Args
Arguments for getSubscriptionIamPolicy. Arguments for getSubscriptionIamPolicy.
GetSubscriptionIamPolicyPubsubV1beta2Result
Result data returned by getSubscriptionIamPolicy.
GetSubscriptionIamPolicyResult
Result data returned by getSubscriptionIamPolicy.
GetSubscriptionPubsubV1beta1aArgs
Arguments for getSubscription. Arguments for getSubscription.
GetSubscriptionPubsubV1beta1aResult
Result data returned by getSubscription.
GetSubscriptionPubsubV1beta2Args
Arguments for getSubscription. Arguments for getSubscription.
GetSubscriptionPubsubV1beta2Result
Result data returned by getSubscription.
GetSubscriptionResult
Result data returned by getSubscription.
GetTopicArgs
Arguments for getTopic. Arguments for getTopic.
GetTopicIamPolicyArgs
Arguments for getTopicIamPolicy. Arguments for getTopicIamPolicy.
GetTopicIamPolicyPubsubV1beta2Args
Arguments for getTopicIamPolicy. Arguments for getTopicIamPolicy.
GetTopicIamPolicyPubsubV1beta2Result
Result data returned by getTopicIamPolicy.
GetTopicIamPolicyResult
Result data returned by getTopicIamPolicy.
GetTopicPubsubV1beta1aArgs
Arguments for getTopic. Arguments for getTopic.
GetTopicPubsubV1beta1aResult
Result data returned by getTopic.
GetTopicPubsubV1beta2Args
Arguments for getTopic. Arguments for getTopic.
GetTopicPubsubV1beta2Result
Result data returned by getTopic.
GetTopicResult
Result data returned by getTopic.
MessageStoragePolicy
A policy constraining the storage of messages published to the topic.
MessageStoragePolicyResponse
A policy constraining the storage of messages published to the topic.
NoWrapper
Sets the data field as the HTTP body for delivery.
NoWrapperResponse
Sets the data field as the HTTP body for delivery.
OidcToken
Contains information needed for generating an OpenID Connect token.
OidcTokenPubsubV1beta2
Contains information needed for generating an OpenID Connect token.
OidcTokenResponse
Contains information needed for generating an OpenID Connect token.
OidcTokenResponsePubsubV1beta2
Contains information needed for generating an OpenID Connect token.
PushConfig
Configuration for a push delivery endpoint.
PushConfigPubsubV1beta1a
Configuration for a push delivery endpoint.
PushConfigPubsubV1beta2
Configuration for a push delivery endpoint.
PushConfigResponse
Configuration for a push delivery endpoint.
PushConfigResponsePubsubV1beta1a
Configuration for a push delivery endpoint.
PushConfigResponsePubsubV1beta2
Configuration for a push delivery endpoint.
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.
RetryPolicyResponse
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.
Schema
Creates a schema.
SchemaArgs
The set of arguments for Schema. The set of arguments for Schema.
SchemaIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
SchemaIamBindingArgs
The set of arguments for SchemaIamBinding. The set of arguments for SchemaIamBinding.
SchemaIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
SchemaIamMemberArgs
The set of arguments for SchemaIamMember. The set of arguments for SchemaIamMember.
SchemaIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
SchemaIamPolicyArgs
The set of arguments for SchemaIamPolicy. The set of arguments for SchemaIamPolicy.
SchemaSettings
Settings for validating messages published against a schema.
SchemaSettingsResponse
Settings for validating messages published against a schema.
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 (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request. Auto-naming is currently not supported for this resource.
SnapshotArgs
The set of arguments for Snapshot. The set of arguments for Snapshot.
SnapshotIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
SnapshotIamBindingArgs
The set of arguments for SnapshotIamBinding. The set of arguments for SnapshotIamBinding.
SnapshotIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
SnapshotIamMemberArgs
The set of arguments for SnapshotIamMember. The set of arguments for SnapshotIamMember.
SnapshotIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
SnapshotIamPolicyArgs
The set of arguments for SnapshotIamPolicy. The set of arguments for SnapshotIamPolicy.
Subscription
Creates a subscription to a given topic. See the resource name rules (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). 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 (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
SubscriptionArgs
The set of arguments for Subscription. The set of arguments for Subscription.
SubscriptionIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
SubscriptionIamBindingArgs
The set of arguments for SubscriptionIamBinding. The set of arguments for SubscriptionIamBinding.
SubscriptionIamBindingPubsubV1beta2
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
SubscriptionIamBindingPubsubV1beta2Args
The set of arguments for SubscriptionIamBinding. The set of arguments for SubscriptionIamBinding.
SubscriptionIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
SubscriptionIamMemberArgs
The set of arguments for SubscriptionIamMember. The set of arguments for SubscriptionIamMember.
SubscriptionIamMemberPubsubV1beta2
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
SubscriptionIamMemberPubsubV1beta2Args
The set of arguments for SubscriptionIamMember. The set of arguments for SubscriptionIamMember.
SubscriptionIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
SubscriptionIamPolicyArgs
The set of arguments for SubscriptionIamPolicy. The set of arguments for SubscriptionIamPolicy.
SubscriptionIamPolicyPubsubV1beta2
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
SubscriptionIamPolicyPubsubV1beta2Args
The set of arguments for SubscriptionIamPolicy. The set of arguments for SubscriptionIamPolicy.
SubscriptionPubsubV1beta1a
Creates a subscription on a given topic for a given subscriber. 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.
SubscriptionPubsubV1beta1aArgs
The set of arguments for Subscription. The set of arguments for Subscription.
SubscriptionPubsubV1beta2
Creates a subscription to a given topic. 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. Note that for REST API requests, you must specify a name.
SubscriptionPubsubV1beta2Args
The set of arguments for Subscription. The set of arguments for Subscription.
Topic
Creates the given topic with the given name. See the resource name rules (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
TopicArgs
The set of arguments for Topic. The set of arguments for Topic.
TopicIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
TopicIamBindingArgs
The set of arguments for TopicIamBinding. The set of arguments for TopicIamBinding.
TopicIamBindingPubsubV1beta2
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
TopicIamBindingPubsubV1beta2Args
The set of arguments for TopicIamBinding. The set of arguments for TopicIamBinding.
TopicIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
TopicIamMemberArgs
The set of arguments for TopicIamMember. The set of arguments for TopicIamMember.
TopicIamMemberPubsubV1beta2
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
TopicIamMemberPubsubV1beta2Args
The set of arguments for TopicIamMember. The set of arguments for TopicIamMember.
TopicIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
TopicIamPolicyArgs
The set of arguments for TopicIamPolicy. The set of arguments for TopicIamPolicy.
TopicIamPolicyPubsubV1beta2
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
TopicIamPolicyPubsubV1beta2Args
The set of arguments for TopicIamPolicy. The set of arguments for TopicIamPolicy.
TopicPubsubV1beta1a
Creates the given topic with the given name.
TopicPubsubV1beta1aArgs
The set of arguments for Topic. The set of arguments for Topic.
TopicPubsubV1beta2
Creates the given topic with the given name.
TopicPubsubV1beta2Args
The set of arguments for Topic. The set of arguments for Topic.

Enums

SchemaSettingsEncoding
Optional. The encoding of messages validated against schema.
SchemaType
The type of the schema definition.

Functions

getSchema(GetSchemaArgs args, {InvokeOptions? options}) → Future<GetSchemaResult>
Gets a schema. args Arguments passed to this invoke. Arguments for getSchema. options Invoke options controlling this call.
getSchemaIamPolicy(GetSchemaIamPolicyArgs args, {InvokeOptions? options}) → Future<GetSchemaIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getSchemaIamPolicy. options Invoke options controlling this call.
getSnapshot(GetSnapshotArgs args, {InvokeOptions? options}) → Future<GetSnapshotResult>
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. args Arguments passed to this invoke. Arguments for getSnapshot. options Invoke options controlling this call.
getSnapshotIamPolicy(GetSnapshotIamPolicyArgs args, {InvokeOptions? options}) → Future<GetSnapshotIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getSnapshotIamPolicy. options Invoke options controlling this call.
getSubscription(GetSubscriptionArgs args, {InvokeOptions? options}) → Future<GetSubscriptionResult>
Gets the configuration details of a subscription. args Arguments passed to this invoke. Arguments for getSubscription. options Invoke options controlling this call.
getSubscriptionIamPolicy(GetSubscriptionIamPolicyArgs args, {InvokeOptions? options}) → Future<GetSubscriptionIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getSubscriptionIamPolicy. options Invoke options controlling this call.
getSubscriptionIamPolicyPubsubV1beta2(GetSubscriptionIamPolicyPubsubV1beta2Args args, {InvokeOptions? options}) → Future<GetSubscriptionIamPolicyPubsubV1beta2Result>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getSubscriptionIamPolicy. options Invoke options controlling this call.
getSubscriptionPubsubV1beta1a(GetSubscriptionPubsubV1beta1aArgs args, {InvokeOptions? options}) → Future<GetSubscriptionPubsubV1beta1aResult>
Gets the configuration details of a subscription. args Arguments passed to this invoke. Arguments for getSubscription. options Invoke options controlling this call.
getSubscriptionPubsubV1beta2(GetSubscriptionPubsubV1beta2Args args, {InvokeOptions? options}) → Future<GetSubscriptionPubsubV1beta2Result>
Gets the configuration details of a subscription. args Arguments passed to this invoke. Arguments for getSubscription. options Invoke options controlling this call.
getTopic(GetTopicArgs args, {InvokeOptions? options}) → Future<GetTopicResult>
Gets the configuration of a topic. args Arguments passed to this invoke. Arguments for getTopic. options Invoke options controlling this call.
getTopicIamPolicy(GetTopicIamPolicyArgs args, {InvokeOptions? options}) → Future<GetTopicIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getTopicIamPolicy. options Invoke options controlling this call.
getTopicIamPolicyPubsubV1beta2(GetTopicIamPolicyPubsubV1beta2Args args, {InvokeOptions? options}) → Future<GetTopicIamPolicyPubsubV1beta2Result>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getTopicIamPolicy. options Invoke options controlling this call.
getTopicPubsubV1beta1a(GetTopicPubsubV1beta1aArgs args, {InvokeOptions? options}) → Future<GetTopicPubsubV1beta1aResult>
Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here. args Arguments passed to this invoke. Arguments for getTopic. options Invoke options controlling this call.
getTopicPubsubV1beta2(GetTopicPubsubV1beta2Args args, {InvokeOptions? options}) → Future<GetTopicPubsubV1beta2Result>
Gets the configuration of a topic. args Arguments passed to this invoke. Arguments for getTopic. options Invoke options controlling this call.