Lines Matching refs:params

33      * $params['transform_id'] = (string) The id of the transform to delete
34      * $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.
36      * @param array $params Associative array of parameters
40     public function deleteTransform(array $params = [])
42         $transform_id = $this->extractArgument($params, 'transform_id');
46         $endpoint->setParams($params);
54      * $params['transform_id']      = (string) The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms
55      * $params['from']              = (int) skips a number of transform configs, defaults to 0
56      * $params['size']              = (int) specifies a max number of transforms to get, defaults to 100
57      * $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)
58      * $params['exclude_generated'] = (boolean) Omits fields that are illegal to set on transform PUT (Default = false)
60      * @param array $params Associative array of parameters
64     public function getTransform(array $params = [])
66         $transform_id = $this->extractArgument($params, 'transform_id');
70         $endpoint->setParams($params);
78      * $params['transform_id']   = (string) The id of the transform for which to get stats. '_all' or '*' implies all transforms
79      * $params['from']           = (number) skips a number of transform stats, defaults to 0
80      * $params['size']           = (number) specifies a max number of transform stats to get, defaults to 100
81      * $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)
83      * @param array $params Associative array of parameters
87     public function getTransformStats(array $params = [])
89         $transform_id = $this->extractArgument($params, 'transform_id');
93         $endpoint->setParams($params);
101      * $params['transform_id'] = (string) The id of the transform to preview.
102      * $params['body']         = (array) The definition for the transform to preview
104      * @param array $params Associative array of parameters
108     public function previewTransform(array $params = [])
110         $transform_id = $this->extractArgument($params, 'transform_id');
111         $body = $this->extractArgument($params, 'body');
115         $endpoint->setParams($params);
124      * $params['transform_id']     = (string) The id of the new transform.
125      * $params['defer_validation'] = (boolean) If validations should be deferred until transform starts, defaults to false.
126      * $params['body']             = (array) The transform definition (Required)
128      * @param array $params Associative array of parameters
132     public function putTransform(array $params = [])
134         $transform_id = $this->extractArgument($params, 'transform_id');
135         $body = $this->extractArgument($params, 'body');
139         $endpoint->setParams($params);
148      * $params['transform_id'] = (string) The id of the transform to start
149      * $params['timeout']      = (time) Controls the time to wait for the transform to start
151      * @param array $params Associative array of parameters
155     public function startTransform(array $params = [])
157         $transform_id = $this->extractArgument($params, 'transform_id');
161         $endpoint->setParams($params);
169      * $params['transform_id']        = (string) The id of the transform to stop
170      * $params['force']               = (boolean) Whether to force stop a failed transform or not. Default to false
171      * $params['wait_for_completion'] = (boolean) Whether to wait for the transform to fully stop before returning or not. Default to false
172      * $params['timeout']             = (time) Controls the time to wait until the transform has stopped. Default to 30 seconds
173      * $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)
174      * $params['wait_for_checkpoint'] = (boolean) Whether to wait for the transform to reach a checkpoint before stopping. Default to false
176      * @param array $params Associative array of parameters
180     public function stopTransform(array $params = [])
182         $transform_id = $this->extractArgument($params, 'transform_id');
186         $endpoint->setParams($params);
194      * $params['transform_id']     = (string) The id of the transform.
195      * $params['defer_validation'] = (boolean) If validations should be deferred until transform starts, defaults to false.
196      * $params['body']             = (array) The update transform definition (Required)
198      * @param array $params Associative array of parameters
202     public function updateTransform(array $params = [])
204         $transform_id = $this->extractArgument($params, 'transform_id');
205         $body = $this->extractArgument($params, 'body');
209         $endpoint->setParams($params);