Package com.hashicorp.cdktf.providers.google.pubsub_subscription

Class PubsubSubscription

  • All Implemented Interfaces:
    com.hashicorp.cdktf.IInterpolatingParent, com.hashicorp.cdktf.ITerraformAddressable, com.hashicorp.cdktf.ITerraformDependable, com.hashicorp.cdktf.ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.475Z")
@Stability(Stable)
public class PubsubSubscription
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription google_pubsub_subscription}.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • PubsubSubscription

        protected PubsubSubscription​(software.amazon.jsii.JsiiObjectRef objRef)

      • PubsubSubscription

        protected PubsubSubscription​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • PubsubSubscription

        @Stability(Stable)
public PubsubSubscription​(@NotNull
                          software.constructs.Construct scope,
                          @NotNull
                          String id,
                          @NotNull
                          PubsubSubscriptionConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription google_pubsub_subscription} Resource.

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        config - This parameter is required.

    • Method Detail

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId,
                                                                             @Nullable
                                                                             com.hashicorp.cdktf.TerraformProvider provider)
        Generates CDKTF code for importing a PubsubSubscription resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the PubsubSubscription to import. This parameter is required.
        importFromId - The id of the existing PubsubSubscription that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the PubsubSubscription to import is found.

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId)
        Generates CDKTF code for importing a PubsubSubscription resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the PubsubSubscription to import. This parameter is required.
        importFromId - The id of the existing PubsubSubscription that should be imported. This parameter is required.

      • putBigqueryConfig

        @Stability(Stable)
public void putBigqueryConfig​(@NotNull
                              PubsubSubscriptionBigqueryConfig value)
        Parameters:
        value - This parameter is required.

      • putCloudStorageConfig

        @Stability(Stable)
public void putCloudStorageConfig​(@NotNull
                                  PubsubSubscriptionCloudStorageConfig value)
        Parameters:
        value - This parameter is required.

      • putDeadLetterPolicy

        @Stability(Stable)
public void putDeadLetterPolicy​(@NotNull
                                PubsubSubscriptionDeadLetterPolicy value)
        Parameters:
        value - This parameter is required.

      • putExpirationPolicy

        @Stability(Stable)
public void putExpirationPolicy​(@NotNull
                                PubsubSubscriptionExpirationPolicy value)
        Parameters:
        value - This parameter is required.

      • putPushConfig

        @Stability(Stable)
public void putPushConfig​(@NotNull
                          PubsubSubscriptionPushConfig value)
        Parameters:
        value - This parameter is required.

      • putRetryPolicy

        @Stability(Stable)
public void putRetryPolicy​(@NotNull
                           PubsubSubscriptionRetryPolicy value)
        Parameters:
        value - This parameter is required.

      • putTimeouts

        @Stability(Stable)
public void putTimeouts​(@NotNull
                        PubsubSubscriptionTimeouts value)
        Parameters:
        value - This parameter is required.

      • resetAckDeadlineSeconds

        @Stability(Stable)
public void resetAckDeadlineSeconds()

      • resetBigqueryConfig

        @Stability(Stable)
public void resetBigqueryConfig()

      • resetCloudStorageConfig

        @Stability(Stable)
public void resetCloudStorageConfig()

      • resetDeadLetterPolicy

        @Stability(Stable)
public void resetDeadLetterPolicy()

      • resetEnableExactlyOnceDelivery

        @Stability(Stable)
public void resetEnableExactlyOnceDelivery()

      • resetEnableMessageOrdering

        @Stability(Stable)
public void resetEnableMessageOrdering()

      • resetExpirationPolicy

        @Stability(Stable)
public void resetExpirationPolicy()

      • resetFilter

        @Stability(Stable)
public void resetFilter()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetLabels

        @Stability(Stable)
public void resetLabels()

      • resetMessageRetentionDuration

        @Stability(Stable)
public void resetMessageRetentionDuration()

      • resetProject

        @Stability(Stable)
public void resetProject()

      • resetPushConfig

        @Stability(Stable)
public void resetPushConfig()

      • resetRetainAckedMessages

        @Stability(Stable)
public void resetRetainAckedMessages()

      • resetRetryPolicy

        @Stability(Stable)
public void resetRetryPolicy()

      • resetTimeouts

        @Stability(Stable)
public void resetTimeouts()

      • synthesizeAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeAttributes()
        Overrides:
        synthesizeAttributes in class com.hashicorp.cdktf.TerraformResource

      • synthesizeHclAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeHclAttributes()
        Overrides:
        synthesizeHclAttributes in class com.hashicorp.cdktf.TerraformResource

      • getEffectiveLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getEffectiveLabels()

      • getTerraformLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getTerraformLabels()

      • getAckDeadlineSecondsInput

        @Stability(Stable)
@Nullable
public Number getAckDeadlineSecondsInput()

      • getEnableExactlyOnceDeliveryInput

        @Stability(Stable)
@Nullable
public Object getEnableExactlyOnceDeliveryInput()

      • getEnableMessageOrderingInput

        @Stability(Stable)
@Nullable
public Object getEnableMessageOrderingInput()

      • getFilterInput

        @Stability(Stable)
@Nullable
public String getFilterInput()

      • getIdInput

        @Stability(Stable)
@Nullable
public String getIdInput()

      • getLabelsInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getLabelsInput()

      • getMessageRetentionDurationInput

        @Stability(Stable)
@Nullable
public String getMessageRetentionDurationInput()

      • getNameInput

        @Stability(Stable)
@Nullable
public String getNameInput()

      • getProjectInput

        @Stability(Stable)
@Nullable
public String getProjectInput()

      • getRetainAckedMessagesInput

        @Stability(Stable)
@Nullable
public Object getRetainAckedMessagesInput()

      • getTimeoutsInput

        @Stability(Stable)
@Nullable
public Object getTimeoutsInput()

      • getTopicInput

        @Stability(Stable)
@Nullable
public String getTopicInput()

      • getAckDeadlineSeconds

        @Stability(Stable)
@NotNull
public Number getAckDeadlineSeconds()

      • setAckDeadlineSeconds

        @Stability(Stable)
public void setAckDeadlineSeconds​(@NotNull
                                  Number value)

      • getEnableExactlyOnceDelivery

        @Stability(Stable)
@NotNull
public Object getEnableExactlyOnceDelivery()

      • setEnableExactlyOnceDelivery

        @Stability(Stable)
public void setEnableExactlyOnceDelivery​(@NotNull
                                         Boolean value)

      • setEnableExactlyOnceDelivery

        @Stability(Stable)
public void setEnableExactlyOnceDelivery​(@NotNull
                                         com.hashicorp.cdktf.IResolvable value)

      • getEnableMessageOrdering

        @Stability(Stable)
@NotNull
public Object getEnableMessageOrdering()

      • setEnableMessageOrdering

        @Stability(Stable)
public void setEnableMessageOrdering​(@NotNull
                                     Boolean value)

      • setEnableMessageOrdering

        @Stability(Stable)
public void setEnableMessageOrdering​(@NotNull
                                     com.hashicorp.cdktf.IResolvable value)

      • getFilter

        @Stability(Stable)
@NotNull
public String getFilter()

      • setFilter

        @Stability(Stable)
public void setFilter​(@NotNull
                      String value)

      • getId

        @Stability(Stable)
@NotNull
public String getId()

      • setId

        @Stability(Stable)
public void setId​(@NotNull
                  String value)

      • getLabels

        @Stability(Stable)
@NotNull
public Map<String,​String> getLabels()

      • setLabels

        @Stability(Stable)
public void setLabels​(@NotNull
                      Map<String,​String> value)

      • getMessageRetentionDuration

        @Stability(Stable)
@NotNull
public String getMessageRetentionDuration()

      • setMessageRetentionDuration

        @Stability(Stable)
public void setMessageRetentionDuration​(@NotNull
                                        String value)

      • getName

        @Stability(Stable)
@NotNull
public String getName()

      • setName

        @Stability(Stable)
public void setName​(@NotNull
                    String value)

      • getProject

        @Stability(Stable)
@NotNull
public String getProject()

      • setProject

        @Stability(Stable)
public void setProject​(@NotNull
                       String value)

      • getRetainAckedMessages

        @Stability(Stable)
@NotNull
public Object getRetainAckedMessages()

      • setRetainAckedMessages

        @Stability(Stable)
public void setRetainAckedMessages​(@NotNull
                                   Boolean value)

      • setRetainAckedMessages

        @Stability(Stable)
public void setRetainAckedMessages​(@NotNull
                                   com.hashicorp.cdktf.IResolvable value)

      • getTopic

        @Stability(Stable)
@NotNull
public String getTopic()

      • setTopic

        @Stability(Stable)
public void setTopic​(@NotNull
                     String value)