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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, which has this collection of data products. Format: |
↳ filter |
string
Optional. Filter expression that filters data products listed in the response. Example of using this filter is: |
↳ 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 |
↳ order_by |
string
Optional. Order by expression that orders data products listed in the response. Supported Order by fields are: |
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/-
| Returns | |
|---|---|
| Type | Description |
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/-
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. Filter expression that filters data products listed in the response.
Example of using this filter is: display_name="my-data-product"
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Filter expression that filters data products listed in the response.
Example of using this filter is: display_name="my-data-product"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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/-).
| Returns | |
|---|---|
| Type | Description |
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/-).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which has this collection of data products. Format: Supports listing across all locations with the wildcard |
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest |
|