public static final class ListSessionsRequest.Builder extends GeneratedMessageV3.Builder<ListSessionsRequest.Builder> implements ListSessionsRequestOrBuilderRequest for ListSessions method.
Protobuf type google.cloud.discoveryengine.v1beta.ListSessionsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListSessionsRequest.BuilderImplements
ListSessionsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListSessionsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
build()
public ListSessionsRequest build()| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest |
|
buildPartial()
public ListSessionsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest |
|
clear()
public ListSessionsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListSessionsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
clearFilter()
public ListSessionsRequest.Builder clearFilter()A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are:
user_pseudo_idstatedisplay_namestarredis_pinnedlabelscreate_timeupdate_timeExamples: "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;
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListSessionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
clearOrderBy()
public ListSessionsRequest.Builder clearOrderBy()A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
update_timecreate_timesession_nameis_pinnedExample:
- "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;
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListSessionsRequest.Builder clearPageSize()Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListSessionsRequest.Builder clearPageToken() A page token, received from a previous ListSessions call.
Provide this to retrieve the subsequent page.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
clearParent()
public ListSessionsRequest.Builder clearParent() 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
clone()
public ListSessionsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
getDefaultInstanceForType()
public ListSessionsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String getFilter()A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are:
user_pseudo_idstatedisplay_namestarredis_pinnedlabelscreate_timeupdate_timeExamples: "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;
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are:
user_pseudo_idstatedisplay_namestarredis_pinnedlabelscreate_timeupdate_timeExamples: "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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
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_timecreate_timesession_nameis_pinnedExample:
- "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;
| Returns | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByBytes()
public 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_timecreate_timesession_nameis_pinnedExample:
- "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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderBy. |
getPageSize()
public int getPageSize()Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
int |
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;
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes() A page token, received from a previous ListSessions call.
Provide this to retrieve the subsequent page.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListSessionsRequest other)
public ListSessionsRequest.Builder mergeFrom(ListSessionsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListSessionsRequest |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListSessionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListSessionsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListSessionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListSessionsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
setFilter(String value)
public ListSessionsRequest.Builder setFilter(String value)A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are:
user_pseudo_idstatedisplay_namestarredis_pinnedlabelscreate_timeupdate_timeExamples: "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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListSessionsRequest.Builder setFilterBytes(ByteString value)A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are:
user_pseudo_idstatedisplay_namestarredis_pinnedlabelscreate_timeupdate_timeExamples: "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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListSessionsRequest.Builder setOrderBy(String value)A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
update_timecreate_timesession_nameis_pinnedExample:
- "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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListSessionsRequest.Builder setOrderByBytes(ByteString value)A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
update_timecreate_timesession_nameis_pinnedExample:
- "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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListSessionsRequest.Builder setPageSize(int value)Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
int32 page_size = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListSessionsRequest.Builder setPageToken(String value) A page token, received from a previous ListSessions call.
Provide this to retrieve the subsequent page.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListSessionsRequest.Builder setPageTokenBytes(ByteString value) A page token, received from a previous ListSessions call.
Provide this to retrieve the subsequent page.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListSessionsRequest.Builder setParent(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListSessionsRequest.Builder setParentBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListSessionsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListSessionsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListSessionsRequest.Builder |
|