@maxim_mazurok/gapi.client.analyticshub-v1 0.0.20250310 → 0.0.20250414
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +12 -26
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://analyticshub.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250414
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -24,12 +24,6 @@ declare namespace gapi.client {
|
|
|
24
24
|
function load(name: 'analyticshub', version: 'v1', callback: () => any): void;
|
|
25
25
|
|
|
26
26
|
namespace analyticshub {
|
|
27
|
-
interface AnalyticsHubSubscriptionInfo {
|
|
28
|
-
/** Optional. The name of the associated Analytics Hub listing resource. Pattern: "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}" */
|
|
29
|
-
listing?: string;
|
|
30
|
-
/** Optional. The name of the associated Analytics Hub subscription resource. Pattern: "projects/{project}/locations/{location}/subscriptions/{subscription}" */
|
|
31
|
-
subscription?: string;
|
|
32
|
-
}
|
|
33
27
|
interface AuditConfig {
|
|
34
28
|
/** The configuration for logging of each type of permission. */
|
|
35
29
|
auditLogConfigs?: AuditLogConfig[];
|
|
@@ -53,8 +47,6 @@ declare namespace gapi.client {
|
|
|
53
47
|
dropUnknownFields?: boolean;
|
|
54
48
|
/** 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. */
|
|
55
49
|
serviceAccountEmail?: string;
|
|
56
|
-
/** Output only. An output-only field that indicates whether or not the subscription can receive messages. */
|
|
57
|
-
state?: string;
|
|
58
50
|
/** Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId} */
|
|
59
51
|
table?: string;
|
|
60
52
|
/** 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. */
|
|
@@ -93,14 +85,12 @@ declare namespace gapi.client {
|
|
|
93
85
|
filenameSuffix?: string;
|
|
94
86
|
/** 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. */
|
|
95
87
|
maxBytes?: string;
|
|
96
|
-
/** 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
|
|
88
|
+
/** Optional. File batching settings. If no max_duration setting is specified, a max_duration of 5 minutes will be set by default. max_duration is required regardless of whether other file batching settings are specified. 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 acknowledgement deadline. */
|
|
97
89
|
maxDuration?: string;
|
|
98
90
|
/** Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages. */
|
|
99
91
|
maxMessages?: string;
|
|
100
92
|
/** 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. */
|
|
101
93
|
serviceAccountEmail?: string;
|
|
102
|
-
/** Output only. An output-only field that indicates whether or not the subscription can receive messages. */
|
|
103
|
-
state?: string;
|
|
104
94
|
/** Optional. If set, message data will be written to Cloud Storage in text format. */
|
|
105
95
|
textConfig?: any;
|
|
106
96
|
}
|
|
@@ -141,7 +131,7 @@ declare namespace gapi.client {
|
|
|
141
131
|
interface DeadLetterPolicy {
|
|
142
132
|
/** 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. */
|
|
143
133
|
deadLetterTopic?: string;
|
|
144
|
-
/** 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
|
|
134
|
+
/** 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 acknowledgement 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. */
|
|
145
135
|
maxDeliveryAttempts?: number;
|
|
146
136
|
}
|
|
147
137
|
interface DefaultExchangeConfig {}
|
|
@@ -156,6 +146,8 @@ declare namespace gapi.client {
|
|
|
156
146
|
labels?: {[P in string]: string};
|
|
157
147
|
/** Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. */
|
|
158
148
|
location?: string;
|
|
149
|
+
/** Optional. The geographic locations where the dataset should be replicated. See https://cloud.google.com/bigquery/docs/locations for supported locations. */
|
|
150
|
+
replicaLocations?: string[];
|
|
159
151
|
}
|
|
160
152
|
interface DestinationDatasetReference {
|
|
161
153
|
/** Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. */
|
|
@@ -211,8 +203,6 @@ declare namespace gapi.client {
|
|
|
211
203
|
interface GooglePubsubV1Subscription {
|
|
212
204
|
/** Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. */
|
|
213
205
|
ackDeadlineSeconds?: number;
|
|
214
|
-
/** Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub. */
|
|
215
|
-
analyticsHubSubscriptionInfo?: AnalyticsHubSubscriptionInfo;
|
|
216
206
|
/** Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it. */
|
|
217
207
|
bigqueryConfig?: BigQueryConfig;
|
|
218
208
|
/** Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it. */
|
|
@@ -221,7 +211,7 @@ declare namespace gapi.client {
|
|
|
221
211
|
deadLetterPolicy?: DeadLetterPolicy;
|
|
222
212
|
/** Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. */
|
|
223
213
|
detached?: boolean;
|
|
224
|
-
/** Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's
|
|
214
|
+
/** Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. */
|
|
225
215
|
enableExactlyOnceDelivery?: boolean;
|
|
226
216
|
/** Optional. If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. */
|
|
227
217
|
enableMessageOrdering?: boolean;
|
|
@@ -241,12 +231,8 @@ declare namespace gapi.client {
|
|
|
241
231
|
pushConfig?: PushConfig;
|
|
242
232
|
/** Optional. Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages. */
|
|
243
233
|
retainAckedMessages?: boolean;
|
|
244
|
-
/** Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or
|
|
234
|
+
/** Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. */
|
|
245
235
|
retryPolicy?: RetryPolicy;
|
|
246
|
-
/** Output only. An output-only field indicating whether or not the subscription can receive messages. */
|
|
247
|
-
state?: string;
|
|
248
|
-
/** Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. */
|
|
249
|
-
topicMessageRetentionDuration?: string;
|
|
250
236
|
}
|
|
251
237
|
interface JavaScriptUDF {
|
|
252
238
|
/** Required. JavaScript code that contains a function `function_name` with the below signature: ``` /** * 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: * - (required) 'message_id' : {string} * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': {string} */ function (message, metadata) { } ``` */
|
|
@@ -393,7 +379,7 @@ declare namespace gapi.client {
|
|
|
393
379
|
primaryContact?: string;
|
|
394
380
|
}
|
|
395
381
|
interface PubSubTopicSource {
|
|
396
|
-
/** Optional. Region hint on where the data might be published. Data affinity regions are modifiable. See
|
|
382
|
+
/** Optional. Region hint on where the data might be published. Data affinity regions are modifiable. See https://cloud.google.com/about/locations for full listing of possible Cloud regions. */
|
|
397
383
|
dataAffinityRegions?: string[];
|
|
398
384
|
/** Required. Resource name of the Pub/Sub topic source for this listing. e.g. projects/myproject/topics/topicId */
|
|
399
385
|
topic?: string;
|
|
@@ -586,7 +572,7 @@ declare namespace gapi.client {
|
|
|
586
572
|
fields?: string;
|
|
587
573
|
/** 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. */
|
|
588
574
|
key?: string;
|
|
589
|
-
/** Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_).
|
|
575
|
+
/** Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes. */
|
|
590
576
|
listingId?: string;
|
|
591
577
|
/** OAuth 2.0 token for the current user. */
|
|
592
578
|
oauth_token?: string;
|
|
@@ -617,7 +603,7 @@ declare namespace gapi.client {
|
|
|
617
603
|
fields?: string;
|
|
618
604
|
/** 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. */
|
|
619
605
|
key?: string;
|
|
620
|
-
/** Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_).
|
|
606
|
+
/** Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes. */
|
|
621
607
|
listingId?: string;
|
|
622
608
|
/** OAuth 2.0 token for the current user. */
|
|
623
609
|
oauth_token?: string;
|
|
@@ -976,7 +962,7 @@ declare namespace gapi.client {
|
|
|
976
962
|
alt?: string;
|
|
977
963
|
/** JSONP */
|
|
978
964
|
callback?: string;
|
|
979
|
-
/** Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_).
|
|
965
|
+
/** Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes. */
|
|
980
966
|
dataExchangeId?: string;
|
|
981
967
|
/** Selector specifying which fields to include in a partial response. */
|
|
982
968
|
fields?: string;
|
|
@@ -1007,7 +993,7 @@ declare namespace gapi.client {
|
|
|
1007
993
|
alt?: string;
|
|
1008
994
|
/** JSONP */
|
|
1009
995
|
callback?: string;
|
|
1010
|
-
/** Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_).
|
|
996
|
+
/** Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes. */
|
|
1011
997
|
dataExchangeId?: string;
|
|
1012
998
|
/** Selector specifying which fields to include in a partial response. */
|
|
1013
999
|
fields?: string;
|