StreamState class

Input properties used for looking up and filtering Stream resources.

Constructors

StreamState({Input<StreamBackfillAll?>? backfillAll, Input<Map<String, dynamic>?>? backfillNone, Input<bool?>? createWithoutValidation, Input<String?>? customerManagedEncryptionKey, Input<String?>? deletionPolicy, Input<String?>? desiredState, Input<StreamDestinationConfig?>? destinationConfig, Input<String?>? displayName, Input<Map<String, String>?>? effectiveLabels, Input<Map<String, String>?>? labels, Input<String?>? location, Input<String?>? name, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<List<StreamRuleSet>?>? ruleSets, Input<StreamSourceConfig?>? sourceConfig, Input<String?>? state, Input<String?>? streamId})

Creates a new StreamState. backfillAll Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. backfillNone Backfill strategy to disable automatic backfill for the Stream's objects. createWithoutValidation Create the stream without validating it. customerManagedEncryptionKey A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. desiredState Desired state of the Stream. Set this field to RUNNING to start the stream, destinationConfig Destination connection profile configuration. displayName Display name. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. labels Labels. location The name of the location this stream is located in. name The stream's name. project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource ruleSets Rule sets to apply to the stream. sourceConfig Source connection profile configuration. state The state of the stream. streamId The stream identifier.

const

StreamState.fromMap(Map<String, dynamic> map)

factory

Properties

backfillAll → Input<StreamBackfillAll?>?

Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. Structure is documented below.

final

backfillNone → Input<Map<String, dynamic>?>?

Backfill strategy to disable automatic backfill for the Stream's objects.

final

createWithoutValidation → Input<bool?>?

Create the stream without validating it.

final

customerManagedEncryptionKey → Input<String?>?

A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.

final

deletionPolicy → Input<String?>?

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

final

desiredState → Input<String?>?

Desired state of the Stream. Set this field to RUNNING to start the stream, NOT_STARTED to create the stream without starting and PAUSED to pause the stream from a RUNNING state. Possible values: NOT_STARTED, RUNNING, PAUSED. Default: NOT_STARTED

final

destinationConfig → Input<StreamDestinationConfig?>?

Destination connection profile configuration. Structure is documented below.

final

displayName → Input<String?>?

Display name.

final

effectiveLabels → Input<Map<String, String>?>?

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

final

hashCode → int

The hash code for this object.

no setter, inherited

labels → Input<Map<String, String>?>?

Labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

final

location → Input<String?>?

The name of the location this stream is located in.

final

name → Input<String?>?

The stream's name.

final

project → Input<String?>?

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

final

pulumiLabels → Input<Map<String, String>?>?

The combination of labels configured directly on the resource and default labels configured on the provider.

final

ruleSets → Input<List<StreamRuleSet>?>?

Rule sets to apply to the stream. Structure is documented below.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sourceConfig → Input<StreamSourceConfig?>?

Source connection profile configuration. Structure is documented below.

final

state → Input<String?>?

The state of the stream.

final

streamId → Input<String?>?

The stream identifier.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited