Class ListConversationsRequest.Builder (0.20.0)

public static final class ListConversationsRequest.Builder extends GeneratedMessageV3.Builder<ListConversationsRequest.Builder> implements ListConversationsRequestOrBuilder

Request for ListConversations method.

Protobuf type google.cloud.discoveryengine.v1.ListConversationsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListConversationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides

build()

public ListConversationsRequest build()
Returns
TypeDescription
ListConversationsRequest

buildPartial()

public ListConversationsRequest buildPartial()
Returns
TypeDescription
ListConversationsRequest

clear()

public ListConversationsRequest.Builder clear()
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListConversationsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides

clearFilter()

public ListConversationsRequest.Builder clearFilter()

A filter to apply on the list results. The supported features are: user_pseudo_id, state.

Example: "user_pseudo_id = some_id"

string filter = 4;

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListConversationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides

clearOrderBy()

public ListConversationsRequest.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_time
  • create_time
  • conversation_name

    Example: "update_time desc" "create_time"

string order_by = 5;

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

clearPageSize()

public ListConversationsRequest.Builder clearPageSize()

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

int32 page_size = 2;

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

clearPageToken()

public ListConversationsRequest.Builder clearPageToken()

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

string page_token = 3;

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

clearParent()

public ListConversationsRequest.Builder clearParent()

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

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

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

clone()

public ListConversationsRequest.Builder clone()
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListConversationsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListConversationsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

A filter to apply on the list results. The supported features are: user_pseudo_id, state.

Example: "user_pseudo_id = some_id"

string filter = 4;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

A filter to apply on the list results. The supported features are: user_pseudo_id, state.

Example: "user_pseudo_id = some_id"

string filter = 4;

Returns
TypeDescription
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_time
  • create_time
  • conversation_name

    Example: "update_time desc" "create_time"

string order_by = 5;

Returns
TypeDescription
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_time
  • create_time
  • conversation_name

    Example: "update_time desc" "create_time"

string order_by = 5;

Returns
TypeDescription
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
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

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

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListConversationsRequest other)

public ListConversationsRequest.Builder mergeFrom(ListConversationsRequest other)
Parameter
NameDescription
otherListConversationsRequest
Returns
TypeDescription
ListConversationsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListConversationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListConversationsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListConversationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListConversationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides

setFilter(String value)

public ListConversationsRequest.Builder setFilter(String value)

A filter to apply on the list results. The supported features are: user_pseudo_id, state.

Example: "user_pseudo_id = some_id"

string filter = 4;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListConversationsRequest.Builder setFilterBytes(ByteString value)

A filter to apply on the list results. The supported features are: user_pseudo_id, state.

Example: "user_pseudo_id = some_id"

string filter = 4;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListConversationsRequest.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_time
  • create_time
  • conversation_name

    Example: "update_time desc" "create_time"

string order_by = 5;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListConversationsRequest.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_time
  • create_time
  • conversation_name

    Example: "update_time desc" "create_time"

string order_by = 5;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListConversationsRequest.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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListConversationsRequest.Builder setPageToken(String value)

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

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListConversationsRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

setParent(String value)

public ListConversationsRequest.Builder setParent(String value)

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListConversationsRequest.Builder setParentBytes(ByteString value)

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListConversationsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListConversationsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListConversationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides