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

Inherits:
Object
  • Object
show all
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 collapse

Instance Attribute Details

#drop_unknown_fields ⇒ ::Boolean

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

Returns:

  • (::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. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 717

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)

Returns Output only. An output-only field that indicates whether or not the subscription can receive messages.

Returns:



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 717

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

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

Returns:

  • (::String) —

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



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 717

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_table_schema ⇒ ::Boolean

Returns Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery. use_table_schema and use_topic_schema cannot be enabled at the same time.

Returns:

  • (::Boolean) —

    Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery. use_table_schema and use_topic_schema cannot be enabled at the same time.



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 717

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

Returns Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. use_topic_schema and use_table_schema cannot be enabled at the same time.

Returns:

  • (::Boolean) —

    Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. use_topic_schema and use_table_schema cannot be enabled at the same time.



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 717

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

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

Returns:

  • (::Boolean) —

    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.



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 717

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