Class: Google::Apps::Events::Subscriptions::V1beta::UpdateSubscriptionRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/apps/events/subscriptions/v1beta/subscriptions_service.rb

Overview

The request message for SubscriptionsService.UpdateSubscription.

Instance Attribute Summary collapse

Instance Attribute Details

#subscription ⇒ ::Google::Apps::Events::Subscriptions::V1beta::Subscription

Returns Required. The subscription to update.

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

Returns:



106
107
108
109
 
# File 'proto_docs/google/apps/events/subscriptions/v1beta/subscriptions_service.rb', line 106

class UpdateSubscriptionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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 of PUT), use *. Any omitted fields are updated with empty values.

Returns:

  • (::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:

    • 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 of PUT), use *. Any omitted fields are updated with empty values.



106
107
108
109
 
# File 'proto_docs/google/apps/events/subscriptions/v1beta/subscriptions_service.rb', line 106

class UpdateSubscriptionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#validate_only ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



106
107
108
109
 
# File 'proto_docs/google/apps/events/subscriptions/v1beta/subscriptions_service.rb', line 106

class UpdateSubscriptionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end