gcp_analyticshub_listing

allow_only_metadata_sharing

Type: BOOLEAN
Provider name: allowOnlyMetadataSharing
Description: Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.

ancestors

Type: UNORDERED_LIST_STRING

bigquery_dataset

Type: STRUCT
Provider name: bigqueryDataset
Description: Shared dataset i.e. BigQuery dataset source.

  • dataset
    Type: STRING
    Provider name: dataset
    Description: Optional. Resource name of the dataset source for this listing. e.g. projects/myproject/datasets/123
  • effective_replicas
    Type: UNORDERED_LIST_STRUCT
    Provider name: effectiveReplicas
    Description: 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.
    • location
      Type: STRING
      Provider name: location
      Description: Output only. The geographic location where the replica resides. See BigQuery locations for supported locations. Eg. “us-central1”.
    • primary_state
      Type: STRING
      Provider name: primaryState
      Description: Output only. Indicates that this replica is the primary replica.
      Possible values:
      • PRIMARY_STATE_UNSPECIFIED - Default value. This value is unused.
      • PRIMARY_REPLICA - The replica is the primary replica.
    • replica_state
      Type: STRING
      Provider name: replicaState
      Description: Output only. Assigned by Analytics Hub based on real BigQuery replication state.
      Possible values:
      • REPLICA_STATE_UNSPECIFIED - Default value. This value is unused.
      • READY_TO_USE - The replica is backfilled and ready to use.
      • UNAVAILABLE - The replica is unavailable, does not exist, or has not been backfilled yet.
  • replica_locations
    Type: UNORDERED_LIST_STRING
    Provider name: replicaLocations
    Description: Optional. A list of regions where the publisher has created shared dataset replicas.
  • restricted_export_policy
    Type: STRUCT
    Provider name: restrictedExportPolicy
    Description: Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.
    • enabled
      Type: BOOLEAN
      Provider name: enabled
      Description: Optional. If true, enable restricted export.
    • restrict_direct_table_access
      Type: BOOLEAN
      Provider name: restrictDirectTableAccess
      Description: Optional. If true, restrict direct table access (read api/tabledata.list) on linked table.
    • restrict_query_result
      Type: BOOLEAN
      Provider name: restrictQueryResult
      Description: Optional. If true, restrict export of query result derived from restricted linked dataset table.
  • selected_resources
    Type: UNORDERED_LIST_STRUCT
    Provider name: selectedResources
    Description: Optional. Resource in this dataset that is selectively shared. This field is required for data clean room exchanges.
    • routine
      Type: STRING
      Provider name: routine
      Description: Optional. Format: For routine: projects/{projectId}/datasets/{datasetId}/routines/{routineId} Example:“projects/test_project/datasets/test_dataset/routines/test_routine”
    • table
      Type: STRING
      Provider name: table
      Description: Optional. Format: For table: projects/{projectId}/datasets/{datasetId}/tables/{tableId} Example:“projects/test_project/datasets/test_dataset/tables/test_table”

categories

Type: UNORDERED_LIST_STRING
Provider name: categories
Description: Optional. Categories of the listing. Up to five categories are allowed.

commercial_info

Type: STRUCT
Provider name: commercialInfo
Description: Output only. Commercial info contains the information about the commercial data products associated with the listing.

  • cloud_marketplace
    Type: STRUCT
    Provider name: cloudMarketplace
    Description: Output only. Details of the Marketplace Data Product associated with the Listing.
    • commercial_state
      Type: STRING
      Provider name: commercialState
      Description: Output only. Commercial state of the Marketplace Data Product.
      Possible values:
      • COMMERCIAL_STATE_UNSPECIFIED - Commercialization is incomplete and cannot be used.
      • ONBOARDING - Commercialization has been initialized.
      • ACTIVE - Commercialization is complete and available for use.
    • service
      Type: STRING
      Provider name: service
      Description: Output only. Resource name of the commercial service associated with the Marketplace Data Product. e.g. example.com

data_provider

Type: STRUCT
Provider name: dataProvider
Description: Optional. Details of the data provider who owns the source data.

  • name
    Type: STRING
    Provider name: name
    Description: Optional. Name of the data provider.
  • primary_contact
    Type: STRING
    Provider name: primaryContact
    Description: Optional. Email or URL of the data provider. Max Length: 1000 bytes.

description

Type: STRING
Provider name: description
Description: 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.

discovery_type

Type: STRING
Provider name: discoveryType
Description: Optional. Type of discovery of the listing on the discovery page.
Possible values:

  • DISCOVERY_TYPE_UNSPECIFIED - Unspecified. Defaults to DISCOVERY_TYPE_PRIVATE.
  • DISCOVERY_TYPE_PRIVATE - The Data exchange/listing can be discovered in the ‘Private’ results list.
  • DISCOVERY_TYPE_PUBLIC - The Data exchange/listing can be discovered in the ‘Public’ results list.

documentation

Type: STRING
Provider name: documentation
Description: Optional. Documentation describing the listing.

gcp_display_name

Type: STRING
Provider name: displayName
Description: 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.

labels

Type: UNORDERED_LIST_STRING

log_linked_dataset_query_user_email

Type: BOOLEAN
Provider name: logLinkedDatasetQueryUserEmail
Description: Optional. By default, false. If true, the Listing has an email sharing mandate enabled.

name

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

organization_id

Type: STRING

parent

Type: STRING

primary_contact

Type: STRING
Provider name: primaryContact
Description: Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.

project_id

Type: STRING

project_number

Type: STRING

publisher

Type: STRUCT
Provider name: publisher
Description: Optional. Details of the publisher who owns the listing and who can share the source data.

  • name
    Type: STRING
    Provider name: name
    Description: Optional. Name of the listing publisher.
  • primary_contact
    Type: STRING
    Provider name: primaryContact
    Description: Optional. Email or URL of the listing publisher. Max Length: 1000 bytes.

pubsub_topic

Type: STRUCT
Provider name: pubsubTopic
Description: Pub/Sub topic source.

  • data_affinity_regions
    Type: UNORDERED_LIST_STRING
    Provider name: dataAffinityRegions
    Description: 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.
  • topic
    Type: STRING
    Provider name: topic
    Description: Required. Resource name of the Pub/Sub topic source for this listing. e.g. projects/myproject/topics/topicId

region_id

Type: STRING

request_access

Type: STRING
Provider name: requestAccess
Description: Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

resource_name

Type: STRING

resource_type

Type: STRING
Provider name: resourceType
Description: Output only. Listing shared asset type.
Possible values:

  • SHARED_RESOURCE_TYPE_UNSPECIFIED - Not specified.
  • BIGQUERY_DATASET - BigQuery Dataset Asset.
  • PUBSUB_TOPIC - Pub/Sub Topic Asset.

restricted_export_config

Type: STRUCT
Provider name: restrictedExportConfig
Description: Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

  • enabled
    Type: BOOLEAN
    Provider name: enabled
    Description: Optional. If true, enable restricted export.
  • restrict_direct_table_access
    Type: BOOLEAN
    Provider name: restrictDirectTableAccess
    Description: Output only. If true, restrict direct table access(read api/tabledata.list) on linked table.
  • restrict_query_result
    Type: BOOLEAN
    Provider name: restrictQueryResult
    Description: Optional. If true, restrict export of query result derived from restricted linked dataset table.

state

Type: STRING
Provider name: state
Description: Output only. Current state of the listing.
Possible values:

  • STATE_UNSPECIFIED - Default value. This value is unused.
  • ACTIVE - Subscribable state. Users with dataexchange.listings.subscribe permission can subscribe to this listing.

stored_procedure_config

Type: STRUCT
Provider name: storedProcedureConfig
Description: Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset.

  • allowed_stored_procedure_types
    Type: UNORDERED_LIST_STRING
    Provider name: allowedStoredProcedureTypes
    Description: Output only. Types of stored procedure supported to share.
  • enabled
    Type: BOOLEAN
    Provider name: enabled
    Description: Optional. If true, enable sharing of stored procedure.

tags

Type: UNORDERED_LIST_STRING

zone_id

Type: STRING