2022-09-20
▼ ▲ analyticshub.organizations.locations.dataExchanges.list
Scopes :
Parameter Order : organization
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/dataExchanges
Description : Lists all data exchanges from projects in a given organization and location.
HTTP Method : GET
Parameters :
pageToken
Description : Page token, returned by a previous call, to request the next page of results.
Type : string
Location : query
organization
Type : string
Required : Yes
Location : path
Description : Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`.
Pattern : ^organizations/[^/]+/locations/[^/]+$
pageSize
Type : integer
Location : query
Format : int32
Description : The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
Path : v1/{+organization}/dataExchanges
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.subscribe
Description : Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.
Scopes :
HTTP Method : POST
Path : v1/{+name}:subscribe
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:subscribe
Parameter Order : name
Parameters :
name
Type : string
Description : Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.getIamPolicy
Parameters :
resource
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Required : Yes
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Path : v1/{+resource}:getIamPolicy
HTTP Method : POST
Description : Gets the IAM policy.
Scopes :
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:getIamPolicy
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.get
Parameter Order : name
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Description : Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}
HTTP Method : GET
Scopes :
Description : Gets the details of a listing.
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.setIamPolicy
Parameters :
resource
Required : Yes
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
HTTP Method : POST
Description : Sets the IAM policy.
Path : v1/{+resource}:setIamPolicy
Scopes :
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:setIamPolicy
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.delete
HTTP Method : DELETE
Description : Deletes a listing.
Path : v1/{+name}
Scopes :
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Description : Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
Type : string
Required : Yes
Location : path
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.create
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings
Description : Creates a new listing.
Path : v1/{+parent}/listings
HTTP Method : POST
Parameters :
parent
Location : path
Description : Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
listingId
Location : query
Type : string
Description : Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.
Scopes :
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.list
Parameter Order : parent
Description : Lists all listings in a given project and location.
Path : v1/{+parent}/listings
Scopes :
HTTP Method : GET
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Type : string
Description : Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.
Location : path
pageSize
Location : query
Format : int32
Description : The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
Type : integer
pageToken
Description : Page token, returned by a previous call, to request the next page of results.
Location : query
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.testIamPermissions
HTTP Method : POST
Path : v1/{+resource}:testIamPermissions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:testIamPermissions
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Description : Returns the permissions that a caller has.
Parameter Order : resource
Scopes :
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.patch
Path : v1/{+name}
Scopes :
HTTP Method : PATCH
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}
Parameter Order : name
Description : Updates an existing listing.
Parameters :
name
Description : Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Type : string
Required : Yes
updateMask
Description : Required. Field mask specifies the fields to update in the listing resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
Type : string
Format : google-fieldmask
Location : query
▼ ▲ analyticshub.projects.locations.dataExchanges.get
Description : Gets the details of a data exchange.
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}
Scopes :
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Description : Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
▼ ▲ analyticshub.projects.locations.dataExchanges.testIamPermissions
Description : Returns the permissions that a caller has.
Scopes :
Parameter Order : resource
HTTP Method : POST
Path : v1/{+resource}:testIamPermissions
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Type : string
Location : path
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:testIamPermissions
▼ ▲ analyticshub.projects.locations.dataExchanges.setIamPolicy
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Location : path
Type : string
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
HTTP Method : POST
Path : v1/{+resource}:setIamPolicy
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:setIamPolicy
Description : Sets the IAM policy.
Scopes :
▼ ▲ analyticshub.projects.locations.dataExchanges.patch
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Required : Yes
Description : Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
updateMask
Description : Required. Field mask specifies the fields to update in the data exchange resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
Location : query
Format : google-fieldmask
Type : string
Description : Updates an existing data exchange.
HTTP Method : PATCH
Parameter Order : name
Path : v1/{+name}
▼ ▲ analyticshub.projects.locations.dataExchanges.getIamPolicy
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:getIamPolicy
Parameter Order : resource
Parameters :
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Required : Yes
Type : string
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Path : v1/{+resource}:getIamPolicy
Description : Gets the IAM policy.
Scopes :
▼ ▲ analyticshub.projects.locations.dataExchanges.delete
Path : v1/{+name}
HTTP Method : DELETE
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Description : Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`.
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}
Description : Deletes an existing data exchange.
Scopes :
▼ ▲ analyticshub.projects.locations.dataExchanges.list
Path : v1/{+parent}/dataExchanges
Parameters :
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`.
Location : path
pageSize
Location : query
Description : The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
Format : int32
Type : integer
pageToken
Location : query
Description : Page token, returned by a previous call, to request the next page of results.
Type : string
HTTP Method : GET
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges
Description : Lists all data exchanges in a given project and location.
Scopes :
▼ ▲ analyticshub.projects.locations.dataExchanges.create
Parameter Order : parent
Parameters :
dataExchangeId
Description : Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.
Type : string
Location : query
parent
Required : Yes
Type : string
Description : Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
HTTP Method : POST
Path : v1/{+parent}/dataExchanges
Scopes :
Description : Creates a new data exchange.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataExchanges