Class ListConversationsRequest (4.4.0)

public final class ListConversationsRequest extends GeneratedMessageV3 implements ListConversationsRequestOrBuilder

The request message for Conversations.ListConversations.

Protobuf type google.cloud.dialogflow.v2.ListConversationsRequest

Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static ListConversationsRequest getDefaultInstance()
Returns
TypeDescription
ListConversationsRequest

getDefaultInstanceForType()

public ListConversationsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListConversationsRequest

getDescriptor()

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

getFilter()

public String getFilter()

A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: <ul> <li>The value must be a string, a number, or a boolean.</li> <li>The comparison operator must be either =,!=, >, or <.</li> <li>To filter on multiple expressions, separate the expressions with AND or OR (omitting both implies AND).</li> <li>For clarity, expressions can be enclosed in parentheses.</li> </ul> Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations: lifecycle_state = "COMPLETED" For more information about filtering, see API Filtering.

string filter = 4;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: <ul> <li>The value must be a string, a number, or a boolean.</li> <li>The comparison operator must be either =,!=, >, or <.</li> <li>To filter on multiple expressions, separate the expressions with AND or OR (omitting both implies AND).</li> <li>For clarity, expressions can be enclosed in parentheses.</li> </ul> Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations: lifecycle_state = "COMPLETED" For more information about filtering, see API Filtering.

string filter = 4;

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The next_page_token value returned from a previous list request.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The next_page_token value returned from a previous list request.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The project from which to list all conversation. Format: projects/<Project ID>/locations/<Location ID>.

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The project from which to list all conversation. Format: projects/<Project ID>/locations/<Location ID>.

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

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<ListConversationsRequest> getParserForType()
Returns
TypeDescription
Parser<ListConversationsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static ListConversationsRequest.Builder newBuilder()
Returns
TypeDescription
ListConversationsRequest.Builder

newBuilder(ListConversationsRequest prototype)

public static ListConversationsRequest.Builder newBuilder(ListConversationsRequest prototype)
Parameter
NameDescription
prototypeListConversationsRequest
Returns
TypeDescription
ListConversationsRequest.Builder

newBuilderForType()

public ListConversationsRequest.Builder newBuilderForType()
Returns
TypeDescription
ListConversationsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListConversationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListConversationsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static ListConversationsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListConversationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListConversationsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListConversationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListConversationsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListConversationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListConversationsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListConversationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListConversationsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListConversationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListConversationsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListConversationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListConversationsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListConversationsRequest> parser()
Returns
TypeDescription
Parser<ListConversationsRequest>

toBuilder()

public ListConversationsRequest.Builder toBuilder()
Returns
TypeDescription
ListConversationsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException