Package version:

Interface Transformations

Interface representing a Transformations.

interface Transformations {
    createOrReplace(resourceGroupName, jobName, transformationName, transformation, options?): Promise<TransformationsCreateOrReplaceResponse>;
    get(resourceGroupName, jobName, transformationName, options?): Promise<TransformationsGetResponse>;
    update(resourceGroupName, jobName, transformationName, transformation, options?): Promise<TransformationsUpdateResponse>;
}

Methods

createOrReplace(resourceGroupName, jobName, transformationName, transformation, options?): Promise<TransformationsCreateOrReplaceResponse>
Creates a transformation or replaces an already existing transformation under an existing streaming job.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- jobName: string
  The name of the streaming job.
- transformationName: string
  The name of the transformation.
- transformation: Transformation
  The definition of the transformation that will be used to create a new transformation or replace the existing one under the streaming job.
- Optional options: TransformationsCreateOrReplaceOptionalParams
  The options parameters.
Returns Promise<TransformationsCreateOrReplaceResponse>
- Defined in operationsInterfaces/transformations.ts:31

get(resourceGroupName, jobName, transformationName, options?): Promise<TransformationsGetResponse>
Gets details about the specified transformation.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- jobName: string
  The name of the streaming job.
- transformationName: string
  The name of the transformation.
- Optional options: TransformationsGetOptionalParams
  The options parameters.
Returns Promise<TransformationsGetResponse>
- Defined in operationsInterfaces/transformations.ts:65

update(resourceGroupName, jobName, transformationName, transformation, options?): Promise<TransformationsUpdateResponse>
Updates an existing transformation under an existing streaming job. This can be used to partially update (ie. update one or two properties) a transformation without affecting the rest the job or transformation definition.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- jobName: string
  The name of the streaming job.
- transformationName: string
  The name of the transformation.
- transformation: Transformation
  A Transformation object. The properties specified here will overwrite the corresponding properties in the existing transformation (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing transformation will remain the same and not change as a result of this PATCH operation.
- Optional options: TransformationsUpdateOptionalParams
  The options parameters.
Returns Promise<TransformationsUpdateResponse>
- Defined in operationsInterfaces/transformations.ts:51