googleapis
Version:
Google APIs Client Library for Node.js
803 lines • 235 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace analyticshub_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;
}
/**
* Analytics Hub API
*
* Exchange data and analytics assets securely and efficiently.
*
* @example
* ```js
* const {google} = require('googleapis');
* const analyticshub = google.analyticshub('v1');
* ```
*/
export class Analyticshub {
context: APIRequestContext;
organizations: Resource$Organizations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Configuration for making inference requests against Vertex AI models.
*/
export interface Schema$AIInference {
/**
* Required. An endpoint to a Vertex AI model of the form `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}`. Vertex AI API requests will be sent to this endpoint.
*/
endpoint?: string | null;
/**
* Optional. The service account to use to make prediction requests against endpoints. The resource 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]({$universe.dns_names.final_documentation_domain\}/iam/docs/service-agents), service-{project_number\}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*/
serviceAccountEmail?: string | null;
/**
* Optional. Requests and responses can be any arbitrary JSON object.
*/
unstructuredInference?: Schema$UnstructuredInference;
}
/**
* Message for approving a QueryTemplate.
*/
export interface Schema$ApproveQueryTemplateRequest {
}
/**
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: 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 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;
/**
* 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;
}
/**
* A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset.
*/
export interface Schema$BigQueryDatasetSource {
/**
* Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
*/
dataset?: string | null;
/**
* Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation.
*/
effectiveReplicas?: Schema$Replica[];
/**
* Optional. A list of regions where the publisher has created shared dataset replicas.
*/
replicaLocations?: string[] | null;
/**
* Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.
*/
restrictedExportPolicy?: Schema$RestrictedExportPolicy;
/**
* Optional. Resource in this dataset that is selectively shared. This field is required for data clean room exchanges.
*/
selectedResources?: Schema$SelectedResource[];
}
/**
* 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;
}
/**
* 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. 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.
*/
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;
/**
* Optional. If set, message data will be written to Cloud Storage in text format.
*/
textConfig?: Schema$TextConfig;
}
/**
* A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
*/
export interface Schema$DataExchange {
/**
* Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
*/
description?: string | null;
/**
* Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.
*/
discoveryType?: string | null;
/**
* Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
*/
displayName?: string | null;
/**
* Optional. Documentation describing the data exchange.
*/
documentation?: string | null;
/**
* Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
*/
icon?: string | null;
/**
* Output only. Number of listings contained in the data exchange.
*/
listingCount?: number | null;
/**
* Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
*/
logLinkedDatasetQueryUserEmail?: boolean | null;
/**
* Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
*/
name?: string | null;
/**
* Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
*/
primaryContact?: string | null;
/**
* Optional. Configurable data sharing environment option for a data exchange.
*/
sharingEnvironmentConfig?: Schema$SharingEnvironmentConfig;
}
/**
* Contains details of the data provider.
*/
export interface Schema$DataProvider {
/**
* Optional. Name of the data provider.
*/
name?: string | null;
/**
* Optional. Email or URL of the data provider. Max Length: 1000 bytes.
*/
primaryContact?: string | null;
}
/**
* Data Clean Room (DCR), used for privacy-safe and secured data sharing.
*/
export interface Schema$DcrExchangeConfig {
/**
* Output only. If True, when subscribing to this DCR, it will create only one linked dataset containing all resources shared within the cleanroom. If False, when subscribing to this DCR, it will create 1 linked dataset per listing. This is not configurable, and by default, all new DCRs will have the restriction set to True.
*/
singleLinkedDatasetPerCleanroom?: boolean | null;
/**
* Output only. If True, this DCR restricts the contributors to sharing only a single resource in a Listing. And no two resources should have the same IDs. So if a contributor adds a view with a conflicting name, the CreateListing API will reject the request. if False, the data contributor can publish an entire dataset (as before). This is not configurable, and by default, all new DCRs will have the restriction set to True.
*/
singleSelectedResourceSharingRestriction?: boolean | 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 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.
*/
maxDeliveryAttempts?: number | null;
}
/**
* Default Analytics Hub data exchange, used for secured data sharing.
*/
export interface Schema$DefaultExchangeConfig {
}
/**
* Defines the destination bigquery dataset.
*/
export interface Schema$DestinationDataset {
/**
* Required. A reference that identifies the destination dataset.
*/
datasetReference?: Schema$DestinationDatasetReference;
/**
* Optional. A user-friendly description of the dataset.
*/
description?: string | null;
/**
* Optional. A descriptive name for the dataset.
*/
friendlyName?: string | null;
/**
* Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
*/
location?: string | null;
/**
* Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations.
*/
replicaLocations?: string[] | null;
}
export interface Schema$DestinationDatasetReference {
/**
* 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.
*/
datasetId?: string | null;
/**
* Required. The ID of the project containing this dataset.
*/
projectId?: string | null;
}
/**
* Defines the destination Pub/Sub subscription.
*/
export interface Schema$DestinationPubSubSubscription {
/**
* Required. Destination Pub/Sub subscription resource.
*/
pubsubSubscription?: Schema$GooglePubsubV1Subscription;
}
/**
* 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;
}
/**
* Request message for `GetIamPolicy` method.
*/
export interface Schema$GetIamPolicyRequest {
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
*/
options?: Schema$GetPolicyOptions;
}
/**
* Encapsulates settings provided to GetIamPolicy.
*/
export interface Schema$GetPolicyOptions {
/**
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
requestedPolicyVersion?: number | null;
}
/**
* Commercial info contains the information about the commercial data products associated with the listing.
*/
export interface Schema$GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfo {
/**
* Output only. Details of the Marketplace Data Product associated with the Listing.
*/
cloudMarketplace?: Schema$GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfoGoogleCloudMarketplaceInfo;
}
/**
* Specifies the details of the Marketplace Data Product associated with the Listing.
*/
export interface Schema$GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfoGoogleCloudMarketplaceInfo {
/**
* Output only. Commercial state of the Marketplace Data Product.
*/
commercialState?: string | null;
/**
* Output only. Resource name of the commercial service associated with the Marketplace Data Product. e.g. example.com
*/
service?: string | null;
}
/**
* Commercial info metadata for this subscription.
*/
export interface Schema$GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfo {
/**
* Output only. This is set when the subscription is commercialised via Cloud Marketplace.
*/
cloudMarketplace?: Schema$GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfoGoogleCloudMarketplaceInfo;
}
/**
* Cloud Marketplace commercial metadata for this subscription.
*/
export interface Schema$GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfoGoogleCloudMarketplaceInfo {
/**
* Resource name of the Marketplace Order.
*/
order?: string | null;
}
/**
* Defines the destination Pub/Sub subscription. If none of `push_config`, `bigquery_config`, `cloud_storage_config`, `pubsub_export_config`, or `pubsublite_export_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.
*/
export interface Schema$GooglePubsubV1Subscription {
/**
* 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.
*/
ackDeadlineSeconds?: number | null;
/**
* Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
*/
bigqueryConfig?: Schema$BigQueryConfig;
/**
* Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
*/
cloudStorageConfig?: Schema$CloudStorageConfig;
/**
* Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number\}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
*/
deadLetterPolicy?: Schema$DeadLetterPolicy;
/**
* 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.
*/
detached?: boolean | null;
/**
* 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.
*/
enableExactlyOnceDelivery?: boolean | null;
/**
* 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.
*/
enableMessageOrdering?: boolean | null;
/**
* Optional. A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires.
*/
expirationPolicy?: Schema$ExpirationPolicy;
/**
* Optional. An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
*/
filter?: string | null;
/**
* Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
*/
labels?: {
[key: string]: string;
} | null;
/**
* Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes.
*/
messageRetentionDuration?: string | null;
/**
* Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.
*/
messageTransforms?: Schema$MessageTransform[];
/**
* Required. Identifier. Name of the subscription. Format is `projects/{project\}/subscriptions/{sub\}`.
*/
name?: string | null;
/**
* Optional. If push delivery is used with this subscription, this field is used to configure it.
*/
pushConfig?: Schema$PushConfig;
/**
* 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.
*/
retainAckedMessages?: boolean | null;
/**
* 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.
*/
retryPolicy?: Schema$RetryPolicy;
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
*/
tags?: {
[key: string]: string;
} | null;
}
/**
* 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: * - (required) '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;
}
/**
* Reference to a linked resource tracked by this Subscription.
*/
export interface Schema$LinkedResource {
/**
* Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
*/
linkedDataset?: string | null;
/**
* Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
*/
linkedPubsubSubscription?: string | null;
/**
* Output only. Listing for which linked resource is created.
*/
listing?: string | null;
}
/**
* Message for response to the list of data exchanges.
*/
export interface Schema$ListDataExchangesResponse {
/**
* The list of data exchanges.
*/
dataExchanges?: Schema$DataExchange[];
/**
* A token to request the next page of results.
*/
nextPageToken?: string | null;
}
/**
* A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.
*/
export interface Schema$Listing {
/**
* Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.
*/
allowOnlyMetadataSharing?: boolean | null;
/**
* Shared dataset i.e. BigQuery dataset source.
*/
bigqueryDataset?: Schema$BigQueryDatasetSource;
/**
* Optional. Categories of the listing. Up to five categories are allowed.
*/
categories?: string[] | null;
/**
* Output only. Commercial info contains the information about the commercial data products associated with the listing.
*/
commercialInfo?: Schema$GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfo;
/**
* Optional. Details of the data provider who owns the source data.
*/
dataProvider?: Schema$DataProvider;
/**
* Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
*/
description?: string | null;
/**
* Optional. Type of discovery of the listing on the discovery page.
*/
discoveryType?: string | null;
/**
* Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
*/
displayName?: string | null;
/**
* Optional. Documentation describing the listing.
*/
documentation?: string | null;
/**
* Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
*/
icon?: string | null;
/**
* Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
*/
logLinkedDatasetQueryUserEmail?: boolean | null;
/**
* Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
*/
name?: string | null;
/**
* Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
*/
primaryContact?: string | null;
/**
* Optional. Details of the publisher who owns the listing and who can share the source data.
*/
publisher?: Schema$Publisher;
/**
* Pub/Sub topic source.
*/
pubsubTopic?: Schema$PubSubTopicSource;
/**
* Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
*/
requestAccess?: string | null;
/**
* Output only. Listing shared asset type.
*/
resourceType?: string | null;
/**
* Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.
*/
restrictedExportConfig?: Schema$RestrictedExportConfig;
/**
* Output only. Current state of the listing.
*/
state?: string | null;
/**
* Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset.
*/
storedProcedureConfig?: Schema$StoredProcedureConfig;
}
/**
* Message for response to the list of Listings.
*/
export interface Schema$ListListingsResponse {
/**
* The list of Listing.
*/
listings?: Schema$Listing[];
/**
* A token to request the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Message for response to listing data exchanges in an organization and location.
*/
export interface Schema$ListOrgDataExchangesResponse {
/**
* The list of data exchanges.
*/
dataExchanges?: Schema$DataExchange[];
/**
* A token to request the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Message for response to the list of QueryTemplates.
*/
export interface Schema$ListQueryTemplatesResponse {
/**
* A token to request the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of QueryTemplates.
*/
queryTemplates?: Schema$QueryTemplate[];
}
/**
* Message for response to the listing of shared resource subscriptions.
*/
export interface Schema$ListSharedResourceSubscriptionsResponse {
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* The list of subscriptions.
*/
sharedResourceSubscriptions?: Schema$Subscription[];
}
/**
* Message for response to the listing of subscriptions.
*/
export interface Schema$ListSubscriptionsResponse {
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* The list of subscriptions.
*/
subscriptions?: Schema$Subscription[];
}
/**
* All supported message transforms types.
*/
export interface Schema$MessageTransform {
/**
* Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to.
*/
aiInference?: Schema$AIInference;
/**
* 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;
}
/**
* 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;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
don