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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 |
getParent
Required. The parent, which owns this collection of sessions.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent, which owns this collection of sessions.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of sessions to return in each response.
The service may return fewer than this value.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of sessions to return in each response.
The service may return fewer than this value.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A page token received from a previous ListSessions call.
Provide this token to retrieve the subsequent page.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token received from a previous ListSessions call.
Provide this token to retrieve the subsequent page.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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, create_time,
and labels.
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. state = ACTIVE and labels.environment=production is a filter
for sessions in an ACTIVE state that have a production environment label.
See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed
description of the filter syntax and a list of supported comparators.
| Returns | |
|---|---|
| Type | Description |
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, create_time,
and labels.
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. state = ACTIVE and labels.environment=production is a filter
for sessions in an ACTIVE state that have a production environment label.
See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed
description of the filter syntax and a list of supported comparators.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which owns this collection of sessions. Please see Google\Cloud\Dataproc\V1\SessionControllerClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataproc\V1\ListSessionsRequest |
|