Listing

import type { Listing } from "https://googleapis.deno.dev/v1/analyticshub:v1.ts";

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.

interface Listing {

allowOnlyMetadataSharing?: boolean;

bigqueryDataset?: BigQueryDatasetSource;

categories?:

| "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"

| "CATEGORY_GOOGLE_EARTH_ENGINE"[];

readonly commercialInfo?: GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfo;

dataProvider?: DataProvider;

description?: string;

discoveryType?: "DISCOVERY_TYPE_UNSPECIFIED" | "DISCOVERY_TYPE_PRIVATE" | "DISCOVERY_TYPE_PUBLIC";

displayName?: string;

documentation?: string;

icon?: Uint8Array;

logLinkedDatasetQueryUserEmail?: boolean;

readonly name?: string;

primaryContact?: string;

publisher?: Publisher;

pubsubTopic?: PubSubTopicSource;

requestAccess?: string;

readonly resourceType?: "SHARED_RESOURCE_TYPE_UNSPECIFIED" | "BIGQUERY_DATASET" | "PUBSUB_TOPIC";

restrictedExportConfig?: RestrictedExportConfig;

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE";

}

§Properties

allowOnlyMetadataSharing?: boolean

[src]

Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.

bigqueryDataset?: BigQueryDatasetSource

[src]

Shared dataset i.e. BigQuery dataset source.

[src]

Optional. Categories of the listing. Up to five categories are allowed.

readonly commercialInfo?: GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfo

[src]

Output only. Commercial info contains the information about the commercial data products associated with the listing.

dataProvider?: DataProvider

[src]

Optional. Details of the data provider who owns the source data.

description?: string

[src]

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.

discoveryType?: "DISCOVERY_TYPE_UNSPECIFIED" | "DISCOVERY_TYPE_PRIVATE" | "DISCOVERY_TYPE_PUBLIC"

[src]

Optional. Type of discovery of the listing on the discovery page.

displayName?: string

[src]

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.

documentation?: string

[src]

Optional. Documentation describing the listing.

icon?: Uint8Array

[src]

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.

logLinkedDatasetQueryUserEmail?: boolean

[src]

Optional. By default, false. If true, the Listing has an email sharing mandate enabled.

readonly name?: string

[src]

Output only. The resource name of the listing. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456

primaryContact?: string

[src]

Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.

publisher?: Publisher

[src]

Optional. Details of the publisher who owns the listing and who can share the source data.

pubsubTopic?: PubSubTopicSource

[src]

Pub/Sub topic source.

requestAccess?: string

[src]

Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

readonly resourceType?: "SHARED_RESOURCE_TYPE_UNSPECIFIED" | "BIGQUERY_DATASET" | "PUBSUB_TOPIC"

[src]

Output only. Listing shared asset type.

restrictedExportConfig?: RestrictedExportConfig

[src]

Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE"

[src]

Output only. Current state of the listing.