API создания или обновления шаблона компонента

Вы можете использовать комментарии в блочном стиле /* */ языка C в шаблонах компонентов. Вы можете включать комментарии в любом месте тела запроса, кроме места перед открывающей фигурной скобкой.

Вы можете включать псевдонимы индексов в шаблон компонента.

resp = client.cluster.put_component_template(
    name="template_1",
    template={
        "settings": {
            "number_of_shards": 1
        },
        "aliases": {
            "alias1": {},
            "alias2": {
                "filter": {
                    "term": {
                        "user.id": "kimchy"
                    }
                },
                "routing": "shard-1"
            },
            "{index}-alias": {}
        }
    },
)
print(resp)

response = client.cluster.put_component_template(
  name: 'template_1',
  body: {
    template: {
      settings: {
        number_of_shards: 1
      },
      aliases: {
        "alias1": {},
        "alias2": {
          filter: {
            term: {
              'user.id' => 'kimchy'
            }
          },
          routing: 'shard-1'
        },
        "{index}-alias": {}
      }
    }
  }
)
puts response

const response = await client.cluster.putComponentTemplate({
  name: "template_1",
  template: {
    settings: {
      number_of_shards: 1,
    },
    aliases: {
      alias1: {},
      alias2: {
        filter: {
          term: {
            "user.id": "kimchy",
          },
        },
        routing: "shard-1",
      },
      "{index}-alias": {},
    },
  },
});
console.log(response);

PUT _component_template/template_1
{
  "template": {
    "settings" : {
        "number_of_shards" : 1
    },
    "aliases" : {
        "alias1" : {},
        "alias2" : {
            "filter" : {
                "term" : {"user.id" : "kimchy" }
            },
            "routing" : "shard-1"
        },
        "{index}-alias" : {} 
    }
  }
}

Вы не можете напрямую применить шаблон компонента к потоку данных или индексу. Для применения шаблон компонента должен быть включён в список composed_of шаблона индекса. См. Шаблоны индексов.

Вы можете использовать параметр version, чтобы добавить номер версии к шаблону компонента. Внешние системы могут использовать эти номера версий для упрощения управления шаблонами.

Параметр version необязателен и не генерируется и не используется Elasticsearch автоматически.

Чтобы сбросить version, замените шаблон, не указывая его.

resp = client.cluster.put_component_template(
    name="template_1",
    template={
        "settings": {
            "number_of_shards": 1
        }
    },
    version=123,
)
print(resp)

response = client.cluster.put_component_template(
  name: 'template_1',
  body: {
    template: {
      settings: {
        number_of_shards: 1
      }
    },
    version: 123
  }
)
puts response

const response = await client.cluster.putComponentTemplate({
  name: "template_1",
  template: {
    settings: {
      number_of_shards: 1,
    },
  },
  version: 123,
});
console.log(response);

PUT /_component_template/template_1
{
  "template": {
    "settings" : {
        "number_of_shards" : 1
    }
  },
  "version": 123
}

Чтобы проверить version, вы можете использовать API получения шаблона компонента.

Вы можете использовать параметр _meta, чтобы добавить произвольные метаданные к шаблону компонента. Этот пользовательский объект хранится в состоянии кластера, поэтому предпочтительно, чтобы он был коротким.

Параметр _meta необязателен и не генерируется и не используется Elasticsearch автоматически.

Чтобы сбросить _meta, замените шаблон, не указывая его.

resp = client.cluster.put_component_template(
    name="template_1",
    template={
        "settings": {
            "number_of_shards": 1
        }
    },
    meta={
        "description": "set number of shards to one",
        "serialization": {
            "class": "MyComponentTemplate",
            "id": 10
        }
    },
)
print(resp)

response = client.cluster.put_component_template(
  name: 'template_1',
  body: {
    template: {
      settings: {
        number_of_shards: 1
      }
    },
    _meta: {
      description: 'set number of shards to one',
      serialization: {
        class: 'MyComponentTemplate',
        id: 10
      }
    }
  }
)
puts response

const response = await client.cluster.putComponentTemplate({
  name: "template_1",
  template: {
    settings: {
      number_of_shards: 1,
    },
  },
  _meta: {
    description: "set number of shards to one",
    serialization: {
      class: "MyComponentTemplate",
      id: 10,
    },
  },
});
console.log(response);

PUT /_component_template/template_1
{
  "template": {
    "settings" : {
        "number_of_shards" : 1
    }
  },
  "_meta": {
    "description": "set number of shards to one",
    "serialization": {
      "class": "MyComponentTemplate",
      "id": 10
    }
  }
}

Чтобы проверить _meta, вы можете использовать API получения шаблона компонента.