Analytics Hub API . organizations . locations . dataExchanges

close()

Close httplib2 connections.

list(organization, pageSize=None, pageToken=None, x__xgafv=None)

Lists all data exchanges from projects in a given organization and location.

Args:
  organization: string, Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`. (required)
  pageSize: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
  pageToken: string, Page token, returned by a previous call, to request the next page of results.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing data exchanges in an organization and location.
  "dataExchanges": [ # The list of data exchanges.
    { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
      "description": "A String", # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as 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.
      "discoveryType": "A String", # Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.
      "displayName": "A String", # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
      "documentation": "A String", # Optional. Documentation describing the data exchange.
      "icon": "A String", # Optional. Base64 encoded image representing the data exchange. 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 content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
      "listingCount": 42, # Output only. Number of listings contained in the data exchange.
      "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
      "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
      "sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
        "dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
          "singleLinkedDatasetPerCleanroom": True or False, # Output only. If True, when subscribing to this DCR, it will create only one linked dataset containing all resources shared within the cleanroom. If False, when subscribing to this DCR, it will create 1 linked dataset per listing. This is not configurable, and by default, all new DCRs will have the restriction set to True.
          "singleSelectedResourceSharingRestriction": True or False, # Output only. If True, this DCR restricts the contributors to sharing only a single resource in a Listing. And no two resources should have the same IDs. So if a contributor adds a view with a conflicting name, the CreateListing API will reject the request. if False, the data contributor can publish an entire dataset (as before). This is not configurable, and by default, all new DCRs will have the restriction set to True.
        },
        "defaultExchangeConfig": { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
        },
      },
    },
  ],
  "nextPageToken": "A String", # A token to request the next page of results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.