1 2 3[[Elasticsearch_Namespaces_TransformNamespace]] 4=== Elasticsearch\Namespaces\TransformNamespace 5 6 7 8Class TransformNamespace 9 10*Description* 11 12 13NOTE: this file is autogenerated using util/GenerateEndpoints.php 14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7) 15 16 17*Methods* 18 19The class defines the following methods: 20 21* <<Elasticsearch_Namespaces_TransformNamespacedeleteTransform_deleteTransform,`deleteTransform()`>> 22* <<Elasticsearch_Namespaces_TransformNamespacegetTransform_getTransform,`getTransform()`>> 23* <<Elasticsearch_Namespaces_TransformNamespacegetTransformStats_getTransformStats,`getTransformStats()`>> 24* <<Elasticsearch_Namespaces_TransformNamespacepreviewTransform_previewTransform,`previewTransform()`>> 25* <<Elasticsearch_Namespaces_TransformNamespaceputTransform_putTransform,`putTransform()`>> 26* <<Elasticsearch_Namespaces_TransformNamespacestartTransform_startTransform,`startTransform()`>> 27* <<Elasticsearch_Namespaces_TransformNamespacestopTransform_stopTransform,`stopTransform()`>> 28* <<Elasticsearch_Namespaces_TransformNamespaceupdateTransform_updateTransform,`updateTransform()`>> 29 30 31 32[[Elasticsearch_Namespaces_TransformNamespacedeleteTransform_deleteTransform]] 33.`deleteTransform(array $params = [])` 34**** 35[source,php] 36---- 37/* 38$params['transform_id'] = (string) The id of the transform to delete 39$params['force'] = (boolean) When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted. 40*/ 41---- 42**** 43 44 45 46[[Elasticsearch_Namespaces_TransformNamespacegetTransform_getTransform]] 47.`getTransform(array $params = [])` 48**** 49[source,php] 50---- 51/* 52$params['transform_id'] = (string) The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms 53$params['from'] = (int) skips a number of transform configs, defaults to 0 54$params['size'] = (int) specifies a max number of transforms to get, defaults to 100 55$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) 56$params['exclude_generated'] = (boolean) Omits fields that are illegal to set on transform PUT (Default = false) 57*/ 58---- 59**** 60 61 62 63[[Elasticsearch_Namespaces_TransformNamespacegetTransformStats_getTransformStats]] 64.`getTransformStats(array $params = [])` 65**** 66[source,php] 67---- 68/* 69$params['transform_id'] = (string) The id of the transform for which to get stats. '_all' or '*' implies all transforms 70$params['from'] = (number) skips a number of transform stats, defaults to 0 71$params['size'] = (number) specifies a max number of transform stats to get, defaults to 100 72$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) 73*/ 74---- 75**** 76 77 78 79[[Elasticsearch_Namespaces_TransformNamespacepreviewTransform_previewTransform]] 80.`previewTransform(array $params = [])` 81**** 82[source,php] 83---- 84/* 85*/ 86---- 87**** 88 89 90 91[[Elasticsearch_Namespaces_TransformNamespaceputTransform_putTransform]] 92.`putTransform(array $params = [])` 93**** 94[source,php] 95---- 96/* 97$params['transform_id'] = (string) The id of the new transform. 98*/ 99---- 100**** 101 102 103 104[[Elasticsearch_Namespaces_TransformNamespacestartTransform_startTransform]] 105.`startTransform(array $params = [])` 106**** 107[source,php] 108---- 109/* 110$params['transform_id'] = (string) The id of the transform to start 111$params['timeout'] = (time) Controls the time to wait for the transform to start 112*/ 113---- 114**** 115 116 117 118[[Elasticsearch_Namespaces_TransformNamespacestopTransform_stopTransform]] 119.`stopTransform(array $params = [])` 120**** 121[source,php] 122---- 123/* 124$params['transform_id'] = (string) The id of the transform to stop 125$params['force'] = (boolean) Whether to force stop a failed transform or not. Default to false 126$params['wait_for_completion'] = (boolean) Whether to wait for the transform to fully stop before returning or not. Default to false 127$params['timeout'] = (time) Controls the time to wait until the transform has stopped. Default to 30 seconds 128$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) 129$params['wait_for_checkpoint'] = (boolean) Whether to wait for the transform to reach a checkpoint before stopping. Default to false 130*/ 131---- 132**** 133 134 135 136[[Elasticsearch_Namespaces_TransformNamespaceupdateTransform_updateTransform]] 137.`updateTransform(array $params = [])` 138**** 139[source,php] 140---- 141/* 142$params['transform_id'] = (string) The id of the transform. 143*/ 144---- 145**** 146 147 148