@googleapis/pubsub
Version:
883 lines (874 loc) • 340 kB
text/typescript
// Copyright 2020 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable @typescript-eslint/no-unused-vars */
/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */
/* eslint-disable no-irregular-whitespace */
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosResponseWithHTTP2,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export namespace pubsub_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?:
| string
| OAuth2Client
| JWT
| Compute
| UserRefreshClient
| BaseExternalAccountClient
| GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Pub/Sub API
*
* Provides reliable, many-to-many, asynchronous messaging between applications.
*
* @example
* ```js
* const {google} = require('googleapis');
* const pubsub = google.pubsub('v1');
* ```
*/
export class Pubsub {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this.context = {
_options: options || {},
google,
};
this.projects = new Resource$Projects(this.context);
}
}
/**
* Request for the Acknowledge method.
*/
export interface Schema$AcknowledgeRequest {
/**
* Required. The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty.
*/
ackIds?: string[] | null;
}
/**
* Information about an associated [Analytics Hub subscription](https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions).
*/
export interface Schema$AnalyticsHubSubscriptionInfo {
/**
* Optional. The name of the associated Analytics Hub listing resource. Pattern: "projects/{project\}/locations/{location\}/dataExchanges/{data_exchange\}/listings/{listing\}"
*/
listing?: string | null;
/**
* Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project\}/locations/{location\}/subscriptions/{subscription\}"
*/
subscription?: string | null;
}
/**
* Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.
*/
export interface Schema$AvroConfig {
/**
* Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
*/
useTopicSchema?: boolean | null;
/**
* 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.
*/
writeMetadata?: boolean | null;
}
/**
* 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.
*/
export interface Schema$AvroFormat {}
/**
* Ingestion settings for Amazon Kinesis Data Streams.
*/
export interface Schema$AwsKinesis {
/**
* 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.
*/
awsRoleArn?: string | null;
/**
* 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.
*/
consumerArn?: string | null;
/**
* Required. The GCP service account to be used for Federated Identity authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for the provided role). The `aws_role_arn` must be set up with `accounts.google.com:sub` equals to this service account number.
*/
gcpServiceAccount?: string | null;
/**
* Output only. An output-only field that indicates the state of the Kinesis ingestion source.
*/
state?: string | null;
/**
* Required. The Kinesis stream ARN to ingest data from.
*/
streamArn?: string | null;
}
/**
* Ingestion settings for Amazon MSK.
*/
export interface Schema$AwsMsk {
/**
* 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.
*/
awsRoleArn?: string | null;
/**
* Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
clusterArn?: string | null;
/**
* Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call for the provided role). The `aws_role_arn` must be set up with `accounts.google.com:sub` equals to this service account number.
*/
gcpServiceAccount?: string | null;
/**
* Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.
*/
state?: string | null;
/**
* Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.
*/
topic?: string | null;
}
/**
* Ingestion settings for Azure Event Hubs.
*/
export interface Schema$AzureEventHubs {
/**
* Optional. The client id of the Azure application that is being used to authenticate Pub/Sub.
*/
clientId?: string | null;
/**
* Optional. The name of the Event Hub.
*/
eventHub?: string | null;
/**
* Optional. The GCP service account to be used for Federated Identity authentication.
*/
gcpServiceAccount?: string | null;
/**
* Optional. The name of the Event Hubs namespace.
*/
namespace?: string | null;
/**
* Optional. Name of the resource group within the azure subscription.
*/
resourceGroup?: string | null;
/**
* Output only. An output-only field that indicates the state of the Event Hubs ingestion source.
*/
state?: string | null;
/**
* Optional. The Azure subscription id.
*/
subscriptionId?: string | null;
/**
* Optional. The tenant id of the Azure application that is being used to authenticate Pub/Sub.
*/
tenantId?: string | null;
}
/**
* Configuration for a BigQuery subscription.
*/
export interface Schema$BigQueryConfig {
/**
* 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.
*/
dropUnknownFields?: boolean | null;
/**
* Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number\}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*/
serviceAccountEmail?: string | null;
/**
* Output only. An output-only field that indicates whether or not the subscription can receive messages.
*/
state?: string | null;
/**
* Optional. The name of the table to which to write data, of the form {projectId\}.{datasetId\}.{tableId\}
*/
table?: string | null;
/**
* Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery. `use_table_schema` and `use_topic_schema` cannot be enabled at the same time.
*/
useTableSchema?: boolean | null;
/**
* Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be enabled at the same time.
*/
useTopicSchema?: boolean | null;
/**
* 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.
*/
writeMetadata?: boolean | null;
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
*/
role?: string | null;
}
/**
* Ingestion settings for Cloud Storage.
*/
export interface Schema$CloudStorage {
/**
* Optional. Data from Cloud Storage will be interpreted in Avro format.
*/
avroFormat?: Schema$AvroFormat;
/**
* Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
*/
bucket?: string | null;
/**
* Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will be ingested. See the [supported patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).
*/
matchGlob?: string | null;
/**
* Optional. Only objects with a larger or equal creation timestamp will be ingested.
*/
minimumObjectCreateTime?: string | null;
/**
* Optional. It will be assumed data from Cloud Storage was written via [Cloud Storage subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
*/
pubsubAvroFormat?: Schema$PubSubAvroFormat;
/**
* Output only. An output-only field that indicates the state of the Cloud Storage ingestion source.
*/
state?: string | null;
/**
* Optional. Data from Cloud Storage will be interpreted as text.
*/
textFormat?: Schema$TextFormat;
}
/**
* Configuration for a Cloud Storage subscription.
*/
export interface Schema$CloudStorageConfig {
/**
* Optional. If set, message data will be written to Cloud Storage in Avro format.
*/
avroConfig?: Schema$AvroConfig;
/**
* Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
*/
bucket?: string | null;
/**
* Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the [datetime format guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).
*/
filenameDatetimeFormat?: string | null;
/**
* Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).
*/
filenamePrefix?: string | null;
/**
* Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/".
*/
filenameSuffix?: string | null;
/**
* 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.
*/
maxBytes?: string | null;
/**
* 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.
*/
maxDuration?: string | null;
/**
* Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
*/
maxMessages?: string | null;
/**
* Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number\}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*/
serviceAccountEmail?: string | null;
/**
* Output only. An output-only field that indicates whether or not the subscription can receive messages.
*/
state?: string | null;
/**
* Optional. If set, message data will be written to Cloud Storage in text format.
*/
textConfig?: Schema$TextConfig;
}
/**
* Request for CommitSchema method.
*/
export interface Schema$CommitSchemaRequest {
/**
* Required. The schema revision to commit.
*/
schema?: Schema$Schema;
}
/**
* Ingestion settings for Confluent Cloud.
*/
export interface Schema$ConfluentCloud {
/**
* Required. The address of the bootstrap server. The format is url:port.
*/
bootstrapServer?: string | null;
/**
* Required. The id of the cluster.
*/
clusterId?: string | null;
/**
* Required. The GCP service account to be used for Federated Identity authentication with `identity_pool_id`.
*/
gcpServiceAccount?: string | null;
/**
* Required. The id of the identity pool to be used for Federated Identity authentication with Confluent Cloud. See https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
*/
identityPoolId?: string | null;
/**
* Output only. An output-only field that indicates the state of the Confluent Cloud ingestion source.
*/
state?: string | null;
/**
* Required. The name of the topic in the Confluent Cloud cluster that Pub/Sub will import from.
*/
topic?: string | null;
}
/**
* Request for the `CreateSnapshot` method.
*/
export interface Schema$CreateSnapshotRequest {
/**
* Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
*/
labels?: {[key: string]: string} | null;
/**
* Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project\}/subscriptions/{sub\}`.
*/
subscription?: string | null;
}
/**
* 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.
*/
export interface Schema$DeadLetterPolicy {
/**
* Optional. The name of the topic to which dead letter messages should be published. Format is `projects/{project\}/topics/{topic\}`.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number\}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
*/
deadLetterTopic?: string | null;
/**
* 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.
*/
maxDeliveryAttempts?: number | null;
}
/**
* Response for the DetachSubscription method. Reserved for future use.
*/
export interface Schema$DetachSubscriptionResponse {}
/**
* 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); \}
*/
export interface Schema$Empty {}
/**
* A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
*/
export interface Schema$ExpirationPolicy {
/**
* Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of `ttl`. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for `ttl` depend on the type of the associated resource, as well. If `ttl` is not set, the associated resource never expires.
*/
ttl?: string | null;
}
/**
* 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.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* Settings for an ingestion data source on a topic.
*/
export interface Schema$IngestionDataSourceSettings {
/**
* Optional. Amazon Kinesis Data Streams.
*/
awsKinesis?: Schema$AwsKinesis;
/**
* Optional. Amazon MSK.
*/
awsMsk?: Schema$AwsMsk;
/**
* Optional. Azure Event Hubs.
*/
azureEventHubs?: Schema$AzureEventHubs;
/**
* Optional. Cloud Storage.
*/
cloudStorage?: Schema$CloudStorage;
/**
* Optional. Confluent Cloud.
*/
confluentCloud?: Schema$ConfluentCloud;
/**
* Optional. Platform Logs settings. If unset, no Platform Logs will be generated.
*/
platformLogsSettings?: Schema$PlatformLogsSettings;
}
/**
* User-defined JavaScript function that can transform or filter a Pub/Sub message.
*/
export interface Schema$JavaScriptUDF {
/**
* Required. JavaScript code that contains a function `function_name` with the below signature: ``` /x* * Transforms a Pub/Sub message. * @return {(Object)\>|null)\} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string\} * - (optional) 'attributes' : {Object\} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object)\>\} Pub/Sub * message. Keys: * - (required) 'data' : {string\} * - (required) 'attributes' : {Object\} * * @param {Object\} metadata - Pub/Sub message metadata. * Keys: * - (optional) 'message_id' : {string\} * - (optional) 'publish_time': {string\} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string\} x/ function (message, metadata) { \} ```
*/
code?: string | null;
/**
* Required. Name of the JavasScript function that should applied to Pub/Sub messages.
*/
functionName?: string | null;
}
/**
* Response for the `ListSchemaRevisions` method.
*/
export interface Schema$ListSchemaRevisionsResponse {
/**
* A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The revisions of the schema.
*/
schemas?: Schema$Schema[];
}
/**
* Response for the `ListSchemas` method.
*/
export interface Schema$ListSchemasResponse {
/**
* If not empty, indicates that there may be more schemas that match the request; this value should be passed in a new `ListSchemasRequest`.
*/
nextPageToken?: string | null;
/**
* The resulting schemas.
*/
schemas?: Schema$Schema[];
}
/**
* Response for the `ListSnapshots` method.
*/
export interface Schema$ListSnapshotsResponse {
/**
* Optional. If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new `ListSnapshotsRequest`.
*/
nextPageToken?: string | null;
/**
* Optional. The resulting snapshots.
*/
snapshots?: Schema$Snapshot[];
}
/**
* Response for the `ListSubscriptions` method.
*/
export interface Schema$ListSubscriptionsResponse {
/**
* Optional. If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions.
*/
nextPageToken?: string | null;
/**
* Optional. The subscriptions that match the request.
*/
subscriptions?: Schema$Subscription[];
}
/**
* Response for the `ListTopicSnapshots` method.
*/
export interface Schema$ListTopicSnapshotsResponse {
/**
* Optional. If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new `ListTopicSnapshotsRequest` to get more snapshots.
*/
nextPageToken?: string | null;
/**
* Optional. The names of the snapshots that match the request.
*/
snapshots?: string[] | null;
}
/**
* Response for the `ListTopics` method.
*/
export interface Schema$ListTopicsResponse {
/**
* Optional. If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.
*/
nextPageToken?: string | null;
/**
* Optional. The resulting topics.
*/
topics?: Schema$Topic[];
}
/**
* Response for the `ListTopicSubscriptions` method.
*/
export interface Schema$ListTopicSubscriptionsResponse {
/**
* Optional. If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions.
*/
nextPageToken?: string | null;
/**
* Optional. The names of subscriptions attached to the topic specified in the request.
*/
subscriptions?: string[] | null;
}
/**
* A policy constraining the storage of messages published to the topic.
*/
export interface Schema$MessageStoragePolicy {
/**
* 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.
*/
allowedPersistenceRegions?: string[] | null;
/**
* Optional. If true, `allowed_persistence_regions` is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in `allowed_persistence_regions`.
*/
enforceInTransit?: boolean | null;
}
/**
* All supported message transforms types.
*/
export interface Schema$MessageTransform {
/**
* Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
*/
disabled?: boolean | null;
/**
* Optional. This field is deprecated, use the `disabled` field to disable transforms.
*/
enabled?: boolean | null;
/**
* Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
*/
javascriptUdf?: Schema$JavaScriptUDF;
}
/**
* Request for the ModifyAckDeadline method.
*/
export interface Schema$ModifyAckDeadlineRequest {
/**
* Required. The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify in a single request is 600 seconds (10 minutes).
*/
ackDeadlineSeconds?: number | null;
/**
* Required. List of acknowledgment IDs.
*/
ackIds?: string[] | null;
}
/**
* Request for the ModifyPushConfig method.
*/
export interface Schema$ModifyPushConfigRequest {
/**
* Required. The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` or `StreamingPull` is not called.
*/
pushConfig?: Schema$PushConfig;
}
/**
* Sets the `data` field as the HTTP body for delivery.
*/
export interface Schema$NoWrapper {
/**
* Optional. When true, writes the Pub/Sub message metadata to `x-goog-pubsub-:` headers of the HTTP request. Writes the Pub/Sub message attributes to `:` headers of the HTTP request.
*/
writeMetadata?: boolean | null;
}
/**
* Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).
*/
export interface Schema$OidcToken {
/**
* 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.
*/
audience?: string | null;
/**
* Optional. [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
*/
serviceAccountEmail?: string | null;
}
/**
* Settings for Platform Logs produced by Pub/Sub.
*/
export interface Schema$PlatformLogsSettings {
/**
* Optional. The minimum severity level of Platform Logs that will be written.
*/
severity?: string | null;
}
/**
* 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/).
*/
export interface Schema$Policy {
/**
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*/
etag?: string | null;
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
version?: number | null;
}
/**
* Request for the Publish method.
*/
export interface Schema$PublishRequest {
/**
* Required. The messages to publish.
*/
messages?: Schema$PubsubMessage[];
}
/**
* Response for the `Publish` method.
*/
export interface Schema$PublishResponse {
/**
* 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.
*/
messageIds?: string[] | null;
}
/**
* 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.
*/
export interface Schema$PubSubAvroFormat {}
/**
* 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.
*/
export interface Schema$PubsubMessage {
/**
* 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.
*/
attributes?: {[key: string]: string} | null;
/**
* Optional. The message data field. If this field is empty, the message must contain at least one attribute.
*/
data?: string | null;
/**
* ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
*/
messageId?: string | null;
/**
* Optional. If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).
*/
orderingKey?: string | null;
/**
* The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.
*/
publishTime?: string | null;
}
/**
* 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).
*/
export interface Schema$PubsubWrapper {}
/**
* Request for the `Pull` method.
*/
export interface Schema$PullRequest {
/**
* 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.
*/
maxMessages?: number | null;
/**
* Optional. If this field set to true, the system will respond immediately even if it there are no messages available to return in the `Pull` response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages. Warning: setting this field to `true` is discouraged because it adversely impacts the performance of `Pull` operations. We recommend that users do not set this field.
*/
returnImmediately?: boolean | null;
}
/**
* Response for the `Pull` method.
*/
export interface Schema$PullResponse {
/**
* Optional. Received Pub/Sub messages. The list will be empty if there are no more messages available in the backlog, or if no messages could be returned before the request timeout. For JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog.
*/
receivedMessages?: Schema$ReceivedMessage[];
}
/**
* Configuration for a push delivery endpoint.
*/
export interface Schema$PushConfig {
/**
* Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" \}`
*/
attributes?: {[key: string]: string} | null;
/**
* Optional. When set, the payload to the push endpoint is not wrapped.
*/
noWrapper?: Schema$NoWrapper;
/**
* Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.
*/
oidcToken?: Schema$OidcToken;
/**
* 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).
*/
pubsubWrapper?: Schema$PubsubWrapper;
/**
* Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use `https://example.com/push`.
*/
pushEndpoint?: string | null;
}
/**
* A message and its corresponding acknowledgment ID.
*/
export interface Schema$ReceivedMessage {
/**
* Optional. This ID can be used to acknowledge the received message.
*/
ackId?: string | null;
/**
* 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.
*/
deliveryAttempt?: number | null;
/**
* Optional. The message.
*/
message?: Schema$PubsubMessage;
}
/**
* 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.
*/
export interface Schema$RetryPolicy {
/**
* Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
*/
maximumBackoff?: string | null;
/**
* Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
*/
minimumBackoff?: string | null;
}
/**
* Request for the `RollbackSchema` method.
*/
export interface Schema$RollbackSchemaRequest {
/**
* Required. The revision ID to roll back to. It must be a revision of the same schema. Example: c7cfa2a8
*/
revisionId?: string | null;
}
/**
* A schema resource.
*/
export interface Schema$Schema {
/**
* The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`.
*/
definition?: string | null;
/**
* Required. Name of the schema. Format is `projects/{project\}/schemas/{schema\}`.
*/
name?: string | null;
/**
* Output only. The timestamp that the revision was created.
*/
revisionCreateTime?: string | null;
/**
* Output only. Immutable. The revision ID of the schema.
*/
revisionId?: string | null;
/**
* The type of the schema definition.
*/
type?: string | null;
}
/**
* Settings for validating me