Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListDataProductsRequest.
Request message for listing data products.
Generated from protobuf message google.cloud.dataplex.v1.ListDataProductsRequest
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent, which has this collection of data products. Format: projects/{project_id_or_number}/locations/{location_id}
. Supports listing across all locations with the wildcard -
(hyphen) character. Example: projects/{project_id_or_number}/locations/-
↳ filter
string
Optional. Filter expression that filters data products listed in the response. Example of using this filter is: display_name="my-data-product"
↳ page_size
int
Optional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
↳ page_token
string
Optional. A page token, received from a previous ListDataProducts
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataProducts
must match the call that provided the page token.
↳ order_by
string
Optional. Order by expression that orders data products listed in the response. Supported Order by fields are: name
or create_time
. If not specified, the ordering is undefined. Ordering by create_time
is not supported when listing resources across locations (i.e. when request contains /locations/-
).
getParent
Required. The parent, which has this collection of data products.
Format: projects/{project_id_or_number}/locations/{location_id}
.
Supports listing across all locations with the wildcard -
(hyphen)
character. Example: projects/{project_id_or_number}/locations/-
string
setParent
Required. The parent, which has this collection of data products.
Format: projects/{project_id_or_number}/locations/{location_id}
.
Supports listing across all locations with the wildcard -
(hyphen)
character. Example: projects/{project_id_or_number}/locations/-
var
string
$this
getFilter
Optional. Filter expression that filters data products listed in the response.
Example of using this filter is: display_name="my-data-product"
string
setFilter
Optional. Filter expression that filters data products listed in the response.
Example of using this filter is: display_name="my-data-product"
var
string
$this
getPageSize
Optional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int
setPageSize
Optional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
var
int
$this
getPageToken
Optional. A page token, received from a previous ListDataProducts
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDataProducts
must
match the call that provided the page token.
string
setPageToken
Optional. A page token, received from a previous ListDataProducts
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDataProducts
must
match the call that provided the page token.
var
string
$this
getOrderBy
Optional. Order by expression that orders data products listed in the response.
Supported Order by fields are: name
or create_time
.
If not specified, the ordering is undefined.
Ordering by create_time
is not supported when listing resources across
locations (i.e. when request contains /locations/-
).
string
setOrderBy
Optional. Order by expression that orders data products listed in the response.
Supported Order by fields are: name
or create_time
.
If not specified, the ordering is undefined.
Ordering by create_time
is not supported when listing resources across
locations (i.e. when request contains /locations/-
).
var
string
$this
static::build
parent
string
Required. The parent, which has this collection of data products.
Format: projects/{project_id_or_number}/locations/{location_id}
.
Supports listing across all locations with the wildcard -
(hyphen)
character. Example: projects/{project_id_or_number}/locations/-
Please see DataProductServiceClient::locationName()
for help formatting this field.
