IndicesCreateDataStreamRequest.ts

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import { RequestBase } from '@_types/Base'
import { DataStreamName } from '@_types/common'

/**
 * Creates a data stream.
 * You must have a matching index template with data stream enabled.
 * @rest_spec_name indices.create_data_stream
 * @availability stack since=7.9.0 stability=stable
 * @availability serverless stability=stable visibility=public
 * @index_privileges create_index
 */
export interface Request extends RequestBase {
  path_parts: {
    /**
     * Name of the data stream, which must meet the following criteria:
     * Lowercase only;
     * Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character;
     * Cannot start with `-`, `_`, `+`, or `.ds-`;
     * Cannot be `.` or `..`;
     * Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.
     */
    name: DataStreamName
  }
}