REST Resource: admin.projects.locations.subscriptions

Resource: Subscription

Metadata about a subscription resource.

JSON representation
{
  "name": string,
  "topic": string,
  "deliveryConfig": {
    object (DeliveryConfig)
  }
}
Fields
name

string

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscriptionId}

topic

string

The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topicId}

deliveryConfig

object (DeliveryConfig)

The settings for this subscription's message delivery.

DeliveryConfig

The settings for a subscription's message delivery.

JSON representation
{
  "deliveryRequirement": enum (DeliveryRequirement)
}
Fields
deliveryRequirement

enum (DeliveryRequirement)

The DeliveryRequirement for this subscription.

DeliveryRequirement

When this subscription should send messages to subscribers relative to messages persistence in storage. For details, see Creating Lite subscriptions.

Enums
DELIVERY_REQUIREMENT_UNSPECIFIED Default value. This value is unused.
DELIVER_IMMEDIATELY The server does not wait for a published message to be successfully written to storage before delivering it to subscribers.
DELIVER_AFTER_STORED The server will not deliver a published message to subscribers until the message has been successfully written to storage. This will result in higher end-to-end latency, but consistent delivery.

Methods

create

Creates a new subscription.

delete

Deletes the specified subscription.

get

Returns the subscription configuration.

list

Returns the list of subscriptions for the given project.

patch

Updates properties of the specified subscription.