Rama

https://redplanetlabs.com/javadoc/
Admin
Rama is a distributed stream processing and database system developed by Red Planet Labs, designed...
Tokens:244,594
Snippets:1,909
Trust Score:7.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start From Beginning StreamSourceOptions

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/module/StreamSourceOptions

Configures the stream topology to start processing from the beginning of a depot partition. This setting only takes effect the first time the topology encounters the depot. Consult the documentation on start options for stream and microbatch topologies.

```Java
static StreamSourceOptions.Impl startFromBeginning()
```

--------------------------------

### Start Microbatch Processing from Beginning

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/module/MicrobatchSourceOptions

Configures the microbatch topology to start processing from the beginning of the depot partition. This setting is only effective the first time the topology encounters the depot.

```Java
static MicrobatchSourceOptions.Impl startFromBeginning()
Start processing from beginning of depot partition. Only takes effect the first time the topology encounters this depot.
```

--------------------------------

### Start Stream/Microbatch Processing (Rama Module)

Source: https://redplanetlabs.com/javadoc/index-all

Configures stream or microbatch topologies to start processing from the beginning of a depot partition or from a specific point in the past.

```Java
MicrobatchSourceOptions.Impl startFromBeginning()
static MicrobatchSourceOptions startFromBeginning()
StreamSourceOptions.Impl startFromBeginning()
static StreamSourceOptions startFromBeginning()
MicrobatchSourceOptions.Impl startFromOffsetAfterTimestamp(long timestamp)
static MicrobatchSourceOptions startFromOffsetAfterTimestamp(long timestamp)
StreamSourceOptions.Impl startFromOffsetAfterTimestamp(long timestamp)
static StreamSourceOptions startFromOffsetAfterTimestamp(long timestamp)
MicrobatchSourceOptions.Impl startFromOffsetAgo(long offset, OffsetAgo offsetAgo)
static MicrobatchSourceOptions startFromOffsetAgo(long offset, OffsetAgo offsetAgo)
StreamSourceOptions.Impl startFromOffsetAgo(long offset, OffsetAgo offsetAgo)
static StreamSourceOptions startFromOffsetAgo(long offset, OffsetAgo offsetAgo)
```

--------------------------------

### Get Start Offset (Rama Integration)

Source: https://redplanetlabs.com/javadoc/index-all

Asynchronously retrieves the starting offset for a given partition index.

```Java
ExternalDepot startOffset(int partitionIndex)
```

--------------------------------

### Get Start Offset - DepotPartitionInfo

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the start offset of the depot partition log. This method is part of the DepotPartitionInfo class.

```Java
long getStartOffset()
    - Method in class com.rpl.rama.object.DepotPartitionInfo
```

--------------------------------

### Start From Offset After Timestamp StreamSourceOptions

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/module/StreamSourceOptions

Configures the stream topology to start processing each depot partition from a point in the past, specified by a timestamp in milliseconds. This setting only takes effect the first time the topology encounters the depot. Consult the documentation on start options for stream and microbatch topologies.

```Java
static StreamSourceOptions.Impl startFromOffsetAfterTimestamp(long millis)
```

--------------------------------

### getStartOffset Method

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/object/DepotPartitionInfo

Retrieves the start offset of the depot partition log.

```Java
public long getStartOffset()
```

--------------------------------

### Start From Offset Ago StreamSourceOptions

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/module/StreamSourceOptions

Configures the stream topology to start processing each depot partition from a point in the past, specified by an amount and a time unit. This setting only takes effect the first time the topology encounters the depot. Consult the documentation on start options for stream and microbatch topologies.

```Java
static StreamSourceOptions.Impl startFromOffsetAgo(long amt,
                                                   OffsetAgo unit)
```

--------------------------------

### Rama: Navigate to Beginning of List (beginning)

Source: https://redplanetlabs.com/javadoc/index-all

The beginning method navigates a list to an empty subsequence at its start. This method is part of the Path and Path.Impl interfaces, useful for resetting or accessing the start of a list.

```Java
beginning()
```

--------------------------------

### startOffset - Get Start Offset of Partition

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/integration/ExternalDepot

Asynchronously returns the starting offset (inclusive) for a given partition index. This method is optional if topologies do not use startFromBeginning().

```Java
java.util.concurrent.CompletableFuture<java.lang.Long> startOffset(int partitionIndex)
```

--------------------------------

### Navigate Subset in Rama

Source: https://redplanetlabs.com/javadoc/index-all

Details how to navigate to a subset of a starting set containing specific elements using Rama's Path interface.

```Java
subset(Object...) - Method in interface com.rpl.rama.Path.Impl
    
    Navigates to subset of starting set with given elements.
```

```Java
subset(Object...) - Static method in interface com.rpl.rama.Path
    
    Navigates to subset of starting set with given elements.
```

--------------------------------

### fetchFrom - Fetch Records from Start Offset

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/integration/ExternalDepot

Asynchronously fetches records from a specified partition starting from a given offset. This overload is used when a specific end offset is not required.

```Java
java.util.concurrent.CompletableFuture<java.util.List> fetchFrom(int partitionIndex,
          long startOffset)
```

--------------------------------

### originPartition: Change Back to Starting Task

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Block

Changes back to the starting task for a query topology invocation. Can only be used in query topologies and must be the final partitioner used. Requires Query topology documentation.

```Java
static Block.Impl originPartition()
```

--------------------------------

### Path.Impl subset

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

Navigates to a subset of the starting set containing the specified elements. This is a substructure navigator.

```Java
Path.Impl subset(java.lang.Object... argVals)
```

--------------------------------

### DepotPartitionInfo Constructor

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/object/DepotPartitionInfo

Constructs a DepotPartitionInfo object with the specified start and end offsets.

```Java
public DepotPartitionInfo(long startOffset,
                          long endOffset)
```

--------------------------------

### Return to Origin Task - SubSource.Impl

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/SubSource

Changes back to the starting task for a query topology invocation.

```Java
SubSource.Impl originPartition()
```

--------------------------------

### Navigate Sorted Set From Element with Options

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

Navigates a sorted set starting from a specified element, with options to limit the number of elements or control the inclusivity of the start element. This offers fine-grained control over the retrieval process.

```Java
Path.Impl sortedSetRangeFrom(java.lang.Object argElemStart, java.lang.Object argAmtOrOptions)
```

--------------------------------

### Path.Impl Method: beginning()

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

Navigates on a list to an empty subsequence at the beginning.

```Java
Path.Impl beginning()
Navigates on a list to empty subsequence at beginning.
```

--------------------------------

### RamaModule Setup Options

Source: https://redplanetlabs.com/javadoc/index-all

Methods for setting dynamic options for module launch, including depot, module, PState, and topology specific options. These can be overridden at deploy time.

```Java
setLaunchDepotDynamicOption(String, String, Object)
```

```Java
setLaunchModuleDynamicOption(String, Object)
```

```Java
setLaunchPStateDynamicOption(String, String, Object)
```

```Java
setLaunchTopologyDynamicOption(String, String, Object)
```

--------------------------------

### Declare Depot with Native Partitioning - Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Defines a depot with a specified native partitioning scheme. This method returns a builder for setting additional depot options.

```Java
Depot.Declaration declareDepot(java.lang.String var, com.rpl.rama.impl.NativeDepotPartitioning partitioning)
```

--------------------------------

### Get Partition Information

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Depot

Retrieves the start and end offsets for a specified partition index within the depot. An asynchronous version is also available.

```Java
DepotPartitionInfo getPartitionInfo(long partitionIndex)
java.util.concurrent.CompletableFuture<DepotPartitionInfo> getPartitionInfoAsync(long partitionIndex)
```

--------------------------------

### Declare Depot with Custom Partitioning - Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Defines a depot with a custom partitioning scheme. This method is generic and accepts any class implementing Depot.Partitioning, returning a builder for further configuration.

```Java
<T extends Depot.Partitioning> Depot.Declaration declareDepot(java.lang.String var, java.lang.Class<T> partitioning)
```

--------------------------------

### Prepend Multiple Elements with beginning

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

The beginning() method navigates to an empty subsequence at the beginning of a list, used for prepending multiple elements. This is a substructure navigator.

```Java
Path.Impl beginning()

```

--------------------------------

### Get Partition Information - Depot

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the start and end offsets of the log for a specified partition index of a depot. This method is defined in the Depot interface and takes a long partition index.

```Java
getPartitionInfo(long)
    - Method in interface com.rpl.rama.Depot
```

--------------------------------

### Get Partition Information Async - Depot

Source: https://redplanetlabs.com/javadoc/index-all

Asynchronously retrieves the start and end offsets of the log for a specified partition index of a depot. This method is defined in the Depot interface and takes a long partition index.

```Java
getPartitionInfoAsync(long)
    - Method in interface com.rpl.rama.Depot
```

--------------------------------

### Generate Integer Range (Rama)

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/ops/Ops

Generates a sequence of integers starting from the first argument (inclusive) up to, but not including, the second argument. Example: `Block.each(Ops.RANGE, 10, 20).out("*i")`. This function is part of the NativeRamaOperation2 interface.

```Java
static com.rpl.rama.impl.NativeRamaOperation2<java.lang.Number,java.lang.Number> RANGE
```

--------------------------------

### RANGE Operation

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/ops/Ops

Generates a sequence of integers within a specified range. The arguments are a starting integer (inclusive) and an ending integer (exclusive). Each integer in the range is emitted individually. Example usage: Block.each(Ops.RANGE, 10, 20).out("*i"). This is a native Rama operation.

```Java
public static final com.rpl.rama.impl.NativeRamaOperation2<java.lang.Number,java.lang.Number> RANGE
```

--------------------------------

### Launch Module with Configuration

Source: https://redplanetlabs.com/javadoc/index-all

Launches a Rama module on an InProcessCluster with specified parallelism settings.

```Java
com.rpl.rama.test.LaunchConfig
com.rpl.rama.test.LaunchConfig(int, int)
com.rpl.rama.test.InProcessCluster.launchModule(RamaModule, LaunchConfig)
```

--------------------------------

### Rama Module Definition Interfaces

Source: https://redplanetlabs.com/javadoc/index-all

Interfaces for defining Rama modules, including setup for depots and global objects, and defining ETL and query topologies.

```Java
interface RamaModule {
    // Defines a Rama module.
    // A module specifies an arbitrary collection of depots, ETLs, PStates, and query topologies to deploy onto a Rama cluster.

    interface Setup {
        // Used to define depots, global objects, and module dependencies in a module definition.
    }

    interface Topologies {
        // Used to define ETL and query topologies in a module definition.
    }
}
```

--------------------------------

### Exclude Start Key in SortedRangeOptions

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/SortedRangeOptions

Configures SortedRangeOptions to exclude the start key from the query results. By default, the start key is included.

```Java
static SortedRangeOptions.Impl excludeStart()
Excludes the start key from the results (by default it's included).
```

--------------------------------

### Path.Impl Method: beforeElem()

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

Navigates on a list to the element at the beginning.

```Java
Path.Impl beforeElem()
Navigates on a list to void element at beginning.
```

--------------------------------

### Exclude Start Key in Rama SortedRangeOptions

Source: https://redplanetlabs.com/javadoc/index-all

The excludeStart() method, available in SortedRangeOptions and its implementations, is used to exclude the start key from query results. By default, the start key is included.

```Java
com.rpl.rama.SortedRangeOptions.excludeStart()
com.rpl.rama.SortedRangeOptions.Impl.excludeStart()
```

--------------------------------

### Origin Partitioning in Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/SubSource

Changes back to the starting task for a query topology invocation. This must be the final partitioner used in query topologies.

```Java
SubSource.Impl originPartition()
```

--------------------------------

### Path.Impl: Navigate to Subset

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

Navigates to a subset of the starting set, containing only the elements specified by the provided argument values. This is useful for filtering collections.

```Java
Path.Impl` | `subset(java.lang.Object... argVals)
```

--------------------------------

### ProxyState get() Method

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/ProxyState

The get() method retrieves the current value of the object represented by ProxyState. This operation is thread-safe.

```Java
T get()
```

--------------------------------

### Set Launch PState Dynamic Option - Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Sets a dynamic option for a PState, which will be applied during module launch. Deployment-time overrides are possible.

```Java
void setLaunchPStateDynamicOption(java.lang.String pstate, java.lang.String opt, java.lang.Object value)
```

--------------------------------

### Path.Impl Method: all()

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

Navigates to every element of a collection.

```Java
Path.Impl all()
Navigates to every element of a collection.
```

--------------------------------

### Block Method Summary - Creation

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Block

Describes the method for creating a new Block instance. The `create` method initializes an empty Block that can be further configured with additional code.

```Java
static Block.Impl 
create()
Creates an empty Block that can have additional code attached.
```

--------------------------------

### Exclude Start Key from Results

Source: https://redplanetlabs.com/javadoc/index-all

Excludes the start key from the results (by default it's included). This method is available in SortedRangeFromOptions and its implementations.

```Java
excludeStart()
```

--------------------------------

### Create StreamSourceOptions

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/module/StreamSourceOptions

Creates an empty StreamSourceOptions instance. This is equivalent to calling `StreamSourceOptions.create().startFromBeginning()`.

```Java
static StreamSourceOptions.Impl create()
```

--------------------------------

### Rama Ops: GET Operation

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/ops/Ops

The GET operation retrieves a value from a collection using a specified key. It takes a collection and a key as arguments.

```Java
public class Ops
extends java.lang.Object
{
  public static com.rpl.rama.impl.NativeRamaFunction2<java.lang.Object, java.lang.Object, java.lang.Object> GET;
}
```

--------------------------------

### GET - Static Ops Variable

Source: https://redplanetlabs.com/javadoc/index-all

Represents the 'GET' operation. It takes a collection and a key as arguments and emits the value associated with that key in the collection.

```Java
GET - Static variable in class com.rpl.rama.ops.Ops
Arguments are a collection and a key and emits the value for the key in the collection.
```

--------------------------------

### Set Launch Topology Dynamic Option - Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Sets a dynamic option for a topology, to be used when the module is launched. This setting can be overridden during the deployment phase.

```Java
void setLaunchTopologyDynamicOption(java.lang.String topology, java.lang.String opt, java.lang.Object value)
```

--------------------------------

### Navigate PState Partition - SubSource.OutImpl

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/SubSource

Navigates into the PState partition on the current task using the given Path. Overloaded to include optional SelectOptions.

```Java
SubSource.OutImpl localSelect(java.lang.String pstateVar, Path path)
```

```Java
SubSource.OutImpl localSelect(java.lang.String pstateVar, Path path, SelectOptions options)
```

--------------------------------

### Define Mirror Depot

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Defines a mirror depot that accesses a depot on another module. This allows modules to share depot resources across the cluster.

```Java
void clusterDepot(java.lang.String var, java.lang.String moduleName, java.lang.String depotName)
```

--------------------------------

### List Keys with Prefix and Pagination

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/backup/BackupProvider

Lists all keys with a given prefix. If the prefix ends in '/', the contents of the path are returned; otherwise, the prefix is treated as an object name. Filenames are returned relative to the root. This method supports pagination using a token.

```Java
java.lang.String paginationKey)
```

List all keys with the given prefix. If the prefix ends in "/", then the contents of the path are returned, otherwise the prefix is treated as an object name. The filenames are returned relative to the root. 

Parameters:
    `prefix` - the path to start listing keys.     `paginationKey` - token controlling pagination. 

Returns:
    CompletableFuture that is delivered with a KeysPage instance. paginationKey should be be null on the initial call. On subsequent calls, pass the nextPageMarker returned by the previous call.
```

--------------------------------

### isStartIncluded Method

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/SortedRangeFromOptions

Checks whether the start key is included in the sorted range results. Returns true if the start key is included, false otherwise.

```Java
public boolean isStartIncluded()
```

--------------------------------

### Generate Hashing Index Keys with Prefix (String prefix, int numTasks)

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Helpers

Generates a list of keys, each starting with a given prefix, that hash to each task in a specified range. The nth element in the list partitions to the nth task. This method is deterministic and produces unique keys for different prefixes.

```Java
public static java.util.List<java.lang.String> genHashingIndexKeys(java.lang.String prefix,
                                                                   int numTasks)
```

--------------------------------

### Start Microbatch Processing After Timestamp

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/module/MicrobatchSourceOptions

Configures the microbatch topology to start processing from a point in the past, specified by a timestamp in milliseconds. This setting is only effective the first time the topology encounters the depot.

```Java
static MicrobatchSourceOptions.Impl startFromOffsetAfterTimestamp(long millis)
Start processing each depot partition from a point in the past. Only takes effect the first time the topology encounters this depot.

Parameters:
    millis - Timestamp based on number of milliseconds since midnight, January 1, 1970 UTC
```

--------------------------------

### Declare Mirrored Depot - Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Defines a mirror depot that accesses a depot on another module. This allows modules to share data depots across different parts of the system.

```Java
void clusterDepot(java.lang.String var, java.lang.String moduleName, java.lang.String depotName)
```

--------------------------------

### excludeStart Method - SortedRangeFromOptions.Impl

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/SortedRangeFromOptions

Excludes the start key from the results of a sorted range query. By default, the start key is included. This method is specified by the SortedRangeFromOptions.Impl interface.

```Java
public SortedRangeFromOptions.Impl excludeStart()
```

--------------------------------

### ModuleInstanceInfo Constructor

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/ModuleInstanceInfo

Initializes a new ModuleInstanceInfo object with details about a module instance. It requires parameters for module name, instance ID, number of tasks, replication factor, supervisor ID, port, and task thread IDs.

```Java
public ModuleInstanceInfo(java.lang.String moduleName,
                          java.lang.String moduleInstanceId,
                          int numTasks,
                          int replicationFactor,
                          java.lang.String supervisorId,
                          int port,
                          java.util.Set<java.lang.Integer> taskThreadIds)
```

--------------------------------

### Creation Methods in Rama

Source: https://redplanetlabs.com/javadoc/index-all

Various static `create` methods are provided across different Rama interfaces for initializing objects. These include creating empty `Block`, `Case`, `LoopVars`, `MicrobatchSourceOptions`, `StreamSourceOptions`, `Path`, `SelectOptions`, and `SortedRangeOptions`, as well as a `LimitAgg` specification.

```Java
create() - Static method in interface com.rpl.rama.Block
Creates an empty Block that can have additional code attached.

create(Object) - Static method in interface com.rpl.rama.Case
Create a case matching on the given condition.

create() - Static method in interface com.rpl.rama.LoopVars
Creates an empty LoopVars.

create() - Static method in interface com.rpl.rama.module.MicrobatchSourceOptions
Creates an empty MicrobatchSourceOptions.

create() - Static method in interface com.rpl.rama.module.StreamSourceOptions
Creates an empty StreamSourceOptions.

create(int, String...) - Static method in interface com.rpl.rama.ops.LimitAgg
Creates a limit aggregator specification

create() - Static method in interface com.rpl.rama.Path
Creates an empty Path.

create() - Static method in interface com.rpl.rama.SelectOptions
Creates an empty SubiSelectOptionsndexOptions.

create() - Static method in interface com.rpl.rama.SortedRangeFromOptions
Creates an empty SortedRangeFromOptions.

create() - Static method in interface com.rpl.rama.SortedRangeOptions
```

--------------------------------

### Navigate Sorted Map From Key (Java)

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

Navigates a sorted map to retrieve all elements starting from a specified key. The start key is inclusive. Useful for subindexed maps.

```Java
Path.Impl.sortedMapRangeFrom(java.lang.Object argKeyStart)
```

--------------------------------

### Declare Object for Tasks

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Defines an object to be copied to all tasks. If the object implements TaskGlobalObject, it will have a specialized instance per task. This is useful for integrating external resources like queues or databases with Rama.

```Java
void declareObject(java.lang.String var, java.lang.Object obj)
```

--------------------------------

### List Keys Non-Recursively in Backup Provider

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/backup/BackupProvider

Asynchronously lists keys with a given prefix without descending into sub-directories. Supports pagination using a token and specifies the page size. Returns a CompletableFuture with a KeysPage instance.

```Java
java.util.concurrent.CompletableFuture<BackupProvider.KeysPage> listKeysNonRecursive(java.lang.String prefix,
java.lang.String paginationKey,
int pageSize)
```

--------------------------------

### Start Microbatch Processing from Offset Ago

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/module/MicrobatchSourceOptions

Configures the microbatch topology to start processing from a point in the past, specified by an amount and a time unit. This setting is only effective the first time the topology encounters the depot.

```Java
static MicrobatchSourceOptions.Impl startFromOffsetAgo(long amt, OffsetAgo unit)
Start processing each depot partition from a point in the past. Only takes effect the first time the topology encounters this depot.

Parameters:
    amt - How far back to start in terms of specified unit     unit - Cardinality or time-based unit
```

--------------------------------

### Select from Local PState Partition

Source: https://redplanetlabs.com/javadoc/index-all

Navigates into the PState partition on the current task using a given Path and optional SelectOptions.

```Java
com.rpl.rama.Block.Impl.localSelect(String, Path)
com.rpl.rama.Block.Impl.localSelect(String, Path, SelectOptions)
com.rpl.rama.Block.localSelect(String, Path)
com.rpl.rama.Block.localSelect(String, Path, SelectOptions)
com.rpl.rama.Case.Impl.localSelect(String, Path)
com.rpl.rama.Case.Impl.localSelect(String, Path, SelectOptions)
com.rpl.rama.SubSource.Impl.localSelect(String, Path)
com.rpl.rama.SubSource.Impl.localSelect(String, Path, SelectOptions)
```

--------------------------------

### Rama Path: Navigate Sorted Set Range From Start

Source: https://redplanetlabs.com/javadoc/index-all

Navigates a sorted set to retrieve a sub-set containing elements from the start up to a specified maximum amount. This functionality is available for both interface implementations and static calls.

```Java
com.rpl.rama.Path.Impl.sortedSetRangeFromStart(Object)
```

```Java
com.rpl.rama.Path.sortedSetRangeFromStart(Object)
```

--------------------------------

### Microbatch Source Options Configuration (Java)

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/module/package-summary

Defines source options for microbatch topologies using a builder pattern. This class facilitates the configuration of data sources for microbatch processing.

```Java
public interface MicrobatchSourceOptions {
    // Interface for microbatch source options
}

public class MicrobatchSourceOptions.Impl {
    // Implementation details for microbatch source options
}
```

--------------------------------

### Get Value by Key from Collection in Rama

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/ops/Ops

The GET function retrieves a value from a collection (map or list) using a key. For lists, the key is an index. It emits null for non-existent keys. Null collections are treated as empty.

```Java
public static final com.rpl.rama.impl.NativeRamaFunction2<java.lang.Object, java.lang.Object, java.lang.Object> GET
```

--------------------------------

### Local State Management - Select

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Block

Navigates into a PState partition on the current task using a given Path. Overloaded versions allow for specifying select options.

```Java
static Block.OutImpl localSelect(java.lang.String pstateVar, Path path)
```

```Java
static Block.OutImpl localSelect(java.lang.String pstateVar, Path path, SelectOptions options)
```

--------------------------------

### Select Data with Navigator

Source: https://redplanetlabs.com/javadoc/index-all

Method to implement codepath for select calls using a Navigator.

```Java
select(T, Navigator.Next) - Method in interface com.rpl.rama.Navigator
```

--------------------------------

### Navigate Sorted Map From Key with Options (Java)

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

Navigates a sorted map starting from a specified key, with options to limit the number of elements or control the inclusivity of the start key. Useful for subindexed maps.

```Java
Path.Impl.sortedMapRangeFrom(java.lang.Object argKeyStart, java.lang.Object argAmtOrOptions)
```

--------------------------------

### Rama Cluster Management: open

Source: https://redplanetlabs.com/javadoc/index-all

Creates a RamaCluster instance. The `open()` method can use configuration from `rama.yaml` on the classpath or accept a provided configuration map.

```Java
RamaCluster open()
// Static method in interface com.rpl.rama.RamaClusterManager

RamaCluster open(Map<String, Object> configuration)
// Static method in interface com.rpl.rama.RamaClusterManager
```

--------------------------------

### Navigate Sorted Map From Key with Options

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

Navigates a sorted map starting from a specified key, with options to limit the number of elements or control the inclusivity of the start key. This offers fine-grained control over the retrieval process.

```Java
Path.Impl sortedMapRangeFrom(java.lang.Object argKeyStart, java.lang.Object argAmtOrOptions)
```

--------------------------------

### Set Launch Depot Dynamic Option - Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Sets a dynamic option for a depot that will be used during module launch. This can be overridden at deploy time.

```Java
void setLaunchDepotDynamicOption(java.lang.String depot, java.lang.String opt, java.lang.Object value)
```

--------------------------------

### Rama Path: Navigate Sorted Set Range From Element

Source: https://redplanetlabs.com/javadoc/index-all

Navigates a sorted set to retrieve a sub-set containing elements starting from a specified element. Options are available to limit the number of elements read and control the inclusivity or exclusivity of the start element.

```Java
com.rpl.rama.Path.Impl.sortedSetRangeFrom(Object)
```

```Java
com.rpl.rama.Path.sortedSetRangeFrom(Object)
```

```Java
com.rpl.rama.Path.Impl.sortedSetRangeFrom(Object, Object)
```

```Java
com.rpl.rama.Path.sortedSetRangeFrom(Object, Object)
```

--------------------------------

### Navigate Sorted Set Range From Start with Max Amount - Path.Impl

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

Navigates a sorted set to retrieve a specified maximum number of elements starting from the beginning. Useful for subindexed sets. Produces KeyDiff or KeyRemoveDiff for proxy transforms.

```Java
Path.Impl sortedSetRangeFromStart(java.lang.Object argMaxAmt)
```

--------------------------------

### BackupProviderTester Constructor

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/backup/BackupProviderTester

Initializes a new instance of the BackupProviderTester class. This is the default constructor.

```Java
public BackupProviderTester()
```

--------------------------------

### Set Topology Launch Dynamic Option

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Sets the value of a topology dynamic option for module launch. This option is used unless an explicit override is provided at deploy time.

```Java
void setLaunchTopologyDynamicOption(java.lang.String topology, java.lang.String opt, java.lang.Object value)
```

--------------------------------

### Set Launch Module Dynamic Option - Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Sets a dynamic option for the module itself, to be used during launch. This option can be overridden during deployment.

```Java
void setLaunchModuleDynamicOption(java.lang.String opt, java.lang.Object value)
```

--------------------------------

### SequenceIndexRemoveDiff getIndex Method

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/diffs/SequenceIndexRemoveDiff

Returns the starting index where elements were removed from the sequence.

```Java
public int getIndex()
```

--------------------------------

### Get Proxy State Status (Rama ProxyState)

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the current status of a ProxyState.

```Java
ProxyState status()
```

--------------------------------

### List Backup Keys

Source: https://redplanetlabs.com/javadoc/index-all

Lists backup keys with a given prefix, with options for recursive listing.

```Java
com.rpl.rama.backup.BackupProvider.listKeysNonRecursive(String, String, int)
com.rpl.rama.backup.BackupProvider.listKeysRecursive(String, String)
```

--------------------------------

### Get Value - Constant

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the value of a constant. This method is part of the Constant class.

```Java
Object getValue()
    - Method in class com.rpl.rama.Constant
```

--------------------------------

### Get Outputs - SubBatch

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the outputs of a sub-batch. This method is part of the SubBatch class.

```Java
getOutputs()
    - Method in class com.rpl.rama.SubBatch
```

--------------------------------

### Query PState with Path and Partitioning Key

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/PState

Queries a PState using a specified partitioning key and a Path. Returns a List of results. Supports explicit partitioning for targeted queries.

```Java
<T> java.util.List<T> select(java.lang.Object partitioningKey, Path path)
```

--------------------------------

### Get SubBatch Block (Java)

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/SubBatch

Retrieves the Block associated with this SubBatch instance.

```Java
public Block getBlock()
```

--------------------------------

### List Keys Recursively in Backup Provider

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/backup/BackupProvider

Asynchronously lists all keys with a given prefix, including those in sub-directories. Supports pagination via a token. Returns a CompletableFuture with a KeysPage instance.

```Java
java.util.concurrent.CompletableFuture<BackupProvider.KeysPage> listKeysRecursive(java.lang.String prefix,
java.lang.String paginationKey)
```

--------------------------------

### Get Value - NewValueDiff

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the new value of an object. This method is part of the NewValueDiff class.

```Java
Object getVal()
    - Method in class com.rpl.rama.diffs.NewValueDiff
```

--------------------------------

### Declare Tick Depot - Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Defines a depot that emits data at a specified frequency in milliseconds. This is suitable for time-based events and cannot be appended to by clients.

```Java
void declareTickDepot(java.lang.String var, long frequencyMillis)
```

--------------------------------

### Get Operation - Expr

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the operation associated with an expression. This method is part of the Expr class.

```Java
getOp()
    - Method in class com.rpl.rama.Expr
```

--------------------------------

### Rama: Case Implementations

Source: https://redplanetlabs.com/javadoc/index-all

Provides different implementations for the `Case` interface, including general, multi-output, and output-specific cases.

```Java
Case.Impl - Interface in com.rpl.rama
     
```

```Java
Case.MultiOutImpl - Interface in com.rpl.rama
     
```

```Java
Case.Out - Interface in com.rpl.rama
     
```

```Java
Case.OutImpl - Interface in com.rpl.rama
     
```

--------------------------------

### Get Value Diff - KeyDiff

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the difference in value for a key. This method is part of the KeyDiff class.

```Java
Object getValDiff()
    - Method in class com.rpl.rama.diffs.KeyDiff
```

--------------------------------

### Local Select on PState Partition with Options

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/SubSource

Navigates into the PState partition on the current task using a given Path and options. It emits once for every navigated value. Use `out` to capture emits for subsequent dataflow code.

```Java
SubSource.OutImpl localSelect(java.lang.String pstateVar, Path path, SelectOptions options)
```

--------------------------------

### Get To Key - KeyChangeDiff

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the new value of a key after a change. This method is part of the KeyChangeDiff class.

```Java
Object getToKey()
    - Method in class com.rpl.rama.diffs.KeyChangeDiff
```

--------------------------------

### Java Method: create() - SelectOptions

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/SelectOptions

Provides a static method to create an empty SelectOptions.Impl instance. This is a factory method for generating default select options.

```Java
static SelectOptions.Impl create()
```

--------------------------------

### Set Module Launch Dynamic Option

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Sets the value of a module dynamic option to be used on module launch. This option will be applied unless an explicit override is provided at deploy time.

```Java
void setLaunchModuleDynamicOption(java.lang.String opt, java.lang.Object value)
```

--------------------------------

### Get Port - ModuleInstanceInfo

Source: https://redplanetlabs.com/javadoc/index-all

Returns the port of the worker from which ModuleInstanceInfo was fetched. This method is part of the ModuleInstanceInfo class.

```Java
int getPort()
    - Method in class com.rpl.rama.ModuleInstanceInfo
```

--------------------------------

### Get Object Name - PartitionedObjectInfo

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the name of a partitioned object. This method is part of the PartitionedObjectInfo class.

```Java
String getName()
    - Method in class com.rpl.rama.object.PartitionedObjectInfo
```

--------------------------------

### All Partitioning in Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/SubSource

Executes subsequent code on all tasks within a module or all partitions of a given depot or PState.

```Java
SubSource.Impl allPartition()
```

```Java
SubSource.Impl allPartition(java.lang.String pobjectVar)
```

--------------------------------

### Set PState Launch Dynamic Option

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Sets the value of a PState dynamic option for module launch. This option is used unless overridden during deployment.

```Java
void setLaunchPStateDynamicOption(java.lang.String pstate, java.lang.String opt, java.lang.Object value)
```

--------------------------------

### Get Current Task ID in Rama

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/ops/Ops

The CURRENT_TASK_ID function emits the ID of the task where an event is currently running.

```Java
public static final com.rpl.rama.impl.NativeRamaFunction0<java.lang.Integer> CURRENT_TASK_ID
```

--------------------------------

### Get Class of Argument in Rama

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/ops/Ops

The CLASS function emits the Class of its argument. If the argument is null, it emits null.

```Java
public static final com.rpl.rama.impl.NativeRamaFunction1<java.lang.Object, java.lang.Class> CLASS
```

--------------------------------

### Query PState with Path (Java)

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/PState

Queries the PState using a given Path. If the PState has multiple partitions, the Path must start with a 'key' navigator to extract the partitioning key. This operation is blocking and performed on a stable view of the PState.

```Java
<T> java.util.List<T> select(Path path)
```

```Java
<T> java.util.List<T> select(java.lang.Object partitioningKey,
                             Path path)
```

--------------------------------

### Select Data with Path and Options

Source: https://redplanetlabs.com/javadoc/index-all

Methods for changing task for a given PState containing data for a specified Path and then performing a localSelect, with support for SelectOptions.

```Java
select(Object, Path, SelectOptions) - Method in interface com.rpl.rama.Block.Impl
select(Object, Path, SelectOptions) - Static method in interface com.rpl.rama.Block
select(Object, Path, SelectOptions) - Method in interface com.rpl.rama.Case.Impl
select(Object, Path, SelectOptions) - Method in interface com.rpl.rama.SubSource.Impl
```

--------------------------------

### SequenceIndexRemoveDiff Constructor

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/diffs/SequenceIndexRemoveDiff

Constructs a SequenceIndexRemoveDiff object. It takes the starting index of the removal, the number of elements removed, and the size of the sequence before the removal.

```Java
public SequenceIndexRemoveDiff(int index,
                               int amt,
                               int oldSize)
```

--------------------------------

### Get Throwable - UngracefulTerminationDiff

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the last exception that led to an ungraceful termination. This method is part of the UngracefulTerminationDiff class.

```Java
Throwable getThrowable()
    - Method in class com.rpl.rama.diffs.UngracefulTerminationDiff
```

--------------------------------

### Set Depot Launch Dynamic Option

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Sets the value of a depot dynamic option for module launch. This option is applied unless an explicit override is provided at deploy time.

```Java
void setLaunchDepotDynamicOption(java.lang.String depot, java.lang.String opt, java.lang.Object value)
```

--------------------------------

### Get Supervisor ID - ModuleInstanceInfo

Source: https://redplanetlabs.com/javadoc/index-all

Returns the supervisor ID where ModuleInstanceInfo was fetched. This method is part of the ModuleInstanceInfo class.

```Java
String getSupervisorId()
    - Method in class com.rpl.rama.ModuleInstanceInfo
```

--------------------------------

### Get Replication Factor - ModuleInstanceInfo

Source: https://redplanetlabs.com/javadoc/index-all

Returns the replication factor of a module instance. This method is part of the ModuleInstanceInfo class.

```Java
int getReplicationFactor()
    - Method in class com.rpl.rama.ModuleInstanceInfo
```

--------------------------------

### Declare Global Object - Java

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/RamaModule

Defines a global object to be copied to all tasks within the module. This is useful for sharing configuration or common data.

```Java
void declareObject(java.lang.String var, java.lang.Object obj)
```

--------------------------------

### Select First Element with first

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/Path

The first() method navigates to the first element of a list if it's not empty. If the list is empty, navigation stops. This is a value navigator.

```Java
Path.Impl first()

```

--------------------------------

### Get Old Size - SequenceInsertDiff

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the size of a sequence before an insert operation. This method is part of the SequenceInsertDiff class.

```Java
int getOldSize()
    - Method in class com.rpl.rama.diffs.SequenceInsertDiff
```

--------------------------------

### Get Old Size - SequenceChangeDiff

Source: https://redplanetlabs.com/javadoc/index-all

Retrieves the size of a sequence before a change occurred. This method is part of the SequenceChangeDiff class.

```Java
int getOldSize()
    - Method in class com.rpl.rama.diffs.SequenceChangeDiff
```

--------------------------------

### Stream Source Options Configuration (Java)

Source: https://redplanetlabs.com/javadoc/com/rpl/rama/module/package-summary

Defines source options for stream topologies using a builder pattern. This class is used to configure data sources for real-time stream processing.

```Java
public interface StreamSourceOptions {
    // Interface for stream source options
}

public class StreamSourceOptions.Impl {
    // Implementation details for stream source options
}
```

--------------------------------

### Get Number of Workers - LaunchConfig

Source: https://redplanetlabs.com/javadoc/index-all

Represents the number of workers in a launch configuration. This method is part of the LaunchConfig class.

```Java
getNumWorkers()
    - Method in class com.rpl.rama.test.LaunchConfig
```

--------------------------------

### Java Path Building with Path.Impl

Source: https://redplanetlabs.com/javadoc/index-all

Demonstrates how to build paths using the Path.Impl interface in Java. These methods allow for concatenating path segments based on functions with varying numbers of arguments.

```Java
pathBuilder(RamaFunction0<Path>) 
pathBuilder(RamaFunction1<T0, Path>, Object) 
pathBuilder(RamaFunction2<T0, T1, Path>, Object, Object) 
pathBuilder(RamaFunction3<T0, T1, T2, Path>, Object, Object, Object) 
pathBuilder(RamaFunction4<T0, T1, T2, T3, Path>, Object, Object, Object, Object) 
pathBuilder(RamaFunction5<T0, T1, T2, T3, T4, Path>, Object, Object, Object, Object, Object) 
pathBuilder(RamaFunction6<T0, T1, T2, T3, T4, T5, Path>, Object, Object, Object, Object, Object, Object) 
pathBuilder(RamaFunction7<T0, T1, T2, T3, T4, T5, T6, Path>, Object, Object, Object, Object, Object, Object, Object) 
pathBuilder(RamaFunction8<T0, T1, T2, T3, T4, T5, T6, T7, Path>, Object, Object, Object, Object, Object, Object, Object, Object)
```

--------------------------------

### Get Number of Threads - LaunchConfig

Source: https://redplanetlabs.com/javadoc/index-all

Represents the number of threads in a launch configuration. This method is part of the LaunchConfig class.

```Java
getNumThreads()
    - Method in class com.rpl.rama.test.LaunchConfig
```

--------------------------------

### Get Number of Tasks - LaunchConfig

Source: https://redplanetlabs.com/javadoc/index-all

Represents the number of tasks in a launch configuration. This method is part of the LaunchConfig class.

```Java
getNumTasks()
    - Method in class com.rpl.rama.test.LaunchConfig
```
Tokens:
Raw