com.google.cloud.datastore.testing

Class LocalDatastoreHelper

java.lang.Object

com.google.cloud.datastore.testing.LocalDatastoreHelper

public class LocalDatastoreHelper
extends Object

Utility to start and stop local Google Cloud Datastore process.

Method Summary

Methods

Modifier and Type	Method and Description
double	consistency() Deprecated.
static LocalDatastoreHelper	create() Creates a local Datastore helper with a placeholder project ID and the default consistency setting of 0.9.
static LocalDatastoreHelper	create(double consistency) Creates a local Datastore helper with the specified settings for project ID and consistency.
double	getConsistency() Returns the consistency setting for the local Datastore emulator.
DatastoreOptions	getOptions() Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost.
DatastoreOptions	getOptions(String namespace) Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost.
String	getProjectId() Returns the project ID associated with this local Datastore emulator.
DatastoreOptions	options() Deprecated.
DatastoreOptions	options(String namespace) Deprecated.
String	projectId() Deprecated.
void	reset() Reset the internal state of the emulator.
String	sendPostRequest(String request)
static boolean	sendQuitRequest(int port)
void	start() Starts the local Datastore emulator.
void	stop() Quit the local emulator and related local service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

sendQuitRequest

public static boolean sendQuitRequest(int port)

sendPostRequest

public String sendPostRequest(String request)
                       throws IOException

Throws:

IOException

stop

public void stop()
          throws IOException,
                 InterruptedException

Quit the local emulator and related local service.

Throws:

IOException

InterruptedException

reset

public void reset()
           throws IOException

Reset the internal state of the emulator.

Throws:

IOException

options

@Deprecated
public DatastoreOptions options()

Deprecated.

Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost.

getOptions

public DatastoreOptions getOptions()

Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost.

options

@Deprecated
public DatastoreOptions options(String namespace)

Deprecated.

Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost. The default namespace is set to namespace.

getOptions

public DatastoreOptions getOptions(String namespace)

Returns a DatastoreOptions instance that sets the host to use the Datastore emulator on localhost. The default namespace is set to namespace.

projectId

@Deprecated
public String projectId()

Deprecated.

Returns the project ID associated with this local Datastore emulator.

getProjectId

public String getProjectId()

Returns the project ID associated with this local Datastore emulator.

consistency

@Deprecated
public double consistency()

Deprecated.

Returns the consistency setting for the local Datastore emulator.

getConsistency

public double getConsistency()

Returns the consistency setting for the local Datastore emulator.

create

public static LocalDatastoreHelper create(double consistency)

Creates a local Datastore helper with the specified settings for project ID and consistency.

Parameters:

consistency - the fraction of Datastore writes that are immediately visible to global queries, with 0.0 meaning no writes are immediately visible and 1.0 meaning all writes are immediately visible. Note that setting this to 1.0 may mask incorrect assumptions about the consistency of non-ancestor queries; non-ancestor queries are eventually consistent.

create

public static LocalDatastoreHelper create()

Creates a local Datastore helper with a placeholder project ID and the default consistency setting of 0.9. Consistency refers to the fraction of Datastore writes that are immediately visible to global queries, with 0.0 meaning no writes are immediately visible and 1.0 meaning all writes are immediately visible.

start

public void start()
           throws IOException,
                  InterruptedException

Starts the local Datastore emulator. Leftover data from previous uses of the emulator will be removed.

Throws:

InterruptedException - if emulator-related tasks are interrupted

IOException - if there are socket exceptions or issues creating/deleting the temporary data folder