Serialized Form (Pravega API)

Package io.pravega.client
- Class io.pravega.client.ClientConfig extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - connectTimeoutMilliSec
      
      long connectTimeoutMilliSec
      
      Maximum Connection timeout in milliseconds for establishing connections.
    - controllerURI
      
      java.net.URI controllerURI
      
      controllerURI The controller rpc URI. This can be of 2 types 1. tcp://ip1:port1,ip2:port2,... This is used if the controller endpoints are static and can be directly accessed. 2. pravega://ip1:port1,ip2:port2,... This is used to autodiscovery the controller endpoints from an initial controller list.
    - credentials
      
      io.pravega.shared.security.auth.Credentials credentials
      
      Credentials to be passed on to the Pravega controller for authentication and authorization.
    - deriveTlsEnabledFromControllerURI
      
      boolean deriveTlsEnabledFromControllerURI
      
      An internal property that determines whether TLS enabled is derived from Controller URI. It cannot be set directly by the caller. It is interpreted as: false - if ClientConfig.enableTlsToController and/or ClientConfig.enableTlsToSegmentStore is/are set, and if either of them is set to false. true - if neither ClientConfig.enableTlsToController or ClientConfig.enableTlsToSegmentStore are set, or if both are set to true.
    - enableTlsToController
      
      boolean enableTlsToController
      
      An optional property representing whether to enable TLS for client's communication with the Controller. If this property and ClientConfig.enableTlsToSegmentStore are not set, and the scheme used in ClientConfig.controllerURI is tls or pravegas, TLS is automatically enabled for both client-to-Controller and client-to-Segment Store communications.
    - enableTlsToSegmentStore
      
      boolean enableTlsToSegmentStore
      
      An optional property representing whether to enable TLS for client's communication with the Controller. If this property and ClientConfig.enableTlsToController are not set, and the scheme used in ClientConfig.controllerURI is tls or pravegas, TLS is automatically enabled for both client-to-Controller and client-to-Segment Store communications.
    - isDefaultMaxConnections
      
      boolean isDefaultMaxConnections
      
      An internal property that determines if the client config.
    - maxConnectionsPerSegmentStore
      
      int maxConnectionsPerSegmentStore
      
      Maximum number of connections per Segment store to be used by connection pooling.
    - metricListener
      
      io.pravega.shared.metrics.MetricListener metricListener
      
      An optional listener which can be used to get performance metrics from the client. The user can implement this interface to obtain performance metrics of the client.
    - trustStore
      
      java.lang.String trustStore
      
      Path to an optional truststore. If this is null or empty, the default JVM trust store is used. This is currently expected to be a signing certificate for the certification authority.
    - validateHostName
      
      boolean validateHostName
      
      If the flag ClientConfig.isEnableTls() is set, this flag decides whether to enable host name validation or not.
Package io.pravega.client.batch
Package io.pravega.client.state
- Class io.pravega.client.state.SynchronizerConfig extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  3L
  - Serialization Methods
    - writeReplace
      
      private java.lang.Object writeReplace()
  - Serialized Fields
    - eventWriterConfig
      
      EventWriterConfig eventWriterConfig
      
      This writer config is used by the segment writers in the StateSynchronizer. The default values enable connection pooling and ensures the background connection retry attempts continue until the StateSynchronizer is closed.
    - readBufferSize
      
      int readBufferSize
      
      This size is used to allocate buffer space for the bytes the reader in the StateSynchronizer reads from the segment. The default buffer size is 256KB.
Package io.pravega.client.stream
- Class io.pravega.client.stream.ConfigMismatchException extends java.lang.IllegalArgumentException implements Serializable
  
  serialVersionUID:
  
  1L
- Class io.pravega.client.stream.DeleteScopeFailedException extends java.lang.Exception implements Serializable
  
  serialVersionUID:
  
  1L
- Class io.pravega.client.stream.EventWriterConfig extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialization Methods
    - writeReplace
      
      private java.lang.Object writeReplace()
  - Serialized Fields
    - automaticallyNoteTime
      
      boolean automaticallyNoteTime
      
      Automatically invoke EventStreamWriter.noteTime(long) passing System.currentTimeMillis() on a regular interval.
    - backoffMultiple
      
      int backoffMultiple
      
      Backoff multiplier used in the retry logic of the writer. The default value is 10.
    - enableConnectionPooling
      
      boolean enableConnectionPooling
      
      Enable or disable connection pooling for writer. The default value is false.
    - enableLargeEvents
      
      boolean enableLargeEvents
      
      Enable or disable whether LargeEvent writes should be processed and sent to the SegmentStore. A LargeEvent is defined as any event containing a number of bytes greater than Serializer.MAX_EVENT_SIZE.
    - initialBackoffMillis
      
      int initialBackoffMillis
      
      Initial backoff in milli seconds used in the retry logic of the writer. The default value is 1ms.
    - maxBackoffMillis
      
      int maxBackoffMillis
      
      Maximum backoff in milli seconds used in the retry logic of the writer. The default value is 20000.
    - retryAttempts
      
      int retryAttempts
      
      Maximum retry attempts performed by the writer before throwing a RetriesExhaustedException. The default value is 10.
    - transactionTimeoutTime
      
      long transactionTimeoutTime
      
      The transaction timeout parameter corresponds to the lease renewal period. In every period, the client must send at least one ping to keep the txn alive. If the client fails to do so, then Pravega aborts the txn automatically. The client sends pings internally and requires no application intervention, only that it sets this parameter accordingly. This parameter is additionally used to determine the total amount of time that a txn can remain open. Currently, we set the maximum amount of time for a txn to remain open to be the minimum between 1 day and 1,000 times the value of the lease renewal period. The 1,000 is hardcoded and has been chosen arbitrarily to be a large enough value. The maximum allowed lease time by default is 600s, see: io.pravega.controller.util.Config.PROPERTY_TXN_MAX_LEASE The maximum allowed lease time is a configuration parameter of the controller and can be changed accordingly. Note that being a controller-wide parameter, it affects all transactions.
- Class io.pravega.client.stream.InvalidStreamException extends java.lang.RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class io.pravega.client.stream.NoSuchScopeException extends java.lang.RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class io.pravega.client.stream.PingFailedException extends java.lang.Exception implements Serializable
  
  serialVersionUID:
  
  1L
- Class io.pravega.client.stream.ReaderConfig extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - bufferSize
      
      int bufferSize
    - disableTimeWindows
      
      boolean disableTimeWindows
    - initialAllocationDelay
      
      long initialAllocationDelay
- Class io.pravega.client.stream.ReaderGroupConfig extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - automaticCheckpointIntervalMillis
      
      long automaticCheckpointIntervalMillis
    - endingStreamCuts
      
      java.util.Map<Stream,StreamCut> endingStreamCuts
    - generation
      
      long generation
    - groupRefreshTimeMillis
      
      long groupRefreshTimeMillis
    - maxOutstandingCheckpointRequest
      
      int maxOutstandingCheckpointRequest
    - readerGroupId
      
      java.util.UUID readerGroupId
    - retentionType
      
      ReaderGroupConfig.StreamDataRetention retentionType
    - startingStreamCuts
      
      java.util.Map<Stream,StreamCut> startingStreamCuts
- Class io.pravega.client.stream.ReaderGroupNotFoundException extends java.lang.IllegalArgumentException implements Serializable
  
  serialVersionUID:
  
  1L
- Class io.pravega.client.stream.ReaderNotInReaderGroupException extends java.lang.Exception implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - readerId
      
      java.lang.String readerId
- Class io.pravega.client.stream.ReinitializationRequiredException extends java.lang.RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class io.pravega.client.stream.RetentionPolicy extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retentionMax
      
      long retentionMax
    - retentionParam
      
      long retentionParam
    - retentionType
      
      RetentionPolicy.RetentionType retentionType
- Class io.pravega.client.stream.ScalingPolicy extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - minNumSegments
      
      int minNumSegments
    - scaleFactor
      
      int scaleFactor
    - scaleType
      
      ScalingPolicy.ScaleType scaleType
    - targetRate
      
      int targetRate
- Class io.pravega.client.stream.Sequence extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialization Methods
    - writeReplace
      
      private java.lang.Object writeReplace()
  - Serialized Fields
    - highOrder
      
      long highOrder
    - lowOrder
      
      long lowOrder
- Class io.pravega.client.stream.StreamConfiguration extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retentionPolicy
      
      RetentionPolicy retentionPolicy
      
      API to return retention policy. Also see: ReaderGroupConfig.StreamDataRetention
    - rolloverSizeBytes
      
      long rolloverSizeBytes
      
      API to return segment rollover size. The default value for this field is 0. If default value is passed down to the server, a non-zero value defined in the server will be used for the actual rollover size.
    - scalingPolicy
      
      ScalingPolicy scalingPolicy
      
      API to return scaling policy.
    - tags
      
      java.util.Set<java.lang.String> tags
      
      API to return the configured tags for the Stream.
    - timestampAggregationTimeout
      
      long timestampAggregationTimeout
      
      The duration after the last call to EventStreamWriter.noteTime(long) until which the writer would be considered for computing EventStreamReader.getCurrentTimeWindow(Stream) Meaning that after this long of not calling EventStreamWriter.noteTime(long) a writer's previously reported time would be ignored for computing the time window. However, after the timestampAggregationTimeout elapses the same writer may resume noting time at any time. If no writer have noted time within the timestampAggregationTimeout, readers that call EventStreamReader.getCurrentTimeWindow(Stream) will receive a `null` when they are at the corresponding position in the stream. until which the writer would be considered active. to continue to consider the provided time.
- Class io.pravega.client.stream.TruncatedDataException extends java.lang.RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class io.pravega.client.stream.TxnFailedException extends java.lang.Exception implements Serializable
  
  serialVersionUID:
  
  1L
Package io.pravega.client.tables
- Class io.pravega.client.tables.BadKeyVersionException extends ConditionalTableUpdateException implements Serializable
- Class io.pravega.client.tables.ConditionalTableUpdateException extends java.lang.Exception implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - tableName
      
      java.lang.String tableName
- Class io.pravega.client.tables.KeyValueTableClientConfiguration extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - backoffMultiple
      
      int backoffMultiple
    - initialBackoffMillis
      
      int initialBackoffMillis
    - maxBackoffMillis
      
      int maxBackoffMillis
    - retryAttempts
      
      int retryAttempts
- Class io.pravega.client.tables.KeyValueTableConfiguration extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - partitionCount
      
      int partitionCount
      
      The number of Partitions for a Key-Value Table. This value cannot be adjusted after the Key-Value Table has been created.
    - primaryKeyLength
      
      int primaryKeyLength
      
      The number of bytes for the Primary Key. This value cannot be changed after the Key-Value Table has been created.
    - rolloverSizeBytes
      
      long rolloverSizeBytes
      
      The rollover size for table segment in LTS. The default value for this field is 0. If default value is passed down to the server, a non-zero value defined in the server will be used for the actual rollover size.
    - secondaryKeyLength
      
      int secondaryKeyLength
      
      The number of bytes for the Secondary Key. This value cannot be changed after the Key-Value Table has been created.
- Class io.pravega.client.tables.KeyVersion extends java.lang.Object implements Serializable
  - Serialized Fields
    - segmentName
      
      java.lang.String segmentName
      
      The Segment where this Key resides. May be null if this is a KeyVersion.NOT_EXISTS or KeyVersion.NO_VERSION KeyVersion.
    - segmentVersion
      
      io.pravega.client.tables.impl.TableSegmentKeyVersion segmentVersion
      
      The internal version inside the Table Segment for this Key.
- Class io.pravega.client.tables.NoSuchKeyException extends ConditionalTableUpdateException implements Serializable

Serialized Form

Package io.pravega.client

Class io.pravega.client.ClientConfig extends java.lang.Object implements Serializable

Serialized Fields

connectTimeoutMilliSec

controllerURI

credentials

deriveTlsEnabledFromControllerURI

enableTlsToController

enableTlsToSegmentStore

isDefaultMaxConnections

maxConnectionsPerSegmentStore

metricListener

trustStore

validateHostName

Package io.pravega.client.batch

Package io.pravega.client.state

Class io.pravega.client.state.SynchronizerConfig extends java.lang.Object implements Serializable

Serialization Methods

writeReplace

Serialized Fields

eventWriterConfig

readBufferSize

Package io.pravega.client.stream

Class io.pravega.client.stream.ConfigMismatchException extends java.lang.IllegalArgumentException implements Serializable

Class io.pravega.client.stream.DeleteScopeFailedException extends java.lang.Exception implements Serializable

Class io.pravega.client.stream.EventWriterConfig extends java.lang.Object implements Serializable

Serialization Methods

writeReplace

Serialized Fields

automaticallyNoteTime

backoffMultiple

enableConnectionPooling

enableLargeEvents

initialBackoffMillis

maxBackoffMillis

retryAttempts

transactionTimeoutTime

Class io.pravega.client.stream.InvalidStreamException extends java.lang.RuntimeException implements Serializable

Class io.pravega.client.stream.NoSuchScopeException extends java.lang.RuntimeException implements Serializable

Class io.pravega.client.stream.PingFailedException extends java.lang.Exception implements Serializable

Class io.pravega.client.stream.ReaderConfig extends java.lang.Object implements Serializable

Serialized Fields

bufferSize

disableTimeWindows

initialAllocationDelay

Class io.pravega.client.stream.ReaderGroupConfig extends java.lang.Object implements Serializable

Serialized Fields

automaticCheckpointIntervalMillis

endingStreamCuts

generation

groupRefreshTimeMillis

maxOutstandingCheckpointRequest

readerGroupId

retentionType

startingStreamCuts

Class io.pravega.client.stream.ReaderGroupNotFoundException extends java.lang.IllegalArgumentException implements Serializable

Class io.pravega.client.stream.ReaderNotInReaderGroupException extends java.lang.Exception implements Serializable

Serialized Fields

readerId

Class io.pravega.client.stream.ReinitializationRequiredException extends java.lang.RuntimeException implements Serializable

Class io.pravega.client.stream.RetentionPolicy extends java.lang.Object implements Serializable

Serialized Fields

retentionMax

retentionParam

retentionType

Class io.pravega.client.stream.ScalingPolicy extends java.lang.Object implements Serializable

Serialized Fields

minNumSegments

scaleFactor

scaleType

targetRate

Class io.pravega.client.stream.Sequence extends java.lang.Object implements Serializable

Serialization Methods

writeReplace

Serialized Fields

highOrder

lowOrder

Class io.pravega.client.stream.StreamConfiguration extends java.lang.Object implements Serializable

Serialized Fields