com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1alphaListSessionsRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1alphaListSessionsRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1alphaListSessionsRequest
extends com.google.api.client.json.GenericJson

Request for ListSessions method.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1alphaListSessionsRequest()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1alphaListSessionsRequest	clone()
String	getFilter() 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.
Integer	getPageSize() Maximum number of results to return.
String	getPageToken() A page token, received from a previous `ListSessions` call.
String	getParent() Required.
GoogleCloudDiscoveryengineV1alphaListSessionsRequest	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1alphaListSessionsRequest	setFilter(String filter) A comma-separated list of fields to filter by, in EBNF grammar.
GoogleCloudDiscoveryengineV1alphaListSessionsRequest	setOrderBy(String orderBy) A comma-separated list of fields to order by, sorted in ascending order.
GoogleCloudDiscoveryengineV1alphaListSessionsRequest	setPageSize(Integer pageSize) Maximum number of results to return.
GoogleCloudDiscoveryengineV1alphaListSessionsRequest	setPageToken(String pageToken) A page token, received from a previous `ListSessions` call.
GoogleCloudDiscoveryengineV1alphaListSessionsRequest	setParent(String parent) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1alphaListSessionsRequest

public GoogleCloudDiscoveryengineV1alphaListSessionsRequest()

Method Detail

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` * `collaborative_project` 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"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`

Returns:

value or null for none

setFilter

public GoogleCloudDiscoveryengineV1alphaListSessionsRequest setFilter(String filter)

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` * `collaborative_project` 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"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`

Parameters:

filter - filter or null for none

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.

Returns:

value or null for none

setOrderBy

public GoogleCloudDiscoveryengineV1alphaListSessionsRequest setOrderBy(String orderBy)

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.

Parameters:

orderBy - orderBy or null for none

getPageSize

public Integer getPageSize()

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

Returns:

value or null for none

setPageSize

public GoogleCloudDiscoveryengineV1alphaListSessionsRequest setPageSize(Integer pageSize)

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

Parameters:

pageSize - pageSize or null for none

getPageToken

public String getPageToken()

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

Returns:

value or null for none

setPageToken

public GoogleCloudDiscoveryengineV1alphaListSessionsRequest setPageToken(String pageToken)

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

Parameters:

pageToken - pageToken or null for none

getParent

public String getParent()

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

Returns:

value or null for none

setParent

public GoogleCloudDiscoveryengineV1alphaListSessionsRequest setParent(String parent)

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

Parameters:

parent - parent or null for none

set

public GoogleCloudDiscoveryengineV1alphaListSessionsRequest set(String fieldName,
                                                                Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1alphaListSessionsRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson