Skip to main content

subscriptions

Creates, updates, deletes, gets or lists a subscriptions resource.

Overview

Namesubscriptions
TypeResource
Idgoogle.analyticshub.subscriptions

Fields

NameDatatypeDescription
namestringOutput only. The resource name of the subscription. e.g. projects/myproject/locations/US/subscriptions/123.
creationTimestringOutput only. Timestamp when the subscription was created.
dataExchangestringOutput only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
lastModifyTimestringOutput only. Timestamp when the subscription was last modified.
linkedDatasetMapobjectOutput 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.
linkedResourcesarrayOutput only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.
listingstringOutput only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
organizationDisplayNamestringOutput only. Display name of the project of this subscription.
organizationIdstringOutput only. Organization of the project this subscription belongs to.
resourceTypestringOutput only. Listing shared asset type.
statestringOutput only. Current state of the subscription.
subscriberContactstringOutput only. Email of the subscriber.

Methods

NameAccessible byRequired ParamsDescription
projects_locations_subscriptions_getSELECTlocationsId, projectsId, subscriptionsIdGets the details of a Subscription.
projects_locations_subscriptions_listSELECTlocationsId, projectsIdLists all subscriptions in a given project and location.
projects_locations_subscriptions_deleteDELETElocationsId, projectsId, subscriptionsIdDeletes a subscription.
projects_locations_subscriptions_refreshEXEClocationsId, projectsId, subscriptionsIdRefreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.
projects_locations_subscriptions_revokeEXEClocationsId, projectsId, subscriptionsIdRevokes a given subscription.

SELECT examples

Lists all subscriptions in a given project and location.

SELECT
name,
creationTime,
dataExchange,
lastModifyTime,
linkedDatasetMap,
linkedResources,
listing,
organizationDisplayName,
organizationId,
resourceType,
state,
subscriberContact
FROM google.analyticshub.subscriptions
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified subscriptions resource.

/*+ delete */
DELETE FROM google.analyticshub.subscriptions
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND subscriptionsId = '{{ subscriptionsId }}';