Class: Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

Inherits:

Object

• Object
• Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb

Overview

A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.

Defined Under Namespace

Modules: Category, State Classes: BigQueryDatasetSource, CommercialInfo, PubSubTopicSource, RestrictedExportConfig

Instance Attribute Summary

• #allow_only_metadata_sharing ⇒ ::Boolean

  Optional.

• #bigquery_dataset ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource

  Shared dataset i.e.

• #categories ⇒ ::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::Category>

  Optional.

• #commercial_info ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo readonly

  Output only.

• #data_provider ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataProvider

  Optional.

• #description ⇒ ::String

  Optional.

• #discovery_type ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DiscoveryType

  Optional.

• #display_name ⇒ ::String

  Required.

• #documentation ⇒ ::String

  Optional.

• #icon ⇒ ::String

  Optional.

• #log_linked_dataset_query_user_email ⇒ ::Boolean

  Optional.

• #name ⇒ ::String readonly

  Output only.

• #primary_contact ⇒ ::String

  Optional.

• #publisher ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Publisher

  Optional.

• #pubsub_topic ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::PubSubTopicSource

  Pub/Sub topic source.

• #request_access ⇒ ::String

  Optional.

• #resource_type ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::SharedResourceType readonly

  Output only.

• #restricted_export_config ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::RestrictedExportConfig

  Optional.

• #state ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::State readonly

  Output only.

Instance Attribute Details

#allow_only_metadata_sharing ⇒ ::Boolean

Returns Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.

Returns:

• (::Boolean) —

  Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#bigquery_dataset ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource

Returns Shared dataset i.e. BigQuery dataset source.

Note: The following fields are mutually exclusive: bigquery_dataset, pubsub_topic. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource) —

  Shared dataset i.e. BigQuery dataset source.

  Note: The following fields are mutually exclusive: bigquery_dataset, pubsub_topic. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#categories ⇒ ::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::Category>

Returns Optional. Categories of the listing. Up to five categories are allowed.

Returns:

• (::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::Category>) —

  Optional. Categories of the listing. Up to five categories are allowed.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#commercial_info ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo (readonly)

Returns Output only. Commercial info contains the information about the commercial data products associated with the listing.

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo) —

  Output only. Commercial info contains the information about the commercial data products associated with the listing.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#data_provider ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataProvider

Returns Optional. Details of the data provider who owns the source data.

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataProvider) —

  Optional. Details of the data provider who owns the source data.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#description ⇒ ::String

Returns Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.

Returns:

• (::String) —

  Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#discovery_type ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DiscoveryType

Returns Optional. Type of discovery of the listing on the discovery page.

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::DiscoveryType) —

  Optional. Type of discovery of the listing on the discovery page.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#display_name ⇒ ::String

Returns Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.

Returns:

• (::String) —

  Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#documentation ⇒ ::String

Returns Optional. Documentation describing the listing.

Returns:

• (::String) —

  Optional. Documentation describing the listing.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#icon ⇒ ::String

Returns Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.

Returns:

• (::String) —

  Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#log_linked_dataset_query_user_email ⇒ ::Boolean

Returns Optional. By default, false. If true, the Listing has an email sharing mandate enabled.

Returns:

• (::Boolean) —

  Optional. By default, false. If true, the Listing has an email sharing mandate enabled.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the listing. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.

Returns:

• (::String) —

  Output only. The resource name of the listing. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#primary_contact ⇒ ::String

Returns Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.

Returns:

• (::String) —

  Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#publisher ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Publisher

Returns Optional. Details of the publisher who owns the listing and who can share the source data.

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::Publisher) —

  Optional. Details of the publisher who owns the listing and who can share the source data.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#pubsub_topic ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::PubSubTopicSource

Returns Pub/Sub topic source.

Note: The following fields are mutually exclusive: pubsub_topic, bigquery_dataset. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::PubSubTopicSource) —

  Pub/Sub topic source.

  Note: The following fields are mutually exclusive: pubsub_topic, bigquery_dataset. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#request_access ⇒ ::String

Returns Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

Returns:

• (::String) —

  Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#resource_type ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::SharedResourceType (readonly)

Returns Output only. Listing shared asset type.

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::SharedResourceType) —

  Output only. Listing shared asset type.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#restricted_export_config ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::RestrictedExportConfig

Returns Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::RestrictedExportConfig) —

  Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end

#state ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::State (readonly)

Returns Output only. Current state of the listing.

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::State) —

  Output only. Current state of the listing.

# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 489

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

  # A reference to a shared dataset. It is an existing BigQuery dataset with a
  # collection of objects such as tables and views that you want to share
  # with subscribers.
  # When subscriber's subscribe to a listing, Analytics Hub creates a linked
  # dataset in
  # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
  # dataset that serves as a _symbolic link_ to a shared dataset.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Optional. Resource name of the dataset source for this listing.
  #     e.g. `projects/myproject/datasets/123`
  # @!attribute [rw] selected_resources
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::SelectedResource>]
  #     Optional. Resource in this dataset that is selectively shared.
  #     This field is required for data clean room exchanges.
  # @!attribute [rw] restricted_export_policy
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::RestrictedExportPolicy]
  #     Optional. If set, restricted export policy will be propagated and
  #     enforced on the linked dataset.
  # @!attribute [rw] replica_locations
  #   @return [::Array<::String>]
  #     Optional. A list of regions where the publisher has created shared
  #     dataset replicas.
  # @!attribute [r] effective_replicas
  #   @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica>]
  #     Output only. Server-owned effective state of replicas.
  #     Contains both primary and secondary replicas.
  #     Each replica includes a system-computed (output-only) state and primary
  #     designation.
  class BigQueryDatasetSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource in this dataset that is selectively shared.
    # @!attribute [rw] table
    #   @return [::String]
    #     Optional. Format:
    #     For table:
    #     `projects/{projectId}/datasets/{datasetId}/tables/{tableId}`
    #     Example:"projects/test_project/datasets/test_dataset/tables/test_table"
    #
    #     Note: The following fields are mutually exclusive: `table`, `routine`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] routine
    #   @return [::String]
    #     Optional. Format:
    #     For routine:
    #     `projects/{projectId}/datasets/{datasetId}/routines/{routineId}`
    #     Example:"projects/test_project/datasets/test_dataset/routines/test_routine"
    #
    #     Note: The following fields are mutually exclusive: `routine`, `table`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class SelectedResource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Restricted export policy used to configure restricted export on linked
    # dataset.
    # @!attribute [rw] enabled
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, enable restricted export.
    # @!attribute [rw] restrict_direct_table_access
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict direct table access (read
    #     api/tabledata.list) on linked table.
    # @!attribute [rw] restrict_query_result
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. If true, restrict export of query result derived from
    #     restricted linked dataset table.
    class RestrictedExportPolicy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the state of a replica of a shared dataset.
    # It includes the geographic location of the replica and
    # system-computed, output-only fields indicating its replication state and
    # whether it is the primary replica.
    # @!attribute [r] location
    #   @return [::String]
    #     Output only. The geographic location where the replica resides. See
    #     [BigQuery locations](https://cloud.google.com/bigquery/docs/locations)
    #     for supported locations. Eg. "us-central1".
    # @!attribute [r] replica_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::ReplicaState]
    #     Output only. Assigned by Analytics Hub based on real BigQuery
    #     replication state.
    # @!attribute [r] primary_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource::Replica::PrimaryState]
    #     Output only. Indicates that this replica is the primary replica.
    class Replica
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Replica state of the shared dataset.
      module ReplicaState
        # Default value. This value is unused.
        REPLICA_STATE_UNSPECIFIED = 0

        # The replica is backfilled and ready to use.
        READY_TO_USE = 1

        # The replica is unavailable, does not exist, or has not been
        # backfilled yet.
        UNAVAILABLE = 2
      end

      # Primary state of the replica. Set only for the primary replica.
      module PrimaryState
        # Default value. This value is unused.
        PRIMARY_STATE_UNSPECIFIED = 0

        # The replica is the primary replica.
        PRIMARY_REPLICA = 1
      end
    end
  end

  # Pub/Sub topic source.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. Resource name of the Pub/Sub topic source for this listing.
  #     e.g. projects/myproject/topics/topicId
  # @!attribute [rw] data_affinity_regions
  #   @return [::Array<::String>]
  #     Optional. Region hint on where the data might be published. Data affinity
  #     regions are modifiable. See https://cloud.google.com/about/locations for
  #     full listing of possible Cloud regions.
  class PubSubTopicSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restricted export config, used to configure restricted export on linked
  # dataset.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. If true, enable restricted export.
  # @!attribute [r] restrict_direct_table_access
  #   @return [::Boolean]
  #     Output only. If true, restrict direct table access(read
  #     api/tabledata.list) on linked table.
  # @!attribute [rw] restrict_query_result
  #   @return [::Boolean]
  #     Optional. If true, restrict export of query result derived from
  #     restricted linked dataset table.
  class RestrictedExportConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Commercial info contains the information about the commercial data products
  # associated with the listing.
  # @!attribute [r] cloud_marketplace
  #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo]
  #     Output only. Details of the Marketplace Data Product associated with the
  #     Listing.
  class CommercialInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies the details of the Marketplace Data Product associated with the
    # Listing.
    # @!attribute [r] service
    #   @return [::String]
    #     Output only. Resource name of the commercial service associated with
    #     the Marketplace Data Product. e.g. example.com
    # @!attribute [r] commercial_state
    #   @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::CommercialInfo::GoogleCloudMarketplaceInfo::CommercialState]
    #     Output only. Commercial state of the Marketplace Data Product.
    class GoogleCloudMarketplaceInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Indicates whether this commercial access is currently active.
      module CommercialState
        # Commercialization is incomplete and cannot be used.
        COMMERCIAL_STATE_UNSPECIFIED = 0

        # Commercialization has been initialized.
        ONBOARDING = 1

        # Commercialization is complete and available for use.
        ACTIVE = 2
      end
    end
  end

  # State of the listing.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Subscribable state. Users with dataexchange.listings.subscribe permission
    # can subscribe to this listing.
    ACTIVE = 1
  end

  # Listing categories.
  module Category
    CATEGORY_UNSPECIFIED = 0

    CATEGORY_OTHERS = 1

    CATEGORY_ADVERTISING_AND_MARKETING = 2

    CATEGORY_COMMERCE = 3

    CATEGORY_CLIMATE_AND_ENVIRONMENT = 4

    CATEGORY_DEMOGRAPHICS = 5

    CATEGORY_ECONOMICS = 6

    CATEGORY_EDUCATION = 7

    CATEGORY_ENERGY = 8

    CATEGORY_FINANCIAL = 9

    CATEGORY_GAMING = 10

    CATEGORY_GEOSPATIAL = 11

    CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12

    CATEGORY_MEDIA = 13

    CATEGORY_PUBLIC_SECTOR = 14

    CATEGORY_RETAIL = 15

    CATEGORY_SPORTS = 16

    CATEGORY_SCIENCE_AND_RESEARCH = 17

    CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18

    CATEGORY_TRAVEL_AND_TOURISM = 19

    CATEGORY_GOOGLE_EARTH_ENGINE = 20
  end
end