Package com.google.cloud.dialogflow.v2

Class ListDocumentsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder>
com.google.cloud.dialogflow.v2.ListDocumentsRequest.Builder
All Implemented Interfaces:
ListDocumentsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListDocumentsRequest
public static final class ListDocumentsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder> implements ListDocumentsRequestOrBuilder
 Request message for
 [Documents.ListDocuments][google.cloud.dialogflow.v2.Documents.ListDocuments].
Protobuf type google.cloud.dialogflow.v2.ListDocumentsRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder>

    • clear

      public ListDocumentsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder>

    • getDefaultInstanceForType

      public ListDocumentsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ListDocumentsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ListDocumentsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ListDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDocumentsRequest.Builder>

    • mergeFrom

      public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListDocumentsRequest.Builder>

    • mergeFrom

      public ListDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDocumentsRequest.Builder>
      Throws:
      IOException

    • getParent

      public String getParent()
       Required. The knowledge base to list all documents for.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListDocumentsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The knowledge base to list all documents for.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListDocumentsRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public ListDocumentsRequest.Builder setParent(String value)
       Required. The knowledge base to list all documents for.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListDocumentsRequest.Builder clearParent()
       Required. The knowledge base to list all documents for.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public ListDocumentsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. The knowledge base to list all documents for.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      getPageSize in interface ListDocumentsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListDocumentsRequest.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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListDocumentsRequest.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:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       The next_page_token value returned from a previous list request.
      string page_token = 3;
      Specified by:
      getPageToken in interface ListDocumentsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       The next_page_token value returned from a previous list request.
      string page_token = 3;
      Specified by:
      getPageTokenBytes in interface ListDocumentsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListDocumentsRequest.Builder setPageToken(String value)
       The next_page_token value returned from a previous list request.
      string page_token = 3;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListDocumentsRequest.Builder clearPageToken()
       The next_page_token value returned from a previous list request.
      string page_token = 3;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListDocumentsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       The next_page_token value returned from a previous list request.
      string page_token = 3;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getFilter

      public String getFilter()
       The filter expression used to filter documents 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:

 * knowledge_types with has(:) operator
 * display_name with has(:) operator
 * state with equals(=) operator

 Examples:

 * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
 * "display_name:customer" matches documents whose display name contains
 "customer".
 * "state=ACTIVE" matches documents with ACTIVE state.
 * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

 For more information about filtering, see
 [API Filtering](https://aip.dev/160).
      string filter = 4;
      Specified by:
      getFilter in interface ListDocumentsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       The filter expression used to filter documents 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:

 * knowledge_types with has(:) operator
 * display_name with has(:) operator
 * state with equals(=) operator

 Examples:

 * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
 * "display_name:customer" matches documents whose display name contains
 "customer".
 * "state=ACTIVE" matches documents with ACTIVE state.
 * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

 For more information about filtering, see
 [API Filtering](https://aip.dev/160).
      string filter = 4;
      Specified by:
      getFilterBytes in interface ListDocumentsRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public ListDocumentsRequest.Builder setFilter(String value)
       The filter expression used to filter documents 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:

 * knowledge_types with has(:) operator
 * display_name with has(:) operator
 * state with equals(=) operator

 Examples:

 * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
 * "display_name:customer" matches documents whose display name contains
 "customer".
 * "state=ACTIVE" matches documents with ACTIVE state.
 * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

 For more information about filtering, see
 [API Filtering](https://aip.dev/160).
      string filter = 4;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListDocumentsRequest.Builder clearFilter()
       The filter expression used to filter documents 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:

 * knowledge_types with has(:) operator
 * display_name with has(:) operator
 * state with equals(=) operator

 Examples:

 * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
 * "display_name:customer" matches documents whose display name contains
 "customer".
 * "state=ACTIVE" matches documents with ACTIVE state.
 * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

 For more information about filtering, see
 [API Filtering](https://aip.dev/160).
      string filter = 4;
      Returns:
      This builder for chaining.

    • setFilterBytes

      public ListDocumentsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       The filter expression used to filter documents 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:

 * knowledge_types with has(:) operator
 * display_name with has(:) operator
 * state with equals(=) operator

 Examples:

 * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
 * "display_name:customer" matches documents whose display name contains
 "customer".
 * "state=ACTIVE" matches documents with ACTIVE state.
 * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

 For more information about filtering, see
 [API Filtering](https://aip.dev/160).
      string filter = 4;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.