Google Cloud BigQuery Analytics Hub V1 Client - Class DataExchange (1.0.0)

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 \ V1

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.

↳ sharing_environment_config Google\Cloud\BigQuery\AnalyticsHub\V1\SharingEnvironmentConfig

Optional. Configurable data sharing environment option for a data exchange.

↳ discovery_type int

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.

getName

Output only. The resource name of the data exchange.

e.g. projects/myproject/locations/US/dataExchanges/123.

Returns
Type Description
string

setName

Output only. The resource name of the data exchange.

e.g. projects/myproject/locations/US/dataExchanges/123.

Parameter
Name Description
var string
Returns
Type Description
$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.

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getSharingEnvironmentConfig

Optional. Configurable data sharing environment option for a data exchange.

Returns
Type Description
Google\Cloud\BigQuery\AnalyticsHub\V1\SharingEnvironmentConfig|null

hasSharingEnvironmentConfig

clearSharingEnvironmentConfig

setSharingEnvironmentConfig

Optional. Configurable data sharing environment option for a data exchange.

Parameter
Name Description
var Google\Cloud\BigQuery\AnalyticsHub\V1\SharingEnvironmentConfig
Returns
Type Description
$this

getDiscoveryType

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.

Returns
Type Description
int

hasDiscoveryType

clearDiscoveryType

setDiscoveryType

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.

Parameter
Name Description
var int
Returns
Type Description
$this