1. class
  2. Google
  3. \
  4. Service
  5. \
  6. AnalyticsHub
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsDataExchanges

ProjectsLocationsDataExchanges

class ProjectsLocationsDataExchanges extends Resource (View source)

The "dataExchanges" collection of methods.

Typical usage is:

 $analyticshubService = new Google\Service\AnalyticsHub(...);
 $dataExchanges = $analyticshubService->projects_locations_dataExchanges;

Methods

DataExchange
create(string $parent, DataExchange $postBody, array $optParams = [])

Creates a new data exchange. (dataExchanges.create)

AnalyticshubEmpty
delete(string $name, array $optParams = [])

Deletes an existing data exchange. (dataExchanges.delete)

DataExchange
get(string $name, array $optParams = [])

Gets the details of a data exchange. (dataExchanges.get)

Policy
getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the IAM policy. (dataExchanges.getIamPolicy)

ListDataExchangesResponse
listProjectsLocationsDataExchanges(string $parent, array $optParams = [])

Lists all data exchanges in a given project and location.

ListSharedResourceSubscriptionsResponse
listSubscriptions(string $resource, array $optParams = [])

Lists all subscriptions on a given Data Exchange or Listing.

DataExchange
patch(string $name, DataExchange $postBody, array $optParams = [])

Updates an existing data exchange. (dataExchanges.patch)

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the IAM policy. (dataExchanges.setIamPolicy)

Operation
subscribe(string $name, SubscribeDataExchangeRequest $postBody, array $optParams = [])

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. (dataExchanges.subscribe)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns the permissions that a caller has. (dataExchanges.testIamPermissions)

Details

at line 57
DataExchange create(string $parent, DataExchange $postBody, array $optParams = [])

Creates a new data exchange. (dataExchanges.create)

Parameters

string $parent

Required. The parent resource path of the data exchange. e.g. projects/myproject/locations/US.
DataExchange $postBody
array $optParams

Optional parameters.

Return Value

DataExchange

Exceptions

Exception

at line 73
AnalyticshubEmpty delete(string $name, array $optParams = [])

Deletes an existing data exchange. (dataExchanges.delete)

Parameters

string $name

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

Optional parameters.

Return Value

AnalyticshubEmpty

Exceptions

Exception

at line 88
DataExchange get(string $name, array $optParams = [])

Gets the details of a data exchange. (dataExchanges.get)

Parameters

string $name

Required. The resource name of the data exchange. e.g. projects/myproject/locations/US/dataExchanges/123.
array $optParams

Optional parameters.

Return Value

DataExchange

Exceptions

Exception

at line 106
Policy getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the IAM policy. (dataExchanges.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
GetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 128
ListDataExchangesResponse listProjectsLocationsDataExchanges(string $parent, array $optParams = [])

Lists all data exchanges in a given project and location.

(dataExchanges.listProjectsLocationsDataExchanges)

Parameters

string $parent

Required. The parent resource path of the data exchanges. e.g. projects/myproject/locations/US.
array $optParams

Optional parameters.

Return Value

ListDataExchangesResponse

Exceptions

Exception

at line 152
ListSharedResourceSubscriptionsResponse listSubscriptions(string $resource, array $optParams = [])

Lists all subscriptions on a given Data Exchange or Listing.

(dataExchanges.listSubscriptions)

Parameters

string $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
array $optParams

Optional parameters.

Return Value

ListSharedResourceSubscriptionsResponse

Exceptions

Exception

at line 172
DataExchange patch(string $name, DataExchange $postBody, array $optParams = [])

Updates an existing data exchange. (dataExchanges.patch)

Parameters

string $name

Output only. The resource name of the data exchange. e.g. projects/myproject/locations/US/dataExchanges/123.
DataExchange $postBody
array $optParams

Optional parameters.

Return Value

DataExchange

Exceptions

Exception

at line 190
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the IAM policy. (dataExchanges.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 207
Operation subscribe(string $name, SubscribeDataExchangeRequest $postBody, array $optParams = [])

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. (dataExchanges.subscribe)

Parameters

string $name

Required. Resource name of the Data Exchange. e.g. projects/publisherproject/locations/US/dataExchanges/123
SubscribeDataExchangeRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 225
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns the permissions that a caller has. (dataExchanges.testIamPermissions)

Parameters

string $resource

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

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception