Google Cloud BigQuery Analytics Hub V1 Client - Class Subscription (0.4.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 Google\Protobuf\Timestamp

Output only. Timestamp when the subscription was created.

↳ last_modify_time Google\Protobuf\Timestamp

Output only. Timestamp when the subscription was last modified.

↳ 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.

getListing

Output only. Resource name of the source Listing.

e.g. projects/123/locations/US/dataExchanges/456/listings/789

Returns
TypeDescription
string

hasListing

setListing

Output only. Resource name of the source Listing.

e.g. projects/123/locations/US/dataExchanges/456/listings/789

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataExchange

Output only. Resource name of the source Data Exchange.

e.g. projects/123/locations/US/dataExchanges/456

Returns
TypeDescription
string

hasDataExchange

setDataExchange

Output only. Resource name of the source Data Exchange.

e.g. projects/123/locations/US/dataExchanges/456

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

Output only. The resource name of the subscription.

e.g. projects/myproject/locations/US/subscriptions/123.

Returns
TypeDescription
string

setName

Output only. The resource name of the subscription.

e.g. projects/myproject/locations/US/subscriptions/123.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreationTime

Output only. Timestamp when the subscription was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreationTime

clearCreationTime

setCreationTime

Output only. Timestamp when the subscription was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLastModifyTime

Output only. Timestamp when the subscription was last modified.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasLastModifyTime

clearLastModifyTime

setLastModifyTime

Output only. Timestamp when the subscription was last modified.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getOrganizationId

Output only. Organization of the project this subscription belongs to.

Returns
TypeDescription
string

setOrganizationId

Output only. Organization of the project this subscription belongs to.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrganizationDisplayName

Output only. Display name of the project of this subscription.

Returns
TypeDescription
string

setOrganizationDisplayName

Output only. Display name of the project of this subscription.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. Current state of the subscription.

Returns
TypeDescription
int

setState

Output only. Current state of the subscription.

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

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.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getSubscriberContact

Output only. Email of the subscriber.

Returns
TypeDescription
string

setSubscriberContact

Output only. Email of the subscriber.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getResourceName

Returns
TypeDescription
string