com.google.cloud.contactcenterinsights.v1

Class ListConversationsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

com.google.cloud.contactcenterinsights.v1.ListConversationsRequest.Builder

All Implemented Interfaces:

ListConversationsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListConversationsRequest

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

 Request to list conversations.
 

Protobuf type google.cloud.contactcenterinsights.v1.ListConversationsRequest

Method Summary

Modifier and Type	Method and Description
ListConversationsRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListConversationsRequest	build()
ListConversationsRequest	buildPartial()
ListConversationsRequest.Builder	clear()
ListConversationsRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ListConversationsRequest.Builder	clearFilter() A filter to reduce results to a specific subset.
ListConversationsRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ListConversationsRequest.Builder	clearOrderBy() Optional.
ListConversationsRequest.Builder	clearPageSize() The maximum number of conversations to return in the response.
ListConversationsRequest.Builder	clearPageToken() The value returned by the last `ListConversationsResponse`.
ListConversationsRequest.Builder	clearParent() Required.
ListConversationsRequest.Builder	clearView() The level of details of the conversation.
ListConversationsRequest.Builder	clone()
ListConversationsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() A filter to reduce results to a specific subset.
com.google.protobuf.ByteString	getFilterBytes() A filter to reduce results to a specific subset.
String	getOrderBy() Optional.
com.google.protobuf.ByteString	getOrderByBytes() Optional.
int	getPageSize() The maximum number of conversations to return in the response.
String	getPageToken() The value returned by the last `ListConversationsResponse`.
com.google.protobuf.ByteString	getPageTokenBytes() The value returned by the last `ListConversationsResponse`.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
ConversationView	getView() The level of details of the conversation.
int	getViewValue() The level of details of the conversation.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListConversationsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListConversationsRequest.Builder	mergeFrom(ListConversationsRequest other)
ListConversationsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListConversationsRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ListConversationsRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListConversationsRequest.Builder	setFilter(String value) A filter to reduce results to a specific subset.
ListConversationsRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) A filter to reduce results to a specific subset.
ListConversationsRequest.Builder	setOrderBy(String value) Optional.
ListConversationsRequest.Builder	setOrderByBytes(com.google.protobuf.ByteString value) Optional.
ListConversationsRequest.Builder	setPageSize(int value) The maximum number of conversations to return in the response.
ListConversationsRequest.Builder	setPageToken(String value) The value returned by the last `ListConversationsResponse`.
ListConversationsRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) The value returned by the last `ListConversationsResponse`.
ListConversationsRequest.Builder	setParent(String value) Required.
ListConversationsRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.
ListConversationsRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ListConversationsRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ListConversationsRequest.Builder	setView(ConversationView value) The level of details of the conversation.
ListConversationsRequest.Builder	setViewValue(int value) The level of details of the conversation.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

clear

public ListConversationsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

getDefaultInstanceForType

public ListConversationsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListConversationsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ListConversationsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ListConversationsRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

clearField

public ListConversationsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

clearOneof

public ListConversationsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

setRepeatedField

public ListConversationsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         int index,
                                                         Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

mergeFrom

public ListConversationsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListConversationsRequest.Builder>

mergeFrom

public ListConversationsRequest.Builder mergeFrom(ListConversationsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

mergeFrom

public ListConversationsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListConversationsRequest.Builder>

Throws:

IOException

getParent

public String getParent()

 Required. The parent resource of the conversation.
 

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

Specified by:

getParent in interface ListConversationsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The parent resource of the conversation.
 

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

Specified by:

getParentBytes in interface ListConversationsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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) = { ... }

Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes

public ListConversationsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)

 Required. The parent resource of the conversation.
 

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

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

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;

Specified by:

getPageSize in interface ListConversationsRequestOrBuilder

Returns:

The pageSize.

setPageSize

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;

Parameters:

value - The pageSize to set.

Returns:

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:

This builder for chaining.

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;

Specified by:

getPageToken in interface ListConversationsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.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;

Specified by:

getPageTokenBytes in interface ListConversationsRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

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;

Parameters:

value - The pageToken to set.

Returns:

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:

This builder for chaining.

setPageTokenBytes

public ListConversationsRequest.Builder setPageTokenBytes(com.google.protobuf.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;

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

getFilter

public String getFilter()

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

string filter = 4;

Specified by:

getFilter in interface ListConversationsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

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

string filter = 4;

Specified by:

getFilterBytes in interface ListConversationsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

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;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setFilterBytes

public ListConversationsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

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

string filter = 4;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

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](https://google.aip.dev/132#ordering).
 

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

Specified by:

getOrderBy in interface ListConversationsRequestOrBuilder

Returns:

The orderBy.

getOrderByBytes

public com.google.protobuf.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](https://google.aip.dev/132#ordering).
 

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

Specified by:

getOrderByBytes in interface ListConversationsRequestOrBuilder

Returns:

The bytes for orderBy.

setOrderBy

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](https://google.aip.dev/132#ordering).
 

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

Parameters:

value - The orderBy to set.

Returns:

This builder for chaining.

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](https://google.aip.dev/132#ordering).
 

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

Returns:

This builder for chaining.

setOrderByBytes

public ListConversationsRequest.Builder setOrderByBytes(com.google.protobuf.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](https://google.aip.dev/132#ordering).
 

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

Parameters:

value - The bytes for orderBy to set.

Returns:

This builder for chaining.

getViewValue

public int getViewValue()

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

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

Specified by:

getViewValue in interface ListConversationsRequestOrBuilder

Returns:

The enum numeric value on the wire for view.

setViewValue

public ListConversationsRequest.Builder setViewValue(int value)

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

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

Parameters:

value - The enum numeric value on the wire for view to set.

Returns:

This builder for chaining.

getView

public ConversationView getView()

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

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

Specified by:

getView in interface ListConversationsRequestOrBuilder

Returns:

The view.

setView

public ListConversationsRequest.Builder setView(ConversationView value)

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

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

Parameters:

value - The view to set.

Returns:

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:

This builder for chaining.

setUnknownFields

public final ListConversationsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>

mergeUnknownFields

public final ListConversationsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListConversationsRequest.Builder>