2023-08-06
▼ ▲ analyticshub.projects.locations.dataExchanges.subscribe
HTTP Method: POST
Scopes:
Path: v1/{+name}:subscribe
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:subscribe
Parameters:
name
Description: Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123`
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Type: string
Location: path
Required: Yes
Description: Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.
▼ ▲ analyticshub.projects.locations.dataExchanges.listSubscriptions
Path: v1/{+resource}:listSubscriptions
Scopes:
HTTP Method: GET
Description: Lists all subscriptions on a given Data Exchange or Listing.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:listSubscriptions
Parameters:
includeDeletedSubscriptions
Type: boolean
Description: If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
Location: query
pageToken
Type: string
Description: Page token, returned by a previous call.
Location: query
resource
Description: Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Required: Yes
Type: string
Location: path
pageSize
Format: int32
Description: The maximum number of results to return in a single response page.
Location: query
Type: integer
Parameter Order: resource
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.listSubscriptions
HTTP Method: GET
Description: Lists all subscriptions on a given Data Exchange or Listing.
Parameter Order: resource
Parameters:
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Required: Yes
Description: Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789
Location: path
pageToken
Type: string
Description: Page token, returned by a previous call.
Location: query
includeDeletedSubscriptions
Type: boolean
Description: If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
Location: query
pageSize
Format: int32
Type: integer
Location: query
Description: The maximum number of results to return in a single response page.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:listSubscriptions
Scopes:
Path: v1/{+resource}:listSubscriptions
▼ ▲ analyticshub.projects.locations.subscriptions.refresh
Parameter Order: name
Scopes:
HTTP Method: POST
Path: v1/{+name}:refresh
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$
Description: Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123`
Location: path
Type: string
Description: Refreshes 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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}:refresh
▼ ▲ analyticshub.projects.locations.subscriptions.revoke
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$
Description: Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456
Type: string
Location: path
HTTP Method: POST
Path: v1/{+name}:revoke
Parameter Order: name
Description: Revokes a given subscription.
Scopes:
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}:revoke
▼ ▲ analyticshub.projects.locations.subscriptions.list
HTTP Method: GET
Parameters:
pageToken
Type: string
Description: Page token, returned by a previous call.
Location: query
pageSize
Type: integer
Description: The maximum number of results to return in a single response page.
Format: int32
Location: query
filter
Location: query
Description: The filter expression may be used to filter by Data Exchange or Listing.
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US
Location: path
Required: Yes
Scopes:
Parameter Order: parent
Path: v1/{+parent}/subscriptions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/subscriptions
Description: Lists all subscriptions in a given project and location.
▼ ▲ analyticshub.projects.locations.subscriptions.delete
Description: Deletes a subscription.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}
HTTP Method: DELETE
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$
Type: string
Description: Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456
Required: Yes
Location: path
Parameter Order: name
Scopes:
Path: v1/{+name}
▼ ▲ analyticshub.projects.locations.subscriptions.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$
Description: Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456
HTTP Method: GET
Description: Gets the details of a Subscription.
Scopes: