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

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.pubsub/v1.Subscription

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
pulumi/pulumi-google-native

Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn’t exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

Create Subscription Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Subscription(name: string, args: SubscriptionArgs, opts?: CustomResourceOptions);
@overload
def Subscription(resource_name: str,
                 args: SubscriptionArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Subscription(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 subscription_id: Optional[str] = None,
                 topic: Optional[str] = None,
                 filter: Optional[str] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 detached: Optional[bool] = None,
                 enable_exactly_once_delivery: Optional[bool] = None,
                 enable_message_ordering: Optional[bool] = None,
                 expiration_policy: Optional[ExpirationPolicyArgs] = None,
                 ack_deadline_seconds: Optional[int] = None,
                 dead_letter_policy: Optional[DeadLetterPolicyArgs] = None,
                 message_retention_duration: Optional[str] = None,
                 name: Optional[str] = None,
                 project: Optional[str] = None,
                 push_config: Optional[PushConfigArgs] = None,
                 retain_acked_messages: Optional[bool] = None,
                 retry_policy: Optional[RetryPolicyArgs] = None,
                 cloud_storage_config: Optional[CloudStorageConfigArgs] = None,
                 bigquery_config: Optional[BigQueryConfigArgs] = None)
func NewSubscription(ctx *Context, name string, args SubscriptionArgs, opts ...ResourceOption) (*Subscription, error)
public Subscription(string name, SubscriptionArgs args, CustomResourceOptions? opts = null)
public Subscription(String name, SubscriptionArgs args)
public Subscription(String name, SubscriptionArgs args, CustomResourceOptions options)

type: google-native:pubsub/v1:Subscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var examplesubscriptionResourceResourceFromPubsubv1 = new GoogleNative.Pubsub.V1.Subscription("examplesubscriptionResourceResourceFromPubsubv1", new()
{
    SubscriptionId = "string",
    Topic = "string",
    Filter = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Detached = false,
    EnableExactlyOnceDelivery = false,
    EnableMessageOrdering = false,
    ExpirationPolicy = new GoogleNative.Pubsub.V1.Inputs.ExpirationPolicyArgs
    {
        Ttl = "string",
    },
    AckDeadlineSeconds = 0,
    DeadLetterPolicy = new GoogleNative.Pubsub.V1.Inputs.DeadLetterPolicyArgs
    {
        DeadLetterTopic = "string",
        MaxDeliveryAttempts = 0,
    },
    MessageRetentionDuration = "string",
    Name = "string",
    Project = "string",
    PushConfig = new GoogleNative.Pubsub.V1.Inputs.PushConfigArgs
    {
        Attributes = 
        {
            { "string", "string" },
        },
        NoWrapper = new GoogleNative.Pubsub.V1.Inputs.NoWrapperArgs
        {
            WriteMetadata = false,
        },
        OidcToken = new GoogleNative.Pubsub.V1.Inputs.OidcTokenArgs
        {
            Audience = "string",
            ServiceAccountEmail = "string",
        },
        PubsubWrapper = null,
        PushEndpoint = "string",
    },
    RetainAckedMessages = false,
    RetryPolicy = new GoogleNative.Pubsub.V1.Inputs.RetryPolicyArgs
    {
        MaximumBackoff = "string",
        MinimumBackoff = "string",
    },
    CloudStorageConfig = new GoogleNative.Pubsub.V1.Inputs.CloudStorageConfigArgs
    {
        Bucket = "string",
        AvroConfig = new GoogleNative.Pubsub.V1.Inputs.AvroConfigArgs
        {
            WriteMetadata = false,
        },
        FilenamePrefix = "string",
        FilenameSuffix = "string",
        MaxBytes = "string",
        MaxDuration = "string",
        TextConfig = null,
    },
    BigqueryConfig = new GoogleNative.Pubsub.V1.Inputs.BigQueryConfigArgs
    {
        DropUnknownFields = false,
        Table = "string",
        UseTopicSchema = false,
        WriteMetadata = false,
    },
});
Copy
example, err := pubsub.NewSubscription(ctx, "examplesubscriptionResourceResourceFromPubsubv1", &pubsub.SubscriptionArgs{
	SubscriptionId: pulumi.String("string"),
	Topic:          pulumi.String("string"),
	Filter:         pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Detached:                  pulumi.Bool(false),
	EnableExactlyOnceDelivery: pulumi.Bool(false),
	EnableMessageOrdering:     pulumi.Bool(false),
	ExpirationPolicy: &pubsub.ExpirationPolicyArgs{
		Ttl: pulumi.String("string"),
	},
	AckDeadlineSeconds: pulumi.Int(0),
	DeadLetterPolicy: &pubsub.DeadLetterPolicyArgs{
		DeadLetterTopic:     pulumi.String("string"),
		MaxDeliveryAttempts: pulumi.Int(0),
	},
	MessageRetentionDuration: pulumi.String("string"),
	Name:                     pulumi.String("string"),
	Project:                  pulumi.String("string"),
	PushConfig: &pubsub.PushConfigArgs{
		Attributes: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		NoWrapper: &pubsub.NoWrapperArgs{
			WriteMetadata: pulumi.Bool(false),
		},
		OidcToken: &pubsub.OidcTokenArgs{
			Audience:            pulumi.String("string"),
			ServiceAccountEmail: pulumi.String("string"),
		},
		PubsubWrapper: &pubsub.PubsubWrapperArgs{},
		PushEndpoint:  pulumi.String("string"),
	},
	RetainAckedMessages: pulumi.Bool(false),
	RetryPolicy: &pubsub.RetryPolicyArgs{
		MaximumBackoff: pulumi.String("string"),
		MinimumBackoff: pulumi.String("string"),
	},
	CloudStorageConfig: &pubsub.CloudStorageConfigArgs{
		Bucket: pulumi.String("string"),
		AvroConfig: &pubsub.AvroConfigArgs{
			WriteMetadata: pulumi.Bool(false),
		},
		FilenamePrefix: pulumi.String("string"),
		FilenameSuffix: pulumi.String("string"),
		MaxBytes:       pulumi.String("string"),
		MaxDuration:    pulumi.String("string"),
		TextConfig:     &pubsub.TextConfigArgs{},
	},
	BigqueryConfig: &pubsub.BigQueryConfigArgs{
		DropUnknownFields: pulumi.Bool(false),
		Table:             pulumi.String("string"),
		UseTopicSchema:    pulumi.Bool(false),
		WriteMetadata:     pulumi.Bool(false),
	},
})
Copy
var examplesubscriptionResourceResourceFromPubsubv1 = new Subscription("examplesubscriptionResourceResourceFromPubsubv1", SubscriptionArgs.builder()
    .subscriptionId("string")
    .topic("string")
    .filter("string")
    .labels(Map.of("string", "string"))
    .detached(false)
    .enableExactlyOnceDelivery(false)
    .enableMessageOrdering(false)
    .expirationPolicy(ExpirationPolicyArgs.builder()
        .ttl("string")
        .build())
    .ackDeadlineSeconds(0)
    .deadLetterPolicy(DeadLetterPolicyArgs.builder()
        .deadLetterTopic("string")
        .maxDeliveryAttempts(0)
        .build())
    .messageRetentionDuration("string")
    .name("string")
    .project("string")
    .pushConfig(PushConfigArgs.builder()
        .attributes(Map.of("string", "string"))
        .noWrapper(NoWrapperArgs.builder()
            .writeMetadata(false)
            .build())
        .oidcToken(OidcTokenArgs.builder()
            .audience("string")
            .serviceAccountEmail("string")
            .build())
        .pubsubWrapper()
        .pushEndpoint("string")
        .build())
    .retainAckedMessages(false)
    .retryPolicy(RetryPolicyArgs.builder()
        .maximumBackoff("string")
        .minimumBackoff("string")
        .build())
    .cloudStorageConfig(CloudStorageConfigArgs.builder()
        .bucket("string")
        .avroConfig(AvroConfigArgs.builder()
            .writeMetadata(false)
            .build())
        .filenamePrefix("string")
        .filenameSuffix("string")
        .maxBytes("string")
        .maxDuration("string")
        .textConfig()
        .build())
    .bigqueryConfig(BigQueryConfigArgs.builder()
        .dropUnknownFields(false)
        .table("string")
        .useTopicSchema(false)
        .writeMetadata(false)
        .build())
    .build());
Copy
examplesubscription_resource_resource_from_pubsubv1 = google_native.pubsub.v1.Subscription("examplesubscriptionResourceResourceFromPubsubv1",
    subscription_id="string",
    topic="string",
    filter="string",
    labels={
        "string": "string",
    },
    detached=False,
    enable_exactly_once_delivery=False,
    enable_message_ordering=False,
    expiration_policy={
        "ttl": "string",
    },
    ack_deadline_seconds=0,
    dead_letter_policy={
        "dead_letter_topic": "string",
        "max_delivery_attempts": 0,
    },
    message_retention_duration="string",
    name="string",
    project="string",
    push_config={
        "attributes": {
            "string": "string",
        },
        "no_wrapper": {
            "write_metadata": False,
        },
        "oidc_token": {
            "audience": "string",
            "service_account_email": "string",
        },
        "pubsub_wrapper": {},
        "push_endpoint": "string",
    },
    retain_acked_messages=False,
    retry_policy={
        "maximum_backoff": "string",
        "minimum_backoff": "string",
    },
    cloud_storage_config={
        "bucket": "string",
        "avro_config": {
            "write_metadata": False,
        },
        "filename_prefix": "string",
        "filename_suffix": "string",
        "max_bytes": "string",
        "max_duration": "string",
        "text_config": {},
    },
    bigquery_config={
        "drop_unknown_fields": False,
        "table": "string",
        "use_topic_schema": False,
        "write_metadata": False,
    })
Copy
const examplesubscriptionResourceResourceFromPubsubv1 = new google_native.pubsub.v1.Subscription("examplesubscriptionResourceResourceFromPubsubv1", {
    subscriptionId: "string",
    topic: "string",
    filter: "string",
    labels: {
        string: "string",
    },
    detached: false,
    enableExactlyOnceDelivery: false,
    enableMessageOrdering: false,
    expirationPolicy: {
        ttl: "string",
    },
    ackDeadlineSeconds: 0,
    deadLetterPolicy: {
        deadLetterTopic: "string",
        maxDeliveryAttempts: 0,
    },
    messageRetentionDuration: "string",
    name: "string",
    project: "string",
    pushConfig: {
        attributes: {
            string: "string",
        },
        noWrapper: {
            writeMetadata: false,
        },
        oidcToken: {
            audience: "string",
            serviceAccountEmail: "string",
        },
        pubsubWrapper: {},
        pushEndpoint: "string",
    },
    retainAckedMessages: false,
    retryPolicy: {
        maximumBackoff: "string",
        minimumBackoff: "string",
    },
    cloudStorageConfig: {
        bucket: "string",
        avroConfig: {
            writeMetadata: false,
        },
        filenamePrefix: "string",
        filenameSuffix: "string",
        maxBytes: "string",
        maxDuration: "string",
        textConfig: {},
    },
    bigqueryConfig: {
        dropUnknownFields: false,
        table: "string",
        useTopicSchema: false,
        writeMetadata: false,
    },
});
Copy
type: google-native:pubsub/v1:Subscription
properties:
    ackDeadlineSeconds: 0
    bigqueryConfig:
        dropUnknownFields: false
        table: string
        useTopicSchema: false
        writeMetadata: false
    cloudStorageConfig:
        avroConfig:
            writeMetadata: false
        bucket: string
        filenamePrefix: string
        filenameSuffix: string
        maxBytes: string
        maxDuration: string
        textConfig: {}
    deadLetterPolicy:
        deadLetterTopic: string
        maxDeliveryAttempts: 0
    detached: false
    enableExactlyOnceDelivery: false
    enableMessageOrdering: false
    expirationPolicy:
        ttl: string
    filter: string
    labels:
        string: string
    messageRetentionDuration: string
    name: string
    project: string
    pushConfig:
        attributes:
            string: string
        noWrapper:
            writeMetadata: false
        oidcToken:
            audience: string
            serviceAccountEmail: string
        pubsubWrapper: {}
        pushEndpoint: string
    retainAckedMessages: false
    retryPolicy:
        maximumBackoff: string
        minimumBackoff: string
    subscriptionId: string
    topic: string
Copy

Subscription Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Subscription resource accepts the following input properties:

SubscriptionId
This property is required.
Changes to this property will trigger replacement.
string
Topic This property is required. string
The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.
AckDeadlineSeconds int
Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming 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.
BigqueryConfig Pulumi.GoogleNative.Pubsub.V1.Inputs.BigQueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
CloudStorageConfig Pulumi.GoogleNative.Pubsub.V1.Inputs.CloudStorageConfig
Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
DeadLetterPolicy Pulumi.GoogleNative.Pubsub.V1.Inputs.DeadLetterPolicy
Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
Detached bool
Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
EnableExactlyOnceDelivery bool
Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of message_id on this subscription: * 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 message_id values.
EnableMessageOrdering bool
Optional. If true, messages published with the same ordering_key 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.
ExpirationPolicy Pulumi.GoogleNative.Pubsub.V1.Inputs.ExpirationPolicy
Optional. A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expiration_policy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day. If expiration_policy is set, but expiration_policy.ttl is not set, the subscription never expires.
Filter string
Optional. An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
Labels Dictionary<string, string>
Optional. See Creating and managing labels.
MessageRetentionDuration string
Optional. How 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 Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
Name string
The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
Project Changes to this property will trigger replacement. string
PushConfig Pulumi.GoogleNative.Pubsub.V1.Inputs.PushConfig
Optional. If push delivery is used with this subscription, this field is used to configure it.
RetainAckedMessages bool
Optional. Indicates 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 message_retention_duration window. This must be true if you would like to [Seek to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
RetryPolicy Pulumi.GoogleNative.Pubsub.V1.Inputs.RetryPolicy
Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
SubscriptionId
This property is required.
Changes to this property will trigger replacement.
string
Topic This property is required. string
The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.
AckDeadlineSeconds int
Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming 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.
BigqueryConfig BigQueryConfigArgs
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
CloudStorageConfig CloudStorageConfigArgs
Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
DeadLetterPolicy DeadLetterPolicyArgs
Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
Detached bool
Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
EnableExactlyOnceDelivery bool
Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of message_id on this subscription: * 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 message_id values.
EnableMessageOrdering bool
Optional. If true, messages published with the same ordering_key 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.
ExpirationPolicy ExpirationPolicyArgs
Optional. A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expiration_policy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day. If expiration_policy is set, but expiration_policy.ttl is not set, the subscription never expires.
Filter string
Optional. An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
Labels map[string]string
Optional. See Creating and managing labels.
MessageRetentionDuration string
Optional. How 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 Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
Name string
The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
Project Changes to this property will trigger replacement. string
PushConfig PushConfigArgs
Optional. If push delivery is used with this subscription, this field is used to configure it.
RetainAckedMessages bool
Optional. Indicates 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 message_retention_duration window. This must be true if you would like to [Seek to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
RetryPolicy RetryPolicyArgs
Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
subscriptionId
This property is required.
Changes to this property will trigger replacement.
String
topic This property is required. String
The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.
ackDeadlineSeconds Integer
Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming 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.
bigqueryConfig BigQueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
cloudStorageConfig CloudStorageConfig
Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
deadLetterPolicy DeadLetterPolicy
Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
detached Boolean
Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
enableExactlyOnceDelivery Boolean
Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of message_id on this subscription: * 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 message_id values.
enableMessageOrdering Boolean
Optional. If true, messages published with the same ordering_key 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.
expirationPolicy ExpirationPolicy
Optional. A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expiration_policy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day. If expiration_policy is set, but expiration_policy.ttl is not set, the subscription never expires.
filter String
Optional. An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
labels Map<String,String>
Optional. See Creating and managing labels.
messageRetentionDuration String
Optional. How 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 Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
name String
The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
project Changes to this property will trigger replacement. String
pushConfig PushConfig
Optional. If push delivery is used with this subscription, this field is used to configure it.
retainAckedMessages Boolean
Optional. Indicates 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 message_retention_duration window. This must be true if you would like to [Seek to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
retryPolicy RetryPolicy
Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
subscriptionId
This property is required.
Changes to this property will trigger replacement.
string
topic This property is required. string
The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.
ackDeadlineSeconds number
Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming 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.
bigqueryConfig BigQueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
cloudStorageConfig CloudStorageConfig
Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
deadLetterPolicy DeadLetterPolicy
Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
detached boolean
Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
enableExactlyOnceDelivery boolean
Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of message_id on this subscription: * 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 message_id values.
enableMessageOrdering boolean
Optional. If true, messages published with the same ordering_key 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.
expirationPolicy ExpirationPolicy
Optional. A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expiration_policy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day. If expiration_policy is set, but expiration_policy.ttl is not set, the subscription never expires.
filter string
Optional. An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
labels {[key: string]: string}
Optional. See Creating and managing labels.
messageRetentionDuration string
Optional. How 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 Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
name string
The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
project Changes to this property will trigger replacement. string
pushConfig PushConfig
Optional. If push delivery is used with this subscription, this field is used to configure it.
retainAckedMessages boolean
Optional. Indicates 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 message_retention_duration window. This must be true if you would like to [Seek to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
retryPolicy RetryPolicy
Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
subscription_id
This property is required.
Changes to this property will trigger replacement.
str
topic This property is required. str
The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.
ack_deadline_seconds int
Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming 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.
bigquery_config BigQueryConfigArgs
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
cloud_storage_config CloudStorageConfigArgs
Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
dead_letter_policy DeadLetterPolicyArgs
Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
detached bool
Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
enable_exactly_once_delivery bool
Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of message_id on this subscription: * 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 message_id values.
enable_message_ordering bool
Optional. If true, messages published with the same ordering_key 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.
expiration_policy ExpirationPolicyArgs
Optional. A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expiration_policy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day. If expiration_policy is set, but expiration_policy.ttl is not set, the subscription never expires.
filter str
Optional. An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
labels Mapping[str, str]
Optional. See Creating and managing labels.
message_retention_duration str
Optional. How 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 Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
name str
The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
project Changes to this property will trigger replacement. str
push_config PushConfigArgs
Optional. If push delivery is used with this subscription, this field is used to configure it.
retain_acked_messages bool
Optional. Indicates 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 message_retention_duration window. This must be true if you would like to [Seek to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
retry_policy RetryPolicyArgs
Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
subscriptionId
This property is required.
Changes to this property will trigger replacement.
String
topic This property is required. String
The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.
ackDeadlineSeconds Number
Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming 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.
bigqueryConfig Property Map
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
cloudStorageConfig Property Map
Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
deadLetterPolicy Property Map
Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription.
detached Boolean
Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
enableExactlyOnceDelivery Boolean
Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of message_id on this subscription: * 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 message_id values.
enableMessageOrdering Boolean
Optional. If true, messages published with the same ordering_key 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.
expirationPolicy Property Map
Optional. A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expiration_policy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day. If expiration_policy is set, but expiration_policy.ttl is not set, the subscription never expires.
filter String
Optional. An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
labels Map<String>
Optional. See Creating and managing labels.
messageRetentionDuration String
Optional. How 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 Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.
name String
The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
project Changes to this property will trigger replacement. String
pushConfig Property Map
Optional. If push delivery is used with this subscription, this field is used to configure it.
retainAckedMessages Boolean
Optional. Indicates 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 message_retention_duration window. This must be true if you would like to [Seek to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
retryPolicy Property Map
Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.

Outputs

All input properties are implicitly available as output properties. Additionally, the Subscription resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
State string
An output-only field indicating whether or not the subscription can receive messages.
TopicMessageRetentionDuration string
Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last topic_message_retention_duration are always available to subscribers. See the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.
Id string
The provider-assigned unique ID for this managed resource.
State string
An output-only field indicating whether or not the subscription can receive messages.
TopicMessageRetentionDuration string
Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last topic_message_retention_duration are always available to subscribers. See the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.
id String
The provider-assigned unique ID for this managed resource.
state String
An output-only field indicating whether or not the subscription can receive messages.
topicMessageRetentionDuration String
Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last topic_message_retention_duration are always available to subscribers. See the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.
id string
The provider-assigned unique ID for this managed resource.
state string
An output-only field indicating whether or not the subscription can receive messages.
topicMessageRetentionDuration string
Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last topic_message_retention_duration are always available to subscribers. See the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.
id str
The provider-assigned unique ID for this managed resource.
state str
An output-only field indicating whether or not the subscription can receive messages.
topic_message_retention_duration str
Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last topic_message_retention_duration are always available to subscribers. See the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.
id String
The provider-assigned unique ID for this managed resource.
state String
An output-only field indicating whether or not the subscription can receive messages.
topicMessageRetentionDuration String
Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last topic_message_retention_duration are always available to subscribers. See the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.

Supporting Types

AvroConfig
, AvroConfigArgs

WriteMetadata bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
WriteMetadata bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
writeMetadata Boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
writeMetadata boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
write_metadata bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
writeMetadata Boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.

AvroConfigResponse
, AvroConfigResponseArgs

WriteMetadata This property is required. bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
WriteMetadata This property is required. bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
writeMetadata This property is required. Boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
writeMetadata This property is required. boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
write_metadata This property is required. bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.
writeMetadata This property is required. Boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.

BigQueryConfig
, BigQueryConfigArgs

DropUnknownFields bool
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
Table string
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
UseTopicSchema bool
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
WriteMetadata bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
DropUnknownFields bool
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
Table string
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
UseTopicSchema bool
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
WriteMetadata bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
dropUnknownFields Boolean
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
table String
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
useTopicSchema Boolean
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
writeMetadata Boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
dropUnknownFields boolean
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
table string
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
useTopicSchema boolean
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
writeMetadata boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
drop_unknown_fields bool
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
table str
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
use_topic_schema bool
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
write_metadata bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
dropUnknownFields Boolean
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
table String
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
useTopicSchema Boolean
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
writeMetadata Boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.

BigQueryConfigResponse
, BigQueryConfigResponseArgs

DropUnknownFields This property is required. bool
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
State This property is required. string
An output-only field that indicates whether or not the subscription can receive messages.
Table This property is required. string
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
UseTopicSchema This property is required. bool
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
WriteMetadata This property is required. bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
DropUnknownFields This property is required. bool
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
State This property is required. string
An output-only field that indicates whether or not the subscription can receive messages.
Table This property is required. string
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
UseTopicSchema This property is required. bool
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
WriteMetadata This property is required. bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
dropUnknownFields This property is required. Boolean
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
state This property is required. String
An output-only field that indicates whether or not the subscription can receive messages.
table This property is required. String
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
useTopicSchema This property is required. Boolean
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
writeMetadata This property is required. Boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
dropUnknownFields This property is required. boolean
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
state This property is required. string
An output-only field that indicates whether or not the subscription can receive messages.
table This property is required. string
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
useTopicSchema This property is required. boolean
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
writeMetadata This property is required. boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
drop_unknown_fields This property is required. bool
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
state This property is required. str
An output-only field that indicates whether or not the subscription can receive messages.
table This property is required. str
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
use_topic_schema This property is required. bool
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
write_metadata This property is required. bool
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
dropUnknownFields This property is required. Boolean
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
state This property is required. String
An output-only field that indicates whether or not the subscription can receive messages.
table This property is required. String
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
useTopicSchema This property is required. Boolean
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
writeMetadata This property is required. Boolean
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.

CloudStorageConfig
, CloudStorageConfigArgs

Bucket This property is required. string
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
AvroConfig Pulumi.GoogleNative.Pubsub.V1.Inputs.AvroConfig
Optional. If set, message data will be written to Cloud Storage in Avro format.
FilenamePrefix string
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
FilenameSuffix string
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
MaxBytes string
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
MaxDuration string
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
TextConfig Pulumi.GoogleNative.Pubsub.V1.Inputs.TextConfig
Optional. If set, message data will be written to Cloud Storage in text format.
Bucket This property is required. string
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
AvroConfig AvroConfig
Optional. If set, message data will be written to Cloud Storage in Avro format.
FilenamePrefix string
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
FilenameSuffix string
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
MaxBytes string
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
MaxDuration string
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
TextConfig TextConfig
Optional. If set, message data will be written to Cloud Storage in text format.
bucket This property is required. String
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
avroConfig AvroConfig
Optional. If set, message data will be written to Cloud Storage in Avro format.
filenamePrefix String
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
filenameSuffix String
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
maxBytes String
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
maxDuration String
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
textConfig TextConfig
Optional. If set, message data will be written to Cloud Storage in text format.
bucket This property is required. string
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
avroConfig AvroConfig
Optional. If set, message data will be written to Cloud Storage in Avro format.
filenamePrefix string
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
filenameSuffix string
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
maxBytes string
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
maxDuration string
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
textConfig TextConfig
Optional. If set, message data will be written to Cloud Storage in text format.
bucket This property is required. str
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
avro_config AvroConfig
Optional. If set, message data will be written to Cloud Storage in Avro format.
filename_prefix str
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
filename_suffix str
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
max_bytes str
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
max_duration str
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
text_config TextConfig
Optional. If set, message data will be written to Cloud Storage in text format.
bucket This property is required. String
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
avroConfig Property Map
Optional. If set, message data will be written to Cloud Storage in Avro format.
filenamePrefix String
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
filenameSuffix String
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
maxBytes String
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
maxDuration String
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
textConfig Property Map
Optional. If set, message data will be written to Cloud Storage in text format.

CloudStorageConfigResponse
, CloudStorageConfigResponseArgs

AvroConfig This property is required. Pulumi.GoogleNative.Pubsub.V1.Inputs.AvroConfigResponse
Optional. If set, message data will be written to Cloud Storage in Avro format.
Bucket This property is required. string
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
FilenamePrefix This property is required. string
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
FilenameSuffix This property is required. string
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
MaxBytes This property is required. string
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
MaxDuration This property is required. string
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
State This property is required. string
An output-only field that indicates whether or not the subscription can receive messages.
TextConfig This property is required. Pulumi.GoogleNative.Pubsub.V1.Inputs.TextConfigResponse
Optional. If set, message data will be written to Cloud Storage in text format.
AvroConfig This property is required. AvroConfigResponse
Optional. If set, message data will be written to Cloud Storage in Avro format.
Bucket This property is required. string
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
FilenamePrefix This property is required. string
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
FilenameSuffix This property is required. string
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
MaxBytes This property is required. string
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
MaxDuration This property is required. string
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
State This property is required. string
An output-only field that indicates whether or not the subscription can receive messages.
TextConfig This property is required. TextConfigResponse
Optional. If set, message data will be written to Cloud Storage in text format.
avroConfig This property is required. AvroConfigResponse
Optional. If set, message data will be written to Cloud Storage in Avro format.
bucket This property is required. String
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
filenamePrefix This property is required. String
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
filenameSuffix This property is required. String
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
maxBytes This property is required. String
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
maxDuration This property is required. String
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
state This property is required. String
An output-only field that indicates whether or not the subscription can receive messages.
textConfig This property is required. TextConfigResponse
Optional. If set, message data will be written to Cloud Storage in text format.
avroConfig This property is required. AvroConfigResponse
Optional. If set, message data will be written to Cloud Storage in Avro format.
bucket This property is required. string
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
filenamePrefix This property is required. string
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
filenameSuffix This property is required. string
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
maxBytes This property is required. string
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
maxDuration This property is required. string
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
state This property is required. string
An output-only field that indicates whether or not the subscription can receive messages.
textConfig This property is required. TextConfigResponse
Optional. If set, message data will be written to Cloud Storage in text format.
avro_config This property is required. AvroConfigResponse
Optional. If set, message data will be written to Cloud Storage in Avro format.
bucket This property is required. str
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
filename_prefix This property is required. str
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
filename_suffix This property is required. str
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
max_bytes This property is required. str
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
max_duration This property is required. str
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
state This property is required. str
An output-only field that indicates whether or not the subscription can receive messages.
text_config This property is required. TextConfigResponse
Optional. If set, message data will be written to Cloud Storage in text format.
avroConfig This property is required. Property Map
Optional. If set, message data will be written to Cloud Storage in Avro format.
bucket This property is required. String
User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
filenamePrefix This property is required. String
Optional. User-provided prefix for Cloud Storage filename. See the object naming requirements.
filenameSuffix This property is required. String
Optional. User-provided suffix for Cloud Storage filename. See the object naming requirements. Must not end in "/".
maxBytes This property is required. String
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
maxDuration This property is required. String
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
state This property is required. String
An output-only field that indicates whether or not the subscription can receive messages.
textConfig This property is required. Property Map
Optional. If set, message data will be written to Cloud Storage in text format.

DeadLetterPolicy
, DeadLetterPolicyArgs

DeadLetterTopic string
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
MaxDeliveryAttempts int
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
DeadLetterTopic string
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
MaxDeliveryAttempts int
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
deadLetterTopic String
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
maxDeliveryAttempts Integer
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
deadLetterTopic string
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
maxDeliveryAttempts number
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
dead_letter_topic str
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
max_delivery_attempts int
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
deadLetterTopic String
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
maxDeliveryAttempts Number
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.

DeadLetterPolicyResponse
, DeadLetterPolicyResponseArgs

DeadLetterTopic This property is required. string
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
MaxDeliveryAttempts This property is required. int
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
DeadLetterTopic This property is required. string
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
MaxDeliveryAttempts This property is required. int
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
deadLetterTopic This property is required. String
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
maxDeliveryAttempts This property is required. Integer
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
deadLetterTopic This property is required. string
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
maxDeliveryAttempts This property is required. number
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
dead_letter_topic This property is required. str
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
max_delivery_attempts This property is required. int
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.
deadLetterTopic This property is required. String
Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.
maxDeliveryAttempts This property is required. Number
Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.

ExpirationPolicy
, ExpirationPolicyArgs

Ttl string
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.
Ttl string
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.
ttl String
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.
ttl string
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.
ttl str
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.
ttl String
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

ExpirationPolicyResponse
, ExpirationPolicyResponseArgs

Ttl This property is required. string
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.
Ttl This property is required. string
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.
ttl This property is required. String
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.
ttl This property is required. string
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.
ttl This property is required. str
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.
ttl This property is required. String
Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

NoWrapper
, NoWrapperArgs

WriteMetadata bool
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.
WriteMetadata bool
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.
writeMetadata Boolean
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.
writeMetadata boolean
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.
write_metadata bool
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.
writeMetadata Boolean
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.

NoWrapperResponse
, NoWrapperResponseArgs

WriteMetadata This property is required. bool
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.
WriteMetadata This property is required. bool
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.
writeMetadata This property is required. Boolean
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.
writeMetadata This property is required. boolean
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.
write_metadata This property is required. bool
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.
writeMetadata This property is required. Boolean
Optional. When true, writes the Pub/Sub message metadata to x-goog-pubsub-: headers of the HTTP request. Writes the Pub/Sub message attributes to : headers of the HTTP request.

OidcToken
, OidcTokenArgs

Audience string
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
ServiceAccountEmail string
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
Audience string
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
ServiceAccountEmail string
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
audience String
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
serviceAccountEmail String
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
audience string
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
serviceAccountEmail string
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
audience str
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
service_account_email str
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
audience String
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
serviceAccountEmail String
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.

OidcTokenResponse
, OidcTokenResponseArgs

Audience This property is required. string
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
ServiceAccountEmail This property is required. string
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
Audience This property is required. string
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
ServiceAccountEmail This property is required. string
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
audience This property is required. String
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
serviceAccountEmail This property is required. String
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
audience This property is required. string
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
serviceAccountEmail This property is required. string
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
audience This property is required. str
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
service_account_email This property is required. str
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.
audience This property is required. String
Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
serviceAccountEmail This property is required. String
Optional. Service account email used for generating the OIDC token. For more information on setting up authentication, see Push subscriptions.

PushConfig
, PushConfigArgs

Attributes Dictionary<string, string>
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
NoWrapper Pulumi.GoogleNative.Pubsub.V1.Inputs.NoWrapper
Optional. When set, the payload to the push endpoint is not wrapped.
OidcToken Pulumi.GoogleNative.Pubsub.V1.Inputs.OidcToken
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
PubsubWrapper Pulumi.GoogleNative.Pubsub.V1.Inputs.PubsubWrapper
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
PushEndpoint string
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
Attributes map[string]string
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
NoWrapper NoWrapper
Optional. When set, the payload to the push endpoint is not wrapped.
OidcToken OidcToken
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
PubsubWrapper PubsubWrapper
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
PushEndpoint string
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
attributes Map<String,String>
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
noWrapper NoWrapper
Optional. When set, the payload to the push endpoint is not wrapped.
oidcToken OidcToken
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
pubsubWrapper PubsubWrapper
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
pushEndpoint String
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
attributes {[key: string]: string}
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
noWrapper NoWrapper
Optional. When set, the payload to the push endpoint is not wrapped.
oidcToken OidcToken
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
pubsubWrapper PubsubWrapper
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
pushEndpoint string
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
attributes Mapping[str, str]
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
no_wrapper NoWrapper
Optional. When set, the payload to the push endpoint is not wrapped.
oidc_token OidcToken
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
pubsub_wrapper PubsubWrapper
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
push_endpoint str
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
attributes Map<String>
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
noWrapper Property Map
Optional. When set, the payload to the push endpoint is not wrapped.
oidcToken Property Map
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
pubsubWrapper Property Map
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
pushEndpoint String
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.

PushConfigResponse
, PushConfigResponseArgs

Attributes This property is required. Dictionary<string, string>
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
NoWrapper This property is required. Pulumi.GoogleNative.Pubsub.V1.Inputs.NoWrapperResponse
Optional. When set, the payload to the push endpoint is not wrapped.
OidcToken This property is required. Pulumi.GoogleNative.Pubsub.V1.Inputs.OidcTokenResponse
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
PubsubWrapper This property is required. Pulumi.GoogleNative.Pubsub.V1.Inputs.PubsubWrapperResponse
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
PushEndpoint This property is required. string
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
Attributes This property is required. map[string]string
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
NoWrapper This property is required. NoWrapperResponse
Optional. When set, the payload to the push endpoint is not wrapped.
OidcToken This property is required. OidcTokenResponse
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
PubsubWrapper This property is required. PubsubWrapperResponse
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
PushEndpoint This property is required. string
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
attributes This property is required. Map<String,String>
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
noWrapper This property is required. NoWrapperResponse
Optional. When set, the payload to the push endpoint is not wrapped.
oidcToken This property is required. OidcTokenResponse
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
pubsubWrapper This property is required. PubsubWrapperResponse
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
pushEndpoint This property is required. String
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
attributes This property is required. {[key: string]: string}
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
noWrapper This property is required. NoWrapperResponse
Optional. When set, the payload to the push endpoint is not wrapped.
oidcToken This property is required. OidcTokenResponse
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
pubsubWrapper This property is required. PubsubWrapperResponse
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
pushEndpoint This property is required. string
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
attributes This property is required. Mapping[str, str]
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
no_wrapper This property is required. NoWrapperResponse
Optional. When set, the payload to the push endpoint is not wrapped.
oidc_token This property is required. OidcTokenResponse
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
pubsub_wrapper This property is required. PubsubWrapperResponse
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
push_endpoint This property is required. str
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
attributes This property is required. Map<String>
Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
noWrapper This property is required. Property Map
Optional. When set, the payload to the push endpoint is not wrapped.
oidcToken This property is required. Property Map
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.
pubsubWrapper This property is required. Property Map
Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
pushEndpoint This property is required. String
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.

RetryPolicy
, RetryPolicyArgs

MaximumBackoff string
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
MinimumBackoff string
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
MaximumBackoff string
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
MinimumBackoff string
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
maximumBackoff String
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
minimumBackoff String
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
maximumBackoff string
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
minimumBackoff string
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
maximum_backoff str
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
minimum_backoff str
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
maximumBackoff String
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
minimumBackoff String
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

RetryPolicyResponse
, RetryPolicyResponseArgs

MaximumBackoff This property is required. string
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
MinimumBackoff This property is required. string
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
MaximumBackoff This property is required. string
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
MinimumBackoff This property is required. string
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
maximumBackoff This property is required. String
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
minimumBackoff This property is required. String
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
maximumBackoff This property is required. string
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
minimumBackoff This property is required. string
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
maximum_backoff This property is required. str
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
minimum_backoff This property is required. str
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
maximumBackoff This property is required. String
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
minimumBackoff This property is required. String
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

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
pulumi/pulumi-google-native