Package com.google.apps.events.subscriptions.v1beta

Interface SubscriptionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Subscription, Subscription.Builder
@Generated public interface SubscriptionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasDriveOptions

      boolean hasDriveOptions()
       Optional. Features that are supported only for subscriptions on Drive
 resources.
      .google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the driveOptions field is set.

    • getDriveOptions

      Subscription.DriveOptions getDriveOptions()
       Optional. Features that are supported only for subscriptions on Drive
 resources.
      .google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The driveOptions.

    • getDriveOptionsOrBuilder

      Subscription.DriveOptionsOrBuilder getDriveOptionsOrBuilder()
       Optional. Features that are supported only for subscriptions on Drive
 resources.
      .google.apps.events.subscriptions.v1beta.Subscription.DriveOptions drive_options = 20 [(.google.api.field_behavior) = OPTIONAL];

    • hasExpireTime

      boolean hasExpireTime()
       Non-empty default. The timestamp in UTC when the subscription expires.
 Always displayed on output, regardless of what was used on input.
      .google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];
      Returns:
      Whether the expireTime field is set.

    • getExpireTime

      com.google.protobuf.Timestamp getExpireTime()
       Non-empty default. The timestamp in UTC when the subscription expires.
 Always displayed on output, regardless of what was used on input.
      .google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];
      Returns:
      The expireTime.

    • getExpireTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
       Non-empty default. The timestamp in UTC when the subscription expires.
 Always displayed on output, regardless of what was used on input.
      .google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

    • hasTtl

      boolean hasTtl()
       Input only. The time-to-live (TTL) or duration for the subscription. If
 unspecified or set to `0`, uses the maximum possible duration.
      .google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY];
      Returns:
      Whether the ttl field is set.

    • getTtl

      com.google.protobuf.Duration getTtl()
       Input only. The time-to-live (TTL) or duration for the subscription. If
 unspecified or set to `0`, uses the maximum possible duration.
      .google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY];
      Returns:
      The ttl.

    • getTtlOrBuilder

      com.google.protobuf.DurationOrBuilder getTtlOrBuilder()
       Input only. The time-to-live (TTL) or duration for the subscription. If
 unspecified or set to `0`, uses the maximum possible duration.
      .google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = INPUT_ONLY];

    • getName

      String getName()
       Identifier. Resource name of the subscription.

 Format: `subscriptions/{subscription}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. Resource name of the subscription.

 Format: `subscriptions/{subscription}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • getUid

      String getUid()
       Output only. System-assigned unique identifier for the subscription.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
      Returns:
      The uid.

    • getUidBytes

      com.google.protobuf.ByteString getUidBytes()
       Output only. System-assigned unique identifier for the subscription.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
      Returns:
      The bytes for uid.

    • getTargetResource

      String getTargetResource()
       Required. Immutable. The Google Workspace resource that's monitored for
 events, formatted as the [full resource
 name](https://google.aip.dev/122#full-resource-names). To learn about
 target resources and the events that they support, see [Supported Google
 Workspace
 events](https://developers.google.com/workspace/events#supported-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.
      string target_resource = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The targetResource.

    • getTargetResourceBytes

      com.google.protobuf.ByteString getTargetResourceBytes()
       Required. Immutable. The Google Workspace resource that's monitored for
 events, formatted as the [full resource
 name](https://google.aip.dev/122#full-resource-names). To learn about
 target resources and the events that they support, see [Supported Google
 Workspace
 events](https://developers.google.com/workspace/events#supported-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.
      string target_resource = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for targetResource.

    • getEventTypesList

      List<String> getEventTypesList()
       Required. 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](https://developers.google.com/workspace/events/guides#supported-events).

 By default, you also receive events about the [lifecycle of your
 subscription](https://developers.google.com/workspace/events/guides/events-lifecycle).
 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.
      repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];
      Returns:
      A list containing the eventTypes.

    • getEventTypesCount

      int getEventTypesCount()
       Required. 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](https://developers.google.com/workspace/events/guides#supported-events).

 By default, you also receive events about the [lifecycle of your
 subscription](https://developers.google.com/workspace/events/guides/events-lifecycle).
 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.
      repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];
      Returns:
      The count of eventTypes.

    • getEventTypes

      String getEventTypes(int index)
       Required. 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](https://developers.google.com/workspace/events/guides#supported-events).

 By default, you also receive events about the [lifecycle of your
 subscription](https://developers.google.com/workspace/events/guides/events-lifecycle).
 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.
      repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];
      Parameters:
      index - The index of the element to return.
      Returns:
      The eventTypes at the given index.

    • getEventTypesBytes

      com.google.protobuf.ByteString getEventTypesBytes(int index)
       Required. 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](https://developers.google.com/workspace/events/guides#supported-events).

 By default, you also receive events about the [lifecycle of your
 subscription](https://developers.google.com/workspace/events/guides/events-lifecycle).
 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.
      repeated string event_types = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the eventTypes at the given index.

    • hasPayloadOptions

      boolean hasPayloadOptions()
       Optional. Options about what data to include in the event payload. Only
 supported for Google Chat events.
      .google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the payloadOptions field is set.

    • getPayloadOptions

      PayloadOptions getPayloadOptions()
       Optional. Options about what data to include in the event payload. Only
 supported for Google Chat events.
      .google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The payloadOptions.

    • getPayloadOptionsOrBuilder

      PayloadOptionsOrBuilder getPayloadOptionsOrBuilder()
       Optional. Options about what data to include in the event payload. Only
 supported for Google Chat events.
      .google.apps.events.subscriptions.v1beta.PayloadOptions payload_options = 6 [(.google.api.field_behavior) = OPTIONAL];

    • hasNotificationEndpoint

      boolean hasNotificationEndpoint()
       Required. Immutable. The endpoint where the subscription delivers events,
 such as a Pub/Sub topic.
      .google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the notificationEndpoint field is set.

    • getNotificationEndpoint

      NotificationEndpoint getNotificationEndpoint()
       Required. Immutable. The endpoint where the subscription delivers events,
 such as a Pub/Sub topic.
      .google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The notificationEndpoint.

    • getNotificationEndpointOrBuilder

      NotificationEndpointOrBuilder getNotificationEndpointOrBuilder()
       Required. Immutable. The endpoint where the subscription delivers events,
 such as a Pub/Sub topic.
      .google.apps.events.subscriptions.v1beta.NotificationEndpoint notification_endpoint = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

    • getStateValue

      int getStateValue()
       Output only. The state of the subscription. Determines whether the
 subscription can receive events and deliver them to the notification
 endpoint.
      .google.apps.events.subscriptions.v1beta.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Subscription.State getState()
       Output only. The state of the subscription. Determines whether the
 subscription can receive events and deliver them to the notification
 endpoint.
      .google.apps.events.subscriptions.v1beta.Subscription.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • getSuspensionReasonValue

      int getSuspensionReasonValue()
       Output only. The error that suspended the subscription.

 To reactivate the subscription, resolve the error and call the
 [`ReactivateSubscription`][google.apps.events.subscriptions.v1beta.SubscriptionsService.ReactivateSubscription]
 method.
      .google.apps.events.subscriptions.v1beta.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for suspensionReason.

    • getSuspensionReason

      Subscription.ErrorType getSuspensionReason()
       Output only. The error that suspended the subscription.

 To reactivate the subscription, resolve the error and call the
 [`ReactivateSubscription`][google.apps.events.subscriptions.v1beta.SubscriptionsService.ReactivateSubscription]
 method.
      .google.apps.events.subscriptions.v1beta.Subscription.ErrorType suspension_reason = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The suspensionReason.

    • getAuthority

      String getAuthority()
       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`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids)
 field from the Directory API.
      string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The authority.

    • getAuthorityBytes

      com.google.protobuf.ByteString getAuthorityBytes()
       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`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids)
 field from the Directory API.
      string authority = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for authority.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time when the subscription is created.
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The time when the subscription is created.
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time when the subscription is created.
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The last time that the subscription is updated.
      .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The last time that the subscription is updated.
      .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The last time that the subscription is updated.
      .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getReconciling

      boolean getReconciling()
       Output only. If `true`, the subscription is in the process of being
 updated.
      bool reconciling = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The reconciling.

    • getEtag

      String getEtag()
       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.
      string etag = 17 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The etag.

    • getEtagBytes

      com.google.protobuf.ByteString getEtagBytes()
       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.
      string etag = 17 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for etag.

    • getSubscriptionOptionsCase

      Subscription.SubscriptionOptionsCase getSubscriptionOptionsCase()

    • getExpirationCase

      Subscription.ExpirationCase getExpirationCase()