API Stability Preview

The setOffsetForDatasourcesOnPartition() GraphQL mutation is used to set the starting read offset for the given ingest partition.

Syntax

Below is the syntax for the setOffsetForDatasourcesOnPartition() mutation field:

graphql
setOffsetForDatasourcesOnPartition(
      input: SetOffsetForDatasourcesOnPartitionInput!
   ): boolean!

Below is an example of how this mutation field might be used:

Show:
graphql
mutation {
  setOffsetForDatasourcesOnPartition( input:
    {
     partition: 4
     offset: 10
    }
  )
}
Example Responses
Show:
json
{
  "data": {
    "setOffsetForDatasourcesOnPartition": true
  }
}

Given Datatypes

SetOffsetForDatasourcesOnPartitionInput has two parameters. Below is a list of them along with a description of each:

Table: SetOffsetForDatasourcesOnPartitionInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 19, 2024
offsetlongyes  The starting offset for the ingest partition.
partitionintegeryes  The ingest partition for which to set the offset.