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

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.Topic

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 the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).

Create Topic Resource

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

Constructor syntax

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

@overload
def Topic(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          topic_id: Optional[str] = None,
          kms_key_name: Optional[str] = None,
          labels: Optional[Mapping[str, str]] = None,
          message_retention_duration: Optional[str] = None,
          message_storage_policy: Optional[MessageStoragePolicyArgs] = None,
          name: Optional[str] = None,
          project: Optional[str] = None,
          satisfies_pzs: Optional[bool] = None,
          schema_settings: Optional[SchemaSettingsArgs] = None)
func NewTopic(ctx *Context, name string, args TopicArgs, opts ...ResourceOption) (*Topic, error)
public Topic(string name, TopicArgs args, CustomResourceOptions? opts = null)
public Topic(String name, TopicArgs args)
public Topic(String name, TopicArgs args, CustomResourceOptions options)

type: google-native:pubsub/v1:Topic
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. TopicArgs
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. TopicArgs
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. TopicArgs
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. TopicArgs
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. TopicArgs
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 topicResource = new GoogleNative.Pubsub.V1.Topic("topicResource", new()
{
    TopicId = "string",
    KmsKeyName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    MessageRetentionDuration = "string",
    MessageStoragePolicy = new GoogleNative.Pubsub.V1.Inputs.MessageStoragePolicyArgs
    {
        AllowedPersistenceRegions = new[]
        {
            "string",
        },
        EnforceInTransit = false,
    },
    Name = "string",
    Project = "string",
    SatisfiesPzs = false,
    SchemaSettings = new GoogleNative.Pubsub.V1.Inputs.SchemaSettingsArgs
    {
        Schema = "string",
        Encoding = GoogleNative.Pubsub.V1.SchemaSettingsEncoding.EncodingUnspecified,
        FirstRevisionId = "string",
        LastRevisionId = "string",
    },
});
Copy
example, err := pubsub.NewTopic(ctx, "topicResource", &pubsub.TopicArgs{
	TopicId:    pulumi.String("string"),
	KmsKeyName: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	MessageRetentionDuration: pulumi.String("string"),
	MessageStoragePolicy: &pubsub.MessageStoragePolicyArgs{
		AllowedPersistenceRegions: pulumi.StringArray{
			pulumi.String("string"),
		},
		EnforceInTransit: pulumi.Bool(false),
	},
	Name:         pulumi.String("string"),
	Project:      pulumi.String("string"),
	SatisfiesPzs: pulumi.Bool(false),
	SchemaSettings: &pubsub.SchemaSettingsArgs{
		Schema:          pulumi.String("string"),
		Encoding:        pubsub.SchemaSettingsEncodingEncodingUnspecified,
		FirstRevisionId: pulumi.String("string"),
		LastRevisionId:  pulumi.String("string"),
	},
})
Copy
var topicResource = new com.pulumi.googlenative.pubsub_v1.Topic("topicResource", com.pulumi.googlenative.pubsub_v1.TopicArgs.builder()
    .topicId("string")
    .kmsKeyName("string")
    .labels(Map.of("string", "string"))
    .messageRetentionDuration("string")
    .messageStoragePolicy(MessageStoragePolicyArgs.builder()
        .allowedPersistenceRegions("string")
        .enforceInTransit(false)
        .build())
    .name("string")
    .project("string")
    .satisfiesPzs(false)
    .schemaSettings(SchemaSettingsArgs.builder()
        .schema("string")
        .encoding("ENCODING_UNSPECIFIED")
        .firstRevisionId("string")
        .lastRevisionId("string")
        .build())
    .build());
Copy
topic_resource = google_native.pubsub.v1.Topic("topicResource",
    topic_id="string",
    kms_key_name="string",
    labels={
        "string": "string",
    },
    message_retention_duration="string",
    message_storage_policy={
        "allowed_persistence_regions": ["string"],
        "enforce_in_transit": False,
    },
    name="string",
    project="string",
    satisfies_pzs=False,
    schema_settings={
        "schema": "string",
        "encoding": google_native.pubsub.v1.SchemaSettingsEncoding.ENCODING_UNSPECIFIED,
        "first_revision_id": "string",
        "last_revision_id": "string",
    })
Copy
const topicResource = new google_native.pubsub.v1.Topic("topicResource", {
    topicId: "string",
    kmsKeyName: "string",
    labels: {
        string: "string",
    },
    messageRetentionDuration: "string",
    messageStoragePolicy: {
        allowedPersistenceRegions: ["string"],
        enforceInTransit: false,
    },
    name: "string",
    project: "string",
    satisfiesPzs: false,
    schemaSettings: {
        schema: "string",
        encoding: google_native.pubsub.v1.SchemaSettingsEncoding.EncodingUnspecified,
        firstRevisionId: "string",
        lastRevisionId: "string",
    },
});
Copy
type: google-native:pubsub/v1:Topic
properties:
    kmsKeyName: string
    labels:
        string: string
    messageRetentionDuration: string
    messageStoragePolicy:
        allowedPersistenceRegions:
            - string
        enforceInTransit: false
    name: string
    project: string
    satisfiesPzs: false
    schemaSettings:
        encoding: ENCODING_UNSPECIFIED
        firstRevisionId: string
        lastRevisionId: string
        schema: string
    topicId: string
Copy

Topic 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 Topic resource accepts the following input properties:

TopicId
This property is required.
Changes to this property will trigger replacement.
string
KmsKeyName string
Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
Labels Dictionary<string, string>
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
MessageRetentionDuration string
Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
MessageStoragePolicy Pulumi.GoogleNative.Pubsub.V1.Inputs.MessageStoragePolicy
Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
Name string
The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} 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
SatisfiesPzs bool
Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
SchemaSettings Pulumi.GoogleNative.Pubsub.V1.Inputs.SchemaSettings
Optional. Settings for validating messages published against a schema.
TopicId
This property is required.
Changes to this property will trigger replacement.
string
KmsKeyName string
Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
Labels map[string]string
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
MessageRetentionDuration string
Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
MessageStoragePolicy MessageStoragePolicyArgs
Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
Name string
The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} 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
SatisfiesPzs bool
Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
SchemaSettings SchemaSettingsArgs
Optional. Settings for validating messages published against a schema.
topicId
This property is required.
Changes to this property will trigger replacement.
String
kmsKeyName String
Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
labels Map<String,String>
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
messageRetentionDuration String
Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
messageStoragePolicy MessageStoragePolicy
Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
name String
The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} 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
satisfiesPzs Boolean
Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
schemaSettings SchemaSettings
Optional. Settings for validating messages published against a schema.
topicId
This property is required.
Changes to this property will trigger replacement.
string
kmsKeyName string
Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
labels {[key: string]: string}
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
messageRetentionDuration string
Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
messageStoragePolicy MessageStoragePolicy
Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
name string
The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} 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
satisfiesPzs boolean
Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
schemaSettings SchemaSettings
Optional. Settings for validating messages published against a schema.
topic_id
This property is required.
Changes to this property will trigger replacement.
str
kms_key_name str
Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
labels Mapping[str, str]
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
message_retention_duration str
Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
message_storage_policy MessageStoragePolicyArgs
Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
name str
The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} 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
satisfies_pzs bool
Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
schema_settings SchemaSettingsArgs
Optional. Settings for validating messages published against a schema.
topicId
This property is required.
Changes to this property will trigger replacement.
String
kmsKeyName String
Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
labels Map<String>
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
messageRetentionDuration String
Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
messageStoragePolicy Property Map
Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
name String
The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} 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
satisfiesPzs Boolean
Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
schemaSettings Property Map
Optional. Settings for validating messages published against a schema.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

MessageStoragePolicy
, MessageStoragePolicyArgs

AllowedPersistenceRegions List<string>
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
EnforceInTransit bool
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.
AllowedPersistenceRegions []string
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
EnforceInTransit bool
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.
allowedPersistenceRegions List<String>
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
enforceInTransit Boolean
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.
allowedPersistenceRegions string[]
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
enforceInTransit boolean
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.
allowed_persistence_regions Sequence[str]
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
enforce_in_transit bool
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.
allowedPersistenceRegions List<String>
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
enforceInTransit Boolean
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.

MessageStoragePolicyResponse
, MessageStoragePolicyResponseArgs

AllowedPersistenceRegions This property is required. List<string>
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
EnforceInTransit This property is required. bool
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.
AllowedPersistenceRegions This property is required. []string
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
EnforceInTransit This property is required. bool
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.
allowedPersistenceRegions This property is required. List<String>
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
enforceInTransit This property is required. Boolean
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.
allowedPersistenceRegions This property is required. string[]
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
enforceInTransit This property is required. boolean
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.
allowed_persistence_regions This property is required. Sequence[str]
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
enforce_in_transit This property is required. bool
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.
allowedPersistenceRegions This property is required. List<String>
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
enforceInTransit This property is required. Boolean
Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.

SchemaSettings
, SchemaSettingsArgs

Schema This property is required. string
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
Encoding Pulumi.GoogleNative.Pubsub.V1.SchemaSettingsEncoding
Optional. The encoding of messages validated against schema.
FirstRevisionId string
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
LastRevisionId string
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
Schema This property is required. string
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
Encoding SchemaSettingsEncoding
Optional. The encoding of messages validated against schema.
FirstRevisionId string
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
LastRevisionId string
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
schema This property is required. String
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
encoding SchemaSettingsEncoding
Optional. The encoding of messages validated against schema.
firstRevisionId String
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
lastRevisionId String
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
schema This property is required. string
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
encoding SchemaSettingsEncoding
Optional. The encoding of messages validated against schema.
firstRevisionId string
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
lastRevisionId string
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
schema This property is required. str
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
encoding SchemaSettingsEncoding
Optional. The encoding of messages validated against schema.
first_revision_id str
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
last_revision_id str
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
schema This property is required. String
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
encoding "ENCODING_UNSPECIFIED" | "JSON" | "BINARY"
Optional. The encoding of messages validated against schema.
firstRevisionId String
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
lastRevisionId String
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.

SchemaSettingsEncoding
, SchemaSettingsEncodingArgs

EncodingUnspecified
ENCODING_UNSPECIFIEDUnspecified
Json
JSONJSON encoding
Binary
BINARYBinary encoding, as defined by the schema type. For some schema types, binary encoding may not be available.
SchemaSettingsEncodingEncodingUnspecified
ENCODING_UNSPECIFIEDUnspecified
SchemaSettingsEncodingJson
JSONJSON encoding
SchemaSettingsEncodingBinary
BINARYBinary encoding, as defined by the schema type. For some schema types, binary encoding may not be available.
EncodingUnspecified
ENCODING_UNSPECIFIEDUnspecified
Json
JSONJSON encoding
Binary
BINARYBinary encoding, as defined by the schema type. For some schema types, binary encoding may not be available.
EncodingUnspecified
ENCODING_UNSPECIFIEDUnspecified
Json
JSONJSON encoding
Binary
BINARYBinary encoding, as defined by the schema type. For some schema types, binary encoding may not be available.
ENCODING_UNSPECIFIED
ENCODING_UNSPECIFIEDUnspecified
JSON
JSONJSON encoding
BINARY
BINARYBinary encoding, as defined by the schema type. For some schema types, binary encoding may not be available.
"ENCODING_UNSPECIFIED"
ENCODING_UNSPECIFIEDUnspecified
"JSON"
JSONJSON encoding
"BINARY"
BINARYBinary encoding, as defined by the schema type. For some schema types, binary encoding may not be available.

SchemaSettingsResponse
, SchemaSettingsResponseArgs

Encoding This property is required. string
Optional. The encoding of messages validated against schema.
FirstRevisionId This property is required. string
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
LastRevisionId This property is required. string
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
Schema This property is required. string
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
Encoding This property is required. string
Optional. The encoding of messages validated against schema.
FirstRevisionId This property is required. string
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
LastRevisionId This property is required. string
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
Schema This property is required. string
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
encoding This property is required. String
Optional. The encoding of messages validated against schema.
firstRevisionId This property is required. String
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
lastRevisionId This property is required. String
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
schema This property is required. String
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
encoding This property is required. string
Optional. The encoding of messages validated against schema.
firstRevisionId This property is required. string
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
lastRevisionId This property is required. string
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
schema This property is required. string
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
encoding This property is required. str
Optional. The encoding of messages validated against schema.
first_revision_id This property is required. str
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
last_revision_id This property is required. str
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
schema This property is required. str
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.
encoding This property is required. String
Optional. The encoding of messages validated against schema.
firstRevisionId This property is required. String
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
lastRevisionId This property is required. String
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
schema This property is required. String
The name of the schema that messages published should be validated against. Format is projects/{project}/schemas/{schema}. The value of this field will be _deleted-schema_ if the schema has been deleted.

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