Google Cloud Dataplex V1 Client - Class ListLakesRequest (0.4.0)

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

Methods

build

Parameter
NameDescription
parent string

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. Please see {@see \Google\Cloud\Dataplex\V1\DataplexServiceClient::locationName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\ListLakesRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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.

↳ 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 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.

↳ 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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Optional. Filter request.

Returns
TypeDescription
string

setFilter

Optional. Filter request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Optional. Order by fields for the result.

Returns
TypeDescription
string

setOrderBy

Optional. Order by fields for the result.

Parameter
NameDescription
var string
Returns
TypeDescription
$this