Package-level declarations

Types

Link copied to clipboard
data class AvroConfigResponse(val writeMetadata: Boolean)

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

Link copied to clipboard
data class BigQueryConfigResponse(val dropUnknownFields: Boolean, val state: String, val table: String, val useTopicSchema: Boolean, val writeMetadata: Boolean)

Configuration for a BigQuery subscription.

Link copied to clipboard
data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

Link copied to clipboard
data class CloudStorageConfigResponse(val avroConfig: AvroConfigResponse, val bucket: String, val filenamePrefix: String, val filenameSuffix: String, val maxBytes: String, val maxDuration: String, val state: String, val textConfig: TextConfigResponse)

Configuration for a Cloud Storage subscription.

Link copied to clipboard
data class DeadLetterPolicyResponse(val deadLetterTopic: String, val maxDeliveryAttempts: Int)

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.

Link copied to clipboard
data class ExpirationPolicyResponse(val ttl: String)

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

Link copied to clipboard
data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

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.

Link copied to clipboard
data class GetSchemaIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetSchemaResult(val definition: String, val name: String, val revisionCreateTime: String, val revisionId: String, val type: String)
Link copied to clipboard
data class GetSnapshotIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetSnapshotResult(val expireTime: String, val labels: Map<String, String>, val name: String, val topic: String)
Link copied to clipboard
data class GetSubscriptionIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetSubscriptionResult(val ackDeadlineSeconds: Int, val bigqueryConfig: BigQueryConfigResponse, val cloudStorageConfig: CloudStorageConfigResponse, val deadLetterPolicy: DeadLetterPolicyResponse, val detached: Boolean, val enableExactlyOnceDelivery: Boolean, val enableMessageOrdering: Boolean, val expirationPolicy: ExpirationPolicyResponse, val filter: String, val labels: Map<String, String>, val messageRetentionDuration: String, val name: String, val pushConfig: PushConfigResponse, val retainAckedMessages: Boolean, val retryPolicy: RetryPolicyResponse, val state: String, val topic: String, val topicMessageRetentionDuration: String)
Link copied to clipboard
data class GetTopicIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetTopicResult(val kmsKeyName: String, val labels: Map<String, String>, val messageRetentionDuration: String, val messageStoragePolicy: MessageStoragePolicyResponse, val name: String, val satisfiesPzs: Boolean, val schemaSettings: SchemaSettingsResponse)
Link copied to clipboard
data class MessageStoragePolicyResponse(val allowedPersistenceRegions: List<String>)

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

Link copied to clipboard
data class OidcTokenResponse(val audience: String, val serviceAccountEmail: String)

Contains information needed for generating an OpenID Connect token.

Link copied to clipboard
data class PushConfigResponse(val attributes: Map<String, String>, val oidcToken: OidcTokenResponse, val pushEndpoint: String)

Configuration for a push delivery endpoint.

Link copied to clipboard
data class RetryPolicyResponse(val maximumBackoff: String, val minimumBackoff: String)

A policy that specifies how Cloud Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.

Link copied to clipboard
data class SchemaSettingsResponse(val encoding: String, val firstRevisionId: String, val lastRevisionId: String, val schema: String)

Settings for validating messages published against a schema.

Link copied to clipboard

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