Class ListKnowledgeBasesRequest (4.37.0)

public final class ListKnowledgeBasesRequest extends GeneratedMessageV3 implements ListKnowledgeBasesRequestOrBuilder

Request message for KnowledgeBases.ListKnowledgeBases.

Protobuf type google.cloud.dialogflow.v2.ListKnowledgeBasesRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_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

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListKnowledgeBasesRequest getDefaultInstance()
Returns
Type Description
ListKnowledgeBasesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListKnowledgeBasesRequest.Builder newBuilder()
Returns
Type Description
ListKnowledgeBasesRequest.Builder

newBuilder(ListKnowledgeBasesRequest prototype)

public static ListKnowledgeBasesRequest.Builder newBuilder(ListKnowledgeBasesRequest prototype)
Parameter
Name Description
prototype ListKnowledgeBasesRequest
Returns
Type Description
ListKnowledgeBasesRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListKnowledgeBasesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListKnowledgeBasesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListKnowledgeBasesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListKnowledgeBasesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListKnowledgeBasesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListKnowledgeBasesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListKnowledgeBasesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListKnowledgeBasesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListKnowledgeBasesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListKnowledgeBasesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListKnowledgeBasesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListKnowledgeBasesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListKnowledgeBasesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListKnowledgeBasesRequest> parser()
Returns
Type Description
Parser<ListKnowledgeBasesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListKnowledgeBasesRequest getDefaultInstanceForType()
Returns
Type Description
ListKnowledgeBasesRequest

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
Type Description
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
Type Description
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
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

The next_page_token value returned from a previous list request.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The next_page_token value returned from a previous list request.

string page_token = 3;

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListKnowledgeBasesRequest> getParserForType()
Returns
Type Description
Parser<ListKnowledgeBasesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListKnowledgeBasesRequest.Builder newBuilderForType()
Returns
Type Description
ListKnowledgeBasesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListKnowledgeBasesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListKnowledgeBasesRequest.Builder toBuilder()
Returns
Type Description
ListKnowledgeBasesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException