Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client class Subscription.
A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.
Generated from protobuf message google.cloud.bigquery.analyticshub.v1.Subscription
Namespace
Google \ Cloud \ BigQuery \ AnalyticsHub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ listing
string
Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789
↳ data_exchange
string
Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
↳ name
string
Output only. The resource name of the subscription. e.g. projects/myproject/locations/us/subscriptions/123
.
↳ creation_time
↳ last_modify_time
↳ organization_id
string
Output only. Organization of the project this subscription belongs to.
↳ organization_display_name
string
Output only. Display name of the project of this subscription.
↳ state
int
Output only. Current state of the subscription.
↳ linked_dataset_map
array| Google\Protobuf\Internal\MapField
Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
↳ subscriber_contact
string
Output only. Email of the subscriber.
↳ linked_resources
array< Subscription\LinkedResource
>
Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.
↳ resource_type
int
Output only. Listing shared asset type.
↳ commercial_info
Subscription\CommercialInfo
Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.
↳ log_linked_dataset_query_user_email
bool
Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
↳ destination_dataset
getListing
Output only. Resource name of the source Listing.
e.g. projects/123/locations/us/dataExchanges/456/listings/789
string
hasListing
setListing
Output only. Resource name of the source Listing.
e.g. projects/123/locations/us/dataExchanges/456/listings/789
var
string
$this
getDataExchange
Output only. Resource name of the source Data Exchange.
e.g. projects/123/locations/us/dataExchanges/456
string
hasDataExchange
setDataExchange
Output only. Resource name of the source Data Exchange.
e.g. projects/123/locations/us/dataExchanges/456
var
string
$this
getName
Output only. The resource name of the subscription.
e.g. projects/myproject/locations/us/subscriptions/123
.
string
setName
Output only. The resource name of the subscription.
e.g. projects/myproject/locations/us/subscriptions/123
.
var
string
$this
getCreationTime
Output only. Timestamp when the subscription was created.
hasCreationTime
clearCreationTime
setCreationTime
Output only. Timestamp when the subscription was created.
$this
getLastModifyTime
Output only. Timestamp when the subscription was last modified.
hasLastModifyTime
clearLastModifyTime
setLastModifyTime
Output only. Timestamp when the subscription was last modified.
$this
getOrganizationId
Output only. Organization of the project this subscription belongs to.
string
setOrganizationId
Output only. Organization of the project this subscription belongs to.
var
string
$this
getOrganizationDisplayName
Output only. Display name of the project of this subscription.
string
setOrganizationDisplayName
Output only. Display name of the project of this subscription.
var
string
$this
getState
Output only. Current state of the subscription.
int
setState
Output only. Current state of the subscription.
var
int
$this
getLinkedDatasetMap
Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1.
Only contains values if state == STATE_ACTIVE.
setLinkedDatasetMap
Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1.
Only contains values if state == STATE_ACTIVE.
$this
getSubscriberContact
Output only. Email of the subscriber.
string
setSubscriberContact
Output only. Email of the subscriber.
var
string
$this
getLinkedResources
Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.
setLinkedResources
Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.
$this
getResourceType
Output only. Listing shared asset type.
int
setResourceType
Output only. Listing shared asset type.
var
int
$this
getCommercialInfo
Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.
hasCommercialInfo
clearCommercialInfo
setCommercialInfo
Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.
$this
getLogLinkedDatasetQueryUserEmail
Output only. By default, false.
If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
bool
hasLogLinkedDatasetQueryUserEmail
clearLogLinkedDatasetQueryUserEmail
setLogLinkedDatasetQueryUserEmail
Output only. By default, false.
If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
var
bool
$this
getDestinationDataset
Optional. BigQuery destination dataset to create for the subscriber.
hasDestinationDataset
clearDestinationDataset
setDestinationDataset
Optional. BigQuery destination dataset to create for the subscriber.
$this
getResourceName
string
