Class: Google::Cloud::PubSub::V1::BigQueryConfig

Inherits:

Object

• Object
• Google::Cloud::PubSub::V1::BigQueryConfig

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/pubsub/v1/pubsub.rb

Overview

Configuration for a BigQuery subscription.

Defined Under Namespace

Modules: State

Instance Attribute Summary

• #drop_unknown_fields ⇒ ::Boolean

  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.

• #state ⇒ ::Google::Cloud::PubSub::V1::BigQueryConfig::State readonly

  Output only.

• #table ⇒ ::String

  The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}.

• #use_topic_schema ⇒ ::Boolean

  When true, use the topic's schema as the columns to write to in BigQuery, if it exists.

• #write_metadata ⇒ ::Boolean

  When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table.

Instance Attribute Details

#drop_unknown_fields ⇒ ::Boolean

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 676

class BigQueryConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states for a BigQuery subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to BigQuery
    ACTIVE = 1

    # Cannot write to the BigQuery table because of permission denied errors.
    # This can happen if
    # - Pub/Sub SA has not been granted the [appropriate BigQuery IAM
    # permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account)
    # - bigquery.googleapis.com API is not enabled for the project
    # ([instructions](https://cloud.google.com/service-usage/docs/enable-disable))
    PERMISSION_DENIED = 2

    # Cannot write to the BigQuery table because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the BigQuery table due to a schema mismatch.
    SCHEMA_MISMATCH = 4
  end
end

#state ⇒ ::Google::Cloud::PubSub::V1::BigQueryConfig::State (readonly)

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 676

class BigQueryConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states for a BigQuery subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to BigQuery
    ACTIVE = 1

    # Cannot write to the BigQuery table because of permission denied errors.
    # This can happen if
    # - Pub/Sub SA has not been granted the [appropriate BigQuery IAM
    # permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account)
    # - bigquery.googleapis.com API is not enabled for the project
    # ([instructions](https://cloud.google.com/service-usage/docs/enable-disable))
    PERMISSION_DENIED = 2

    # Cannot write to the BigQuery table because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the BigQuery table due to a schema mismatch.
    SCHEMA_MISMATCH = 4
  end
end

#table ⇒ ::String

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 676

class BigQueryConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states for a BigQuery subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to BigQuery
    ACTIVE = 1

    # Cannot write to the BigQuery table because of permission denied errors.
    # This can happen if
    # - Pub/Sub SA has not been granted the [appropriate BigQuery IAM
    # permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account)
    # - bigquery.googleapis.com API is not enabled for the project
    # ([instructions](https://cloud.google.com/service-usage/docs/enable-disable))
    PERMISSION_DENIED = 2

    # Cannot write to the BigQuery table because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the BigQuery table due to a schema mismatch.
    SCHEMA_MISMATCH = 4
  end
end

#use_topic_schema ⇒ ::Boolean

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 676

class BigQueryConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states for a BigQuery subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to BigQuery
    ACTIVE = 1

    # Cannot write to the BigQuery table because of permission denied errors.
    # This can happen if
    # - Pub/Sub SA has not been granted the [appropriate BigQuery IAM
    # permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account)
    # - bigquery.googleapis.com API is not enabled for the project
    # ([instructions](https://cloud.google.com/service-usage/docs/enable-disable))
    PERMISSION_DENIED = 2

    # Cannot write to the BigQuery table because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the BigQuery table due to a schema mismatch.
    SCHEMA_MISMATCH = 4
  end
end

#write_metadata ⇒ ::Boolean

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 676

class BigQueryConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states for a BigQuery subscription.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The subscription can actively send messages to BigQuery
    ACTIVE = 1

    # Cannot write to the BigQuery table because of permission denied errors.
    # This can happen if
    # - Pub/Sub SA has not been granted the [appropriate BigQuery IAM
    # permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account)
    # - bigquery.googleapis.com API is not enabled for the project
    # ([instructions](https://cloud.google.com/service-usage/docs/enable-disable))
    PERMISSION_DENIED = 2

    # Cannot write to the BigQuery table because it does not exist.
    NOT_FOUND = 3

    # Cannot write to the BigQuery table due to a schema mismatch.
    SCHEMA_MISMATCH = 4
  end
end