API Stability Short-Term

The updateIngestPartitionScheme() GraphQL mutation field is used to set the ingest partition scheme of a LogScale cluster. It requires ManageCluster permission. The ingest partition scheme is normally automated; Changes will be overwritten by the automation. This mutation field shouldn't be used generally, unless automation is temporarily disabled.

Syntax

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

graphql
updateIngestPartitionScheme(
      partitions: [IngestPartitionInput!]!
   ): BooleanResultType!

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

Show:
graphql
mutation {
  updateIngestPartitionScheme( 
       partitions: { id: 1, nodeIds: [ 1, 2 ] }
  )
  { result }
}

Given Datatypes

For IngestPartitionInput, there are a couple of parameters. Below is a list of them along with a description of each:

Table: IngestPartitionInput

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 18, 2024
idintegeryes Short-TermThe unique identifier of the ingest partition.
nodeIds[integer]yes Short-TermThe unique identifiers of the node.

Returned Datatypes

The returned datatype BooleanResultType one parameter. It's described below:

Table: BooleanResultType

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 24, 2024
resultsbooleanyes Long-TermWhether the mutation was performed.