Class PubsubSubscriptionConfig.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- com.hashicorp.cdktf.providers.google.pubsub_subscription.PubsubSubscriptionConfig.Jsii$Proxy
-
- All Implemented Interfaces:
PubsubSubscriptionConfig,com.hashicorp.cdktf.TerraformMetaArguments,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- PubsubSubscriptionConfig
@Stability(Stable) @Internal public static final class PubsubSubscriptionConfig.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements PubsubSubscriptionConfig
An implementation forPubsubSubscriptionConfig
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Nested classes/interfaces inherited from interface com.hashicorp.cdktf.providers.google.pubsub_subscription.PubsubSubscriptionConfig
PubsubSubscriptionConfig.Builder, PubsubSubscriptionConfig.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(PubsubSubscriptionConfig.Builder builder)Constructor that initializes the object based on literal property values passed by thePubsubSubscriptionConfig.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)NumbergetAckDeadlineSeconds()This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.PubsubSubscriptionBigqueryConfiggetBigqueryConfig()bigquery_config block.PubsubSubscriptionCloudStorageConfiggetCloudStorageConfig()cloud_storage_config block.ObjectgetConnection()ObjectgetCount()PubsubSubscriptionDeadLetterPolicygetDeadLetterPolicy()dead_letter_policy block.List<com.hashicorp.cdktf.ITerraformDependable>getDependsOn()ObjectgetEnableExactlyOnceDelivery()If 'true', Pub/Sub provides the following guarantees for the delivery of a message with a given value of messageId on this Subscriptions': - The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.ObjectgetEnableMessageOrdering()If 'true', messages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system.PubsubSubscriptionExpirationPolicygetExpirationPolicy()expiration_policy block.StringgetFilter()The subscription only delivers the messages that match the filter.com.hashicorp.cdktf.ITerraformIteratorgetForEach()StringgetId()Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#id PubsubSubscription#id}.Map<String,String>getLabels()A set of key/value label pairs to assign to this Subscription.com.hashicorp.cdktf.TerraformResourceLifecyclegetLifecycle()StringgetMessageRetentionDuration()How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.StringgetName()Name of the subscription.StringgetProject()Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#project PubsubSubscription#project}.com.hashicorp.cdktf.TerraformProvidergetProvider()List<Object>getProvisioners()PubsubSubscriptionPushConfiggetPushConfig()push_config block.ObjectgetRetainAckedMessages()Indicates whether to retain acknowledged messages.PubsubSubscriptionRetryPolicygetRetryPolicy()retry_policy block.PubsubSubscriptionTimeoutsgetTimeouts()timeouts block.StringgetTopic()A reference to a Topic resource, of the form projects/{project}/topics/{{name}} (as in the id property of a google_pubsub_topic), or just a topic name if the topic is in the same project as the subscription.inthashCode()
-
-
-
Constructor Detail
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
protected Jsii$Proxy(PubsubSubscriptionConfig.Builder builder)
Constructor that initializes the object based on literal property values passed by thePubsubSubscriptionConfig.Builder.
-
-
Method Detail
-
getName
public final String getName()
Description copied from interface:PubsubSubscriptionConfigName of the subscription.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#name PubsubSubscription#name}
- Specified by:
getNamein interfacePubsubSubscriptionConfig
-
getTopic
public final String getTopic()
Description copied from interface:PubsubSubscriptionConfigA reference to a Topic resource, of the form projects/{project}/topics/{{name}} (as in the id property of a google_pubsub_topic), or just a topic name if the topic is in the same project as the subscription.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#topic PubsubSubscription#topic}
- Specified by:
getTopicin interfacePubsubSubscriptionConfig
-
getAckDeadlineSeconds
public final Number getAckDeadlineSeconds()
Description copied from interface:PubsubSubscriptionConfigThis value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call subscriptions.modifyAckDeadline with the corresponding ackId if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#ack_deadline_seconds PubsubSubscription#ack_deadline_seconds}
- Specified by:
getAckDeadlineSecondsin interfacePubsubSubscriptionConfig
-
getBigqueryConfig
public final PubsubSubscriptionBigqueryConfig getBigqueryConfig()
Description copied from interface:PubsubSubscriptionConfigbigquery_config block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#bigquery_config PubsubSubscription#bigquery_config}
- Specified by:
getBigqueryConfigin interfacePubsubSubscriptionConfig
-
getCloudStorageConfig
public final PubsubSubscriptionCloudStorageConfig getCloudStorageConfig()
Description copied from interface:PubsubSubscriptionConfigcloud_storage_config block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#cloud_storage_config PubsubSubscription#cloud_storage_config}
- Specified by:
getCloudStorageConfigin interfacePubsubSubscriptionConfig
-
getDeadLetterPolicy
public final PubsubSubscriptionDeadLetterPolicy getDeadLetterPolicy()
Description copied from interface:PubsubSubscriptionConfigdead_letter_policy block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#dead_letter_policy PubsubSubscription#dead_letter_policy}
- Specified by:
getDeadLetterPolicyin interfacePubsubSubscriptionConfig
-
getEnableExactlyOnceDelivery
public final Object getEnableExactlyOnceDelivery()
Description copied from interface:PubsubSubscriptionConfigIf 'true', Pub/Sub provides the following guarantees for the delivery of a message with a given value of messageId on this Subscriptions': - The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.* An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when 'enable_exactly_once_delivery' is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct messageId values Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#enable_exactly_once_delivery PubsubSubscription#enable_exactly_once_delivery}
- Specified by:
getEnableExactlyOnceDeliveryin interfacePubsubSubscriptionConfig
-
getEnableMessageOrdering
public final Object getEnableMessageOrdering()
Description copied from interface:PubsubSubscriptionConfigIf 'true', messages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system.Otherwise, they may be delivered in any order. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#enable_message_ordering PubsubSubscription#enable_message_ordering}
- Specified by:
getEnableMessageOrderingin interfacePubsubSubscriptionConfig
-
getExpirationPolicy
public final PubsubSubscriptionExpirationPolicy getExpirationPolicy()
Description copied from interface:PubsubSubscriptionConfigexpiration_policy block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#expiration_policy PubsubSubscription#expiration_policy}
- Specified by:
getExpirationPolicyin interfacePubsubSubscriptionConfig
-
getFilter
public final String getFilter()
Description copied from interface:PubsubSubscriptionConfigThe subscription only delivers the messages that match the filter.Pub/Sub automatically acknowledges the messages that don't match the filter. You can filter messages by their attributes. The maximum length of a filter is 256 bytes. After creating the subscription, you can't modify the filter. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#filter PubsubSubscription#filter}
- Specified by:
getFilterin interfacePubsubSubscriptionConfig
-
getId
public final String getId()
Description copied from interface:PubsubSubscriptionConfigDocs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#id PubsubSubscription#id}.Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
- Specified by:
getIdin interfacePubsubSubscriptionConfig
-
getLabels
public final Map<String,String> getLabels()
Description copied from interface:PubsubSubscriptionConfigA set of key/value label pairs to assign to this Subscription.**Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#labels PubsubSubscription#labels}
- Specified by:
getLabelsin interfacePubsubSubscriptionConfig
-
getMessageRetentionDuration
public final String getMessageRetentionDuration()
Description copied from interface:PubsubSubscriptionConfigHow long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.If retain_acked_messages is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a subscriptions.seek can be done. Defaults to 7 days. Cannot be more than 7 days ('"604800s"') or less than 10 minutes ('"600s"'). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: '"600.5s"'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#message_retention_duration PubsubSubscription#message_retention_duration}
- Specified by:
getMessageRetentionDurationin interfacePubsubSubscriptionConfig
-
getProject
public final String getProject()
Description copied from interface:PubsubSubscriptionConfigDocs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#project PubsubSubscription#project}.- Specified by:
getProjectin interfacePubsubSubscriptionConfig
-
getPushConfig
public final PubsubSubscriptionPushConfig getPushConfig()
Description copied from interface:PubsubSubscriptionConfigpush_config block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#push_config PubsubSubscription#push_config}
- Specified by:
getPushConfigin interfacePubsubSubscriptionConfig
-
getRetainAckedMessages
public final Object getRetainAckedMessages()
Description copied from interface:PubsubSubscriptionConfigIndicates whether to retain acknowledged messages.If 'true', then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the messageRetentionDuration window. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#retain_acked_messages PubsubSubscription#retain_acked_messages}
- Specified by:
getRetainAckedMessagesin interfacePubsubSubscriptionConfig
-
getRetryPolicy
public final PubsubSubscriptionRetryPolicy getRetryPolicy()
Description copied from interface:PubsubSubscriptionConfigretry_policy block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#retry_policy PubsubSubscription#retry_policy}
- Specified by:
getRetryPolicyin interfacePubsubSubscriptionConfig
-
getTimeouts
public final PubsubSubscriptionTimeouts getTimeouts()
Description copied from interface:PubsubSubscriptionConfigtimeouts block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#timeouts PubsubSubscription#timeouts}
- Specified by:
getTimeoutsin interfacePubsubSubscriptionConfig
-
getConnection
public final Object getConnection()
- Specified by:
getConnectionin interfacecom.hashicorp.cdktf.TerraformMetaArguments
-
getCount
public final Object getCount()
- Specified by:
getCountin interfacecom.hashicorp.cdktf.TerraformMetaArguments
-
getDependsOn
public final List<com.hashicorp.cdktf.ITerraformDependable> getDependsOn()
- Specified by:
getDependsOnin interfacecom.hashicorp.cdktf.TerraformMetaArguments
-
getForEach
public final com.hashicorp.cdktf.ITerraformIterator getForEach()
- Specified by:
getForEachin interfacecom.hashicorp.cdktf.TerraformMetaArguments
-
getLifecycle
public final com.hashicorp.cdktf.TerraformResourceLifecycle getLifecycle()
- Specified by:
getLifecyclein interfacecom.hashicorp.cdktf.TerraformMetaArguments
-
getProvider
public final com.hashicorp.cdktf.TerraformProvider getProvider()
- Specified by:
getProviderin interfacecom.hashicorp.cdktf.TerraformMetaArguments
-
getProvisioners
public final List<Object> getProvisioners()
- Specified by:
getProvisionersin interfacecom.hashicorp.cdktf.TerraformMetaArguments
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-