com.google.cloud.dataproc.v1

Interface ListSessionsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListSessionsRequest, ListSessionsRequest.Builder

public interface ListSessionsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. The parent, which owns this collection of sessions.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. The parent, which owns this collection of sessions.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getPageSize

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:

The pageSize.

getPageToken

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:

The pageToken.

getPageTokenBytes

com.google.protobuf.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:

The bytes for pageToken.

getFilter

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`, 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 filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The filter.

getFilterBytes

com.google.protobuf.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`, 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 filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for filter.