RetrieveBytesRequest.Builder
Stay organized with collections
Save and categorize content based on your preferences.
Public Constructor Summary
Inherited Method Summary
From class java.lang.Object
|
Object
|
clone()
|
| boolean |
|
| void |
finalize()
|
|
final Class<?>
|
getClass()
|
| int |
hashCode()
|
| final void |
notify()
|
| final void |
notifyAll()
|
|
String
|
toString()
|
| final void |
wait(long arg0, int arg1)
|
| final void |
wait(long arg0)
|
| final void |
wait()
|
Public Methods
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
BlockstoreClient.DEFAULT_BYTES_DATA_KEY.
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, e.g. keys should be empty. Otherwise, an
IllegalStateException will be thrown.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eRetrieveBytesRequest.Builder\u003c/code\u003e is used to construct \u003ccode\u003eRetrieveBytesRequest\u003c/code\u003e objects for retrieving data from Block Store.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to specify the keys for data retrieval or to retrieve all app data.\u003c/p\u003e\n"],["\u003cp\u003eBy default, no key-based filtering is performed, and \u003ccode\u003eretrieveAll\u003c/code\u003e is set to \u003ccode\u003efalse\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eWhen \u003ccode\u003eretrieveAll\u003c/code\u003e is \u003ccode\u003etrue\u003c/code\u003e, no other retrieval criteria should be set.\u003c/p\u003e\n"],["\u003cp\u003eData stored without an explicit key can be retrieved using \u003ccode\u003eBlockstoreClient.DEFAULT_BYTES_DATA_KEY\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# RetrieveBytesRequest.Builder\n\npublic static final class **RetrieveBytesRequest.Builder** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nA builder for [RetrieveBytesRequest](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest)\nobjects. \n\n### Public Constructor Summary\n\n|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | [Builder](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder#Builder())() Constructor for the [RetrieveBytesRequest.Builder](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder) class. |\n\n### Public Method Summary\n\n|------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [RetrieveBytesRequest](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest) | [build](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder#build())() Builds and returns the [RetrieveBytesRequest](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest) object. |\n| [RetrieveBytesRequest.Builder](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder) | [setKeys](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder#setKeys(java.util.List\u003cjava.lang.String\u003e))([List](//developer.android.com/reference/java/util/List.html)\\\u003c[String](//developer.android.com/reference/java/lang/String.html)\\\u003e keys) Sets the list of keys whose associated data, if any, should be retrieved. |\n| [RetrieveBytesRequest.Builder](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder) | [setRetrieveAll](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder#setRetrieveAll(boolean))(boolean retrieveAll) Sets whether or not all app's Block Store data should be retrieved. |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [Object](//developer.android.com/reference/java/lang/Object.html) | clone() |\n| boolean | equals([Object](//developer.android.com/reference/java/lang/Object.html) arg0) |\n| void | finalize() |\n| final [Class](//developer.android.com/reference/java/lang/Class.html)\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| [String](//developer.android.com/reference/java/lang/String.html) | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Constructors\n-------------------\n\n#### public **Builder** ()\n\nConstructor for the [RetrieveBytesRequest.Builder](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder) class.\n\nPublic Methods\n--------------\n\n#### public [RetrieveBytesRequest](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest)\n**build** ()\n\nBuilds and returns the [RetrieveBytesRequest](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest)\nobject. \n\n#### public [RetrieveBytesRequest.Builder](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder) **setKeys** ([List](//developer.android.com/reference/java/util/List.html)\\\u003c[String](//developer.android.com/reference/java/lang/String.html)\\\u003e keys)\n\nSets the list of keys whose associated data, if any, should be retrieved.\n\nThe default value is an empty list, which means that no key-based filtering will be\nperformed. In other words, no data will be returned if the key list is empty and no\nother criterion is provided.\n\nNote that the app data that was stored without an explicit key can be requested with\nthe default key [BlockstoreClient.DEFAULT_BYTES_DATA_KEY](/android/reference/com/google/android/gms/auth/blockstore/BlockstoreClient#DEFAULT_BYTES_DATA_KEY). \n\n#### public [RetrieveBytesRequest.Builder](/android/reference/com/google/android/gms/auth/blockstore/RetrieveBytesRequest.Builder) **setRetrieveAll** (boolean retrieveAll)\n\nSets whether or not all app's Block Store data should be retrieved.\n\nThe default is `false`.\n\nNote that if `retrieveAll` is set to true, then you should NOT set any\nother retrieval criterion, e.g. `keys` should be empty. Otherwise, an\nIllegalStateException will be thrown."]]