Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 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 message google.cloud.bigquery.analyticshub.v1.DataExchange
Namespace
Google \ Cloud \ BigQuery \ AnalyticsHub \ V1Methods
__construct
Constructor.
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.
↳ sharing_environment_config
Google\Cloud\BigQuery\AnalyticsHub\V1\SharingEnvironmentConfig
Optional. Configurable data sharing environment option for a data exchange.
getName
Output only. The resource name of the data exchange.
e.g. projects/myproject/locations/US/dataExchanges/123
.
string
setName
Output only. The resource name of the data exchange.
e.g. projects/myproject/locations/US/dataExchanges/123
.
var
string
$this
getDisplayName
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.
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.
var
string
$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.
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.
var
string
$this
getPrimaryContact
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
string
setPrimaryContact
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
var
string
$this
getDocumentation
Optional. Documentation describing the data exchange.
string
setDocumentation
Optional. Documentation describing the data exchange.
var
string
$this
getListingCount
Output only. Number of listings contained in the data exchange.
int
setListingCount
Output only. Number of listings contained in the data exchange.
var
int
$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.
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.
var
string
$this
getSharingEnvironmentConfig
Optional. Configurable data sharing environment option for a data exchange.
hasSharingEnvironmentConfig
clearSharingEnvironmentConfig
setSharingEnvironmentConfig
Optional. Configurable data sharing environment option for a data exchange.
$this
