Package org.apache.beam.sdk.io.gcp.datastore

Class DatastoreV1.DeleteKey

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<com.google.datastore.v1.Key>,PDone>

org.apache.beam.sdk.io.gcp.datastore.DatastoreV1.DeleteKey

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

DatastoreV1

public static class DatastoreV1.DeleteKey
extends PTransform<PCollection<com.google.datastore.v1.Key>,PDone>

A PTransform that deletes Entities associated with the given Keys from Cloud Datastore.

See Also:

• DatastoreIO
• Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

annotations, displayData, name, resourceHints

Method Summary

Modifier and Type	Method	Description
PDone	expand(PCollection<com.google.datastore.v1.Key> input)	Override this method to specify how this PTransform should be expanded on the given InputT.
String	getDatabaseId()
String	getProjectId()
void	populateDisplayData(DisplayData.Builder builder)	Register display data for the given transform or component.
String	toString()
DatastoreV1.DeleteKey	withDatabaseId(String databaseId)	Returns a new DatastoreV1.DeleteKey that deletes entities from the Cloud Datastore for the specified database.
DatastoreV1.DeleteKey	withDatabaseId(ValueProvider<String> databaseId)	Same as withDatabaseId(String) but with a ValueProvider.
DatastoreV1.DeleteKey	withHintNumWorkers(int hintNumWorkers)	Returns a new DatastoreV1.DeleteKey with a different worker count hint for ramp-up throttling.
DatastoreV1.DeleteKey	withHintNumWorkers(ValueProvider<Integer> hintNumWorkers)	Same as withHintNumWorkers(int) but with a ValueProvider.
DatastoreV1.DeleteKey	withLocalhost(String localhost)	Returns a new DatastoreV1.DeleteKey that deletes entities from the Cloud Datastore Emulator running locally on the specified host port.
DatastoreV1.DeleteKey	withProjectId(String projectId)	Returns a new DatastoreV1.DeleteKey that deletes entities from the Cloud Datastore for the specified project.
DatastoreV1.DeleteKey	withProjectId(ValueProvider<String> projectId)	Same as withProjectId(String) but with a ValueProvider.
DatastoreV1.DeleteKey	withRampupThrottlingDisabled()	Returns a new DatastoreV1.DeleteKey that does not throttle during ramp-up.
DatastoreV1.DeleteKeyWithSummary	withResults()	Returns DatastoreV1.DeleteKeyWithSummary transform which can be used in Wait.on(PCollection[]) to wait until all data is deleted.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setDisplayData, setResourceHints, validate, validate

Methods inherited from class java.lang.Object

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

Method Details

withProjectId

public DatastoreV1.DeleteKey withProjectId(String projectId)

Returns a new DatastoreV1.DeleteKey that deletes entities from the Cloud Datastore for the specified project.

withDatabaseId

public DatastoreV1.DeleteKey withDatabaseId(String databaseId)

Returns a new DatastoreV1.DeleteKey that deletes entities from the Cloud Datastore for the specified database.

withLocalhost

public DatastoreV1.DeleteKey withLocalhost(String localhost)

Returns a new DatastoreV1.DeleteKey that deletes entities from the Cloud Datastore Emulator running locally on the specified host port.

withProjectId

public DatastoreV1.DeleteKey withProjectId(ValueProvider<String> projectId)

Same as withProjectId(String) but with a ValueProvider.

withDatabaseId

public DatastoreV1.DeleteKey withDatabaseId(ValueProvider<String> databaseId)

Same as withDatabaseId(String) but with a ValueProvider.

withRampupThrottlingDisabled

public DatastoreV1.DeleteKey withRampupThrottlingDisabled()

Returns a new DatastoreV1.DeleteKey that does not throttle during ramp-up.

withHintNumWorkers

public DatastoreV1.DeleteKey withHintNumWorkers(int hintNumWorkers)

Returns a new DatastoreV1.DeleteKey with a different worker count hint for ramp-up throttling. Value is ignored if ramp-up throttling is disabled.

withHintNumWorkers

public DatastoreV1.DeleteKey withHintNumWorkers(ValueProvider<Integer> hintNumWorkers)

Same as withHintNumWorkers(int) but with a ValueProvider.

withResults

public DatastoreV1.DeleteKeyWithSummary withResults()

Returns DatastoreV1.DeleteKeyWithSummary transform which can be used in Wait.on(PCollection[]) to wait until all data is deleted.

Example: delete a PCollection of Key from one database and then from another database, making sure that deleting a window of data to the second database starts only after the respective window has been fully deleted from the first database.

toString

public String toString()

Overrides:

toString in class PTransform<PCollection<com.google.datastore.v1.Key>,PDone>

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<PCollection<com.google.datastore.v1.Key>,PDone>

Parameters:

builder - The builder to populate with display data.

See Also:

• HasDisplayData

getProjectId

public String getProjectId()

getDatabaseId

public String getDatabaseId()

expand

public PDone expand(PCollection<com.google.datastore.v1.Key> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollection<com.google.datastore.v1.Key>,PDone>