Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client class RevokeSubscriptionRequest.
Message for revoking a subscription.
Generated from protobuf message google.cloud.bigquery.analyticshub.v1.RevokeSubscriptionRequest
Namespace
Google \ Cloud \ BigQuery \ AnalyticsHub \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Resource name of the subscription to revoke. e.g. projects/123/locations/us/subscriptions/456 |
↳ revoke_commercial |
bool
Optional. If the subscription is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid revoking commercial subscriptions accidentally. |
getName
Required. Resource name of the subscription to revoke.
e.g. projects/123/locations/us/subscriptions/456
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Resource name of the subscription to revoke.
e.g. projects/123/locations/us/subscriptions/456
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRevokeCommercial
Optional. If the subscription is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid revoking commercial subscriptions accidentally.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRevokeCommercial
Optional. If the subscription is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid revoking commercial subscriptions accidentally.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. Resource name of the subscription to revoke. e.g. projects/123/locations/us/subscriptions/456 Please see AnalyticsHubServiceClient::subscriptionName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
RevokeSubscriptionRequest |
|