public final class ListConversationsRequest extends GeneratedMessageV3 implements ListConversationsRequestOrBuilder
Request to list conversations.
Protobuf type google.cloud.contactcenterinsights.v1.ListConversationsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int VIEW_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ListConversationsRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListConversationsRequest.Builder newBuilder()
public static ListConversationsRequest.Builder newBuilder(ListConversationsRequest prototype)
public static ListConversationsRequest parseDelimitedFrom(InputStream input)
public static ListConversationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListConversationsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ListConversationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListConversationsRequest parseFrom(ByteString data)
public static ListConversationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListConversationsRequest parseFrom(CodedInputStream input)
public static ListConversationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListConversationsRequest parseFrom(InputStream input)
public static ListConversationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListConversationsRequest parseFrom(ByteBuffer data)
public static ListConversationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListConversationsRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public ListConversationsRequest getDefaultInstanceForType()
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.
|
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.
|
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:
string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The orderBy.
|
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:
string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for orderBy.
|
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.
|
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.
|
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.
|
public Parser<ListConversationsRequest> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public ConversationView getView()
The level of details of the conversation. Default is BASIC.
.google.cloud.contactcenterinsights.v1.ConversationView view = 5;
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListConversationsRequest.Builder newBuilderForType()
protected ListConversationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ListConversationsRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
