{% include "/android/_dackka-meta-tags.html" %}

RetrieveBytesRequest.Builder

{% setvar page_path %}com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder.html{% endsetvar %} {% setvar doc_root_path %}/android/reference{% endsetvar %} {% setvar can_switch %}1{% endsetvar %} {% include "android/_java_switcher2.md" %}

public final class RetrieveBytesRequest.Builder


A builder for RetrieveBytesRequest objects.

Summary

Public constructors

Constructor for the Builder class.

Public methods

RetrieveBytesRequest

Builds and returns the RetrieveBytesRequest object.

RetrieveBytesRequest.Builder

Sets the list of keys whose associated data, if any, should be retrieved.

RetrieveBytesRequest.Builder
@CanIgnoreReturnValue
setRetrieveAll(boolean retrieveAll)

Sets whether or not all app's Block Store data should be retrieved.

Public constructors

Builder

public Builder()

Constructor for the Builder class.

Public methods

build

public RetrieveBytesRequest build()

Builds and returns the RetrieveBytesRequest object.

setKeys

@CanIgnoreReturnValue
public RetrieveBytesRequest.Builder setKeys(List<String> keys)

Sets the list of keys whose associated data, if any, should be retrieved.

The default value is an empty list, which means that no key-based filtering will be performed. In other words, no data will be returned if the key list is empty and no other criterion is provided.

Note that the app data that was stored without an explicit key can be requested with the default key DEFAULT_BYTES_DATA_KEY.

setRetrieveAll

@CanIgnoreReturnValue
public RetrieveBytesRequest.Builder setRetrieveAll(boolean retrieveAll)

Sets whether or not all app's Block Store data should be retrieved.

The default is false.

Note that if retrieveAll is set to true, then you should NOT set any other retrieval criterion; that is, keys should be empty. Otherwise, an IllegalStateException will be thrown.