2022-05-06
▼ ▲ analyticshub.organizations.locations.dataExchanges.list
Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/dataExchanges
Description: Lists all data exchanges from projects in a given organization and location.
HTTP Method: GET
Scopes:
Path: v1beta1/{+organization}/dataExchanges
Parameter Order: organization
Parameters:
organization
Description: Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`.
Required: Yes
Location: path
Pattern: ^organizations/[^/]+/locations/[^/]+$
Type: string
pageSize
Format: int32
Type: integer
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.
pageToken
Location: query
Type: string
Description: Page token, returned by a previous call, to request the next page of results.
▼ ▲ analyticshub.projects.locations.list
Flat Path: v1beta1/projects/{projectsId}/locations
Parameter Order: name
Parameters:
pageToken
Location: query
Type: string
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
pageSize
Location: query
Type: integer
Format: int32
Description: The maximum number of results to return. If not set, the service selects a default.
filter
Type: string
Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location: query
name
Description: The resource that owns the locations collection, if applicable.
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Type: string
Description: Lists information about the supported locations for this service.
Scopes:
Path: v1beta1/{+name}/locations
HTTP Method: GET
▼ ▲ analyticshub.projects.locations.get
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Resource name for the location.
Location: path
Type: string
Parameter Order: name
Description: Gets information about a location.
Path: v1beta1/{+name}
HTTP Method: GET
Scopes:
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.getIamPolicy
HTTP Method: POST
Scopes:
Parameters:
resource
Type: string
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Path: v1beta1/{+resource}:getIamPolicy
Parameter Order: resource
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:getIamPolicy
Description: Gets the IAM policy.
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.get
Description: Gets the details of a listing.
Scopes:
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Description: Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
Required: Yes
Path: v1beta1/{+name}
Parameter Order: name
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.patch
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}
Parameters:
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.
Format: google-fieldmask
Location: query
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Location: path
Description: Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
Required: Yes
Type: string
Scopes:
HTTP Method: PATCH
Parameter Order: name
Description: Updates an existing listing.
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.subscribe
Scopes:
Path: v1beta1/{+name}:subscribe
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Location: path
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
Type: string
HTTP Method: POST
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.
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:subscribe
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.testIamPermissions
Path: v1beta1/{+resource}:testIamPermissions
Description: Returns the permissions that a caller has.
HTTP Method: POST
Scopes:
Parameters:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Required: Yes
Location: path
Type: string
Parameter Order: resource
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:testIamPermissions
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.delete
Path: v1beta1/{+name}
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Type: string
Location: path
Description: Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
Scopes:
HTTP Method: DELETE
Description: Deletes a listing.
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.setIamPolicy
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:setIamPolicy
Scopes:
Parameter Order: resource
Path: v1beta1/{+resource}:setIamPolicy
Parameters:
resource
Type: string
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$
Location: path
Description: Sets the IAM policy.
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.create
Parameter Order: parent
Path: v1beta1/{+parent}/listings
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings
Parameters:
parent
Description: Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Required: Yes
Location: path
Type: string
listingId
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.
Location: query
HTTP Method: POST
Scopes:
Description: Creates a new listing.
▼ ▲ analyticshub.projects.locations.dataExchanges.listings.list
Description: Lists all listings in a given project and location.
HTTP Method: GET
Scopes:
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings
Path: v1beta1/{+parent}/listings
Parameters:
parent
Location: path
Description: Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Required: Yes
pageToken
Location: query
Type: string
Description: Page token, returned by a previous call, to request the next page of results.
pageSize
Format: int32
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.
Type: integer
Parameter Order: parent
▼ ▲ analyticshub.projects.locations.dataExchanges.delete
Path: v1beta1/{+name}
Scopes:
Parameters:
name
Required: Yes
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
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
HTTP Method: DELETE
Description: Deletes an existing data exchange.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}
Parameter Order: name
▼ ▲ analyticshub.projects.locations.dataExchanges.getIamPolicy
Parameter Order: resource
Scopes:
Path: v1beta1/{+resource}:getIamPolicy
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:getIamPolicy
Description: Gets the IAM policy.
Parameters:
resource
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Type: string
HTTP Method: POST
▼ ▲ analyticshub.projects.locations.dataExchanges.testIamPermissions
Scopes:
HTTP Method: POST
Path: v1beta1/{+resource}:testIamPermissions
Description: Returns the permissions that a caller has.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:testIamPermissions
Parameter Order: resource
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Required: Yes
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Location: path
Type: string
▼ ▲ analyticshub.projects.locations.dataExchanges.patch
Parameter Order: name
HTTP Method: PATCH
Description: Updates an existing data exchange.
Scopes:
Parameters:
name
Description: Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Type: string
Required: Yes
Location: path
updateMask
Type: string
Format: google-fieldmask
Location: query
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.
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}
▼ ▲ analyticshub.projects.locations.dataExchanges.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}
Parameters:
name
Type: string
Description: Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Required: Yes
Location: path
Path: v1beta1/{+name}
Scopes:
Parameter Order: name
HTTP Method: GET
Description: Gets the details of a data exchange.
▼ ▲ analyticshub.projects.locations.dataExchanges.create
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Description: Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`.
Type: string
dataExchangeId
Type: string
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.
Location: query
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges
Description: Creates a new data exchange.
Scopes:
HTTP Method: POST
Path: v1beta1/{+parent}/dataExchanges
Parameter Order: parent
▼ ▲ analyticshub.projects.locations.dataExchanges.list
HTTP Method: GET
Description: Lists all data exchanges in a given project and location.
Scopes:
Parameters:
parent
Description: Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
pageSize
Description: The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
Location: query
Format: int32
Type: integer
pageToken
Location: query
Description: Page token, returned by a previous call, to request the next page of results.
Type: string
Path: v1beta1/{+parent}/dataExchanges
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges
Parameter Order: parent
▼ ▲ analyticshub.projects.locations.dataExchanges.setIamPolicy
Scopes:
Description: Sets the IAM policy.
Path: v1beta1/{+resource}:setIamPolicy
Parameter Order: resource
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:setIamPolicy
Parameters:
resource
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
HTTP Method: POST