Google Cloud Dataplex V1 Client - Class ListLakesRequest (0.15.1)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListLakesRequest.
List lakes request.
Generated from protobuf message google.cloud.dataplex.v1.ListLakesRequest
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the lake location, of the form: |
↳ page_size |
int
Optional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
Optional. Page token received from a previous |
↳ filter |
string
Optional. Filter request. |
↳ order_by |
string
Optional. Order by fields for the result. |
getParent
Required. The resource name of the lake location, of the form:
projects/{project_number}/locations/{location_id}
where location_id refers to a GCP region.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the lake location, of the form:
projects/{project_number}/locations/{location_id}
where location_id refers to a GCP region.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes 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. Page token received from a previous ListLakes call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to ListLakes must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. Page token received from a previous ListLakes call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to ListLakes must match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. Filter request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Filter request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. Order by fields for the result.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. Order by fields for the result.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The resource name of the lake location, of the form:
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\ListLakesRequest |
|