Google Workspace Events V1 API - Class Google::Apps::Events::Subscriptions::V1::Subscription (v0.1.1)

Reference documentation and code samples for the Google Workspace Events V1 API class Google::Apps::Events::Subscriptions::V1::Subscription.

A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the Google Workspace Events API overview.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#authority

def authority() -> ::String
Returns
  • (::String) — Output only. The user who authorized the creation of the subscription.

    Format: users/{user}

    For Google Workspace users, the {user} value is the user.id field from the Directory API.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
Returns
  • (::String) — Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.

#event_types

def event_types() -> ::Array<::String>
Returns
  • (::Array<::String>) — Required. Immutable. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification.

    The supported event types depend on the target resource of your subscription. For details, see Supported Google Workspace events.

    By default, you also receive events about the lifecycle of your subscription. You don't need to specify lifecycle events for this field.

    If you specify an event type that doesn't exist for the target resource, the request returns an HTTP 400 Bad Request status code.

#event_types=

def event_types=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Required. Immutable. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification.

    The supported event types depend on the target resource of your subscription. For details, see Supported Google Workspace events.

    By default, you also receive events about the lifecycle of your subscription. You don't need to specify lifecycle events for this field.

    If you specify an event type that doesn't exist for the target resource, the request returns an HTTP 400 Bad Request status code.

Returns
  • (::Array<::String>) — Required. Immutable. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification.

    The supported event types depend on the target resource of your subscription. For details, see Supported Google Workspace events.

    By default, you also receive events about the lifecycle of your subscription. You don't need to specify lifecycle events for this field.

    If you specify an event type that doesn't exist for the target resource, the request returns an HTTP 400 Bad Request status code.

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.

#expire_time=

def expire_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
Returns
  • (::Google::Protobuf::Timestamp) — Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.

#name

def name() -> ::String
Returns
  • (::String) — Optional. Immutable. Identifier. Resource name of the subscription.

    Format: subscriptions/{subscription}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Optional. Immutable. Identifier. Resource name of the subscription.

    Format: subscriptions/{subscription}

Returns
  • (::String) — Optional. Immutable. Identifier. Resource name of the subscription.

    Format: subscriptions/{subscription}

#notification_endpoint

def notification_endpoint() -> ::Google::Apps::Events::Subscriptions::V1::NotificationEndpoint
Returns

#notification_endpoint=

def notification_endpoint=(value) -> ::Google::Apps::Events::Subscriptions::V1::NotificationEndpoint
Parameter
Returns

#payload_options

def payload_options() -> ::Google::Apps::Events::Subscriptions::V1::PayloadOptions
Returns

#payload_options=

def payload_options=(value) -> ::Google::Apps::Events::Subscriptions::V1::PayloadOptions
Parameter
Returns

#reconciling

def reconciling() -> ::Boolean
Returns
  • (::Boolean) — Output only. If true, the subscription is in the process of being updated.

#state

def state() -> ::Google::Apps::Events::Subscriptions::V1::Subscription::State
Returns

#suspension_reason

def suspension_reason() -> ::Google::Apps::Events::Subscriptions::V1::Subscription::ErrorType
Returns

#target_resource

def target_resource() -> ::String
Returns
  • (::String) — Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the full resource name. To learn about target resources and the events that they support, see Supported Google Workspace events.

    A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an ALREADY_EXISTS error.

#target_resource=

def target_resource=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the full resource name. To learn about target resources and the events that they support, see Supported Google Workspace events.

    A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an ALREADY_EXISTS error.

Returns
  • (::String) — Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the full resource name. To learn about target resources and the events that they support, see Supported Google Workspace events.

    A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an ALREADY_EXISTS error.

#ttl

def ttl() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to 0, uses the maximum possible duration.

#ttl=

def ttl=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to 0, uses the maximum possible duration.
Returns
  • (::Google::Protobuf::Duration) — Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to 0, uses the maximum possible duration.

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. System-assigned unique identifier for the subscription.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns