Package com.hashicorp.cdktf.providers.google.pubsub_subscription

Interface PubsubSubscriptionBigqueryConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    PubsubSubscriptionBigqueryConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.477Z")
@Stability(Stable)
public interface PubsubSubscriptionBigqueryConfig
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getTable

        @Stability(Stable)
@NotNull
String getTable()
        The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#table PubsubSubscription#table}

      • getDropUnknownFields

        @Stability(Stable)
@Nullable
default Object getDropUnknownFields()
        When true and use_topic_schema or use_table_schema is true, any fields that are a part of the topic schema or message 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#drop_unknown_fields PubsubSubscription#drop_unknown_fields}

      • getServiceAccountEmail

        @Stability(Stable)
@Nullable
default String getServiceAccountEmail()
        The service account to use to write to BigQuery. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#service_account_email PubsubSubscription#service_account_email}

      • getUseTableSchema

        @Stability(Stable)
@Nullable
default Object getUseTableSchema()
        When true, use the BigQuery table's schema as the columns to write to in BigQuery.

        Messages must be published in JSON format. Only one of use_topic_schema and use_table_schema can be set. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#use_table_schema PubsubSubscription#use_table_schema}

      • getUseTopicSchema

        @Stability(Stable)
@Nullable
default Object getUseTopicSchema()
        When true, use the topic's schema as the columns to write to in BigQuery, if it exists.

        Only one of use_topic_schema and use_table_schema can be set. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#use_topic_schema PubsubSubscription#use_topic_schema}

      • getWriteMetadata

        @Stability(Stable)
@Nullable
default Object getWriteMetadata()
        When true, write the subscription name, messageId, publishTime, attributes, and orderingKey to additional columns in the table.

        The subscription name, messageId, and publishTime 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/pubsub_subscription#write_metadata PubsubSubscription#write_metadata}