src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/PutTransformRequest.g.cs (584 lines of code) (raw):

// Licensed to Elasticsearch B.V under one or more agreements. // Elasticsearch B.V licenses this file to you under the Apache 2.0 License. // See the LICENSE file in the project root for more information. // // ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗ // ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝ // ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗ // ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝ // ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗ // ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝ // ------------------------------------------------ // // This file is automatically generated. // Please do not edit these files manually. // // ------------------------------------------------ #nullable restore using System; using System.Linq; using Elastic.Clients.Elasticsearch.Serialization; namespace Elastic.Clients.Elasticsearch.TransformManagement; public sealed partial class PutTransformRequestParameters : Elastic.Transport.RequestParameters { /// <summary> /// <para> /// When the transform is created, a series of validations occur to ensure its success. For example, there is a /// check for the existence of the source indices and a check that the destination index is not part of the source /// index pattern. You can use this parameter to skip the checks, for example when the source index does not exist /// until after the transform is created. The validations are always run when you start the transform, however, with /// the exception of privilege checks. /// </para> /// </summary> public bool? DeferValidation { get => Q<bool?>("defer_validation"); set => Q("defer_validation", value); } /// <summary> /// <para> /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("timeout"); set => Q("timeout", value); } } internal sealed partial class PutTransformRequestConverter : System.Text.Json.Serialization.JsonConverter<Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest> { private static readonly System.Text.Json.JsonEncodedText PropDescription = System.Text.Json.JsonEncodedText.Encode("description"); private static readonly System.Text.Json.JsonEncodedText PropDest = System.Text.Json.JsonEncodedText.Encode("dest"); private static readonly System.Text.Json.JsonEncodedText PropFrequency = System.Text.Json.JsonEncodedText.Encode("frequency"); private static readonly System.Text.Json.JsonEncodedText PropLatest = System.Text.Json.JsonEncodedText.Encode("latest"); private static readonly System.Text.Json.JsonEncodedText PropMeta = System.Text.Json.JsonEncodedText.Encode("_meta"); private static readonly System.Text.Json.JsonEncodedText PropPivot = System.Text.Json.JsonEncodedText.Encode("pivot"); private static readonly System.Text.Json.JsonEncodedText PropRetentionPolicy = System.Text.Json.JsonEncodedText.Encode("retention_policy"); private static readonly System.Text.Json.JsonEncodedText PropSettings = System.Text.Json.JsonEncodedText.Encode("settings"); private static readonly System.Text.Json.JsonEncodedText PropSource = System.Text.Json.JsonEncodedText.Encode("source"); private static readonly System.Text.Json.JsonEncodedText PropSync = System.Text.Json.JsonEncodedText.Encode("sync"); public override Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) { reader.ValidateToken(System.Text.Json.JsonTokenType.StartObject); LocalJsonValue<string?> propDescription = default; LocalJsonValue<Elastic.Clients.Elasticsearch.TransformManagement.Destination> propDest = default; LocalJsonValue<Elastic.Clients.Elasticsearch.Duration?> propFrequency = default; LocalJsonValue<Elastic.Clients.Elasticsearch.TransformManagement.Latest?> propLatest = default; LocalJsonValue<System.Collections.Generic.IDictionary<string, object>?> propMeta = default; LocalJsonValue<Elastic.Clients.Elasticsearch.TransformManagement.Pivot?> propPivot = default; LocalJsonValue<Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy?> propRetentionPolicy = default; LocalJsonValue<Elastic.Clients.Elasticsearch.TransformManagement.Settings?> propSettings = default; LocalJsonValue<Elastic.Clients.Elasticsearch.TransformManagement.Source> propSource = default; LocalJsonValue<Elastic.Clients.Elasticsearch.TransformManagement.Sync?> propSync = default; while (reader.Read() && reader.TokenType is System.Text.Json.JsonTokenType.PropertyName) { if (propDescription.TryReadProperty(ref reader, options, PropDescription, null)) { continue; } if (propDest.TryReadProperty(ref reader, options, PropDest, null)) { continue; } if (propFrequency.TryReadProperty(ref reader, options, PropFrequency, null)) { continue; } if (propLatest.TryReadProperty(ref reader, options, PropLatest, null)) { continue; } if (propMeta.TryReadProperty(ref reader, options, PropMeta, static System.Collections.Generic.IDictionary<string, object>? (ref System.Text.Json.Utf8JsonReader r, System.Text.Json.JsonSerializerOptions o) => r.ReadDictionaryValue<string, object>(o, null, null))) { continue; } if (propPivot.TryReadProperty(ref reader, options, PropPivot, null)) { continue; } if (propRetentionPolicy.TryReadProperty(ref reader, options, PropRetentionPolicy, null)) { continue; } if (propSettings.TryReadProperty(ref reader, options, PropSettings, null)) { continue; } if (propSource.TryReadProperty(ref reader, options, PropSource, null)) { continue; } if (propSync.TryReadProperty(ref reader, options, PropSync, null)) { continue; } if (options.UnmappedMemberHandling is System.Text.Json.Serialization.JsonUnmappedMemberHandling.Skip) { reader.Skip(); continue; } throw new System.Text.Json.JsonException($"Unknown JSON property '{reader.GetString()}' for type '{typeToConvert.Name}'."); } reader.ValidateToken(System.Text.Json.JsonTokenType.EndObject); return new Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest(Elastic.Clients.Elasticsearch.Serialization.JsonConstructorSentinel.Instance) { Description = propDescription.Value, Dest = propDest.Value, Frequency = propFrequency.Value, Latest = propLatest.Value, Meta = propMeta.Value, Pivot = propPivot.Value, RetentionPolicy = propRetentionPolicy.Value, Settings = propSettings.Value, Source = propSource.Value, Sync = propSync.Value }; } public override void Write(System.Text.Json.Utf8JsonWriter writer, Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest value, System.Text.Json.JsonSerializerOptions options) { writer.WriteStartObject(); writer.WriteProperty(options, PropDescription, value.Description, null, null); writer.WriteProperty(options, PropDest, value.Dest, null, null); writer.WriteProperty(options, PropFrequency, value.Frequency, null, null); writer.WriteProperty(options, PropLatest, value.Latest, null, null); writer.WriteProperty(options, PropMeta, value.Meta, null, static (System.Text.Json.Utf8JsonWriter w, System.Text.Json.JsonSerializerOptions o, System.Collections.Generic.IDictionary<string, object>? v) => w.WriteDictionaryValue<string, object>(o, v, null, null)); writer.WriteProperty(options, PropPivot, value.Pivot, null, null); writer.WriteProperty(options, PropRetentionPolicy, value.RetentionPolicy, null, null); writer.WriteProperty(options, PropSettings, value.Settings, null, null); writer.WriteProperty(options, PropSource, value.Source, null, null); writer.WriteProperty(options, PropSync, value.Sync, null, null); writer.WriteEndObject(); } } /// <summary> /// <para> /// Create a transform. /// Creates a transform. /// </para> /// <para> /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a /// unique row per entity. /// </para> /// <para> /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If /// you choose to use the pivot method for your transform, the entities are defined by the set of <c>group_by</c> fields in /// the pivot object. If you choose to use the latest method, the entities are defined by the <c>unique_key</c> field values /// in the latest object. /// </para> /// <para> /// You must have <c>create_index</c>, <c>index</c>, and <c>read</c> privileges on the destination index and <c>read</c> and /// <c>view_index_metadata</c> privileges on the source indices. When Elasticsearch security features are enabled, the /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If /// those roles do not have the required privileges on the source and destination indices, the transform fails when it /// attempts unauthorized operations. /// </para> /// <para> /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any /// <c>.transform-internal*</c> indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do /// not give users any privileges on <c>.transform-internal*</c> indices. If you used transforms prior to 7.5, also do not /// give users any privileges on <c>.data-frame-internal*</c> indices. /// </para> /// </summary> [System.Text.Json.Serialization.JsonConverter(typeof(Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestConverter))] public sealed partial class PutTransformRequest : Elastic.Clients.Elasticsearch.Requests.PlainRequest<Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestParameters> { [System.Obsolete("The request contains additional required properties that must be initialized. Please use an alternative constructor to ensure all required values are properly set.")] [System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public PutTransformRequest(Elastic.Clients.Elasticsearch.Id transformId) : base(r => r.Required("transform_id", transformId)) { } [System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public PutTransformRequest(Elastic.Clients.Elasticsearch.Id transformId, Elastic.Clients.Elasticsearch.TransformManagement.Destination dest, Elastic.Clients.Elasticsearch.TransformManagement.Source source) : base(r => r.Required("transform_id", transformId)) { Dest = dest; Source = source; } #if NET7_0_OR_GREATER public PutTransformRequest() { } #endif [System.Diagnostics.CodeAnalysis.SetsRequiredMembers] internal PutTransformRequest(Elastic.Clients.Elasticsearch.Serialization.JsonConstructorSentinel sentinel) { _ = sentinel; } internal override Elastic.Clients.Elasticsearch.Requests.ApiUrls ApiUrls => Elastic.Clients.Elasticsearch.Requests.ApiUrlLookup.TransformManagementPutTransform; protected override Elastic.Transport.HttpMethod StaticHttpMethod => Elastic.Transport.HttpMethod.PUT; internal override bool SupportsBody => true; internal override string OperationName => "transform.put_transform"; /// <summary> /// <para> /// Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), /// hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. /// </para> /// </summary> public #if NET7_0_OR_GREATER required #endif Elastic.Clients.Elasticsearch.Id TransformId { get => P<Elastic.Clients.Elasticsearch.Id>("transform_id"); set => PR("transform_id", value); } /// <summary> /// <para> /// When the transform is created, a series of validations occur to ensure its success. For example, there is a /// check for the existence of the source indices and a check that the destination index is not part of the source /// index pattern. You can use this parameter to skip the checks, for example when the source index does not exist /// until after the transform is created. The validations are always run when you start the transform, however, with /// the exception of privilege checks. /// </para> /// </summary> public bool? DeferValidation { get => Q<bool?>("defer_validation"); set => Q("defer_validation", value); } /// <summary> /// <para> /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("timeout"); set => Q("timeout", value); } /// <summary> /// <para> /// Free text description of the transform. /// </para> /// </summary> public string? Description { get; set; } /// <summary> /// <para> /// The destination for the transform. /// </para> /// </summary> public #if NET7_0_OR_GREATER required #endif Elastic.Clients.Elasticsearch.TransformManagement.Destination Dest { get; set; } /// <summary> /// <para> /// The interval between checks for changes in the source indices when the transform is running continuously. Also /// determines the retry interval in the event of transient failures while the transform is searching or indexing. /// The minimum value is <c>1s</c> and the maximum is <c>1h</c>. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.Duration? Frequency { get; set; } /// <summary> /// <para> /// The latest method transforms the data by finding the latest document for each unique key. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.Latest? Latest { get; set; } /// <summary> /// <para> /// Defines optional transform metadata. /// </para> /// </summary> public System.Collections.Generic.IDictionary<string, object>? Meta { get; set; } /// <summary> /// <para> /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields /// and the aggregation to reduce the data. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.Pivot? Pivot { get; set; } /// <summary> /// <para> /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the /// destination index. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? RetentionPolicy { get; set; } /// <summary> /// <para> /// Defines optional transform settings. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.Settings? Settings { get; set; } /// <summary> /// <para> /// The source of the data for the transform. /// </para> /// </summary> public #if NET7_0_OR_GREATER required #endif Elastic.Clients.Elasticsearch.TransformManagement.Source Source { get; set; } /// <summary> /// <para> /// Defines the properties transforms require to run continuously. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.Sync? Sync { get; set; } } /// <summary> /// <para> /// Create a transform. /// Creates a transform. /// </para> /// <para> /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a /// unique row per entity. /// </para> /// <para> /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If /// you choose to use the pivot method for your transform, the entities are defined by the set of <c>group_by</c> fields in /// the pivot object. If you choose to use the latest method, the entities are defined by the <c>unique_key</c> field values /// in the latest object. /// </para> /// <para> /// You must have <c>create_index</c>, <c>index</c>, and <c>read</c> privileges on the destination index and <c>read</c> and /// <c>view_index_metadata</c> privileges on the source indices. When Elasticsearch security features are enabled, the /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If /// those roles do not have the required privileges on the source and destination indices, the transform fails when it /// attempts unauthorized operations. /// </para> /// <para> /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any /// <c>.transform-internal*</c> indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do /// not give users any privileges on <c>.transform-internal*</c> indices. If you used transforms prior to 7.5, also do not /// give users any privileges on <c>.data-frame-internal*</c> indices. /// </para> /// </summary> public readonly partial struct PutTransformRequestDescriptor { internal Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest Instance { get; init; } [System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public PutTransformRequestDescriptor(Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest instance) { Instance = instance; } public PutTransformRequestDescriptor(Elastic.Clients.Elasticsearch.Id transformId) { #pragma warning disable CS0618 Instance = new Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest(transformId); #pragma warning restore CS0618 } [System.Obsolete("The use of the parameterless constructor is not permitted for this type.")] public PutTransformRequestDescriptor() { throw new System.InvalidOperationException("The use of the parameterless constructor is not permitted for this type."); } public static explicit operator Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor(Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest instance) => new Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor(instance); public static implicit operator Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest(Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor descriptor) => descriptor.Instance; /// <summary> /// <para> /// Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), /// hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor TransformId(Elastic.Clients.Elasticsearch.Id value) { Instance.TransformId = value; return this; } /// <summary> /// <para> /// When the transform is created, a series of validations occur to ensure its success. For example, there is a /// check for the existence of the source indices and a check that the destination index is not part of the source /// index pattern. You can use this parameter to skip the checks, for example when the source index does not exist /// until after the transform is created. The validations are always run when you start the transform, however, with /// the exception of privilege checks. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor DeferValidation(bool? value = true) { Instance.DeferValidation = value; return this; } /// <summary> /// <para> /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? value) { Instance.Timeout = value; return this; } /// <summary> /// <para> /// Free text description of the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Description(string? value) { Instance.Description = value; return this; } /// <summary> /// <para> /// The destination for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Dest(Elastic.Clients.Elasticsearch.TransformManagement.Destination value) { Instance.Dest = value; return this; } /// <summary> /// <para> /// The destination for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Dest() { Instance.Dest = Elastic.Clients.Elasticsearch.TransformManagement.DestinationDescriptor.Build(null); return this; } /// <summary> /// <para> /// The destination for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Dest(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.DestinationDescriptor>? action) { Instance.Dest = Elastic.Clients.Elasticsearch.TransformManagement.DestinationDescriptor.Build(action); return this; } /// <summary> /// <para> /// The interval between checks for changes in the source indices when the transform is running continuously. Also /// determines the retry interval in the event of transient failures while the transform is searching or indexing. /// The minimum value is <c>1s</c> and the maximum is <c>1h</c>. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Frequency(Elastic.Clients.Elasticsearch.Duration? value) { Instance.Frequency = value; return this; } /// <summary> /// <para> /// The latest method transforms the data by finding the latest document for each unique key. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Latest(Elastic.Clients.Elasticsearch.TransformManagement.Latest? value) { Instance.Latest = value; return this; } /// <summary> /// <para> /// The latest method transforms the data by finding the latest document for each unique key. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Latest(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.LatestDescriptor> action) { Instance.Latest = Elastic.Clients.Elasticsearch.TransformManagement.LatestDescriptor.Build(action); return this; } /// <summary> /// <para> /// The latest method transforms the data by finding the latest document for each unique key. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Latest<T>(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.LatestDescriptor<T>> action) { Instance.Latest = Elastic.Clients.Elasticsearch.TransformManagement.LatestDescriptor<T>.Build(action); return this; } /// <summary> /// <para> /// Defines optional transform metadata. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Meta(System.Collections.Generic.IDictionary<string, object>? value) { Instance.Meta = value; return this; } /// <summary> /// <para> /// Defines optional transform metadata. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Meta() { Instance.Meta = Elastic.Clients.Elasticsearch.Fluent.FluentDictionaryOfStringObject.Build(null); return this; } /// <summary> /// <para> /// Defines optional transform metadata. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Meta(System.Action<Elastic.Clients.Elasticsearch.Fluent.FluentDictionaryOfStringObject>? action) { Instance.Meta = Elastic.Clients.Elasticsearch.Fluent.FluentDictionaryOfStringObject.Build(action); return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor AddMeta(string key, object value) { Instance.Meta ??= new System.Collections.Generic.Dictionary<string, object>(); Instance.Meta.Add(key, value); return this; } /// <summary> /// <para> /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields /// and the aggregation to reduce the data. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Pivot(Elastic.Clients.Elasticsearch.TransformManagement.Pivot? value) { Instance.Pivot = value; return this; } /// <summary> /// <para> /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields /// and the aggregation to reduce the data. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Pivot() { Instance.Pivot = Elastic.Clients.Elasticsearch.TransformManagement.PivotDescriptor.Build(null); return this; } /// <summary> /// <para> /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields /// and the aggregation to reduce the data. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Pivot(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.PivotDescriptor>? action) { Instance.Pivot = Elastic.Clients.Elasticsearch.TransformManagement.PivotDescriptor.Build(action); return this; } /// <summary> /// <para> /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields /// and the aggregation to reduce the data. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Pivot<T>(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.PivotDescriptor<T>>? action) { Instance.Pivot = Elastic.Clients.Elasticsearch.TransformManagement.PivotDescriptor<T>.Build(action); return this; } /// <summary> /// <para> /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the /// destination index. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor RetentionPolicy(Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? value) { Instance.RetentionPolicy = value; return this; } /// <summary> /// <para> /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the /// destination index. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor RetentionPolicy(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicyDescriptor> action) { Instance.RetentionPolicy = Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicyDescriptor.Build(action); return this; } /// <summary> /// <para> /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the /// destination index. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor RetentionPolicy<T>(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicyDescriptor<T>> action) { Instance.RetentionPolicy = Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicyDescriptor<T>.Build(action); return this; } /// <summary> /// <para> /// Defines optional transform settings. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Settings(Elastic.Clients.Elasticsearch.TransformManagement.Settings? value) { Instance.Settings = value; return this; } /// <summary> /// <para> /// Defines optional transform settings. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Settings() { Instance.Settings = Elastic.Clients.Elasticsearch.TransformManagement.SettingsDescriptor.Build(null); return this; } /// <summary> /// <para> /// Defines optional transform settings. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Settings(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.SettingsDescriptor>? action) { Instance.Settings = Elastic.Clients.Elasticsearch.TransformManagement.SettingsDescriptor.Build(action); return this; } /// <summary> /// <para> /// The source of the data for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Source(Elastic.Clients.Elasticsearch.TransformManagement.Source value) { Instance.Source = value; return this; } /// <summary> /// <para> /// The source of the data for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Source(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.SourceDescriptor> action) { Instance.Source = Elastic.Clients.Elasticsearch.TransformManagement.SourceDescriptor.Build(action); return this; } /// <summary> /// <para> /// The source of the data for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Source<T>(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.SourceDescriptor<T>> action) { Instance.Source = Elastic.Clients.Elasticsearch.TransformManagement.SourceDescriptor<T>.Build(action); return this; } /// <summary> /// <para> /// Defines the properties transforms require to run continuously. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Sync(Elastic.Clients.Elasticsearch.TransformManagement.Sync? value) { Instance.Sync = value; return this; } /// <summary> /// <para> /// Defines the properties transforms require to run continuously. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Sync(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.SyncDescriptor> action) { Instance.Sync = Elastic.Clients.Elasticsearch.TransformManagement.SyncDescriptor.Build(action); return this; } /// <summary> /// <para> /// Defines the properties transforms require to run continuously. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Sync<T>(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.SyncDescriptor<T>> action) { Instance.Sync = Elastic.Clients.Elasticsearch.TransformManagement.SyncDescriptor<T>.Build(action); return this; } [System.Runtime.CompilerServices.MethodImpl(System.Runtime.CompilerServices.MethodImplOptions.AggressiveInlining)] internal static Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest Build(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor> action) { var builder = new Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor(new Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest(Elastic.Clients.Elasticsearch.Serialization.JsonConstructorSentinel.Instance)); action.Invoke(builder); return builder.Instance; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor ErrorTrace(bool? value) { Instance.ErrorTrace = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor FilterPath(params string[]? value) { Instance.FilterPath = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Human(bool? value) { Instance.Human = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor Pretty(bool? value) { Instance.Pretty = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor SourceQueryString(string? value) { Instance.SourceQueryString = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor RequestConfiguration(Elastic.Transport.IRequestConfiguration? value) { Instance.RequestConfiguration = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor RequestConfiguration(System.Func<Elastic.Transport.RequestConfigurationDescriptor, Elastic.Transport.IRequestConfiguration>? configurationSelector) { Instance.RequestConfiguration = configurationSelector.Invoke(Instance.RequestConfiguration is null ? new Elastic.Transport.RequestConfigurationDescriptor() : new Elastic.Transport.RequestConfigurationDescriptor(Instance.RequestConfiguration)) ?? Instance.RequestConfiguration; return this; } } /// <summary> /// <para> /// Create a transform. /// Creates a transform. /// </para> /// <para> /// A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as /// a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a /// unique row per entity. /// </para> /// <para> /// You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If /// you choose to use the pivot method for your transform, the entities are defined by the set of <c>group_by</c> fields in /// the pivot object. If you choose to use the latest method, the entities are defined by the <c>unique_key</c> field values /// in the latest object. /// </para> /// <para> /// You must have <c>create_index</c>, <c>index</c>, and <c>read</c> privileges on the destination index and <c>read</c> and /// <c>view_index_metadata</c> privileges on the source indices. When Elasticsearch security features are enabled, the /// transform remembers which roles the user that created it had at the time of creation and uses those same roles. If /// those roles do not have the required privileges on the source and destination indices, the transform fails when it /// attempts unauthorized operations. /// </para> /// <para> /// NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any /// <c>.transform-internal*</c> indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do /// not give users any privileges on <c>.transform-internal*</c> indices. If you used transforms prior to 7.5, also do not /// give users any privileges on <c>.data-frame-internal*</c> indices. /// </para> /// </summary> public readonly partial struct PutTransformRequestDescriptor<TDocument> { internal Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest Instance { get; init; } [System.Diagnostics.CodeAnalysis.SetsRequiredMembers] public PutTransformRequestDescriptor(Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest instance) { Instance = instance; } public PutTransformRequestDescriptor(Elastic.Clients.Elasticsearch.Id transformId) { #pragma warning disable CS0618 Instance = new Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest(transformId); #pragma warning restore CS0618 } [System.Obsolete("The use of the parameterless constructor is not permitted for this type.")] public PutTransformRequestDescriptor() { throw new System.InvalidOperationException("The use of the parameterless constructor is not permitted for this type."); } public static explicit operator Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument>(Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest instance) => new Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument>(instance); public static implicit operator Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest(Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> descriptor) => descriptor.Instance; /// <summary> /// <para> /// Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), /// hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> TransformId(Elastic.Clients.Elasticsearch.Id value) { Instance.TransformId = value; return this; } /// <summary> /// <para> /// When the transform is created, a series of validations occur to ensure its success. For example, there is a /// check for the existence of the source indices and a check that the destination index is not part of the source /// index pattern. You can use this parameter to skip the checks, for example when the source index does not exist /// until after the transform is created. The validations are always run when you start the transform, however, with /// the exception of privilege checks. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> DeferValidation(bool? value = true) { Instance.DeferValidation = value; return this; } /// <summary> /// <para> /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Timeout(Elastic.Clients.Elasticsearch.Duration? value) { Instance.Timeout = value; return this; } /// <summary> /// <para> /// Free text description of the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Description(string? value) { Instance.Description = value; return this; } /// <summary> /// <para> /// The destination for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Dest(Elastic.Clients.Elasticsearch.TransformManagement.Destination value) { Instance.Dest = value; return this; } /// <summary> /// <para> /// The destination for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Dest() { Instance.Dest = Elastic.Clients.Elasticsearch.TransformManagement.DestinationDescriptor.Build(null); return this; } /// <summary> /// <para> /// The destination for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Dest(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.DestinationDescriptor>? action) { Instance.Dest = Elastic.Clients.Elasticsearch.TransformManagement.DestinationDescriptor.Build(action); return this; } /// <summary> /// <para> /// The interval between checks for changes in the source indices when the transform is running continuously. Also /// determines the retry interval in the event of transient failures while the transform is searching or indexing. /// The minimum value is <c>1s</c> and the maximum is <c>1h</c>. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Frequency(Elastic.Clients.Elasticsearch.Duration? value) { Instance.Frequency = value; return this; } /// <summary> /// <para> /// The latest method transforms the data by finding the latest document for each unique key. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Latest(Elastic.Clients.Elasticsearch.TransformManagement.Latest? value) { Instance.Latest = value; return this; } /// <summary> /// <para> /// The latest method transforms the data by finding the latest document for each unique key. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Latest(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.LatestDescriptor<TDocument>> action) { Instance.Latest = Elastic.Clients.Elasticsearch.TransformManagement.LatestDescriptor<TDocument>.Build(action); return this; } /// <summary> /// <para> /// Defines optional transform metadata. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Meta(System.Collections.Generic.IDictionary<string, object>? value) { Instance.Meta = value; return this; } /// <summary> /// <para> /// Defines optional transform metadata. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Meta() { Instance.Meta = Elastic.Clients.Elasticsearch.Fluent.FluentDictionaryOfStringObject.Build(null); return this; } /// <summary> /// <para> /// Defines optional transform metadata. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Meta(System.Action<Elastic.Clients.Elasticsearch.Fluent.FluentDictionaryOfStringObject>? action) { Instance.Meta = Elastic.Clients.Elasticsearch.Fluent.FluentDictionaryOfStringObject.Build(action); return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> AddMeta(string key, object value) { Instance.Meta ??= new System.Collections.Generic.Dictionary<string, object>(); Instance.Meta.Add(key, value); return this; } /// <summary> /// <para> /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields /// and the aggregation to reduce the data. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Pivot(Elastic.Clients.Elasticsearch.TransformManagement.Pivot? value) { Instance.Pivot = value; return this; } /// <summary> /// <para> /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields /// and the aggregation to reduce the data. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Pivot() { Instance.Pivot = Elastic.Clients.Elasticsearch.TransformManagement.PivotDescriptor<TDocument>.Build(null); return this; } /// <summary> /// <para> /// The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields /// and the aggregation to reduce the data. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Pivot(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.PivotDescriptor<TDocument>>? action) { Instance.Pivot = Elastic.Clients.Elasticsearch.TransformManagement.PivotDescriptor<TDocument>.Build(action); return this; } /// <summary> /// <para> /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the /// destination index. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> RetentionPolicy(Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicy? value) { Instance.RetentionPolicy = value; return this; } /// <summary> /// <para> /// Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the /// destination index. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> RetentionPolicy(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicyDescriptor<TDocument>> action) { Instance.RetentionPolicy = Elastic.Clients.Elasticsearch.TransformManagement.RetentionPolicyDescriptor<TDocument>.Build(action); return this; } /// <summary> /// <para> /// Defines optional transform settings. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Settings(Elastic.Clients.Elasticsearch.TransformManagement.Settings? value) { Instance.Settings = value; return this; } /// <summary> /// <para> /// Defines optional transform settings. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Settings() { Instance.Settings = Elastic.Clients.Elasticsearch.TransformManagement.SettingsDescriptor.Build(null); return this; } /// <summary> /// <para> /// Defines optional transform settings. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Settings(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.SettingsDescriptor>? action) { Instance.Settings = Elastic.Clients.Elasticsearch.TransformManagement.SettingsDescriptor.Build(action); return this; } /// <summary> /// <para> /// The source of the data for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Source(Elastic.Clients.Elasticsearch.TransformManagement.Source value) { Instance.Source = value; return this; } /// <summary> /// <para> /// The source of the data for the transform. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Source(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.SourceDescriptor<TDocument>> action) { Instance.Source = Elastic.Clients.Elasticsearch.TransformManagement.SourceDescriptor<TDocument>.Build(action); return this; } /// <summary> /// <para> /// Defines the properties transforms require to run continuously. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Sync(Elastic.Clients.Elasticsearch.TransformManagement.Sync? value) { Instance.Sync = value; return this; } /// <summary> /// <para> /// Defines the properties transforms require to run continuously. /// </para> /// </summary> public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Sync(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.SyncDescriptor<TDocument>> action) { Instance.Sync = Elastic.Clients.Elasticsearch.TransformManagement.SyncDescriptor<TDocument>.Build(action); return this; } [System.Runtime.CompilerServices.MethodImpl(System.Runtime.CompilerServices.MethodImplOptions.AggressiveInlining)] internal static Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest Build(System.Action<Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument>> action) { var builder = new Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument>(new Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequest(Elastic.Clients.Elasticsearch.Serialization.JsonConstructorSentinel.Instance)); action.Invoke(builder); return builder.Instance; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> ErrorTrace(bool? value) { Instance.ErrorTrace = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> FilterPath(params string[]? value) { Instance.FilterPath = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Human(bool? value) { Instance.Human = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> Pretty(bool? value) { Instance.Pretty = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> SourceQueryString(string? value) { Instance.SourceQueryString = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> RequestConfiguration(Elastic.Transport.IRequestConfiguration? value) { Instance.RequestConfiguration = value; return this; } public Elastic.Clients.Elasticsearch.TransformManagement.PutTransformRequestDescriptor<TDocument> RequestConfiguration(System.Func<Elastic.Transport.RequestConfigurationDescriptor, Elastic.Transport.IRequestConfiguration>? configurationSelector) { Instance.RequestConfiguration = configurationSelector.Invoke(Instance.RequestConfiguration is null ? new Elastic.Transport.RequestConfigurationDescriptor() : new Elastic.Transport.RequestConfigurationDescriptor(Instance.RequestConfiguration)) ?? Instance.RequestConfiguration; return this; } }