- Resource: Listing
- BigQueryDatasetSource
- SelectedResource
- RestrictedExportPolicy
- PubSubTopicSource
- State
- DataProvider
- Category
- Publisher
- RestrictedExportConfig
- Methods
Resource: Listing
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.
JSON representation |
---|
{ "name": string, "displayName": string, "description": string, "primaryContact": string, "documentation": string, "state": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the listing. e.g. |
displayName |
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. |
description |
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. |
primaryContact |
Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. |
documentation |
Optional. Documentation describing the listing. |
state |
Output only. Current state of the listing. |
icon |
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. A base64-encoded string. |
dataProvider |
Optional. Details of the data provider who owns the source data. |
categories[] |
Optional. Categories of the listing. Up to two categories are allowed. |
publisher |
Optional. Details of the publisher who owns the listing and who can share the source data. |
requestAccess |
Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. |
restrictedExportConfig |
Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset. |
resourceType |
Output only. Listing shared asset type. |
Union field source . Listing source. source can be only one of the following: |
|
bigqueryDataset |
Required. Shared dataset i.e. BigQuery dataset source. |
pubsubTopic |
Required. Pub/Sub topic source. |
discoveryType |
Optional. Type of discovery of the listing on the discovery page. |
BigQueryDatasetSource
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.
JSON representation |
---|
{ "dataset": string, "selectedResources": [ { object ( |
Fields | |
---|---|
dataset |
Resource name of the dataset source for this listing. e.g. |
selectedResources[] |
Optional. Resource in this dataset that is selectively shared. This field is required for data clean room exchanges. |
restrictedExportPolicy |
Optional. If set, restricted export policy will be propagated and enforced on the linked dataset. |
SelectedResource
Resource in this dataset that is selectively shared.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
table |
Optional. Format: For table: |
RestrictedExportPolicy
Restricted export policy used to configure restricted export on linked dataset.
JSON representation |
---|
{ "enabled": boolean, "restrictDirectTableAccess": boolean, "restrictQueryResult": boolean } |
Fields | |
---|---|
enabled |
Optional. If true, enable restricted export. |
restrictDirectTableAccess |
Optional. If true, restrict direct table access (read api/tabledata.list) on linked table. |
restrictQueryResult |
Optional. If true, restrict export of query result derived from restricted linked dataset table. |
PubSubTopicSource
Pub/Sub topic source.
JSON representation |
---|
{ "topic": string, "dataAffinityRegions": [ string ] } |
Fields | |
---|---|
topic |
Required. Resource name of the Pub/Sub topic source for this listing. e.g. projects/myproject/topics/topicId |
dataAffinityRegions[] |
Optional. Region hint on where the data might be published. Data affinity regions are modifiable. See go/regions for full listing of possible Cloud regions. |
State
State of the listing.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
ACTIVE |
Subscribable state. Users with dataexchange.listings.subscribe permission can subscribe to this listing. |
DataProvider
Contains details of the data provider.
JSON representation |
---|
{ "name": string, "primaryContact": string } |
Fields | |
---|---|
name |
Optional. Name of the data provider. |
primaryContact |
Optional. Email or URL of the data provider. Max Length: 1000 bytes. |
Category
Listing categories.
Enums | |
---|---|
CATEGORY_UNSPECIFIED |
|
CATEGORY_OTHERS |
|
CATEGORY_ADVERTISING_AND_MARKETING |
|
CATEGORY_COMMERCE |
|
CATEGORY_CLIMATE_AND_ENVIRONMENT |
|
CATEGORY_DEMOGRAPHICS |
|
CATEGORY_ECONOMICS |
|
CATEGORY_EDUCATION |
|
CATEGORY_ENERGY |
|
CATEGORY_FINANCIAL |
|
CATEGORY_GAMING |
|
CATEGORY_GEOSPATIAL |
|
CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE |
|
CATEGORY_MEDIA |
|
CATEGORY_PUBLIC_SECTOR |
|
CATEGORY_RETAIL |
|
CATEGORY_SPORTS |
|
CATEGORY_SCIENCE_AND_RESEARCH |
|
CATEGORY_TRANSPORTATION_AND_LOGISTICS |
|
CATEGORY_TRAVEL_AND_TOURISM |
Publisher
Contains details of the listing publisher.
JSON representation |
---|
{ "name": string, "primaryContact": string } |
Fields | |
---|---|
name |
Optional. Name of the listing publisher. |
primaryContact |
Optional. Email or URL of the listing publisher. Max Length: 1000 bytes. |
RestrictedExportConfig
Restricted export config, used to configure restricted export on linked dataset.
JSON representation |
---|
{ "enabled": boolean, "restrictDirectTableAccess": boolean, "restrictQueryResult": boolean } |
Fields | |
---|---|
enabled |
Optional. If true, enable restricted export. |
restrictDirectTableAccess |
Output only. If true, restrict direct table access(read api/tabledata.list) on linked table. |
restrictQueryResult |
Optional. If true, restrict export of query result derived from restricted linked dataset table. |
Methods |
|
---|---|
|
Creates a new listing. |
|
Deletes a listing. |
|
Gets the details of a listing. |
|
Gets the IAM policy. |
|
Lists all listings in a given project and location. |
|
Lists all subscriptions on a given Data Exchange or Listing. |
|
Updates an existing listing. |
|
Sets the IAM policy. |
|
Subscribes to a listing. |
|
Returns the permissions that a caller has. |