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

Class DatastoreV1.WriteWithSummary

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<com.google.datastore.v1.Entity>,PCollection<DatastoreV1.WriteSuccessSummary>>

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

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

DatastoreV1

public static class DatastoreV1.WriteWithSummary
extends PTransform<PCollection<com.google.datastore.v1.Entity>,PCollection<DatastoreV1.WriteSuccessSummary>>

A PTransform that writes Entity objects to Cloud Datastore and returns DatastoreV1.WriteSuccessSummary for each successful write.

See Also:

• DatastoreIO
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ValueProvider<String>	databaseId
protected ValueProvider<Integer>	hintNumWorkers
protected @Nullable String	localhost
protected ValueProvider<String>	projectId
protected boolean	throttleRampup

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

annotations, displayData, name, resourceHints

Method Summary

Modifier and Type	Method	Description
PCollection<DatastoreV1.WriteSuccessSummary>	expand(PCollection<com.google.datastore.v1.Entity> 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.WriteWithSummary	withDatabaseId(String databaseId)	Returns a new DatastoreV1.WriteWithSummary that writes to the Cloud Datastore for the database id.
DatastoreV1.WriteWithSummary	withDatabaseId(ValueProvider<String> databaseId)	Same as withDatabaseId(String) but with a ValueProvider.
DatastoreV1.WriteWithSummary	withHintNumWorkers(int hintNumWorkers)	Returns a new DatastoreV1.WriteWithSummary with a different worker count hint for ramp-up throttling.
DatastoreV1.WriteWithSummary	withHintNumWorkers(ValueProvider<Integer> hintNumWorkers)	Same as withHintNumWorkers(int) but with a ValueProvider.
DatastoreV1.WriteWithSummary	withLocalhost(String localhost)	Returns a new DatastoreV1.WriteWithSummary that writes to the Cloud Datastore Emulator running locally on the specified host port.
DatastoreV1.WriteWithSummary	withProjectId(String projectId)	Returns a new DatastoreV1.WriteWithSummary that writes to the Cloud Datastore for the default database.
DatastoreV1.WriteWithSummary	withProjectId(ValueProvider<String> projectId)	Same as withProjectId(String) but with a ValueProvider.
DatastoreV1.WriteWithSummary	withRampupThrottlingDisabled()	Returns a new DatastoreV1.WriteWithSummary that does not throttle during ramp-up.

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

Field Details

projectId

protected ValueProvider<String> projectId

databaseId

protected ValueProvider<String> databaseId

localhost

protected @Nullable String localhost

throttleRampup

protected boolean throttleRampup

hintNumWorkers

protected ValueProvider<Integer> hintNumWorkers

Method Details

withProjectId

public DatastoreV1.WriteWithSummary withProjectId(String projectId)

Returns a new DatastoreV1.WriteWithSummary that writes to the Cloud Datastore for the default database.

withDatabaseId

public DatastoreV1.WriteWithSummary withDatabaseId(String databaseId)

Returns a new DatastoreV1.WriteWithSummary that writes to the Cloud Datastore for the database id.

withProjectId

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

Same as withProjectId(String) but with a ValueProvider.

withDatabaseId

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

Same as withDatabaseId(String) but with a ValueProvider.

withLocalhost

public DatastoreV1.WriteWithSummary withLocalhost(String localhost)

Returns a new DatastoreV1.WriteWithSummary that writes to the Cloud Datastore Emulator running locally on the specified host port.

withRampupThrottlingDisabled

public DatastoreV1.WriteWithSummary withRampupThrottlingDisabled()

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

withHintNumWorkers

public DatastoreV1.WriteWithSummary withHintNumWorkers(int hintNumWorkers)

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

withHintNumWorkers

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

Same as withHintNumWorkers(int) but with a ValueProvider.

expand

public PCollection<DatastoreV1.WriteSuccessSummary> expand(PCollection<com.google.datastore.v1.Entity> 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<T>,PCollection<DatastoreV1.WriteSuccessSummary>>

toString

public String toString()

Overrides:

toString in class PTransform<PCollection<T>,PCollection<DatastoreV1.WriteSuccessSummary>>

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<T>,PCollection<DatastoreV1.WriteSuccessSummary>>

Parameters:

builder - The builder to populate with display data.

See Also:

• HasDisplayData

getProjectId

public String getProjectId()

getDatabaseId

public String getDatabaseId()