Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListSessionsRequest.
List sessions request.
Generated from protobuf message google.cloud.dataplex.v1.ListSessionsRequest
Methods
build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The resource name of the parent environment:
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\ListSessionsRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the parent environment: |
↳ page_size |
int
Optional. Maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 10 sessions 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. The following |
getParent
Required. The resource name of the parent environment:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The resource name of the parent environment:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Optional. Maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 10 sessions 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 sessions to return. The service may return fewer than this value. If unspecified, at most 10 sessions 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 ListSessions call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to ListSessions must match the call that provided the page
token.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Optional. Page token received from a previous ListSessions call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to ListSessions must match the call that provided the page
token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Optional. Filter request. The following mode filter is supported to
return only the sessions belonging to the requester when the mode is USER
and return sessions of all the users when the mode is ADMIN. When no filter
is sent default to USER mode. NOTE: When the mode is ADMIN, the requester
should have dataplex.environments.listAllSessions permission to list all
sessions, in absence of the permission, the request fails.
mode = ADMIN | USER
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Optional. Filter request. The following mode filter is supported to
return only the sessions belonging to the requester when the mode is USER
and return sessions of all the users when the mode is ADMIN. When no filter
is sent default to USER mode. NOTE: When the mode is ADMIN, the requester
should have dataplex.environments.listAllSessions permission to list all
sessions, in absence of the permission, the request fails.
mode = ADMIN | USER
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |