Packages

c

com.spotify.scio.grpc

GrpcBatchDoFn

class GrpcBatchDoFn[Input, BatchRequest, BatchResponse, Output, Client <: AbstractFutureStub[Client]] extends GuavaAsyncBatchLookupDoFn[Input, BatchRequest, BatchResponse, Output, Client]

DoFn that makes API calls that can be batched and individually cached over a managed GRPC channel.

Source
GrpcBatchDoFn.java
Linear Supertypes
GuavaAsyncBatchLookupDoFn[Input, BatchRequest, BatchResponse, Output, Client], Guava[BatchResponse], BaseAsyncBatchLookupDoFn[Input, BatchRequest, BatchResponse, Output, Client, ListenableFuture[BatchResponse], Try[Output]], Base[ListenableFuture[BatchResponse], BatchResponse], DoFnWithResource[Input, KV[Input, Try[Output]], Pair[Client, Cache[String, Output]]], DoFn[Input, KV[Input, Try[Output]]], HasDisplayData, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GrpcBatchDoFn
  2. GuavaAsyncBatchLookupDoFn
  3. Guava
  4. BaseAsyncBatchLookupDoFn
  5. Base
  6. DoFnWithResource
  7. DoFn
  8. HasDisplayData
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GrpcBatchDoFn(channelSupplier: ChannelSupplier, newClientFn: SerializableFunction[Channel, Client], batchSize: Int, batchRequestFn: SerializableFunction[List[Input], BatchRequest], batchResponseFn: SerializableFunction[BatchResponse, List[Pair[String, Output]]], idExtractorFn: SerializableFunction[Input, String], lookupFn: SerializableBiFunction[Client, BatchRequest, ListenableFuture[BatchResponse]], maxPendingRequests: Int, cacheSupplier: CacheSupplier[String, Output])
  2. new GrpcBatchDoFn(channelSupplier: ChannelSupplier, newClientFn: SerializableFunction[Channel, Client], batchSize: Int, batchRequestFn: SerializableFunction[List[Input], BatchRequest], batchResponseFn: SerializableFunction[BatchResponse, List[Pair[String, Output]]], idExtractorFn: SerializableFunction[Input, String], lookupFn: SerializableBiFunction[Client, BatchRequest, ListenableFuture[BatchResponse]], maxPendingRequests: Int)

Type Members

  1. abstract class FinishBundleContext extends AnyRef
    Definition Classes
    DoFn
  2. abstract class OnTimerContext extends WindowedContext
    Definition Classes
    DoFn
  3. abstract class OnWindowExpirationContext extends WindowedContext
    Definition Classes
    DoFn
  4. abstract class ProcessContext extends WindowedContext
    Definition Classes
    DoFn
  5. abstract class StartBundleContext extends AnyRef
    Definition Classes
    DoFn
  6. abstract class WindowedContext extends AnyRef
    Definition Classes
    DoFn

Abstract Value Members

  1. abstract object FinishBundleContext
    Definition Classes
    DoFn
  2. abstract object ProcessContext
    Definition Classes
    DoFn
  3. abstract object StartBundleContext
    Definition Classes
    DoFn
  4. abstract object WindowedContext
    Definition Classes
    DoFn

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addCallback(future: ListenableFuture[BatchResponse], onSuccess: Function[BatchResponse, Void], onFailure: Function[Throwable, Void]): ListenableFuture[BatchResponse]
    Definition Classes
    Guava → Base
    Annotations
    @Override()
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asyncLookup(client: Client, request: BatchRequest): ListenableFuture[BatchResponse]
    Definition Classes
    GrpcBatchDoFn → BaseAsyncBatchLookupDoFn
    Annotations
    @Override()
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def closeResource(resource: Pair[Client, Cache[String, Output]]): Unit

    Close resource.

    Close resource.

    Default implementation closes AutoCloseable resource.

    Definition Classes
    BaseAsyncBatchLookupDoFn → DoFnWithResource
    Annotations
    @Override()
  9. def createResource(): Pair[Client, Cache[String, Output]]

    Create resource.

    Create resource.

    DoFnWithResource#getResourceType() determines how many times this is called.

    Definition Classes
    BaseAsyncBatchLookupDoFn → DoFnWithResource
    Annotations
    @Override()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def failure(throwable: Throwable): Try[Output]
    Definition Classes
    GuavaAsyncBatchLookupDoFn → BaseAsyncBatchLookupDoFn
    Annotations
    @Override()
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. def finishBundle(context: FinishBundleContext): Unit
    Definition Classes
    BaseAsyncBatchLookupDoFn
    Annotations
    @FinishBundle()
  15. def getCallbackExecutor(): Executor

    Executor used for callbacks.

    Executor used for callbacks. Default is ForkJoinPool#commonPool(). Consider overriding this method if callbacks are blocking.

    returns

    Executor for callbacks.

    Definition Classes
    Guava
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getInputTypeDescriptor(): TypeDescriptor[Input]
    Definition Classes
    DoFn
  18. def getOutputTypeDescriptor(): TypeDescriptor[KV[Input, Try[Output]]]
    Definition Classes
    DoFn
  19. def getResource(): Pair[Client, Cache[String, Output]]

    Get managed resource.

    Get managed resource.

    Definition Classes
    DoFnWithResource
    Annotations
    @SuppressWarnings()
  20. def getResourceCache(): Cache[String, Output]
    Definition Classes
    BaseAsyncBatchLookupDoFn
  21. def getResourceClient(): Client
    Definition Classes
    BaseAsyncBatchLookupDoFn
  22. def getResourceType(): ResourceType

    Get resource type.

    Get resource type.

    Definition Classes
    GrpcBatchDoFn → DoFnWithResource
    Annotations
    @Override()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def newClient(): Client
    Attributes
    protected[grpc]
    Definition Classes
    GrpcBatchDoFn → BaseAsyncBatchLookupDoFn
    Annotations
    @Override()
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def populateDisplayData(builder: Builder): Unit
    Definition Classes
    DoFnWithResource → DoFn → HasDisplayData
    Annotations
    @Override()
  30. def processElement(input: Input, timestamp: Instant, out: OutputReceiver[KV[Input, Try[Output]]], window: BoundedWindow): Unit
    Definition Classes
    BaseAsyncBatchLookupDoFn
    Annotations
    @ProcessElement()
  31. def setup(): Unit
    Definition Classes
    DoFnWithResource
    Annotations
    @Setup()
  32. def startBundle(context: StartBundleContext): Unit
    Definition Classes
    BaseAsyncBatchLookupDoFn
    Annotations
    @StartBundle()
  33. def success(output: Output): Try[Output]
    Definition Classes
    GuavaAsyncBatchLookupDoFn → BaseAsyncBatchLookupDoFn
    Annotations
    @Override()
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def teardown(): Unit
    Definition Classes
    DoFnWithResource
    Annotations
    @Teardown()
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. def waitForFutures(futures: Iterable[ListenableFuture[BatchResponse]]): Unit
    Definition Classes
    Guava → Base
    Annotations
    @Override()

Deprecated Value Members

  1. def getAllowedTimestampSkew(): Duration
    Definition Classes
    DoFn
    Annotations
    @Deprecated
    Deprecated
  2. final def prepareForProcessing(): Unit
    Definition Classes
    DoFn
    Annotations
    @Deprecated
    Deprecated

Inherited from GuavaAsyncBatchLookupDoFn[Input, BatchRequest, BatchResponse, Output, Client]

Inherited from Guava[BatchResponse]

Inherited from BaseAsyncBatchLookupDoFn[Input, BatchRequest, BatchResponse, Output, Client, ListenableFuture[BatchResponse], Try[Output]]

Inherited from Base[ListenableFuture[BatchResponse], BatchResponse]

Inherited from DoFnWithResource[Input, KV[Input, Try[Output]], Pair[Client, Cache[String, Output]]]

Inherited from DoFn[Input, KV[Input, Try[Output]]]

Inherited from HasDisplayData

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped