SubscriptionArgs class
The set of arguments for Subscription. The set of arguments for Subscription.
Constructors
-
SubscriptionArgs({Input<
DeliveryConfig> ? deliveryConfig, Input<ExportConfig> ? exportConfig, Input<String> ? location, Input<String> ? name, Input<String> ? project, Input<bool> ? skipBacklog, required Input<String> subscriptionId, Input<String> ? topic}) -
Creates a new SubscriptionArgs.
deliveryConfigThe settings for this subscription's message delivery.exportConfigIf present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.locationOptional.nameThe name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}projectOptional.skipBacklogIf true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.subscriptionIdRequired. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like:my-sub-name.topicThe name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}const -
SubscriptionArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
deliveryConfig
→ Input<
DeliveryConfig> ? -
The settings for this subscription's message delivery.
final
-
exportConfig
→ Input<
ExportConfig> ? -
If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
location
→ Input<
String> ? -
final
-
name
→ Input<
String> ? -
The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
final
-
project
→ Input<
String> ? -
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
skipBacklog
→ Input<
bool> ? -
If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.
final
-
subscriptionId
→ Input<
String> -
Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like:
my-sub-name.final -
topic
→ Input<
String> ? -
The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited