Google Apps Events Subscriptions V1 Client - Class UpdateSubscriptionRequest (0.1.4)

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

The request message for SubscriptionsService.UpdateSubscription.

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

Namespace

Google \ Apps \ Events \ Subscriptions \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ subscription`	`Subscription` Required. The subscription to update. The subscription's `name` field is used to identify the subscription to update.
`↳ update_mask`	`Google\Protobuf\FieldMask` Optional. Required. The field to update. You can update one of the following fields in a subscription: * * `expire_time`: The timestamp when the subscription expires. * * `ttl`: The time-to-live (TTL) or duration of the subscription.
`↳ validate_only`	`bool` Optional. If set to `true`, validates and previews the request, but doesn't update the subscription.

getSubscription

Required. The subscription to update.

The subscription's name field is used to identify the subscription to update.

Returns
Type	Description
`Subscription\|null`

hasSubscription

clearSubscription

setSubscription

Required. The subscription to update.

The subscription's name field is used to identify the subscription to update.

Parameter
Name	Description
`var`	`Subscription`

Returns
Type	Description
`$this`

getUpdateMask

Optional. Required. The field to update.

You can update one of the following fields in a subscription:

expire_time: The timestamp when the subscription expires.
ttl: The time-to-live (TTL) or duration of the subscription.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. Required. The field to update.

You can update one of the following fields in a subscription:

expire_time: The timestamp when the subscription expires.
ttl: The time-to-live (TTL) or duration of the subscription.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

getValidateOnly

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

Returns
Type	Description
`bool`

setValidateOnly

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameters

Name Description

subscription

Subscription

Required. The subscription to update.

The subscription's name field is used to identify the subscription to update.

updateMask

Google\Protobuf\FieldMask

Optional. Required. The field to update.

You can update one of the following fields in a subscription:

- expire_time: The timestamp when the subscription expires.
- ttl: The time-to-live (TTL) or duration of the subscription.

Returns
Type	Description
`UpdateSubscriptionRequest`