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

ProjectsLocationsSubscriptions

class ProjectsLocationsSubscriptions extends Resource (View source)

The "subscriptions" collection of methods.

Typical usage is:

 $analyticshubService = new Google\Service\AnalyticsHub(...);
 $subscriptions = $analyticshubService->projects_locations_subscriptions;

Methods

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

Deletes a subscription. (subscriptions.delete)

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

Gets the details of a Subscription. (subscriptions.get)

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

Gets the IAM policy. (subscriptions.getIamPolicy)

ListSubscriptionsResponse
listProjectsLocationsSubscriptions(string $parent, array $optParams = [])

Lists all subscriptions in a given project and location.

Operation
refresh(string $name, RefreshSubscriptionRequest $postBody, array $optParams = [])

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. (subscriptions.refresh)

RevokeSubscriptionResponse
revoke(string $name, RevokeSubscriptionRequest $postBody, array $optParams = [])

Revokes a given subscription. (subscriptions.revoke)

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

Sets the IAM policy. (subscriptions.setIamPolicy)

Details

at line 49
Operation delete(string $name, array $optParams = [])

Deletes a subscription. (subscriptions.delete)

Parameters

string $name

Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 64
Subscription get(string $name, array $optParams = [])

Gets the details of a Subscription. (subscriptions.get)

Parameters

string $name

Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

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

Gets the IAM policy. (subscriptions.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 111
ListSubscriptionsResponse listProjectsLocationsSubscriptions(string $parent, array $optParams = [])

Lists all subscriptions in a given project and location.

(subscriptions.listProjectsLocationsSubscriptions)

Parameters

string $parent

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

Optional parameters.

Return Value

ListSubscriptionsResponse

Exceptions

Exception

at line 129
Operation refresh(string $name, RefreshSubscriptionRequest $postBody, array $optParams = [])

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. (subscriptions.refresh)

Parameters

string $name

Required. Resource name of the Subscription to refresh. e.g. projects/subscriberproject/locations/US/subscriptions/123
RefreshSubscriptionRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 145
RevokeSubscriptionResponse revoke(string $name, RevokeSubscriptionRequest $postBody, array $optParams = [])

Revokes a given subscription. (subscriptions.revoke)

Parameters

string $name

Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456
RevokeSubscriptionRequest $postBody
array $optParams

Optional parameters.

Return Value

RevokeSubscriptionResponse

Exceptions

Exception

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

Sets the IAM policy. (subscriptions.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