# ega_pub_sub v0.42.0 - Table of Contents

> Google Cloud Pub/Sub API client library - maintained drop-in fork of
google_api_pub_sub (archived upstream). Provides reliable, many-to-many,
asynchronous messaging between applications. Fixes Tesla >= 1.18.3
compatibility via ega_gax.

## Modules

- [GoogleApi.PubSub.V1](GoogleApi.PubSub.V1.md): API client metadata for GoogleApi.PubSub.V1.

- [GoogleApi.PubSub.V1.Api.Projects](GoogleApi.PubSub.V1.Api.Projects.md): API calls for all endpoints tagged `Projects`.

- [GoogleApi.PubSub.V1.Connection](GoogleApi.PubSub.V1.Connection.md): Handle Tesla connections for GoogleApi.PubSub.V1.

- [GoogleApi.PubSub.V1.Model.AcknowledgeRequest](GoogleApi.PubSub.V1.Model.AcknowledgeRequest.md): Request for the Acknowledge method.
- [GoogleApi.PubSub.V1.Model.AnalyticsHubSubscriptionInfo](GoogleApi.PubSub.V1.Model.AnalyticsHubSubscriptionInfo.md): Information about an associated [Analytics Hub subscription](https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions).
- [GoogleApi.PubSub.V1.Model.AvroConfig](GoogleApi.PubSub.V1.Model.AvroConfig.md): Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.
- [GoogleApi.PubSub.V1.Model.AvroFormat](GoogleApi.PubSub.V1.Model.AvroFormat.md): Configuration for reading Cloud Storage data in Avro binary format. The bytes of each object will be set to the `data` field of a Pub/Sub message.
- [GoogleApi.PubSub.V1.Model.AwsKinesis](GoogleApi.PubSub.V1.Model.AwsKinesis.md): Ingestion settings for Amazon Kinesis Data Streams.
- [GoogleApi.PubSub.V1.Model.AwsMsk](GoogleApi.PubSub.V1.Model.AwsMsk.md): Ingestion settings for Amazon MSK.
- [GoogleApi.PubSub.V1.Model.AzureEventHubs](GoogleApi.PubSub.V1.Model.AzureEventHubs.md): Ingestion settings for Azure Event Hubs.
- [GoogleApi.PubSub.V1.Model.BigQueryConfig](GoogleApi.PubSub.V1.Model.BigQueryConfig.md): Configuration for a BigQuery subscription.
- [GoogleApi.PubSub.V1.Model.Binding](GoogleApi.PubSub.V1.Model.Binding.md): Associates `members`, or principals, with a `role`.
- [GoogleApi.PubSub.V1.Model.CloudStorage](GoogleApi.PubSub.V1.Model.CloudStorage.md): Ingestion settings for Cloud Storage.
- [GoogleApi.PubSub.V1.Model.CloudStorageConfig](GoogleApi.PubSub.V1.Model.CloudStorageConfig.md): Configuration for a Cloud Storage subscription.
- [GoogleApi.PubSub.V1.Model.CommitSchemaRequest](GoogleApi.PubSub.V1.Model.CommitSchemaRequest.md): Request for CommitSchema method.
- [GoogleApi.PubSub.V1.Model.ConfluentCloud](GoogleApi.PubSub.V1.Model.ConfluentCloud.md): Ingestion settings for Confluent Cloud.
- [GoogleApi.PubSub.V1.Model.CreateSnapshotRequest](GoogleApi.PubSub.V1.Model.CreateSnapshotRequest.md): Request for the `CreateSnapshot` method.
- [GoogleApi.PubSub.V1.Model.DeadLetterPolicy](GoogleApi.PubSub.V1.Model.DeadLetterPolicy.md): 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.
- [GoogleApi.PubSub.V1.Model.DetachSubscriptionResponse](GoogleApi.PubSub.V1.Model.DetachSubscriptionResponse.md): Response for the DetachSubscription method. Reserved for future use.
- [GoogleApi.PubSub.V1.Model.Empty](GoogleApi.PubSub.V1.Model.Empty.md): A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
- [GoogleApi.PubSub.V1.Model.ExpirationPolicy](GoogleApi.PubSub.V1.Model.ExpirationPolicy.md): A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
- [GoogleApi.PubSub.V1.Model.Expr](GoogleApi.PubSub.V1.Model.Expr.md): 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.
- [GoogleApi.PubSub.V1.Model.IngestionDataSourceSettings](GoogleApi.PubSub.V1.Model.IngestionDataSourceSettings.md): Settings for an ingestion data source on a topic.
- [GoogleApi.PubSub.V1.Model.JavaScriptUDF](GoogleApi.PubSub.V1.Model.JavaScriptUDF.md): User-defined JavaScript function that can transform or filter a Pub/Sub message.
- [GoogleApi.PubSub.V1.Model.ListSchemaRevisionsResponse](GoogleApi.PubSub.V1.Model.ListSchemaRevisionsResponse.md): Response for the `ListSchemaRevisions` method.
- [GoogleApi.PubSub.V1.Model.ListSchemasResponse](GoogleApi.PubSub.V1.Model.ListSchemasResponse.md): Response for the `ListSchemas` method.
- [GoogleApi.PubSub.V1.Model.ListSnapshotsResponse](GoogleApi.PubSub.V1.Model.ListSnapshotsResponse.md): Response for the `ListSnapshots` method.
- [GoogleApi.PubSub.V1.Model.ListSubscriptionsResponse](GoogleApi.PubSub.V1.Model.ListSubscriptionsResponse.md): Response for the `ListSubscriptions` method.
- [GoogleApi.PubSub.V1.Model.ListTopicSnapshotsResponse](GoogleApi.PubSub.V1.Model.ListTopicSnapshotsResponse.md): Response for the `ListTopicSnapshots` method.
- [GoogleApi.PubSub.V1.Model.ListTopicSubscriptionsResponse](GoogleApi.PubSub.V1.Model.ListTopicSubscriptionsResponse.md): Response for the `ListTopicSubscriptions` method.
- [GoogleApi.PubSub.V1.Model.ListTopicsResponse](GoogleApi.PubSub.V1.Model.ListTopicsResponse.md): Response for the `ListTopics` method.
- [GoogleApi.PubSub.V1.Model.MessageStoragePolicy](GoogleApi.PubSub.V1.Model.MessageStoragePolicy.md): A policy constraining the storage of messages published to the topic.
- [GoogleApi.PubSub.V1.Model.MessageTransform](GoogleApi.PubSub.V1.Model.MessageTransform.md): All supported message transforms types.
- [GoogleApi.PubSub.V1.Model.ModifyAckDeadlineRequest](GoogleApi.PubSub.V1.Model.ModifyAckDeadlineRequest.md): Request for the ModifyAckDeadline method.
- [GoogleApi.PubSub.V1.Model.ModifyPushConfigRequest](GoogleApi.PubSub.V1.Model.ModifyPushConfigRequest.md): Request for the ModifyPushConfig method.
- [GoogleApi.PubSub.V1.Model.NoWrapper](GoogleApi.PubSub.V1.Model.NoWrapper.md): Sets the `data` field as the HTTP body for delivery.
- [GoogleApi.PubSub.V1.Model.OidcToken](GoogleApi.PubSub.V1.Model.OidcToken.md): Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).
- [GoogleApi.PubSub.V1.Model.PlatformLogsSettings](GoogleApi.PubSub.V1.Model.PlatformLogsSettings.md): Settings for Platform Logs produced by Pub/Sub.
- [GoogleApi.PubSub.V1.Model.Policy](GoogleApi.PubSub.V1.Model.Policy.md): An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
- [GoogleApi.PubSub.V1.Model.PubSubAvroFormat](GoogleApi.PubSub.V1.Model.PubSubAvroFormat.md): Configuration for reading Cloud Storage data written via [Cloud Storage subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). The data and attributes fields of the originally exported Pub/Sub message will be restored when publishing.
- [GoogleApi.PubSub.V1.Model.PublishRequest](GoogleApi.PubSub.V1.Model.PublishRequest.md): Request for the Publish method.
- [GoogleApi.PubSub.V1.Model.PublishResponse](GoogleApi.PubSub.V1.Model.PublishResponse.md): Response for the `Publish` method.
- [GoogleApi.PubSub.V1.Model.PubsubMessage](GoogleApi.PubSub.V1.Model.PubsubMessage.md): 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](https://cloud.google.com/pubsub/docs/reference/libraries) for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.
- [GoogleApi.PubSub.V1.Model.PubsubWrapper](GoogleApi.PubSub.V1.Model.PubsubWrapper.md): 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).
- [GoogleApi.PubSub.V1.Model.PullRequest](GoogleApi.PubSub.V1.Model.PullRequest.md): Request for the `Pull` method.
- [GoogleApi.PubSub.V1.Model.PullResponse](GoogleApi.PubSub.V1.Model.PullResponse.md): Response for the `Pull` method.
- [GoogleApi.PubSub.V1.Model.PushConfig](GoogleApi.PubSub.V1.Model.PushConfig.md): Configuration for a push delivery endpoint.
- [GoogleApi.PubSub.V1.Model.ReceivedMessage](GoogleApi.PubSub.V1.Model.ReceivedMessage.md): A message and its corresponding acknowledgment ID.
- [GoogleApi.PubSub.V1.Model.RetryPolicy](GoogleApi.PubSub.V1.Model.RetryPolicy.md): 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 acknowledgment 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.
- [GoogleApi.PubSub.V1.Model.RollbackSchemaRequest](GoogleApi.PubSub.V1.Model.RollbackSchemaRequest.md): Request for the `RollbackSchema` method.
- [GoogleApi.PubSub.V1.Model.Schema](GoogleApi.PubSub.V1.Model.Schema.md): A schema resource.
- [GoogleApi.PubSub.V1.Model.SchemaSettings](GoogleApi.PubSub.V1.Model.SchemaSettings.md): Settings for validating messages published against a schema.
- [GoogleApi.PubSub.V1.Model.SeekRequest](GoogleApi.PubSub.V1.Model.SeekRequest.md): Request for the `Seek` method.
- [GoogleApi.PubSub.V1.Model.SeekResponse](GoogleApi.PubSub.V1.Model.SeekResponse.md): Response for the `Seek` method (this response is empty).
- [GoogleApi.PubSub.V1.Model.SetIamPolicyRequest](GoogleApi.PubSub.V1.Model.SetIamPolicyRequest.md): Request message for `SetIamPolicy` method.
- [GoogleApi.PubSub.V1.Model.Snapshot](GoogleApi.PubSub.V1.Model.Snapshot.md): A snapshot resource. 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.
- [GoogleApi.PubSub.V1.Model.Subscription](GoogleApi.PubSub.V1.Model.Subscription.md): 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.
- [GoogleApi.PubSub.V1.Model.TestIamPermissionsRequest](GoogleApi.PubSub.V1.Model.TestIamPermissionsRequest.md): Request message for `TestIamPermissions` method.
- [GoogleApi.PubSub.V1.Model.TestIamPermissionsResponse](GoogleApi.PubSub.V1.Model.TestIamPermissionsResponse.md): Response message for `TestIamPermissions` method.
- [GoogleApi.PubSub.V1.Model.TextConfig](GoogleApi.PubSub.V1.Model.TextConfig.md): Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline.
- [GoogleApi.PubSub.V1.Model.TextFormat](GoogleApi.PubSub.V1.Model.TextFormat.md): Configuration for reading Cloud Storage data in text format. Each line of text as specified by the delimiter will be set to the `data` field of a Pub/Sub message.
- [GoogleApi.PubSub.V1.Model.Topic](GoogleApi.PubSub.V1.Model.Topic.md): A topic resource.
- [GoogleApi.PubSub.V1.Model.UpdateSnapshotRequest](GoogleApi.PubSub.V1.Model.UpdateSnapshotRequest.md): Request for the UpdateSnapshot method.
- [GoogleApi.PubSub.V1.Model.UpdateSubscriptionRequest](GoogleApi.PubSub.V1.Model.UpdateSubscriptionRequest.md): Request for the UpdateSubscription method.
- [GoogleApi.PubSub.V1.Model.UpdateTopicRequest](GoogleApi.PubSub.V1.Model.UpdateTopicRequest.md): Request for the UpdateTopic method.
- [GoogleApi.PubSub.V1.Model.ValidateMessageRequest](GoogleApi.PubSub.V1.Model.ValidateMessageRequest.md): Request for the `ValidateMessage` method.
- [GoogleApi.PubSub.V1.Model.ValidateMessageResponse](GoogleApi.PubSub.V1.Model.ValidateMessageResponse.md): Response for the `ValidateMessage` method. Empty for now.
- [GoogleApi.PubSub.V1.Model.ValidateSchemaRequest](GoogleApi.PubSub.V1.Model.ValidateSchemaRequest.md): Request for the `ValidateSchema` method.
- [GoogleApi.PubSub.V1.Model.ValidateSchemaResponse](GoogleApi.PubSub.V1.Model.ValidateSchemaResponse.md): Response for the `ValidateSchema` method. Empty for now.

