com.google.cloud.discoveryengine.v1

Class ListSessionsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.ListSessionsRequest

All Implemented Interfaces:

ListSessionsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class ListSessionsRequest
extends com.google.protobuf.GeneratedMessage
implements ListSessionsRequestOrBuilder

 Request for ListSessions method.
 

Protobuf type google.cloud.discoveryengine.v1.ListSessionsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListSessionsRequest.Builder Request for ListSessions method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	ORDER_BY_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ListSessionsRequest	getDefaultInstance()
ListSessionsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() A comma-separated list of fields to filter by, in EBNF grammar.
com.google.protobuf.ByteString	getFilterBytes() A comma-separated list of fields to filter by, in EBNF grammar.
String	getOrderBy() A comma-separated list of fields to order by, sorted in ascending order.
com.google.protobuf.ByteString	getOrderByBytes() A comma-separated list of fields to order by, sorted in ascending order.
int	getPageSize() Maximum number of results to return.
String	getPageToken() A page token, received from a previous `ListSessions` call.
com.google.protobuf.ByteString	getPageTokenBytes() A page token, received from a previous `ListSessions` call.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<ListSessionsRequest>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListSessionsRequest.Builder	newBuilder()
static ListSessionsRequest.Builder	newBuilder(ListSessionsRequest prototype)
ListSessionsRequest.Builder	newBuilderForType()
protected ListSessionsRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ListSessionsRequest	parseDelimitedFrom(InputStream input)
static ListSessionsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListSessionsRequest	parseFrom(byte[] data)
static ListSessionsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListSessionsRequest	parseFrom(ByteBuffer data)
static ListSessionsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListSessionsRequest	parseFrom(com.google.protobuf.ByteString data)
static ListSessionsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListSessionsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ListSessionsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListSessionsRequest	parseFrom(InputStream input)
static ListSessionsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ListSessionsRequest>	parser()
ListSessionsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getParent

public String getParent()

 Required. The data store resource name. Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
 

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

Specified by:

getParent in interface ListSessionsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The data store resource name. Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
 

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

Specified by:

getParentBytes in interface ListSessionsRequestOrBuilder

Returns:

The bytes for parent.

getPageSize

public int getPageSize()

 Maximum number of results to return. If unspecified, defaults
 to 50. Max allowed value is 1000.
 

int32 page_size = 2;

Specified by:

getPageSize in interface ListSessionsRequestOrBuilder

Returns:

The pageSize.

getPageToken

public String getPageToken()

 A page token, received from a previous `ListSessions` call.
 Provide this to retrieve the subsequent page.
 

string page_token = 3;

Specified by:

getPageToken in interface ListSessionsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 A page token, received from a previous `ListSessions` call.
 Provide this to retrieve the subsequent page.
 

string page_token = 3;

Specified by:

getPageTokenBytes in interface ListSessionsRequestOrBuilder

Returns:

The bytes for pageToken.

getFilter

public String getFilter()

 A comma-separated list of fields to filter by, in EBNF grammar.
 The supported fields are:
 * `user_pseudo_id`
 * `state`
 * `display_name`
 * `starred`
 * `is_pinned`
 * `labels`
 * `create_time`
 * `update_time`

 Examples:
 "user_pseudo_id = some_id"
 "display_name = \"some_name\""
 "starred = true"
 "is_pinned=true AND (NOT labels:hidden)"
 "create_time > \"1970-01-01T12:00:00Z\""
 

string filter = 4;

Specified by:

getFilter in interface ListSessionsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 A comma-separated list of fields to filter by, in EBNF grammar.
 The supported fields are:
 * `user_pseudo_id`
 * `state`
 * `display_name`
 * `starred`
 * `is_pinned`
 * `labels`
 * `create_time`
 * `update_time`

 Examples:
 "user_pseudo_id = some_id"
 "display_name = \"some_name\""
 "starred = true"
 "is_pinned=true AND (NOT labels:hidden)"
 "create_time > \"1970-01-01T12:00:00Z\""
 

string filter = 4;

Specified by:

getFilterBytes in interface ListSessionsRequestOrBuilder

Returns:

The bytes for filter.

getOrderBy

public String getOrderBy()

 A comma-separated list of fields to order by, sorted in ascending order.
 Use "desc" after a field name for descending.
 Supported fields:

 * `update_time`
 * `create_time`
 * `session_name`
 * `is_pinned`

 Example:

 * "update_time desc"
 * "create_time"
 * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
 by update_time.
 

string order_by = 5;

Specified by:

getOrderBy in interface ListSessionsRequestOrBuilder

Returns:

The orderBy.

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

 A comma-separated list of fields to order by, sorted in ascending order.
 Use "desc" after a field name for descending.
 Supported fields:

 * `update_time`
 * `create_time`
 * `session_name`
 * `is_pinned`

 Example:

 * "update_time desc"
 * "create_time"
 * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
 by update_time.
 

string order_by = 5;

Specified by:

getOrderByBytes in interface ListSessionsRequestOrBuilder

Returns:

The bytes for orderBy.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ListSessionsRequest parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListSessionsRequest parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListSessionsRequest parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListSessionsRequest parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListSessionsRequest parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListSessionsRequest parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListSessionsRequest parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static ListSessionsRequest parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListSessionsRequest parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListSessionsRequest parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static ListSessionsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static ListSessionsRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public ListSessionsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ListSessionsRequest.Builder newBuilder()

newBuilder

public static ListSessionsRequest.Builder newBuilder(ListSessionsRequest prototype)

toBuilder

public ListSessionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ListSessionsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static ListSessionsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ListSessionsRequest> parser()

getParserForType

public com.google.protobuf.Parser<ListSessionsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public ListSessionsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder