Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client 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.
Generated from protobuf message google.cloud.bigquery.analyticshub.v1.Listing
Namespace
Google \ Cloud \ BigQuery \ AnalyticsHub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ bigquery_dataset
↳ pubsub_topic
↳ name
string
Output only. The resource name of the listing. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456
↳ display_name
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.
↳ description
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.
↳ primary_contact
string
Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
↳ documentation
string
Optional. Documentation describing the listing.
↳ state
int
Output only. Current state of the listing.
↳ icon
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.
↳ data_provider
↳ categories
array
Optional. Categories of the listing. Up to two categories are allowed.
↳ publisher
Publisher
Optional. Details of the publisher who owns the listing and who can share the source data.
↳ request_access
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
Listing\RestrictedExportConfig
Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.
↳ discovery_type
int
Optional. Type of discovery of the listing on the discovery page.
↳ resource_type
int
Output only. Listing shared asset type.
↳ commercial_info
Listing\CommercialInfo
Output only. Commercial info contains the information about the commercial data products associated with the listing.
↳ log_linked_dataset_query_user_email
bool
Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
↳ allow_only_metadata_sharing
bool
Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.
getBigqueryDataset
Shared dataset i.e. BigQuery dataset source.
hasBigqueryDataset
setBigqueryDataset
Shared dataset i.e. BigQuery dataset source.
$this
getPubsubTopic
Pub/Sub topic source.
hasPubsubTopic
setPubsubTopic
Pub/Sub topic source.
$this
getName
Output only. The resource name of the listing.
e.g. projects/myproject/locations/us/dataExchanges/123/listings/456
string
setName
Output only. The resource name of the listing.
e.g. projects/myproject/locations/us/dataExchanges/123/listings/456
var
string
$this
getDisplayName
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.
string
setDisplayName
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.
var
string
$this
getDescription
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.
string
setDescription
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.
var
string
$this
getPrimaryContact
Optional. Email or URL of the primary point of contact of the listing.
Max Length: 1000 bytes.
string
setPrimaryContact
Optional. Email or URL of the primary point of contact of the listing.
Max Length: 1000 bytes.
var
string
$this
getDocumentation
Optional. Documentation describing the listing.
string
setDocumentation
Optional. Documentation describing the listing.
var
string
$this
getState
Output only. Current state of the listing.
int
setState
Output only. Current state of the listing.
var
int
$this
getIcon
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.
string
setIcon
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.
var
string
$this
getDataProvider
Optional. Details of the data provider who owns the source data.
hasDataProvider
clearDataProvider
setDataProvider
Optional. Details of the data provider who owns the source data.
$this
getCategories
Optional. Categories of the listing. Up to two categories are allowed.
setCategories
Optional. Categories of the listing. Up to two categories are allowed.
var
int[]
$this
getPublisher
Optional. Details of the publisher who owns the listing and who can share the source data.
hasPublisher
clearPublisher
setPublisher
Optional. Details of the publisher who owns the listing and who can share the source data.
$this
getRequestAccess
Optional. Email or URL of the request access of the listing.
Subscribers can use this reference to request access. Max Length: 1000 bytes.
string
setRequestAccess
Optional. Email or URL of the request access of the listing.
Subscribers can use this reference to request access. Max Length: 1000 bytes.
var
string
$this
getRestrictedExportConfig
Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.
hasRestrictedExportConfig
clearRestrictedExportConfig
setRestrictedExportConfig
Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.
$this
getDiscoveryType
Optional. Type of discovery of the listing on the discovery page.
int
hasDiscoveryType
clearDiscoveryType
setDiscoveryType
Optional. Type of discovery of the listing on the discovery page.
var
int
$this
getResourceType
Output only. Listing shared asset type.
int
setResourceType
Output only. Listing shared asset type.
var
int
$this
getCommercialInfo
Output only. Commercial info contains the information about the commercial data products associated with the listing.
hasCommercialInfo
clearCommercialInfo
setCommercialInfo
Output only. Commercial info contains the information about the commercial data products associated with the listing.
$this
getLogLinkedDatasetQueryUserEmail
Optional. By default, false.
If true, the Listing has an email sharing mandate enabled.
bool
hasLogLinkedDatasetQueryUserEmail
clearLogLinkedDatasetQueryUserEmail
setLogLinkedDatasetQueryUserEmail
Optional. By default, false.
If true, the Listing has an email sharing mandate enabled.
var
bool
$this
getAllowOnlyMetadataSharing
Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.
bool
hasAllowOnlyMetadataSharing
clearAllowOnlyMetadataSharing
setAllowOnlyMetadataSharing
Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.
var
bool
$this
getSource
string
