ListCollectionIdsRequest.Builder (proto-google-cloud-firestore-v1 3.6.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ListCollectionIdsRequest.Builder>
    - - com.google.firestore.v1.ListCollectionIdsRequest.Builder

All Implemented Interfaces:

ListCollectionIdsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListCollectionIdsRequest
```
public static final class ListCollectionIdsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListCollectionIdsRequest.Builder>
implements ListCollectionIdsRequestOrBuilder
```
```
 The request for [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].
 
```
Protobuf type google.firestore.v1.ListCollectionIdsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListCollectionIdsRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListCollectionIdsRequest`	`build()`
`ListCollectionIdsRequest`	`buildPartial()`
`ListCollectionIdsRequest.Builder`	`clear()`
`ListCollectionIdsRequest.Builder`	`clearConsistencySelector()`
`ListCollectionIdsRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ListCollectionIdsRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ListCollectionIdsRequest.Builder`	`clearPageSize()` The maximum number of results to return.
`ListCollectionIdsRequest.Builder`	`clearPageToken()` A page token.
`ListCollectionIdsRequest.Builder`	`clearParent()` Required.
`ListCollectionIdsRequest.Builder`	`clearReadTime()` Reads documents as they were at the given time.
`ListCollectionIdsRequest.Builder`	`clone()`
`ListCollectionIdsRequest.ConsistencySelectorCase`	`getConsistencySelectorCase()`
`ListCollectionIdsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`int`	`getPageSize()` The maximum number of results to return.
`String`	`getPageToken()` A page token.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` A page token.
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`com.google.protobuf.Timestamp`	`getReadTime()` Reads documents as they were at the given time.
`com.google.protobuf.Timestamp.Builder`	`getReadTimeBuilder()` Reads documents as they were at the given time.
`com.google.protobuf.TimestampOrBuilder`	`getReadTimeOrBuilder()` Reads documents as they were at the given time.
`boolean`	`hasReadTime()` Reads documents as they were at the given time.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListCollectionIdsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListCollectionIdsRequest.Builder`	`mergeFrom(ListCollectionIdsRequest other)`
`ListCollectionIdsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListCollectionIdsRequest.Builder`	`mergeReadTime(com.google.protobuf.Timestamp value)` Reads documents as they were at the given time.
`ListCollectionIdsRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListCollectionIdsRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListCollectionIdsRequest.Builder`	`setPageSize(int value)` The maximum number of results to return.
`ListCollectionIdsRequest.Builder`	`setPageToken(String value)` A page token.
`ListCollectionIdsRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` A page token.
`ListCollectionIdsRequest.Builder`	`setParent(String value)` Required.
`ListCollectionIdsRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`ListCollectionIdsRequest.Builder`	`setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)` Reads documents as they were at the given time.
`ListCollectionIdsRequest.Builder`	`setReadTime(com.google.protobuf.Timestamp value)` Reads documents as they were at the given time.
`ListCollectionIdsRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ListCollectionIdsRequest.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, internalGetMutableMapField, 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, mergeFrom, 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

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

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

clear
```
public ListCollectionIdsRequest.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<ListCollectionIdsRequest.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<ListCollectionIdsRequest.Builder>

getDefaultInstanceForType
```
public ListCollectionIdsRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public ListCollectionIdsRequest build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public ListCollectionIdsRequest buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public ListCollectionIdsRequest.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<ListCollectionIdsRequest.Builder>

setField

public ListCollectionIdsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCollectionIdsRequest.Builder>

clearField
```
public ListCollectionIdsRequest.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<ListCollectionIdsRequest.Builder>

clearOneof
```
public ListCollectionIdsRequest.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<ListCollectionIdsRequest.Builder>

setRepeatedField

public ListCollectionIdsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         int index,
                                                         Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCollectionIdsRequest.Builder>

addRepeatedField

public ListCollectionIdsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCollectionIdsRequest.Builder>

mergeFrom
```
public ListCollectionIdsRequest.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<ListCollectionIdsRequest.Builder>

mergeFrom

public ListCollectionIdsRequest.Builder mergeFrom(ListCollectionIdsRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListCollectionIdsRequest.Builder>

mergeFrom

public ListCollectionIdsRequest.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<ListCollectionIdsRequest.Builder>
Throws:: IOException

getConsistencySelectorCase
```
public ListCollectionIdsRequest.ConsistencySelectorCase getConsistencySelectorCase()
```
Specified by:

getConsistencySelectorCase in interface ListCollectionIdsRequestOrBuilder

clearConsistencySelector

public ListCollectionIdsRequest.Builder clearConsistencySelector()

getParent

public String getParent()

 Required. The parent document. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getParent in interface ListCollectionIdsRequestOrBuilder
Returns:: The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The parent document. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getParentBytes in interface ListCollectionIdsRequestOrBuilder
Returns:: The bytes for parent.

setParent

public ListCollectionIdsRequest.Builder setParent(String value)

 Required. The parent document. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:: value - The parent to set.
Returns:: This builder for chaining.

clearParent

public ListCollectionIdsRequest.Builder clearParent()

 Required. The parent document. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:: This builder for chaining.

setParentBytes

public ListCollectionIdsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)

 Required. The parent document. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:: value - The bytes for parent to set.
Returns:: This builder for chaining.

getPageSize
```
public int getPageSize()
```
```
 The maximum number of results to return.
 
```
int32 page_size = 2;
Specified by:

getPageSize in interface ListCollectionIdsRequestOrBuilder

Returns:

The pageSize.

setPageSize

public ListCollectionIdsRequest.Builder setPageSize(int value)

 The maximum number of results to return.

int32 page_size = 2;

Parameters:: value - The pageSize to set.
Returns:: This builder for chaining.

clearPageSize

public ListCollectionIdsRequest.Builder clearPageSize()

 The maximum number of results to return.

int32 page_size = 2;

Returns:: This builder for chaining.

getPageToken

public String getPageToken()

 A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].

string page_token = 3;

Specified by:: getPageToken in interface ListCollectionIdsRequestOrBuilder
Returns:: The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].

string page_token = 3;

Specified by:: getPageTokenBytes in interface ListCollectionIdsRequestOrBuilder
Returns:: The bytes for pageToken.

setPageToken

public ListCollectionIdsRequest.Builder setPageToken(String value)

 A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].

string page_token = 3;

Parameters:: value - The pageToken to set.
Returns:: This builder for chaining.

clearPageToken

public ListCollectionIdsRequest.Builder clearPageToken()

 A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].

string page_token = 3;

Returns:: This builder for chaining.

setPageTokenBytes

public ListCollectionIdsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].

string page_token = 3;

Parameters:: value - The bytes for pageToken to set.
Returns:: This builder for chaining.

hasReadTime
```
public boolean hasReadTime()
```
```
 Reads documents as they were at the given time.
 This may not be older than 270 seconds.
 
```
.google.protobuf.Timestamp read_time = 4;
Specified by:

hasReadTime in interface ListCollectionIdsRequestOrBuilder

Returns:

Whether the readTime field is set.