Class ListKnowledgeBasesRequest (4.4.0)

public final class ListKnowledgeBasesRequest extends GeneratedMessageV3 implements ListKnowledgeBasesRequestOrBuilder

Request message for KnowledgeBases.ListKnowledgeBases.

Protobuf type google.cloud.dialogflow.v2.ListKnowledgeBasesRequest

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 ListKnowledgeBasesRequest getDefaultInstance()
Returns
TypeDescription
ListKnowledgeBasesRequest

getDefaultInstanceForType()

public ListKnowledgeBasesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListKnowledgeBasesRequest

getDescriptor()

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

getFilter()

public String getFilter()

The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: <field> <operator> <value> [AND <field> <operator> <value>] ... The following fields and operators are supported:

  • display_name with has(:) operator
  • language_code with equals(=) operator Examples:
  • 'language_code=en-us' matches knowledge bases with en-us language code.
  • 'display_name:articles' matches knowledge bases whose display name contains "articles".
  • 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles".
  • 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see API Filtering.

string filter = 4;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: <field> <operator> <value> [AND <field> <operator> <value>] ... The following fields and operators are supported:

  • display_name with has(:) operator
  • language_code with equals(=) operator Examples:
  • 'language_code=en-us' matches knowledge bases with en-us language code.
  • 'display_name:articles' matches knowledge bases whose display name contains "articles".
  • 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles".
  • 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see API Filtering.

string filter = 4;

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

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

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The next_page_token value returned from a previous list request.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The next_page_token value returned from a previous list request.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The project to list of knowledge bases for. 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 to list of knowledge bases for. 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<ListKnowledgeBasesRequest> getParserForType()
Returns
TypeDescription
Parser<ListKnowledgeBasesRequest>
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 ListKnowledgeBasesRequest.Builder newBuilder()
Returns
TypeDescription
ListKnowledgeBasesRequest.Builder

newBuilder(ListKnowledgeBasesRequest prototype)

public static ListKnowledgeBasesRequest.Builder newBuilder(ListKnowledgeBasesRequest prototype)
Parameter
NameDescription
prototypeListKnowledgeBasesRequest
Returns
TypeDescription
ListKnowledgeBasesRequest.Builder

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

toBuilder()

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

writeTo(CodedOutputStream output)

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