SinkContext (Pulsar IO :: IO 2.4.1 API)

```
public interface SinkContext
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getCounter(String key)` Retrieve the counter value for the key.
`CompletableFuture<Long>`	`getCounterAsync(String key)` Retrieve the counter value for the key, but don't wait for the operation to be completed
`Collection<String>`	`getInputTopics()` Get a list of all input topics
`int`	`getInstanceId()` The id of the instance that invokes this sink.
`org.slf4j.Logger`	`getLogger()` The logger object that can be used to log in a sink
`String`	`getNamespace()` The namespace this sink belongs to
`int`	`getNumInstances()` Get the number of instances that invoke this sink.
`String`	`getSecret(String secretName)` Get the secret associated with this key
`String`	`getSinkName()` The name of the sink that we are executing
`ByteBuffer`	`getState(String key)` Retrieve the state value for the key.
`CompletableFuture<ByteBuffer>`	`getStateAsync(String key)` Retrieve the state value for the key, but don't wait for the operation to be completed
`String`	`getTenant()` The tenant this sink belongs to
`void`	`incrCounter(String key, long amount)` Increment the builtin distributed counter referred by key.
`CompletableFuture<Void>`	`incrCounterAsync(String key, long amount)` Increment the builtin distributed counter referred by key but dont wait for the completion of the increment operation
`void`	`putState(String key, ByteBuffer value)` Update the state value for the key.
`CompletableFuture<Void>`	`putStateAsync(String key, ByteBuffer value)` Update the state value for the key, but don't wait for the operation to be completed
`void`	`recordMetric(String metricName, double value)` Record a user defined metric

- Method Detail
  - getInstanceId
```
int getInstanceId()
```
    The id of the instance that invokes this sink.
    
    Returns:
    
    the instance id
  - getNumInstances
```
int getNumInstances()
```
    Get the number of instances that invoke this sink.
    
    Returns:
    
    the number of instances that invoke this sink.
  - recordMetric
```
void recordMetric(String metricName,
                  double value)
```
    Record a user defined metric
    
    Parameters:
    
    metricName - The name of the metric
    
    value - The value of the metric
  - getInputTopics
```
Collection<String> getInputTopics()
```
    Get a list of all input topics
    
    Returns:
    
    a list of all input topics
  - getTenant
```
String getTenant()
```
    The tenant this sink belongs to
    
    Returns:
    
    the tenant this sink belongs to
  - getNamespace
```
String getNamespace()
```
    The namespace this sink belongs to
    
    Returns:
    
    the namespace this sink belongs to
  - getSinkName
```
String getSinkName()
```
    The name of the sink that we are executing
    
    Returns:
    
    The Sink name
  - getLogger
```
org.slf4j.Logger getLogger()
```
    The logger object that can be used to log in a sink
    
    Returns:
    
    the logger object
  - getSecret
```
String getSecret(String secretName)
```
    Get the secret associated with this key
    
    Parameters:
    
    secretName - The name of the secret
    
    Returns:
    
    The secret if anything was found or null
  - incrCounter
```
void incrCounter(String key,
                 long amount)
```
    Increment the builtin distributed counter referred by key.
    
    Parameters:
    
    key - The name of the key
    
    amount - The amount to be incremented
  - incrCounterAsync
```
CompletableFuture<Void> incrCounterAsync(String key,
                                         long amount)
```
    Increment the builtin distributed counter referred by key but dont wait for the completion of the increment operation
    
    Parameters:
    
    key - The name of the key
    
    amount - The amount to be incremented
  - getCounter
```
long getCounter(String key)
```
    Retrieve the counter value for the key.
    
    Parameters:
    
    key - name of the key
    
    Returns:
    
    the amount of the counter value for this key
  - getCounterAsync
```
CompletableFuture<Long> getCounterAsync(String key)
```
    Retrieve the counter value for the key, but don't wait for the operation to be completed
    
    Parameters:
    
    key - name of the key
    
    Returns:
    
    the amount of the counter value for this key
  - putState
```
void putState(String key,
              ByteBuffer value)
```
    Update the state value for the key.
    
    Parameters:
    
    key - name of the key
    
    value - state value of the key
  - putStateAsync
```
CompletableFuture<Void> putStateAsync(String key,
                                      ByteBuffer value)
```
    Update the state value for the key, but don't wait for the operation to be completed
    
    Parameters:
    
    key - name of the key
    
    value - state value of the key
  - getState
```
ByteBuffer getState(String key)
```
    Retrieve the state value for the key.
    
    Parameters:
    
    key - name of the key
    
    Returns:
    
    the state value for the key.
  - getStateAsync
```
CompletableFuture<ByteBuffer> getStateAsync(String key)
```
    Retrieve the state value for the key, but don't wait for the operation to be completed
    
    Parameters:
    
    key - name of the key
    
    Returns:
    
    the state value for the key.

Interface SinkContext

Method Summary

Method Detail

getInstanceId

getNumInstances

recordMetric

getInputTopics

getTenant

getNamespace

getSinkName

getLogger

getSecret

incrCounter

incrCounterAsync

getCounter

getCounterAsync

putState

putStateAsync

getState

getStateAsync