Listing(mapping=None, *, ignore_unknown_fields=False, **kwargs)
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes | |
---|---|
Name | Description |
bigquery_dataset |
google.cloud.bigquery_analyticshub_v1.types.Listing.BigQueryDatasetSource
Required. Shared dataset i.e. BigQuery dataset source. This field is a member of oneof _ source .
|
name |
str
Output only. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456
|
display_name |
str
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 |
str
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. |
primary_contact |
str
Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. |
documentation |
str
Optional. Documentation describing the listing. |
state |
google.cloud.bigquery_analyticshub_v1.types.Listing.State
Output only. Current state of the listing. |
icon |
bytes
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. |
data_provider |
google.cloud.bigquery_analyticshub_v1.types.DataProvider
Optional. Details of the data provider who owns the source data. |
categories |
MutableSequence[google.cloud.bigquery_analyticshub_v1.types.Listing.Category]
Optional. Categories of the listing. Up to two categories are allowed. |
publisher |
google.cloud.bigquery_analyticshub_v1.types.Publisher
Optional. Details of the publisher who owns the listing and who can share the source data. |
request_access |
str
Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. |
Classes
BigQueryDatasetSource
BigQueryDatasetSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)
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.
Category
Category(value)
Listing categories.
Values: CATEGORY_UNSPECIFIED (0): No description available. CATEGORY_OTHERS (1): No description available. CATEGORY_ADVERTISING_AND_MARKETING (2): No description available. CATEGORY_COMMERCE (3): No description available. CATEGORY_CLIMATE_AND_ENVIRONMENT (4): No description available. CATEGORY_DEMOGRAPHICS (5): No description available. CATEGORY_ECONOMICS (6): No description available. CATEGORY_EDUCATION (7): No description available. CATEGORY_ENERGY (8): No description available. CATEGORY_FINANCIAL (9): No description available. CATEGORY_GAMING (10): No description available. CATEGORY_GEOSPATIAL (11): No description available. CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE (12): No description available. CATEGORY_MEDIA (13): No description available. CATEGORY_PUBLIC_SECTOR (14): No description available. CATEGORY_RETAIL (15): No description available. CATEGORY_SPORTS (16): No description available. CATEGORY_SCIENCE_AND_RESEARCH (17): No description available. CATEGORY_TRANSPORTATION_AND_LOGISTICS (18): No description available. CATEGORY_TRAVEL_AND_TOURISM (19): No description available.
State
State(value)
State of the listing.
Values: STATE_UNSPECIFIED (0): Default value. This value is unused. ACTIVE (1): Subscribable state. Users with dataexchange.listings.subscribe permission can subscribe to this listing.