1. Packages
  2. Google Cloud Native
  3. API Docs
  4. pubsublite
  5. pubsublite/v1
  6. getTopic

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

google-native.pubsublite/v1.getTopic

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

    Returns the topic configuration.

    Using getTopic

    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 getTopic(args: GetTopicArgs, opts?: InvokeOptions): Promise<GetTopicResult>
    function getTopicOutput(args: GetTopicOutputArgs, opts?: InvokeOptions): Output<GetTopicResult>
    def get_topic(location: Optional[str] = None,
                  project: Optional[str] = None,
                  topic_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetTopicResult
    def get_topic_output(location: Optional[pulumi.Input[str]] = None,
                  project: Optional[pulumi.Input[str]] = None,
                  topic_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetTopicResult]
    func LookupTopic(ctx *Context, args *LookupTopicArgs, opts ...InvokeOption) (*LookupTopicResult, error)
    func LookupTopicOutput(ctx *Context, args *LookupTopicOutputArgs, opts ...InvokeOption) LookupTopicResultOutput

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

    public static class GetTopic 
    {
        public static Task<GetTopicResult> InvokeAsync(GetTopicArgs args, InvokeOptions? opts = null)
        public static Output<GetTopicResult> Invoke(GetTopicInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:pubsublite/v1:getTopic
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Location string
    TopicId string
    Project string
    Location string
    TopicId string
    Project string
    location String
    topicId String
    project String
    location string
    topicId string
    project string
    location String
    topicId String
    project String

    getTopic Result

    The following output properties are available:

    Name string
    The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    PartitionConfig Pulumi.GoogleNative.Pubsublite.V1.Outputs.PartitionConfigResponse
    The settings for this topic's partitions.
    ReservationConfig Pulumi.GoogleNative.Pubsublite.V1.Outputs.ReservationConfigResponse
    The settings for this topic's Reservation usage.
    RetentionConfig Pulumi.GoogleNative.Pubsublite.V1.Outputs.RetentionConfigResponse
    The settings for this topic's message retention.
    Name string
    The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    PartitionConfig PartitionConfigResponse
    The settings for this topic's partitions.
    ReservationConfig ReservationConfigResponse
    The settings for this topic's Reservation usage.
    RetentionConfig RetentionConfigResponse
    The settings for this topic's message retention.
    name String
    The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    partitionConfig PartitionConfigResponse
    The settings for this topic's partitions.
    reservationConfig ReservationConfigResponse
    The settings for this topic's Reservation usage.
    retentionConfig RetentionConfigResponse
    The settings for this topic's message retention.
    name string
    The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    partitionConfig PartitionConfigResponse
    The settings for this topic's partitions.
    reservationConfig ReservationConfigResponse
    The settings for this topic's Reservation usage.
    retentionConfig RetentionConfigResponse
    The settings for this topic's message retention.
    name str
    The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    partition_config PartitionConfigResponse
    The settings for this topic's partitions.
    reservation_config ReservationConfigResponse
    The settings for this topic's Reservation usage.
    retention_config RetentionConfigResponse
    The settings for this topic's message retention.
    name String
    The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
    partitionConfig Property Map
    The settings for this topic's partitions.
    reservationConfig Property Map
    The settings for this topic's Reservation usage.
    retentionConfig Property Map
    The settings for this topic's message retention.

    Supporting Types

    CapacityResponse

    PublishMibPerSec int
    Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
    SubscribeMibPerSec int
    Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
    PublishMibPerSec int
    Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
    SubscribeMibPerSec int
    Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
    publishMibPerSec Integer
    Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
    subscribeMibPerSec Integer
    Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
    publishMibPerSec number
    Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
    subscribeMibPerSec number
    Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
    publish_mib_per_sec int
    Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
    subscribe_mib_per_sec int
    Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
    publishMibPerSec Number
    Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
    subscribeMibPerSec Number
    Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.

    PartitionConfigResponse

    Capacity Pulumi.GoogleNative.Pubsublite.V1.Inputs.CapacityResponse
    The capacity configuration.
    Count string
    The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
    Scale int
    DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    Deprecated: DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    Capacity CapacityResponse
    The capacity configuration.
    Count string
    The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
    Scale int
    DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    Deprecated: DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    capacity CapacityResponse
    The capacity configuration.
    count String
    The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
    scale Integer
    DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    Deprecated: DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    capacity CapacityResponse
    The capacity configuration.
    count string
    The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
    scale number
    DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    Deprecated: DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    capacity CapacityResponse
    The capacity configuration.
    count str
    The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
    scale int
    DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    Deprecated: DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    capacity Property Map
    The capacity configuration.
    count String
    The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
    scale Number
    DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    Deprecated: DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

    ReservationConfigResponse

    ThroughputReservation string
    The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
    ThroughputReservation string
    The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
    throughputReservation String
    The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
    throughputReservation string
    The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
    throughput_reservation str
    The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
    throughputReservation String
    The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}

    RetentionConfigResponse

    PerPartitionBytes string
    The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of period.
    Period string
    How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below per_partition_bytes.
    PerPartitionBytes string
    The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of period.
    Period string
    How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below per_partition_bytes.
    perPartitionBytes String
    The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of period.
    period String
    How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below per_partition_bytes.
    perPartitionBytes string
    The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of period.
    period string
    How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below per_partition_bytes.
    per_partition_bytes str
    The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of period.
    period str
    How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below per_partition_bytes.
    perPartitionBytes String
    The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of period.
    period String
    How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below per_partition_bytes.

    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