Analytics Hub V1 API - Class Google::Cloud::Bigquery::AnalyticsHub::V1::Listing (v0.4.0)

Reference documentation and code samples for the Analytics Hub V1 API class Google::Cloud::Bigquery::AnalyticsHub::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#bigquery_dataset

def bigquery_dataset() -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource
Returns

#bigquery_dataset=

def bigquery_dataset=(value) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource
Parameter
Returns

#categories

def categories() -> ::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::Category>
Returns

#categories=

def categories=(value) -> ::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::Category>
Parameter
Returns

#data_provider

def data_provider() -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataProvider
Returns

#data_provider=

def data_provider=(value) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataProvider
Parameter
Returns

#description

def description() -> ::String
Returns
  • (::String) — 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.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#display_name

def display_name() -> ::String
Returns
  • (::String) — 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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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

def documentation() -> ::String
Returns
  • (::String) — Optional. Documentation describing the listing.

#documentation=

def documentation=(value) -> ::String
Parameter
  • value (::String) — Optional. Documentation describing the listing.
Returns
  • (::String) — Optional. Documentation describing the listing.

#icon

def icon() -> ::String
Returns
  • (::String) — 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.

#icon=

def icon=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456

#primary_contact

def primary_contact() -> ::String
Returns
  • (::String) — Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.

#primary_contact=

def primary_contact=(value) -> ::String
Parameter
  • value (::String) — Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
Returns
  • (::String) — Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.

#publisher

def publisher() -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Publisher
Returns

#publisher=

def publisher=(value) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Publisher
Parameter
Returns

#request_access

def request_access() -> ::String
Returns
  • (::String) — Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

#request_access=

def request_access=(value) -> ::String
Parameter
  • value (::String) — Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
Returns
  • (::String) — Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

#restricted_export_config

def restricted_export_config() -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::RestrictedExportConfig
Returns

#restricted_export_config=

def restricted_export_config=(value) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::RestrictedExportConfig
Parameter
Returns

#state

def state() -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::State
Returns