feat(pubsub): update the api

#### pubsub:v1 The following keys were added: - schemas.AwsKinesis (Total Keys: 8) - schemas.BigQueryConfig.properties.serviceAccountEmail.type (Total Keys: 1) - schemas.CloudStorageConfig.properties.serviceAccountEmail.type (Total Keys: 1) - schemas.IngestionDataSourceSettings (Total Keys: 3) - schemas.Topic.properties.ingestionDataSourceSettings.$ref (Total Keys: 1) - schemas.Topic.properties.state (Total Keys: 2)
googleapis · Feb 6, 2024 · 6343e29 · 6343e29
1 parent 802c3be
commit 6343e29
Show file tree

Hide file tree

Showing 9 changed files with 194 additions and 40 deletions.
diff --git a/docs/dyn/pubsub_v1.projects.schemas.html b/docs/dyn/pubsub_v1.projects.schemas.html
diff --git a/docs/dyn/pubsub_v1.projects.snapshots.html b/docs/dyn/pubsub_v1.projects.snapshots.html
diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html
diff --git a/docs/dyn/pubsub_v1.projects.topics.html b/docs/dyn/pubsub_v1.projects.topics.html
diff --git a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
diff --git a/docs/dyn/pubsub_v1beta2.projects.topics.html b/docs/dyn/pubsub_v1beta2.projects.topics.html
diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json
@@ -716,7 +716,7 @@
 ]
 },
 "patch": {
-"description": "Updates an existing snapshot. 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.",
+"description": "Updates an existing snapshot by updating the fields specified in the update mask. 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.",
 "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
 "httpMethod": "PATCH",
 "id": "pubsub.projects.snapshots.patch",
@@ -1070,7 +1070,7 @@
 ]
 },
 "patch": {
-"description": "Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.",
+"description": "Updates an existing subscription by updating the fields specified in the update mask. Note that certain properties of a subscription, such as its topic, are not modifiable.",
 "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
 "httpMethod": "PATCH",
 "id": "pubsub.projects.subscriptions.patch",
@@ -1369,7 +1369,7 @@
 ]
 },
 "patch": {
-"description": "Updates an existing topic. Note that certain properties of a topic are not modifiable.",
+"description": "Updates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.",
 "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
 "httpMethod": "PATCH",
 "id": "pubsub.projects.topics.patch",
@@ -1573,7 +1573,7 @@
 }
 }
 },
-"revision": "20240122",
+"revision": "20240201",
 "rootUrl": "https://pubsub.googleapis.com/",
 "schemas": {
 "AcknowledgeRequest": {
@@ -1601,6 +1601,50 @@
 },
 "type": "object"
 },
+"AwsKinesis": {
+"description": "Ingestion settings for Amazon Kinesis Data Streams.",
+"id": "AwsKinesis",
+"properties": {
+"awsRoleArn": {
+"description": "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.",
+"type": "string"
+},
+"consumerArn": {
+"description": "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.",
+"type": "string"
+},
+"gcpServiceAccount": {
+"description": "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.",
+"type": "string"
+},
+"state": {
+"description": "Output only. An output-only field that indicates the state of the Kinesis ingestion source.",
+"enum": [
+"STATE_UNSPECIFIED",
+"ACTIVE",
+"KINESIS_PERMISSION_DENIED",
+"PUBLISH_PERMISSION_DENIED",
+"STREAM_NOT_FOUND",
+"CONSUMER_NOT_FOUND"
+],
+"enumDescriptions": [
+"Default value. This value is unused.",
+"Ingestion is active.",
+"Permission denied encountered while consuming data from Kinesis. This can happen if: - The provided `aws_role_arn` does not exist or does not have the appropriate permissions attached. - The provided `aws_role_arn` is not set up properly for Identity Federation using `gcp_service_account`. - The Pub/Sub SA is not granted the `iam.serviceAccounts.getOpenIdToken` permission on `gcp_service_account`.",
+"Permission denied encountered while publishing to the topic. This can happen due to Pub/Sub SA has not been granted the [appropriate publish permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)",
+"The Kinesis stream does not exist.",
+"The Kinesis consumer does not exist."
+],
+"readOnly": true,
+"type": "string"
+},
+"streamArn": {
+"description": "Required. The Kinesis stream ARN to ingest data from.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "BigQueryConfig": {
 "description": "Configuration for a BigQuery subscription.",
 "id": "BigQueryConfig",
@@ -1609,6 +1653,10 @@
 "description": "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.",
 "type": "boolean"
 },
+"serviceAccountEmail": {
+"description": "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.",
+"type": "string"
+},
 "state": {
 "description": "Output only. An output-only field that indicates whether or not the subscription can receive messages.",
 "enum": [
@@ -1665,7 +1713,7 @@
 "type": "array"
 },
 "role": {
-"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
+"description": "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).",
 "type": "string"
 }
 },
@@ -1701,6 +1749,10 @@
 "format": "google-duration",
 "type": "string"
 },
+"serviceAccountEmail": {
+"description": "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.",
+"type": "string"
+},
 "state": {
 "description": "Output only. An output-only field that indicates whether or not the subscription can receive messages.",
 "enum": [
@@ -1819,6 +1871,17 @@
 },
 "type": "object"
 },
+"IngestionDataSourceSettings": {
+"description": "Settings for an ingestion data source on a topic.",
+"id": "IngestionDataSourceSettings",
+"properties": {
+"awsKinesis": {
+"$ref": "AwsKinesis",
+"description": "Optional. Amazon Kinesis Data Streams."
+}
+},
+"type": "object"
+},
 "ListSchemaRevisionsResponse": {
 "description": "Response for the `ListSchemaRevisions` method.",
 "id": "ListSchemaRevisionsResponse",
@@ -1968,7 +2031,7 @@
 "id": "ModifyAckDeadlineRequest",
 "properties": {
 "ackDeadlineSeconds": {
-"description": "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 is 600 seconds (10 minutes).",
+"description": "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).",
 "format": "int32",
 "type": "integer"
 },
@@ -2088,15 +2151,15 @@
 "type": "string"
 },
 "messageId": {
-"description": "Optional. 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.",
+"description": "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.",
 "type": "string"
 },
 "orderingKey": {
 "description": "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).",
 "type": "string"
 },
 "publishTime": {
-"description": "Optional. 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.",
+"description": "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.",
 "format": "google-datetime",
 "type": "string"
 }
@@ -2486,6 +2549,10 @@
 "description": "A topic resource.",
 "id": "Topic",
 "properties": {
+"ingestionDataSourceSettings": {
+"$ref": "IngestionDataSourceSettings",
+"description": "Optional. Settings for managed ingestion from a data source into this topic."
+},
 "kmsKeyName": {
 "description": "Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
 "type": "string"
@@ -2517,6 +2584,21 @@
 "schemaSettings": {
 "$ref": "SchemaSettings",
 "description": "Optional. Settings for validating messages published against a schema."
+},
+"state": {
+"description": "Output only. An output-only field indicating the state of the topic.",
+"enum": [
+"STATE_UNSPECIFIED",
+"ACTIVE",
+"INGESTION_RESOURCE_ERROR"
+],
+"enumDescriptions": [
+"Default value. This value is unused.",
+"The topic does not have any persistent errors.",
+"Ingestion from the data source has encountered a permanent error. See the more detailed error state in the corresponding ingestion source configuration."
+],
+"readOnly": true,
+"type": "string"
 }
 },
 "type": "object"

diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json
@@ -464,7 +464,7 @@
 }
 }
 },
-"revision": "20240122",
+"revision": "20240201",
 "rootUrl": "https://pubsub.googleapis.com/",
 "schemas": {
 "AcknowledgeRequest": {

diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json
@@ -731,7 +731,7 @@
 }
 }
 },
-"revision": "20240122",
+"revision": "20240201",
 "rootUrl": "https://pubsub.googleapis.com/",
 "schemas": {
 "AcknowledgeRequest": {
@@ -764,7 +764,7 @@
 "type": "array"
 },
 "role": {
-"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
+"description": "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).",
 "type": "string"
 }
 },