Analytics Hub v1 API - Class Listing (1.7.0)

public sealed class Listing : IMessage<Listing>, IEquatable<Listing>, IDeepCloneable<Listing>, IBufferMessage, IMessage

Reference documentation and code samples for the Analytics Hub v1 API class 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.

Inheritance

object > Listing

Namespace

Google.Cloud.BigQuery.AnalyticsHub.V1

Assembly

Google.Cloud.BigQuery.AnalyticsHub.V1.dll

Constructors

Listing()

public Listing()

Listing(Listing)

public Listing(Listing other)
Parameter
Name Description
other Listing

Properties

BigqueryDataset

public Listing.Types.BigQueryDatasetSource BigqueryDataset { get; set; }

Required. Shared dataset i.e. BigQuery dataset source.

Property Value
Type Description
ListingTypesBigQueryDatasetSource

Categories

public RepeatedField<Listing.Types.Category> Categories { get; }

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

Property Value
Type Description
RepeatedFieldListingTypesCategory

DataProvider

public DataProvider DataProvider { get; set; }

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

Property Value
Type Description
DataProvider

Description

public string Description { get; set; }

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.

Property Value
Type Description
string

DiscoveryType

public DiscoveryType DiscoveryType { get; set; }

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

Property Value
Type Description
DiscoveryType

DisplayName

public string DisplayName { get; set; }

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.

Property Value
Type Description
string

Documentation

public string Documentation { get; set; }

Optional. Documentation describing the listing.

Property Value
Type Description
string

HasDiscoveryType

public bool HasDiscoveryType { get; }

Gets whether the "discovery_type" field is set

Property Value
Type Description
bool

Icon

public ByteString Icon { get; set; }

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.

Property Value
Type Description
ByteString

ListingName

public ListingName ListingName { get; set; }

ListingName-typed view over the Name resource name property.

Property Value
Type Description
ListingName

Name

public string Name { get; set; }

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

Property Value
Type Description
string

PrimaryContact

public string PrimaryContact { get; set; }

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

Property Value
Type Description
string

Publisher

public Publisher Publisher { get; set; }

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

Property Value
Type Description
Publisher

RequestAccess

public string RequestAccess { get; set; }

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

Property Value
Type Description
string

RestrictedExportConfig

public Listing.Types.RestrictedExportConfig RestrictedExportConfig { get; set; }

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

Property Value
Type Description
ListingTypesRestrictedExportConfig

SourceCase

public Listing.SourceOneofCase SourceCase { get; }
Property Value
Type Description
ListingSourceOneofCase

State

public Listing.Types.State State { get; set; }

Output only. Current state of the listing.

Property Value
Type Description
ListingTypesState