API Stability Long-Term

The setTagGroupings() GraphQL mutation is used to set current tag groupings for a repository.

Syntax

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

graphql
setTagGroupings(
      repositoryName: string!, 
      tagGroupings: [TagGroupingRuleInput!]!
   ): [TagGroupingRule!]!

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

Show:
graphql
mutation {
  setTagGroupings( 
    repositoryName: "humio",
  tagGroupings: [ { tagName: "stuff", groupCount: 3 } ]
  ) 
  { groupCount }
}
Example Responses
Show:
json
{
  "data": {
    "setTagGroupings": [
      {
        "groupCount": 3
      }
    ]
  }
}

Given Datatypes

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

Table: TagGroupingRuleInput

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 20, 2024
groupCountintegeryes  The number of groups the tag will be split into.
tagNamestringyes  The tag name to which the rule will apply.

Returned Datatypes

The returned datatype TagGroupingRule has a couple of parameters. Below is a list of them along with a description of each:

Table: TagGroupingRule

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: Oct 3, 2024
tagNamestringyes Short-TermThe name of the given tag into which values will be distributed.
groupCountintegeryes Short-TermThe number of groups that tag values are distributed.