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
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
.
↳ 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 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.
↳ filter
string
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
getParent
Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
.
string
setParent
Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
.
var
string
$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.
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.
var
int
$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.
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.
var
string
$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
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
var
string
$this
static::build
parent
string
Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
. Please see Google\Cloud\Dataplex\V1\DataplexServiceClient::environmentName()
for help formatting this field.
