Provides a set of additional app IDs that may appear in Key values in entities.
This is only required if the client will read entities containing Key values that
contain app IDs other than the one provided to #appId. Any such app IDs should be
provided to this method.
If set to true, stacktrace for async calls is captured and returned as part of error
messages. There is overhead in capturing this stack trace and it is recommended to enable it
primarily for debugging.
Overrides the host (e.g. datastore.googleapis.com) used to contact the Cloud
Datastore API. To connect to the Cloud Datastore Emulator, use #emulatorHost instead.
If set to true, a minimal Environment will be installed (if none is already
installed).
If set to false, no attempt to install an environment will be made and the user must
install it instead. At a minimum, such an environment must provide implementations for Environment#getAppId(), Environment#getAttributes(), and Environment#getRemainingMillis().
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis class provides a builder for configuring \u003ccode\u003eCloudDatastoreRemoteServiceConfig\u003c/code\u003e, which is used to interact with Cloud Datastore.\u003c/p\u003e\n"],["\u003cp\u003eYou can set various parameters like access tokens, app IDs, and emulator host for customized Cloud Datastore interaction.\u003c/p\u003e\n"],["\u003cp\u003eThe builder supports options to control credential usage, including Compute Engine credentials, service account credentials, or a manually provided access token.\u003c/p\u003e\n"],["\u003cp\u003eIt allows for the configuration of HTTP connection timeouts, maximum retries, and the ability to capture stack traces for async calls, aiding in debugging.\u003c/p\u003e\n"],["\u003cp\u003eThe methods allow you to set additional app IDs, which is needed if the client reads entities containing \u003ccode\u003eKey\u003c/code\u003e values that contain other app IDs.\u003c/p\u003e\n"]]],[],null,["# Class CloudDatastoreRemoteServiceConfig.Builder (2.0.0)\n\n public abstract static class CloudDatastoreRemoteServiceConfig.Builder\n\nBuilder for [CloudDatastoreRemoteServiceConfig](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.CloudDatastoreRemoteServiceConfig). \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e CloudDatastoreRemoteServiceConfig.Builder \n\nInherited Members\n-----------------\n\n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nConstructors\n------------\n\n### Builder()\n\n public Builder()\n\nMethods\n-------\n\n### accessToken(String accessToken)\n\n public abstract CloudDatastoreRemoteServiceConfig.Builder accessToken(String accessToken)\n\nSets the access token.\n\nCannot be combined with a call to [#useComputeEngineCredential(boolean)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.CloudDatastoreRemoteServiceConfig.Builder#com_google_appengine_api_datastore_CloudDatastoreRemoteServiceConfig_Builder_useComputeEngineCredential_boolean_) or [#useServiceAccountCredential(String, PrivateKey)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.CloudDatastoreRemoteServiceConfig.Builder#com_google_appengine_api_datastore_CloudDatastoreRemoteServiceConfig_Builder_useServiceAccountCredential_java_lang_String_java_security_PrivateKey_).\n\n### additionalAppIds(Set\\\u003cCloudDatastoreRemoteServiceConfig.AppId\\\u003e value)\n\n public abstract CloudDatastoreRemoteServiceConfig.Builder additionalAppIds(Set\u003cCloudDatastoreRemoteServiceConfig.AppId\u003e value)\n\nProvides a set of additional app IDs that may appear in [Key](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.Key) values in entities.\n\nThis is only required if the client will read entities containing [Key](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.Key) values that\ncontain app IDs other than the one provided to [#appId](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.CloudDatastoreRemoteServiceConfig.Builder#com_google_appengine_api_datastore_CloudDatastoreRemoteServiceConfig_Builder_appId_). Any such app IDs should be\nprovided to this method.\n\n### appId(CloudDatastoreRemoteServiceConfig.AppId value)\n\n public abstract CloudDatastoreRemoteServiceConfig.Builder appId(CloudDatastoreRemoteServiceConfig.AppId value)\n\nSets the [AppId](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.CloudDatastoreRemoteServiceConfig.AppId) of the Cloud Datastore instance to call. Required.\n\n### asyncStackTraceCaptureEnabled(boolean value)\n\n public abstract CloudDatastoreRemoteServiceConfig.Builder asyncStackTraceCaptureEnabled(boolean value)\n\nIf set to true, stacktrace for async calls is captured and returned as part of error\nmessages. There is overhead in capturing this stack trace and it is recommended to enable it\nprimarily for debugging.\n\n### build()\n\n public CloudDatastoreRemoteServiceConfig build()\n\n### emulatorHost(String value)\n\n public abstract CloudDatastoreRemoteServiceConfig.Builder emulatorHost(String value)\n\nInstructs the client to connect to a locally-running Cloud Datastore Emulator and not to pass\ncredentials.\n\n### hostOverride(String value)\n\n public abstract CloudDatastoreRemoteServiceConfig.Builder hostOverride(String value)\n\nOverrides the host (e.g. `datastore.googleapis.com`) used to contact the Cloud\nDatastore API. To connect to the Cloud Datastore Emulator, use [#emulatorHost](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.CloudDatastoreRemoteServiceConfig.Builder#com_google_appengine_api_datastore_CloudDatastoreRemoteServiceConfig_Builder_emulatorHost_) instead.\n\n### httpConnectTimeoutMillis(int value)\n\n public abstract CloudDatastoreRemoteServiceConfig.Builder httpConnectTimeoutMillis(int value)\n\nSets the HTTP connect timeout in milliseconds.\n\n### installApiProxyEnvironment(boolean value)\n\n public abstract CloudDatastoreRemoteServiceConfig.Builder installApiProxyEnvironment(boolean value)\n\nIf set to true, a minimal Environment will be installed (if none is already\ninstalled).\n\nIf set to false, no attempt to install an environment will be made and the user must\ninstall it instead. At a minimum, such an environment must provide implementations for Environment#getAppId(), Environment#getAttributes(), and Environment#getRemainingMillis().\n\n### maxRetries(int value)\n\n public abstract CloudDatastoreRemoteServiceConfig.Builder maxRetries(int value)\n\nSets the maximum number of retries for underlying HTTP connect exceptions.\n\n### useComputeEngineCredential(boolean value)\n\n public abstract CloudDatastoreRemoteServiceConfig.Builder useComputeEngineCredential(boolean value)\n\nIf set to true, always use a Compute Engine credential instead of using the Application\nDefault Credentials library to construct the credential.\n\nCannot be combined with a call to [#useServiceAccountCredential(String, PrivateKey)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.CloudDatastoreRemoteServiceConfig.Builder#com_google_appengine_api_datastore_CloudDatastoreRemoteServiceConfig_Builder_useServiceAccountCredential_java_lang_String_java_security_PrivateKey_)\nor [#accessToken(String)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.CloudDatastoreRemoteServiceConfig.Builder#com_google_appengine_api_datastore_CloudDatastoreRemoteServiceConfig_Builder_accessToken_java_lang_String_).\n\n### useServiceAccountCredential(String serviceAccountId, PrivateKey privateKey)\n\n public CloudDatastoreRemoteServiceConfig.Builder useServiceAccountCredential(String serviceAccountId, PrivateKey privateKey)\n\nInstructs the client to use a service account credential instead of using the Application\nDefault Credentials library to construct the credential.\n\nCannot be combined with a call to [#useComputeEngineCredential(boolean)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.CloudDatastoreRemoteServiceConfig.Builder#com_google_appengine_api_datastore_CloudDatastoreRemoteServiceConfig_Builder_useComputeEngineCredential_boolean_) or [#accessToken(String)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.datastore.CloudDatastoreRemoteServiceConfig.Builder#com_google_appengine_api_datastore_CloudDatastoreRemoteServiceConfig_Builder_accessToken_java_lang_String_)."]]
