ListRequest.Builder (pinecone-java-client 2.0.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
    - - io.pinecone.proto.ListRequest.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListRequestOrBuilder, java.lang.Cloneable

Enclosing class:

ListRequest
```
public static final class ListRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
implements ListRequestOrBuilder
```
```
 The request for the `List` operation.
 
```
Protobuf type ListRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`ListRequest`	`build()`
`ListRequest`	`buildPartial()`
`ListRequest.Builder`	`clear()`
`ListRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ListRequest.Builder`	`clearLimit()` Max number of ids to return
`ListRequest.Builder`	`clearNamespace()` `string namespace = 4;`
`ListRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ListRequest.Builder`	`clearPaginationToken()` Pagination token to continue a previous listing operation
`ListRequest.Builder`	`clearPrefix()` The vector IDs to fetch.
`ListRequest.Builder`	`clone()`
`ListRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`int`	`getLimit()` Max number of ids to return
`java.lang.String`	`getNamespace()` `string namespace = 4;`
`com.google.protobuf.ByteString`	`getNamespaceBytes()` `string namespace = 4;`
`java.lang.String`	`getPaginationToken()` Pagination token to continue a previous listing operation
`com.google.protobuf.ByteString`	`getPaginationTokenBytes()` Pagination token to continue a previous listing operation
`java.lang.String`	`getPrefix()` The vector IDs to fetch.
`com.google.protobuf.ByteString`	`getPrefixBytes()` The vector IDs to fetch.
`boolean`	`hasLimit()` Max number of ids to return
`boolean`	`hasPaginationToken()` Pagination token to continue a previous listing operation
`boolean`	`hasPrefix()` The vector IDs to fetch.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListRequest.Builder`	`mergeFrom(ListRequest other)`
`ListRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`ListRequest.Builder`	`setLimit(int value)` Max number of ids to return
`ListRequest.Builder`	`setNamespace(java.lang.String value)` `string namespace = 4;`
`ListRequest.Builder`	`setNamespaceBytes(com.google.protobuf.ByteString value)` `string namespace = 4;`
`ListRequest.Builder`	`setPaginationToken(java.lang.String value)` Pagination token to continue a previous listing operation
`ListRequest.Builder`	`setPaginationTokenBytes(com.google.protobuf.ByteString value)` Pagination token to continue a previous listing operation
`ListRequest.Builder`	`setPrefix(java.lang.String value)` The vector IDs to fetch.
`ListRequest.Builder`	`setPrefixBytes(com.google.protobuf.ByteString value)` The vector IDs to fetch.
`ListRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`ListRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
  - clear
```
public ListRequest.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.GeneratedMessageV3.Builder<ListRequest.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.GeneratedMessageV3.Builder<ListRequest.Builder>
  - getDefaultInstanceForType
```
public ListRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public ListRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public ListRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public ListRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
  - setField
```
public ListRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    java.lang.Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
  - clearField
```
public ListRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
  - clearOneof
```
public ListRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
  - setRepeatedField
```
public ListRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            java.lang.Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
  - addRepeatedField
```
public ListRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            java.lang.Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
  - mergeFrom
```
public ListRequest.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<ListRequest.Builder>
  - mergeFrom
```
public ListRequest.Builder mergeFrom(ListRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
  - mergeFrom
```
public ListRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.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<ListRequest.Builder>
    
    Throws:
    
    java.io.IOException
  - hasPrefix
```
public boolean hasPrefix()
```
```
 The vector IDs to fetch. Does not accept values containing spaces.
 
```
    optional string prefix = 1;
    Specified by:
    
    hasPrefix in interface ListRequestOrBuilder
    
    Returns:
    
    Whether the prefix field is set.
  - getPrefix
```
public java.lang.String getPrefix()
```
```
 The vector IDs to fetch. Does not accept values containing spaces.
 
```
    optional string prefix = 1;
    Specified by:
    
    getPrefix in interface ListRequestOrBuilder
    
    Returns:
    
    The prefix.
  - getPrefixBytes
```
public com.google.protobuf.ByteString getPrefixBytes()
```
```
 The vector IDs to fetch. Does not accept values containing spaces.
 
```
    optional string prefix = 1;
    Specified by:
    
    getPrefixBytes in interface ListRequestOrBuilder
    
    Returns:
    
    The bytes for prefix.
  - setPrefix
```
public ListRequest.Builder setPrefix(java.lang.String value)
```
```
 The vector IDs to fetch. Does not accept values containing spaces.
 
```
    optional string prefix = 1;
    Parameters:
    
    value - The prefix to set.
    
    Returns:
    
    This builder for chaining.
  - clearPrefix
```
public ListRequest.Builder clearPrefix()
```
```
 The vector IDs to fetch. Does not accept values containing spaces.
 
```
    optional string prefix = 1;
    Returns:
    
    This builder for chaining.
  - setPrefixBytes
```
public ListRequest.Builder setPrefixBytes(com.google.protobuf.ByteString value)
```
```
 The vector IDs to fetch. Does not accept values containing spaces.
 
```
    optional string prefix = 1;
    Parameters:
    
    value - The bytes for prefix to set.
    
    Returns:
    
    This builder for chaining.
  - hasLimit
```
public boolean hasLimit()
```
```
 Max number of ids to return
 
```
    optional uint32 limit = 2;
    Specified by:
    
    hasLimit in interface ListRequestOrBuilder
    
    Returns:
    
    Whether the limit field is set.
  - getLimit
```
public int getLimit()
```
```
 Max number of ids to return
 
```
    optional uint32 limit = 2;
    Specified by:
    
    getLimit in interface ListRequestOrBuilder
    
    Returns:
    
    The limit.
  - setLimit
```
public ListRequest.Builder setLimit(int value)
```
```
 Max number of ids to return
 
```
    optional uint32 limit = 2;
    Parameters:
    
    value - The limit to set.
    
    Returns:
    
    This builder for chaining.
  - clearLimit
```
public ListRequest.Builder clearLimit()
```
```
 Max number of ids to return
 
```
    optional uint32 limit = 2;
    Returns:
    
    This builder for chaining.
  - hasPaginationToken
```
public boolean hasPaginationToken()
```
```
 Pagination token to continue a previous listing operation
 
```
    optional string pagination_token = 3;
    Specified by:
    
    hasPaginationToken in interface ListRequestOrBuilder
    
    Returns:
    
    Whether the paginationToken field is set.
  - getPaginationToken
```
public java.lang.String getPaginationToken()
```
```
 Pagination token to continue a previous listing operation
 
```
    optional string pagination_token = 3;
    Specified by:
    
    getPaginationToken in interface ListRequestOrBuilder
    
    Returns:
    
    The paginationToken.
  - getPaginationTokenBytes
```
public com.google.protobuf.ByteString getPaginationTokenBytes()
```
```
 Pagination token to continue a previous listing operation
 
```
    optional string pagination_token = 3;
    Specified by:
    
    getPaginationTokenBytes in interface ListRequestOrBuilder
    
    Returns:
    
    The bytes for paginationToken.
  - setPaginationToken
```
public ListRequest.Builder setPaginationToken(java.lang.String value)
```
```
 Pagination token to continue a previous listing operation
 
```
    optional string pagination_token = 3;
    Parameters:
    
    value - The paginationToken to set.
    
    Returns:
    
    This builder for chaining.
  - clearPaginationToken
```
public ListRequest.Builder clearPaginationToken()
```
```
 Pagination token to continue a previous listing operation
 
```
    optional string pagination_token = 3;
    Returns:
    
    This builder for chaining.
  - setPaginationTokenBytes
```
public ListRequest.Builder setPaginationTokenBytes(com.google.protobuf.ByteString value)
```
```
 Pagination token to continue a previous listing operation
 
```
    optional string pagination_token = 3;
    Parameters:
    
    value - The bytes for paginationToken to set.
    
    Returns:
    
    This builder for chaining.
  - getNamespace
```
public java.lang.String getNamespace()
```
    string namespace = 4;
    
    Specified by:
    
    getNamespace in interface ListRequestOrBuilder
    
    Returns:
    
    The namespace.
  - getNamespaceBytes
```
public com.google.protobuf.ByteString getNamespaceBytes()
```
    string namespace = 4;
    
    Specified by:
    
    getNamespaceBytes in interface ListRequestOrBuilder
    
    Returns:
    
    The bytes for namespace.
  - setNamespace
```
public ListRequest.Builder setNamespace(java.lang.String value)
```
    string namespace = 4;
    
    Parameters:
    
    value - The namespace to set.
    
    Returns:
    
    This builder for chaining.
  - clearNamespace
```
public ListRequest.Builder clearNamespace()
```
    string namespace = 4;
    
    Returns:
    
    This builder for chaining.
  - setNamespaceBytes
```
public ListRequest.Builder setNamespaceBytes(com.google.protobuf.ByteString value)
```
    string namespace = 4;
    
    Parameters:
    
    value - The bytes for namespace to set.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final ListRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>
  - mergeUnknownFields
```
public final ListRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListRequest.Builder>

Class ListRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasPrefix

getPrefix

getPrefixBytes

setPrefix

clearPrefix

setPrefixBytes

hasLimit

getLimit

setLimit

clearLimit

hasPaginationToken

getPaginationToken

getPaginationTokenBytes

setPaginationToken

clearPaginationToken

setPaginationTokenBytes

getNamespace

getNamespaceBytes

setNamespace

clearNamespace

setNamespaceBytes

setUnknownFields

mergeUnknownFields