Google Apps Events Subscriptions V1beta Client - Class UpdateSubscriptionRequest (0.4.1)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Google Apps Events Subscriptions V1beta Client class UpdateSubscriptionRequest.
The request message for SubscriptionsService.UpdateSubscription.
Generated from protobuf message google.apps.events.subscriptions.v1beta.UpdateSubscriptionRequest
Namespace
Google \ Apps \ Events \ Subscriptions \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ subscription |
Subscription
Required. The subscription to update. The subscription's |
↳ update_mask |
Google\Protobuf\FieldMask
Optional. The field to update. If omitted, updates any fields included in the request. You can update one of the following fields in a subscription: * * |
↳ validate_only |
bool
Optional. If set to |
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. The field to update. If omitted, updates any fields included in the request.
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.event_types: The list of event types to receive about the target resource. To fully replace the subscription (the equivalent ofPUT), use*. Any omitted fields are updated with empty values.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasUpdateMask
clearUpdateMask
setUpdateMask
Optional. The field to update. If omitted, updates any fields included in the request.
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.event_types: The list of event types to receive about the target resource. To fully replace the subscription (the equivalent ofPUT), use*. Any omitted fields are updated with empty values.
| 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 |
updateMask |
Google\Protobuf\FieldMask
Optional. The field to update. If omitted, updates any fields included in the request. You can update one of the following fields in a subscription:
To fully replace the subscription (the equivalent of |
| Returns | |
|---|---|
| Type | Description |
UpdateSubscriptionRequest |
|