Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. pubsublite
  5. pubsublite/v1
  6. getSubscription

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.pubsublite/v1.getSubscription

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Returns the subscription configuration.

    Using getSubscription

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSubscription(args: GetSubscriptionArgs, opts?: InvokeOptions): Promise<GetSubscriptionResult>
function getSubscriptionOutput(args: GetSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetSubscriptionResult>
    def get_subscription(location: Optional[str] = None,
                     project: Optional[str] = None,
                     subscription_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSubscriptionResult
def get_subscription_output(location: Optional[pulumi.Input[str]] = None,
                     project: Optional[pulumi.Input[str]] = None,
                     subscription_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSubscriptionResult]
    func LookupSubscription(ctx *Context, args *LookupSubscriptionArgs, opts ...InvokeOption) (*LookupSubscriptionResult, error)
func LookupSubscriptionOutput(ctx *Context, args *LookupSubscriptionOutputArgs, opts ...InvokeOption) LookupSubscriptionResultOutput

    > Note: This function is named LookupSubscription in the Go SDK.

    public static class GetSubscription 
{
    public static Task<GetSubscriptionResult> InvokeAsync(GetSubscriptionArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscriptionResult> Invoke(GetSubscriptionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSubscriptionResult> getSubscription(GetSubscriptionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:pubsublite/v1:getSubscription
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    SubscriptionId string
    Project string
    Location string
    SubscriptionId string
    Project string
    location String
    subscriptionId String
    project String
    location string
    subscriptionId string
    project string
    location String
    subscriptionId String
    project String

    getSubscription Result

    The following output properties are available:

    DeliveryConfig Pulumi.GoogleNative.Pubsublite.V1.Outputs.DeliveryConfigResponse
    The settings for this subscription's message delivery.
    ExportConfig Pulumi.GoogleNative.Pubsublite.V1.Outputs.ExportConfigResponse
    If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.
    Name string
    The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
    Topic string
    The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    DeliveryConfig DeliveryConfigResponse
    The settings for this subscription's message delivery.
    ExportConfig ExportConfigResponse
    If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.
    Name string
    The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
    Topic string
    The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    deliveryConfig DeliveryConfigResponse
    The settings for this subscription's message delivery.
    exportConfig ExportConfigResponse
    If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.
    name String
    The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
    topic String
    The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    deliveryConfig DeliveryConfigResponse
    The settings for this subscription's message delivery.
    exportConfig ExportConfigResponse
    If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.
    name string
    The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
    topic string
    The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    delivery_config DeliveryConfigResponse
    The settings for this subscription's message delivery.
    export_config ExportConfigResponse
    If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.
    name str
    The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
    topic str
    The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    deliveryConfig Property Map
    The settings for this subscription's message delivery.
    exportConfig Property Map
    If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.
    name String
    The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
    topic String
    The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

    Supporting Types

    DeliveryConfigResponse

    DeliveryRequirement string
    The DeliveryRequirement for this subscription.
    DeliveryRequirement string
    The DeliveryRequirement for this subscription.
    deliveryRequirement String
    The DeliveryRequirement for this subscription.
    deliveryRequirement string
    The DeliveryRequirement for this subscription.
    delivery_requirement str
    The DeliveryRequirement for this subscription.
    deliveryRequirement String
    The DeliveryRequirement for this subscription.

    ExportConfigResponse

    CurrentState string
    The current state of the export, which may be different to the desired state due to errors. This field is output only.
    DeadLetterTopic string
    Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.
    DesiredState string
    The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.
    PubsubConfig Pulumi.GoogleNative.Pubsublite.V1.Inputs.PubSubConfigResponse
    Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.
    CurrentState string
    The current state of the export, which may be different to the desired state due to errors. This field is output only.
    DeadLetterTopic string
    Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.
    DesiredState string
    The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.
    PubsubConfig PubSubConfigResponse
    Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.
    currentState String
    The current state of the export, which may be different to the desired state due to errors. This field is output only.
    deadLetterTopic String
    Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.
    desiredState String
    The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.
    pubsubConfig PubSubConfigResponse
    Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.
    currentState string
    The current state of the export, which may be different to the desired state due to errors. This field is output only.
    deadLetterTopic string
    Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.
    desiredState string
    The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.
    pubsubConfig PubSubConfigResponse
    Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.
    current_state str
    The current state of the export, which may be different to the desired state due to errors. This field is output only.
    dead_letter_topic str
    Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.
    desired_state str
    The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.
    pubsub_config PubSubConfigResponse
    Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.
    currentState String
    The current state of the export, which may be different to the desired state due to errors. This field is output only.
    deadLetterTopic String
    Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.
    desiredState String
    The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.
    pubsubConfig Property Map
    Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.

    PubSubConfigResponse

    Topic string
    The name of the Pub/Sub topic. Structured like: projects/{project_number}/topics/{topic_id}. The topic may be changed.
    Topic string
    The name of the Pub/Sub topic. Structured like: projects/{project_number}/topics/{topic_id}. The topic may be changed.
    topic String
    The name of the Pub/Sub topic. Structured like: projects/{project_number}/topics/{topic_id}. The topic may be changed.
    topic string
    The name of the Pub/Sub topic. Structured like: projects/{project_number}/topics/{topic_id}. The topic may be changed.
    topic str
    The name of the Pub/Sub topic. Structured like: projects/{project_number}/topics/{topic_id}. The topic may be changed.
    topic String
    The name of the Pub/Sub topic. Structured like: projects/{project_number}/topics/{topic_id}. The topic may be changed.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native