Google Apps Events Subscriptions V1 Client - Class DeleteSubscriptionRequest (0.3.1)

Reference documentation and code samples for the Google Apps Events Subscriptions V1 Client class DeleteSubscriptionRequest.

The request message for SubscriptionsService.DeleteSubscription.

Generated from protobuf message google.apps.events.subscriptions.v1.DeleteSubscriptionRequest

Namespace

Google \ Apps \ Events \ Subscriptions \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. Resource name of the subscription to delete. Format: subscriptions/{subscription}
↳ validate_only bool

Optional. If set to true, validates and previews the request, but doesn't delete the subscription.
↳ allow_missing bool

Optional. If set to true and the subscription isn't found, the request succeeds but doesn't delete the subscription.
↳ etag string

Optional. Etag of the subscription. If present, it must match with the server's etag. Otherwise, request fails with the status ABORTED.

getName

Required. Resource name of the subscription to delete.

Format: subscriptions/{subscription}

Returns
Type Description
string

setName

Required. Resource name of the subscription to delete.

Format: subscriptions/{subscription}

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. If set to true, validates and previews the request, but doesn't delete the subscription.

Returns
Type Description
bool

setValidateOnly

Optional. If set to true, validates and previews the request, but doesn't delete the subscription.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAllowMissing

Optional. If set to true and the subscription isn't found, the request succeeds but doesn't delete the subscription.

Returns
Type Description
bool

setAllowMissing

Optional. If set to true and the subscription isn't found, the request succeeds but doesn't delete the subscription.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEtag

Optional. Etag of the subscription.

If present, it must match with the server's etag. Otherwise, request fails with the status ABORTED.

Returns
Type Description
string

setEtag

Optional. Etag of the subscription.

If present, it must match with the server's etag. Otherwise, request fails with the status ABORTED.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Resource name of the subscription to delete.

Format: subscriptions/{subscription} Please see SubscriptionsServiceClient::subscriptionName() for help formatting this field.
Returns
Type Description
DeleteSubscriptionRequest