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

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

Message for listing subscriptions.

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

Namespace

Google \ Cloud \ BigQuery \ AnalyticsHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US
↳ filter string

An expression for filtering the results of the request. Eligible fields for filtering are: * listing * data_exchange Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above. In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters: * data_exchange="projects/myproject/locations/us/dataExchanges/123" * listing="projects/123/locations/us/dataExchanges/456/listings/789" * "projects/myproject/locations/us/dataExchanges/123"
↳ page_size int

The maximum number of results to return in a single response page.
↳ page_token string

Page token, returned by a previous call.

getParent

Required. The parent resource path of the subscription.

e.g. projects/myproject/locations/US

Returns
Type Description
string

setParent

Required. The parent resource path of the subscription.

e.g. projects/myproject/locations/US

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

An expression for filtering the results of the request. Eligible fields for filtering are:

  • listing
  • data_exchange Alternatively, a literal wrapped in double quotes may be provided.

This will be checked for an exact match against both fields above. In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters:

  • data_exchange="projects/myproject/locations/us/dataExchanges/123"
  • listing="projects/123/locations/us/dataExchanges/456/listings/789"
  • "projects/myproject/locations/us/dataExchanges/123"
Returns
Type Description
string

setFilter

An expression for filtering the results of the request. Eligible fields for filtering are:

  • listing
  • data_exchange Alternatively, a literal wrapped in double quotes may be provided.

This will be checked for an exact match against both fields above. In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters:

  • data_exchange="projects/myproject/locations/us/dataExchanges/123"
  • listing="projects/123/locations/us/dataExchanges/456/listings/789"
  • "projects/myproject/locations/us/dataExchanges/123"
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of results to return in a single response page.

Returns
Type Description
int

setPageSize

The maximum number of results to return in a single response page.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Page token, returned by a previous call.

Returns
Type Description
string

setPageToken

Page token, returned by a previous call.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US Please see Google\Cloud\BigQuery\AnalyticsHub\V1\AnalyticsHubServiceClient::locationName() for help formatting this field.
Returns
Type Description
Google\Cloud\BigQuery\AnalyticsHub\V1\ListSubscriptionsRequest