Package org.apache.beam.sdk.io.components.ratelimiter

Class RateLimiterOptions

java.lang.Object

org.apache.beam.sdk.io.components.ratelimiter.RateLimiterOptions

All Implemented Interfaces:

Serializable

@DefaultSchema(AutoValueSchema.class)
public abstract class RateLimiterOptions
extends Object
implements Serializable

Configuration options for RateLimiterFactory.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RateLimiterOptions.Builder

Constructor Summary

Constructors

Constructor	Description
RateLimiterOptions()

Method Summary

Modifier and Type	Method	Description
static RateLimiterOptions.Builder	builder()
abstract String	getAddress()
abstract Integer	getMaxRetries()
abstract Duration	getTimeout()

Methods inherited from class java.lang.Object

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

Constructor Details

RateLimiterOptions

public RateLimiterOptions()

Method Details

getAddress

@SchemaFieldDescription("Address of the rate limiter")
public abstract String getAddress()

getMaxRetries

@Nullable
@SchemaFieldDescription("Maximum number of retries, defaults to infinite")
public abstract Integer getMaxRetries()

getTimeout

@SchemaFieldDescription("Timeout for rate limiter operations, defaults to 5 seconds")
public abstract Duration getTimeout()

builder

public static RateLimiterOptions.Builder builder()