Class ListKnowledgeBasesRequest.Builder (4.29.0)

public static final class ListKnowledgeBasesRequest.Builder extends GeneratedMessageV3.Builder<ListKnowledgeBasesRequest.Builder> implements ListKnowledgeBasesRequestOrBuilder

Request message for KnowledgeBases.ListKnowledgeBases.

Protobuf type google.cloud.dialogflow.v2.ListKnowledgeBasesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListKnowledgeBasesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides

build()

public ListKnowledgeBasesRequest build()
Returns
Type Description
ListKnowledgeBasesRequest

buildPartial()

public ListKnowledgeBasesRequest buildPartial()
Returns
Type Description
ListKnowledgeBasesRequest

clear()

public ListKnowledgeBasesRequest.Builder clear()
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListKnowledgeBasesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides

clearFilter()

public ListKnowledgeBasesRequest.Builder clearFilter()

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
ListKnowledgeBasesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListKnowledgeBasesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides

clearPageSize()

public ListKnowledgeBasesRequest.Builder clearPageSize()

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
ListKnowledgeBasesRequest.Builder

This builder for chaining.

clearPageToken()

public ListKnowledgeBasesRequest.Builder clearPageToken()

The next_page_token value returned from a previous list request.

string page_token = 3;

Returns
Type Description
ListKnowledgeBasesRequest.Builder

This builder for chaining.

clearParent()

public ListKnowledgeBasesRequest.Builder clearParent()

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
ListKnowledgeBasesRequest.Builder

This builder for chaining.

clone()

public ListKnowledgeBasesRequest.Builder clone()
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListKnowledgeBasesRequest getDefaultInstanceForType()
Returns
Type Description
ListKnowledgeBasesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListKnowledgeBasesRequest other)

public ListKnowledgeBasesRequest.Builder mergeFrom(ListKnowledgeBasesRequest other)
Parameter
Name Description
other ListKnowledgeBasesRequest
Returns
Type Description
ListKnowledgeBasesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListKnowledgeBasesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListKnowledgeBasesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListKnowledgeBasesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListKnowledgeBasesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides

setFilter(String value)

public ListKnowledgeBasesRequest.Builder setFilter(String value)

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;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListKnowledgeBasesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListKnowledgeBasesRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListKnowledgeBasesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListKnowledgeBasesRequest.Builder setPageSize(int value)

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

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListKnowledgeBasesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListKnowledgeBasesRequest.Builder setPageToken(String value)

The next_page_token value returned from a previous list request.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListKnowledgeBasesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListKnowledgeBasesRequest.Builder setPageTokenBytes(ByteString value)

The next_page_token value returned from a previous list request.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListKnowledgeBasesRequest.Builder

This builder for chaining.

setParent(String value)

public ListKnowledgeBasesRequest.Builder setParent(String value)

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListKnowledgeBasesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListKnowledgeBasesRequest.Builder setParentBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListKnowledgeBasesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListKnowledgeBasesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListKnowledgeBasesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListKnowledgeBasesRequest.Builder
Overrides