Get desktop application:
View/edit binary Protocol Buffers messages
The `AnalyticsHubService` API facilitates data sharing within and across organizations. It allows data providers to publish listings that reference shared datasets. With Analytics Hub, users can discover and search for listings that they have access to. Subscribers can view and subscribe to listings. When you subscribe to a listing, Analytics Hub creates a linked dataset in your project.
Lists all data exchanges in a given project and location.
Message for requesting the list of data exchanges.
Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`.
The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
Page token, returned by a previous call, to request the next page of results.
Message for response to the list of data exchanges.
The list of data exchanges.
A token to request the next page of results.
Lists all data exchanges from projects in a given organization and location.
Message for requesting the list of data exchanges from projects in an organization and location.
Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`.
The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
Page token, returned by a previous call, to request the next page of results.
Message for response to listing data exchanges in an organization and location.
The list of data exchanges.
A token to request the next page of results.
Gets the details of a data exchange.
Message for getting a data exchange.
Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
Creates a new data exchange.
Message for creating a data exchange.
Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`.
Required. The ID of the data exchange. Must contain only ASCII letters, numbers (0-9), underscores (_). Max length: 100 bytes.
Required. The data exchange to create.
Updates an existing data exchange.
Message for updating a data exchange.
Required. Field mask specifies the fields to update in the data exchange resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
Required. The data exchange to update.
Deletes an existing data exchange.
Message for deleting a data exchange.
Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`.
Lists all listings in a given project and location.
Message for requesting the list of listings.
Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.
The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
Page token, returned by a previous call, to request the next page of results.
Message for response to the list of Listings.
The list of Listing.
A token to request the next page of results.
Gets the details of a listing.
Message for getting a listing.
Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
Creates a new listing.
Message for creating a listing.
Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.
Required. The ID of the listing to create. Must contain only ASCII letters, numbers (0-9), underscores (_). Max length: 100 bytes.
Required. The listing to create.
Updates an existing listing.
Message for updating a Listing.
Required. Field mask specifies the fields to update in the listing resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
Required. The listing to update.
Deletes a listing.
Message for deleting a listing.
Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.
Message for subscribing to a listing.
Resulting destination of the listing that you subscribed to.
Input only. BigQuery destination dataset to create for the subscriber.
Input only. Destination Pub/Sub subscription to create for the subscriber.
Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
Message for response when you subscribe to a listing.
Subscription object created from this subscribe action.
Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets.
Message for subscribing to a Data Exchange.
Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123`
Required. The parent resource path of the Subscription. e.g. `projects/subscriberproject/locations/US`
Optional. BigQuery destination dataset to create for the subscriber.
Required. Name of the subscription to create. e.g. `subscription1`
Email of the subscriber.
Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.
Message for refreshing a subscription.
Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123`
Gets the details of a Subscription.
Message for getting a subscription.
Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456
Lists all subscriptions in a given project and location.
Message for listing subscriptions.
Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US
An expression for filtering the results of the request. Eligible fields for filtering are: * `listing` * `data_exchange` Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above. In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters: * data_exchange="projects/myproject/locations/us/dataExchanges/123" * listing="projects/123/locations/us/dataExchanges/456/listings/789" * "projects/myproject/locations/us/dataExchanges/123"
The maximum number of results to return in a single response page.
Page token, returned by a previous call.
Message for response to the listing of subscriptions.
The list of subscriptions.
Next page token.
Lists all subscriptions on a given Data Exchange or Listing.
Message for listing subscriptions of a shared resource.
Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789
If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
The maximum number of results to return in a single response page.
Page token, returned by a previous call.
Message for response to the listing of shared resource subscriptions.
The list of subscriptions.
Next page token.
Revokes a given subscription.
Message for revoking a subscription.
Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456
Message for response when you revoke a subscription. Empty for now.
(message has no fields)
Deletes a subscription.
Message for deleting a subscription.
Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456
Gets the IAM policy.
Sets the IAM policy.
Returns the permissions that a caller has.
Configuration for a BigQuery subscription.
Used in:
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
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.
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.
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.
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.
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.
Configuration for a Cloud Storage subscription.
Used in:
Defaults to text format.
Optional. If set, message data will be written to Cloud Storage in text format.
Optional. If set, message data will be written to Cloud Storage in Avro format.
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).
Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).
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 "/".
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).
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.
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.
Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
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.
Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.
Used in:
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.
Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.
Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline.
Used in:
(message has no fields)
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.
Used as response type in: AnalyticsHubService.CreateDataExchange, AnalyticsHubService.GetDataExchange, AnalyticsHubService.UpdateDataExchange
Used as field type in:
, , ,Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
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.
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.
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
Optional. Documentation describing the data exchange.
Output only. Number of listings contained in the data exchange.
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.
Optional. Configurable data sharing environment option for a data exchange.
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.
Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled. Publishers can view the logged email of the subscriber.
Contains details of the data provider.
Used in:
Optional. Name of the data provider.
Optional. Email or URL of the data provider. Max Length: 1000 bytes.
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.
Used in:
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.
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.
Defines the destination bigquery dataset.
Used in:
,Required. A reference that identifies the destination dataset.
Optional. A descriptive name for the dataset.
Optional. A user-friendly description of the dataset.
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.
Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
Used in:
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.
Required. The ID of the project containing this dataset.
Defines the destination Pub/Sub subscription.
Used in:
Required. Destination Pub/Sub subscription resource.
Specifies the type of discovery on the discovery page. Note that this does not control the visibility of the exchange/listing which is defined by IAM permission.
Used in:
,Unspecified. Defaults to DISCOVERY_TYPE_PRIVATE.
The Data exchange/listing can be discovered in the 'Private' results list.
The Data exchange/listing can be discovered in the 'Public' results list.
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
Used in:
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.
User-defined JavaScript function that can transform or filter a Pub/Sub message.
Used in:
Required. Name of the JavasScript function that should applied to Pub/Sub messages.
Required. JavaScript code that contains a function `function_name` with the below signature: ``` /** * Transforms a Pub/Sub message. * @return {(Object<string, (string | Object<string, string>)>|null)} - To * filter a message, return `null`. To transform a message return a map * with the following keys: * - (required) 'data' : {string} * - (optional) 'attributes' : {Object<string, string>} * Returning empty `attributes` will remove all attributes from the * message. * * @param {(Object<string, (string | Object<string, string>)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * - (required) 'attributes' : {Object<string, string>} * * @param {Object<string, any>} 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 <function_name>(message, metadata) { } ```
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.
Used as response type in: AnalyticsHubService.CreateListing, AnalyticsHubService.GetListing, AnalyticsHubService.UpdateListing
Used as field type in:
, ,Listing source.
Shared dataset i.e. BigQuery dataset source.
Pub/Sub topic source.
Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
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.
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.
Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
Optional. Documentation describing the listing.
Output only. Current state of the listing.
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.
Optional. Details of the data provider who owns the source data.
Optional. Categories of the listing. Up to two categories are allowed.
Optional. Details of the publisher who owns the listing and who can share the source data.
Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.
Optional. Type of discovery of the listing on the discovery page.
Output only. Listing shared asset type.
Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
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.
Used in:
Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`
Optional. Resource in this dataset that is selectively shared. This field is required for data clean room exchanges.
Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.
Restricted export policy used to configure restricted export on linked dataset.
Used in:
Optional. If true, enable restricted export.
Optional. If true, restrict direct table access (read api/tabledata.list) on linked table.
Optional. If true, restrict export of query result derived from restricted linked dataset table.
Resource in this dataset that is selectively shared.
Used in:
Optional. Format: For table: `projects/{projectId}/datasets/{datasetId}/tables/{tableId}` Example:"projects/test_project/datasets/test_dataset/tables/test_table"
Listing categories.
Used in:
Pub/Sub topic source.
Used in:
Required. Resource name of the Pub/Sub topic source for this listing. e.g. projects/myproject/topics/topicId
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.
Restricted export config, used to configure restricted export on linked dataset.
Used in:
Optional. If true, enable restricted export.
Output only. If true, restrict direct table access(read api/tabledata.list) on linked table.
Optional. If true, restrict export of query result derived from restricted linked dataset table.
State of the listing.
Used in:
Default value. This value is unused.
Subscribable state. Users with dataexchange.listings.subscribe permission can subscribe to this listing.
All supported message transforms types.
Used in:
The type of transform to apply to messages.
Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`.
Optional. This field is deprecated, use the `disabled` field to disable transforms.
Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.
Represents the metadata of a long-running operation in Analytics Hub.
Output only. The time the operation was created.
Output only. The time the operation finished running.
Output only. Server-defined resource path for the target of the operation.
Output only. Name of the verb executed by the operation.
Output only. Human-readable status of the operation, if any.
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
Output only. API version used to start the operation.
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.
Used in:
Required. Name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.
Optional. If push delivery is used with this subscription, this field is used to configure it.
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
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.
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.
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.
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
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.
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.
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.
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.
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.
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.
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.
Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified.
Contains details of the listing publisher.
Used in:
Optional. Name of the listing publisher.
Optional. Email or URL of the listing publisher. Max Length: 1000 bytes.
Configuration for a push delivery endpoint.
Used in:
An authentication method used by push endpoints to verify the source of push requests. This can be used with push endpoints that are private by default to allow requests only from the Pub/Sub system, for example. This field is optional and should be set only by users interested in authenticated push.
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.
The format of the delivered message to the push endpoint is defined by the chosen wrapper. When unset, `PubsubWrapper` is used.
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).
Optional. When set, the payload to the push endpoint is not wrapped.
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use `https://example.com/push`.
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" }`
Sets the `data` field as the HTTP body for delivery.
Used in:
Optional. When true, writes the Pub/Sub message metadata to `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request.
Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).
Used in:
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).
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.
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).
Used in:
(message has no fields)
Message for response when you refresh a subscription.
The refreshed subscription resource.
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 acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.
Used in:
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
The underlying shared asset type shared in a listing by a publisher.
Used in:
,Not specified.
BigQuery Dataset Asset.
Pub/Sub Topic Asset.
Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange.
Used in:
Default Analytics Hub data exchange, used for secured data sharing.
Data Clean Room (DCR), used for privacy-safe and secured data sharing.
Data Clean Room (DCR), used for privacy-safe and secured data sharing.
Used in:
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.
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.
Default Analytics Hub data exchange, used for secured data sharing.
Used in:
(message has no fields)
Message for response when you subscribe to a Data Exchange.
Subscription object created from this subscribe action.
A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.
Used as response type in: AnalyticsHubService.GetSubscription
Used as field type in:
, , , ,Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
Output only. Timestamp when the subscription was created.
Output only. Timestamp when the subscription was last modified.
Output only. Organization of the project this subscription belongs to.
Output only. Display name of the project of this subscription.
Output only. Current state of the subscription.
Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
Output only. Email of the subscriber.
Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.
Output only. Listing shared asset type.
Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
Reference to a linked resource tracked by this Subscription.
Used in:
Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
Output only. Listing for which linked resource is created.
State of the subscription.
Used in:
Default value. This value is unused.
This subscription is active and the data is accessible.
The data referenced by this subscription is out of date and should be refreshed. This can happen when a data provider adds or removes datasets.
This subscription has been cancelled or revoked and the data is no longer accessible.