AnalyticsHub

import { AnalyticsHub } from "https://googleapis.deno.dev/v1/analyticshub:v1.ts";

Exchange data and analytics assets securely and efficiently.

class AnalyticsHub {

constructor(client?: CredentialsClient, baseUrl?: string);

async organizationsLocationsDataExchangesList(organization: string, opts?: OrganizationsLocationsDataExchangesListOptions): Promise<ListOrgDataExchangesResponse>;

async projectsLocationsDataExchangesCreate(

parent: string,

req: DataExchange,

opts?: ProjectsLocationsDataExchangesCreateOptions,

): Promise<DataExchange>;

async projectsLocationsDataExchangesDelete(name: string): Promise<Empty>;

async projectsLocationsDataExchangesGet(name: string): Promise<DataExchange>;

async projectsLocationsDataExchangesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsDataExchangesList(parent: string, opts?: ProjectsLocationsDataExchangesListOptions): Promise<ListDataExchangesResponse>;

async projectsLocationsDataExchangesListingsCreate(

parent: string,

req: Listing,

opts?: ProjectsLocationsDataExchangesListingsCreateOptions,

): Promise<Listing>;

async projectsLocationsDataExchangesListingsDelete(name: string, opts?: ProjectsLocationsDataExchangesListingsDeleteOptions): Promise<Empty>;

async projectsLocationsDataExchangesListingsGet(name: string): Promise<Listing>;

async projectsLocationsDataExchangesListingsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsDataExchangesListingsList(parent: string, opts?: ProjectsLocationsDataExchangesListingsListOptions): Promise<ListListingsResponse>;

async projectsLocationsDataExchangesListingsListSubscriptions(resource: string, opts?: ProjectsLocationsDataExchangesListingsListSubscriptionsOptions): Promise<ListSharedResourceSubscriptionsResponse>;

async projectsLocationsDataExchangesListingsPatch(

name: string,

req: Listing,

opts?: ProjectsLocationsDataExchangesListingsPatchOptions,

): Promise<Listing>;

async projectsLocationsDataExchangesListingsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsDataExchangesListingsSubscribe(name: string, req: SubscribeListingRequest): Promise<SubscribeListingResponse>;

async projectsLocationsDataExchangesListingsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsDataExchangesListSubscriptions(resource: string, opts?: ProjectsLocationsDataExchangesListSubscriptionsOptions): Promise<ListSharedResourceSubscriptionsResponse>;

async projectsLocationsDataExchangesPatch(

name: string,

req: DataExchange,

opts?: ProjectsLocationsDataExchangesPatchOptions,

): Promise<DataExchange>;

async projectsLocationsDataExchangesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsDataExchangesSubscribe(name: string, req: SubscribeDataExchangeRequest): Promise<Operation>;

async projectsLocationsDataExchangesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsSubscriptionsDelete(name: string): Promise<Operation>;

async projectsLocationsSubscriptionsGet(name: string): Promise<Subscription>;

async projectsLocationsSubscriptionsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsSubscriptionsList(parent: string, opts?: ProjectsLocationsSubscriptionsListOptions): Promise<ListSubscriptionsResponse>;

async projectsLocationsSubscriptionsRefresh(name: string, req: RefreshSubscriptionRequest): Promise<Operation>;

async projectsLocationsSubscriptionsRevoke(name: string, req: RevokeSubscriptionRequest): Promise<RevokeSubscriptionResponse>;

async projectsLocationsSubscriptionsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

}

§Constructors

new AnalyticsHub(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

organizationsLocationsDataExchangesList(organization: string, opts?: OrganizationsLocationsDataExchangesListOptions): Promise<ListOrgDataExchangesResponse>

[src]

Lists all data exchanges from projects in a given organization and location.

@param organization

Required. The organization resource path of the projects containing DataExchanges. e.g. organizations/myorg/locations/us.

projectsLocationsDataExchangesCreate(parent: string, req: DataExchange, opts?: ProjectsLocationsDataExchangesCreateOptions): Promise<DataExchange>

[src]

Creates a new data exchange.

@param parent

Required. The parent resource path of the data exchange. e.g. projects/myproject/locations/us.

projectsLocationsDataExchangesDelete(name: string): Promise<Empty>

[src]

Deletes an existing data exchange.

@param name

Required. The full name of the data exchange resource that you want to delete. For example, projects/myproject/locations/us/dataExchanges/123.

projectsLocationsDataExchangesGet(name: string): Promise<DataExchange>

[src]

Gets the details of a data exchange.

@param name

Required. The resource name of the data exchange. e.g. projects/myproject/locations/us/dataExchanges/123.

projectsLocationsDataExchangesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the IAM policy.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsDataExchangesList(parent: string, opts?: ProjectsLocationsDataExchangesListOptions): Promise<ListDataExchangesResponse>

[src]

Lists all data exchanges in a given project and location.

@param parent

Required. The parent resource path of the data exchanges. e.g. projects/myproject/locations/us.

projectsLocationsDataExchangesListingsCreate(parent: string, req: Listing, opts?: ProjectsLocationsDataExchangesListingsCreateOptions): Promise<Listing>

[src]

Creates a new listing.

@param parent

Required. The parent resource path of the listing. e.g. projects/myproject/locations/us/dataExchanges/123.

projectsLocationsDataExchangesListingsDelete(name: string, opts?: ProjectsLocationsDataExchangesListingsDeleteOptions): Promise<Empty>

[src]

Deletes a listing.

@param name

Required. Resource name of the listing to delete. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.

projectsLocationsDataExchangesListingsGet(name: string): Promise<Listing>

[src]

Gets the details of a listing.

@param name

Required. The resource name of the listing. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.

projectsLocationsDataExchangesListingsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the IAM policy.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsDataExchangesListingsList(parent: string, opts?: ProjectsLocationsDataExchangesListingsListOptions): Promise<ListListingsResponse>

[src]

Lists all listings in a given project and location.

@param parent

Required. The parent resource path of the listing. e.g. projects/myproject/locations/us/dataExchanges/123.

projectsLocationsDataExchangesListingsListSubscriptions(resource: string, opts?: ProjectsLocationsDataExchangesListingsListSubscriptionsOptions): Promise<ListSharedResourceSubscriptionsResponse>

[src]

Lists all subscriptions on a given Data Exchange or Listing.

@param resource

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

projectsLocationsDataExchangesListingsPatch(name: string, req: Listing, opts?: ProjectsLocationsDataExchangesListingsPatchOptions): Promise<Listing>

[src]

Updates an existing listing.

@param name

Output only. The resource name of the listing. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456

projectsLocationsDataExchangesListingsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the IAM policy.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsDataExchangesListingsSubscribe(name: string, req: SubscribeListingRequest): Promise<SubscribeListingResponse>

[src]

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.

@param name

Required. Resource name of the listing that you want to subscribe to. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.

projectsLocationsDataExchangesListingsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

Returns the permissions that a caller has.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsDataExchangesListSubscriptions(resource: string, opts?: ProjectsLocationsDataExchangesListSubscriptionsOptions): Promise<ListSharedResourceSubscriptionsResponse>

[src]

Lists all subscriptions on a given Data Exchange or Listing.

@param resource

projectsLocationsDataExchangesPatch(name: string, req: DataExchange, opts?: ProjectsLocationsDataExchangesPatchOptions): Promise<DataExchange>

[src]

Updates an existing data exchange.

@param name

Output only. The resource name of the data exchange. e.g. projects/myproject/locations/us/dataExchanges/123.

projectsLocationsDataExchangesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the IAM policy.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsDataExchangesSubscribe(name: string, req: SubscribeDataExchangeRequest): Promise<Operation>

[src]

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.

@param name

Required. Resource name of the Data Exchange. e.g. projects/publisherproject/locations/us/dataExchanges/123

projectsLocationsDataExchangesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

Returns the permissions that a caller has.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsSubscriptionsDelete(name: string): Promise<Operation>

[src]

Deletes a subscription.

@param name

Required. Resource name of the subscription to delete. e.g. projects/123/locations/us/subscriptions/456

projectsLocationsSubscriptionsGet(name: string): Promise<Subscription>

[src]

Gets the details of a Subscription.

@param name

Required. Resource name of the subscription. e.g. projects/123/locations/us/subscriptions/456

projectsLocationsSubscriptionsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the IAM policy.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsSubscriptionsList(parent: string, opts?: ProjectsLocationsSubscriptionsListOptions): Promise<ListSubscriptionsResponse>

[src]

Lists all subscriptions in a given project and location.

@param parent

Required. The parent resource path of the subscription. e.g. projects/myproject/locations/us

projectsLocationsSubscriptionsRefresh(name: string, req: RefreshSubscriptionRequest): Promise<Operation>

[src]

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.

@param name

Required. Resource name of the Subscription to refresh. e.g. projects/subscriberproject/locations/us/subscriptions/123

projectsLocationsSubscriptionsRevoke(name: string, req: RevokeSubscriptionRequest): Promise<RevokeSubscriptionResponse>

[src]

Revokes a given subscription.

@param name

Required. Resource name of the subscription to revoke. e.g. projects/123/locations/us/subscriptions/456

projectsLocationsSubscriptionsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the IAM policy.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.