- 4.51.0 (latest)
- 4.50.0
- 4.49.0
- 4.48.0
- 4.46.0
- 4.45.0
- 4.44.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.34.0
- 4.33.0
- 4.32.0
- 4.31.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.16.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.0
- 4.8.0
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.0
- 4.1.0
- 4.0.8
- 3.1.2
- 3.0.3
- 2.3.1
public interface ListSessionsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getFilter()
public abstract String 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.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()
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.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for filter. |
getPageSize()
public abstract int getPageSize()
Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The pageSize. |
getPageToken()
public abstract String getPageToken()
Optional. A page token received from a previous ListSessions
call.
Provide this token to retrieve the subsequent page.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()
Optional. A page token received from a previous ListSessions
call.
Provide this token to retrieve the subsequent page.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public abstract String getParent()
Required. The parent, which owns this collection of sessions.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The parent. |
getParentBytes()
public abstract ByteString getParentBytes()
Required. The parent, which owns this collection of sessions.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for parent. |