Reference documentation and code samples for the Google Cloud BigQuery Data Exchange V1beta1 Client class DataExchange.
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.
Generated from protobuf messagegoogle.cloud.bigquery.dataexchange.v1beta1.DataExchange
Namespace
Google \ Cloud \ BigQuery \ DataExchange \ V1beta1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the data exchange. e.g.projects/myproject/locations/US/dataExchanges/123.
↳ display_name
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.
↳ description
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.
↳ primary_contact
string
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
↳ documentation
string
Optional. Documentation describing the data exchange.
↳ listing_count
int
Output only. Number of listings contained in the data exchange.
↳ icon
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.
getName
Output only. The resource name of the data exchange.
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.
Returns
Type
Description
string
setDisplayName
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
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.
Returns
Type
Description
string
setDescription
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPrimaryContact
Optional. Email or URL of the primary point of contact of the data exchange.
Max Length: 1000 bytes.
Returns
Type
Description
string
setPrimaryContact
Optional. Email or URL of the primary point of contact of the data exchange.
Max Length: 1000 bytes.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDocumentation
Optional. Documentation describing the data exchange.
Returns
Type
Description
string
setDocumentation
Optional. Documentation describing the data exchange.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getListingCount
Output only. Number of listings contained in the data exchange.
Returns
Type
Description
int
setListingCount
Output only. Number of listings contained in the data exchange.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getIcon
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.
Returns
Type
Description
string
setIcon
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud BigQuery Data Exchange V1beta1 Client - Class DataExchange (0.5.2)\n\nVersion latestkeyboard_arrow_down\n\n- [0.5.2 (latest)](/php/docs/reference/cloud-bigquery-data-exchange/latest/V1beta1.DataExchange)\n- [0.5.1](/php/docs/reference/cloud-bigquery-data-exchange/0.5.1/V1beta1.DataExchange)\n- [0.4.7](/php/docs/reference/cloud-bigquery-data-exchange/0.4.7/V1beta1.DataExchange)\n- [0.3.3](/php/docs/reference/cloud-bigquery-data-exchange/0.3.3/V1beta1.DataExchange)\n- [0.2.6](/php/docs/reference/cloud-bigquery-data-exchange/0.2.6/V1beta1.DataExchange) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud BigQuery Data Exchange V1beta1 Client class DataExchange.\n\nA data exchange is a container that lets you share data. Along with the\ndescriptive information about the data exchange, it contains listings that\nreference shared datasets.\n\nGenerated from protobuf message `google.cloud.bigquery.dataexchange.v1beta1.DataExchange`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BigQuery \\\\ DataExchange \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. The resource name of the data exchange.\n\ne.g. `projects/myproject/locations/US/dataExchanges/123`.\n\n### setName\n\nOutput only. The resource name of the data exchange.\n\ne.g. `projects/myproject/locations/US/dataExchanges/123`.\n\n### getDisplayName\n\nRequired. Human-readable display name of the data exchange. The display name must\ncontain only Unicode letters, numbers (0-9), underscores (_), dashes (-),\nspaces ( ), ampersands (\\&) and must not start or end with spaces.\n\nDefault value is an empty string.\nMax length: 63 bytes.\n\n### setDisplayName\n\nRequired. Human-readable display name of the data exchange. The display name must\ncontain only Unicode letters, numbers (0-9), underscores (_), dashes (-),\nspaces ( ), ampersands (\\&) and must not start or end with spaces.\n\nDefault value is an empty string.\nMax length: 63 bytes.\n\n### getDescription\n\nOptional. Description of the data exchange. The description must not contain Unicode\nnon-characters as well as C0 and C1 control codes except tabs (HT),\nnew lines (LF), carriage returns (CR), and page breaks (FF).\n\nDefault value is an empty string.\nMax length: 2000 bytes.\n\n### setDescription\n\nOptional. Description of the data exchange. The description must not contain Unicode\nnon-characters as well as C0 and C1 control codes except tabs (HT),\nnew lines (LF), carriage returns (CR), and page breaks (FF).\n\nDefault value is an empty string.\nMax length: 2000 bytes.\n\n### getPrimaryContact\n\nOptional. Email or URL of the primary point of contact of the data exchange.\n\nMax Length: 1000 bytes.\n\n### setPrimaryContact\n\nOptional. Email or URL of the primary point of contact of the data exchange.\n\nMax Length: 1000 bytes.\n\n### getDocumentation\n\nOptional. Documentation describing the data exchange.\n\n### setDocumentation\n\nOptional. Documentation describing the data exchange.\n\n### getListingCount\n\nOutput only. Number of listings contained in the data exchange.\n\n### setListingCount\n\nOutput only. Number of listings contained in the data exchange.\n\n### getIcon\n\nOptional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB\nExpected image dimensions are 512x512 pixels, however the API only\nperforms validation on size of the encoded data.\n\nNote: For byte fields, the content of the fields are base64-encoded (which\nincreases the size of the data by 33-36%) when using JSON on the wire.\n\n### setIcon\n\nOptional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB\nExpected image dimensions are 512x512 pixels, however the API only\nperforms validation on size of the encoded data.\n\nNote: For byte fields, the content of the fields are base64-encoded (which\nincreases the size of the data by 33-36%) when using JSON on the wire."]]
