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 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:
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}
- Partition
Config Pulumi.Google Native. Pubsublite. V1. Outputs. Partition Config Response - The settings for this topic's partitions.
- Reservation
Config Pulumi.Google Native. Pubsublite. V1. Outputs. Reservation Config Response - The settings for this topic's Reservation usage.
- Retention
Config Pulumi.Google Native. Pubsublite. V1. Outputs. Retention Config Response - 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}
- Partition
Config PartitionConfig Response - The settings for this topic's partitions.
- Reservation
Config ReservationConfig Response - The settings for this topic's Reservation usage.
- Retention
Config RetentionConfig Response - 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}
- partition
Config PartitionConfig Response - The settings for this topic's partitions.
- reservation
Config ReservationConfig Response - The settings for this topic's Reservation usage.
- retention
Config RetentionConfig Response - 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}
- partition
Config PartitionConfig Response - The settings for this topic's partitions.
- reservation
Config ReservationConfig Response - The settings for this topic's Reservation usage.
- retention
Config RetentionConfig Response - 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 PartitionConfig Response - The settings for this topic's partitions.
- reservation_
config ReservationConfig Response - The settings for this topic's Reservation usage.
- retention_
config RetentionConfig Response - 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}
- partition
Config Property Map - The settings for this topic's partitions.
- reservation
Config Property Map - The settings for this topic's Reservation usage.
- retention
Config Property Map - The settings for this topic's message retention.
Supporting Types
CapacityResponse
- Publish
Mib intPer Sec - Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
- Subscribe
Mib intPer Sec - Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
- Publish
Mib intPer Sec - Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
- Subscribe
Mib intPer Sec - Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
- publish
Mib IntegerPer Sec - Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
- subscribe
Mib IntegerPer Sec - Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
- publish
Mib numberPer Sec - Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
- subscribe
Mib numberPer Sec - Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
- publish_
mib_ intper_ sec - Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
- subscribe_
mib_ intper_ sec - Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
- publish
Mib NumberPer Sec - Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
- subscribe
Mib NumberPer Sec - Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
PartitionConfigResponse
- Capacity
Pulumi.
Google Native. Pubsublite. V1. Inputs. Capacity Response - 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 withscale
of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
- Capacity
Capacity
Response - 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 withscale
of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
- capacity
Capacity
Response - 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 withscale
of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
- capacity
Capacity
Response - 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 withscale
of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
- capacity
Capacity
Response - 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 withscale
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 withscale
of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
ReservationConfigResponse
- Throughput
Reservation string - The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
- Throughput
Reservation string - The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
- throughput
Reservation String - The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
- throughput
Reservation 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}
- throughput
Reservation String - The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
RetentionConfigResponse
- Per
Partition stringBytes - 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 stringBytes - 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 StringBytes - 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 stringBytes - 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_ strbytes - 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
.
- per
Partition StringBytes - 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 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