Google Cloud BigQuery Analytics Hub V1 Client - Class Listing (0.2.2)

Version 0.2.2

• 1.0.2 (latest)
• 1.0.1
• 0.5.3
• 0.4.0
• 0.3.2
• 0.2.2
• 0.1.6

Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client class Listing.

A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.

Generated from protobuf message google.cloud.bigquery.analyticshub.v1.Listing

Namespace

Google \ Cloud \ BigQuery \ AnalyticsHub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ bigquery_dataset	Google\Cloud\BigQuery\AnalyticsHub\V1\Listing\BigQueryDatasetSource Required. Shared dataset i.e. BigQuery dataset source.
↳ name	string Output only. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456
↳ display_name	string 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.
↳ description	string 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.
↳ primary_contact	string Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
↳ documentation	string Optional. Documentation describing the listing.
↳ state	int Output only. Current state of the listing.
↳ icon	string Optional. Base64 encoded image representing the listing. 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 contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
↳ data_provider	Google\Cloud\BigQuery\AnalyticsHub\V1\DataProvider Optional. Details of the data provider who owns the source data.
↳ categories	array Optional. Categories of the listing. Up to two categories are allowed.
↳ publisher	Google\Cloud\BigQuery\AnalyticsHub\V1\Publisher Optional. Details of the publisher who owns the listing and who can share the source data.
↳ request_access	string Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

getBigqueryDataset

Required. Shared dataset i.e. BigQuery dataset source.

Returns
Type	Description
Google\Cloud\BigQuery\AnalyticsHub\V1\Listing\BigQueryDatasetSource|null

hasBigqueryDataset

setBigqueryDataset

Required. Shared dataset i.e. BigQuery dataset source.

Parameter
Name	Description
var	Google\Cloud\BigQuery\AnalyticsHub\V1\Listing\BigQueryDatasetSource

Returns
Type	Description
$this

getName

Output only. The resource name of the listing.

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

Returns
Type	Description
string

setName

Output only. The resource name of the listing.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

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.

Returns
Type	Description
string

setDisplayName

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

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.

Returns
Type	Description
string

setDescription

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPrimaryContact

Optional. Email or URL of the primary point of contact of the listing.

Max Length: 1000 bytes.

Returns
Type	Description
string

setPrimaryContact

Optional. Email or URL of the primary point of contact of the listing.

Max Length: 1000 bytes.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDocumentation

Optional. Documentation describing the listing.

Returns
Type	Description
string

setDocumentation

Optional. Documentation describing the listing.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getState

Output only. Current state of the listing.

Returns
Type	Description
int

setState

Output only. Current state of the listing.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getIcon

Optional. Base64 encoded image representing the listing. 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 contents of the field 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 listing. 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 contents of the field 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

getDataProvider

Optional. Details of the data provider who owns the source data.

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

hasDataProvider

clearDataProvider

setDataProvider

Optional. Details of the data provider who owns the source data.

Parameter
Name	Description
var	Google\Cloud\BigQuery\AnalyticsHub\V1\DataProvider

Returns
Type	Description
$this

getCategories

Optional. Categories of the listing. Up to two categories are allowed.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setCategories

Optional. Categories of the listing. Up to two categories are allowed.

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getPublisher

Optional. Details of the publisher who owns the listing and who can share the source data.

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

hasPublisher

clearPublisher

setPublisher

Optional. Details of the publisher who owns the listing and who can share the source data.

Parameter
Name	Description
var	Google\Cloud\BigQuery\AnalyticsHub\V1\Publisher

Returns
Type	Description
$this

getRequestAccess

Optional. Email or URL of the request access of the listing.

Subscribers can use this reference to request access. Max Length: 1000 bytes.

Returns
Type	Description
string

setRequestAccess

Optional. Email or URL of the request access of the listing.

Subscribers can use this reference to request access. Max Length: 1000 bytes.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSource

Returns
Type	Description
string