Reference documentation and code samples for the Google Cloud Dataproc V1 Client class ListSessionsRequest.
A request to list sessions in a project.
Generated from protobuf message google.cloud.dataproc.v1.ListSessionsRequest
Namespace
Google \ Cloud \ Dataproc \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent, which owns this collection of sessions.
↳ page_size
int
Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.
↳ page_token
string
Optional. A page token received from a previous ListSessions
call. Provide this token to retrieve the subsequent page.
↳ filter
string
Optional. A filter for the sessions to return in the response. A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id
, session_uuid
, state
, and create_time
. Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z"
is a filter for sessions in an ACTIVE state that were created before 2023-01-01. See https://google.aip.dev/assets/misc/ebnf-filtering.txt
for a detailed description of the filter syntax and a list of supported comparators.
getParent
Required. The parent, which owns this collection of sessions.
string
setParent
Required. The parent, which owns this collection of sessions.
var
string
$this
getPageSize
Optional. The maximum number of sessions to return in each response.
The service may return fewer than this value.
int
setPageSize
Optional. The maximum number of sessions to return in each response.
The service may return fewer than this value.
var
int
$this
getPageToken
Optional. A page token received from a previous ListSessions
call.
Provide this token to retrieve the subsequent page.
string
setPageToken
Optional. A page token received from a previous ListSessions
call.
Provide this token to retrieve the subsequent page.
var
string
$this
getFilter
Optional. A filter for the sessions to return in the response.
A filter is a logical expression constraining the values of various fields
in each session resource. Filters are case sensitive, and may contain
multiple clauses combined with logical operators (AND, OR).
Supported fields are session_id
, session_uuid
, state
, and create_time
.
Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z"
is a filter for sessions in an ACTIVE state that were created before
2023-01-01.
See https://google.aip.dev/assets/misc/ebnf-filtering.txt
for a detailed
description of the filter syntax and a list of supported comparators.
string
setFilter
Optional. A filter for the sessions to return in the response.
A filter is a logical expression constraining the values of various fields
in each session resource. Filters are case sensitive, and may contain
multiple clauses combined with logical operators (AND, OR).
Supported fields are session_id
, session_uuid
, state
, and create_time
.
Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z"
is a filter for sessions in an ACTIVE state that were created before
2023-01-01.
See https://google.aip.dev/assets/misc/ebnf-filtering.txt
for a detailed
description of the filter syntax and a list of supported comparators.
var
string
$this
static::build
parent
string
Required. The parent, which owns this collection of sessions. Please see Google\Cloud\Dataproc\V1\SessionControllerClient::locationName() for help formatting this field.
