Class Subscription (0.4.8)

Subscription(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
listing str
Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 This field is a member of oneof_ resource_name.
data_exchange str
Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 This field is a member of oneof_ resource_name.
name str
Output only. The resource name of the subscription. e.g. projects/myproject/locations/US/subscriptions/123.
creation_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when the subscription was created.
last_modify_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when the subscription was last modified.
organization_id str
Output only. Organization of the project this subscription belongs to.
organization_display_name str
Output only. Display name of the project of this subscription.
state google.cloud.bigquery_analyticshub_v1.types.Subscription.State
Output only. Current state of the subscription.
linked_dataset_map MutableMapping[str, google.cloud.bigquery_analyticshub_v1.types.Subscription.LinkedResource]
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 str
Output only. Email of the subscriber.

Classes

LinkedDatasetMapEntry

LinkedDatasetMapEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

LinkedResource

LinkedResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Reference to a linked resource tracked by this Subscription.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

State(value)

State of the subscription.

Values: STATE_UNSPECIFIED (0): Default value. This value is unused. STATE_ACTIVE (1): This subscription is active and the data is accessible. STATE_STALE (2): The data referenced by this subscription is out of date and should be refreshed. This can happen when a data provider adds or removes datasets. STATE_INACTIVE (3): This subscription has been cancelled or revoked and the data is no longer accessible.