Class ListConversationsRequest.Builder (2.53.0)

Version latest

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.10
• 2.2.7

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

Request to list conversations.

Protobuf type google.cloud.contactcenterinsights.v1.ListConversationsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListConversationsRequest.Builder

Implements

ListConversationsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListConversationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListConversationsRequest build()

Returns
Type	Description
ListConversationsRequest

buildPartial()

public ListConversationsRequest buildPartial()

Returns
Type	Description
ListConversationsRequest

clear()

public ListConversationsRequest.Builder clear()

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListConversationsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public ListConversationsRequest.Builder clearFilter()

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

string filter = 4;

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListConversationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrderBy()

public ListConversationsRequest.Builder clearOrderBy()

Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following:

• create_time
• customer_satisfaction_rating
• duration
• latest_analysis
• start_time

• turn_count

  The default sort order is ascending. To specify order, append asc or desc (create_time desc). For more details, see Google AIPs Ordering.

string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

clearPageSize()

public ListConversationsRequest.Builder clearPageSize()

The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.

int32 page_size = 2;

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

clearPageToken()

public ListConversationsRequest.Builder clearPageToken()

The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior ListConversations call and that the system should return the next page of data.

string page_token = 3;

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

clearParent()

public ListConversationsRequest.Builder clearParent()

Required. The parent resource of the conversation.

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

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

clearView()

public ListConversationsRequest.Builder clearView()

The level of details of the conversation. Default is BASIC.

.google.cloud.contactcenterinsights.v1.ConversationView view = 5;

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

clone()

public ListConversationsRequest.Builder clone()

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListConversationsRequest getDefaultInstanceForType()

Returns
Type	Description
ListConversationsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

string filter = 4;

Returns
Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

string filter = 4;

Returns
Type	Description
ByteString	The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following:

• create_time
• customer_satisfaction_rating
• duration
• latest_analysis
• start_time

• turn_count

  The default sort order is ascending. To specify order, append asc or desc (create_time desc). For more details, see Google AIPs Ordering.

string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following:

• create_time
• customer_satisfaction_rating
• duration
• latest_analysis
• start_time

• turn_count

  The default sort order is ascending. To specify order, append asc or desc (create_time desc). For more details, see Google AIPs Ordering.

string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public int getPageSize()

The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.

int32 page_size = 2;

Returns
Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior ListConversations call and that the system should return the next page of data.

string page_token = 3;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior ListConversations call and that the system should return the next page of data.

string page_token = 3;

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public String getParent()

Required. The parent resource of the conversation.

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

Returns
Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource of the conversation.

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

Returns
Type	Description
ByteString	The bytes for parent.

getView()

public ConversationView getView()

The level of details of the conversation. Default is BASIC.

.google.cloud.contactcenterinsights.v1.ConversationView view = 5;

Returns
Type	Description
ConversationView	The view.

getViewValue()

public int getViewValue()

The level of details of the conversation. Default is BASIC.

.google.cloud.contactcenterinsights.v1.ConversationView view = 5;

Returns
Type	Description
int	The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListConversationsRequest other)

public ListConversationsRequest.Builder mergeFrom(ListConversationsRequest other)

Parameter
Name	Description
other	ListConversationsRequest

Returns
Type	Description
ListConversationsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListConversationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ListConversationsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListConversationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public ListConversationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public ListConversationsRequest.Builder setFilter(String value)

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

string filter = 4;

Parameter
Name	Description
value	String The filter to set.

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public ListConversationsRequest.Builder setFilterBytes(ByteString value)

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

string filter = 4;

Parameter
Name	Description
value	ByteString The bytes for filter to set.

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

setOrderBy(String value)

public ListConversationsRequest.Builder setOrderBy(String value)

Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following:

• create_time
• customer_satisfaction_rating
• duration
• latest_analysis
• start_time

• turn_count

  The default sort order is ascending. To specify order, append asc or desc (create_time desc). For more details, see Google AIPs Ordering.

string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The orderBy to set.

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

setOrderByBytes(ByteString value)

public ListConversationsRequest.Builder setOrderByBytes(ByteString value)

Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following:

• create_time
• customer_satisfaction_rating
• duration
• latest_analysis
• start_time

• turn_count

  The default sort order is ascending. To specify order, append asc or desc (create_time desc). For more details, see Google AIPs Ordering.

string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for orderBy to set.

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

setPageSize(int value)

public ListConversationsRequest.Builder setPageSize(int value)

The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.

int32 page_size = 2;

Parameter
Name	Description
value	int The pageSize to set.

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

setPageToken(String value)

public ListConversationsRequest.Builder setPageToken(String value)

The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior ListConversations call and that the system should return the next page of data.

string page_token = 3;

Parameter
Name	Description
value	String The pageToken to set.

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListConversationsRequest.Builder setPageTokenBytes(ByteString value)

The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior ListConversations call and that the system should return the next page of data.

string page_token = 3;

Parameter
Name	Description
value	ByteString The bytes for pageToken to set.

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

setParent(String value)

public ListConversationsRequest.Builder setParent(String value)

Required. The parent resource of the conversation.

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

Parameter
Name	Description
value	String The parent to set.

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public ListConversationsRequest.Builder setParentBytes(ByteString value)

Required. The parent resource of the conversation.

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

Parameter
Name	Description
value	ByteString The bytes for parent to set.

Returns
Type	Description
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
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListConversationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListConversationsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setView(ConversationView value)

public ListConversationsRequest.Builder setView(ConversationView value)

The level of details of the conversation. Default is BASIC.

.google.cloud.contactcenterinsights.v1.ConversationView view = 5;

Parameter
Name	Description
value	ConversationView The view to set.

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.

setViewValue(int value)

public ListConversationsRequest.Builder setViewValue(int value)

The level of details of the conversation. Default is BASIC.

.google.cloud.contactcenterinsights.v1.ConversationView view = 5;

Parameter
Name	Description
value	int The enum numeric value on the wire for view to set.

Returns
Type	Description
ListConversationsRequest.Builder	This builder for chaining.