toJson method

  1. @override
Map<String, dynamic> toJson({
  1. OptimizeFor optimizeFor = OptimizeFor.put,
})
override

Converts this object into JSON format.

optimizeFor lets the program know what information to include in the JSON data map.

  • OptimizeFor.put (the default value) is used when making a data map that is being placed in a PUT request. This only includes data that has changed.
  • OptimizeFor.putFull is used when a parent object updates; so, all of the children are required to be present for the PUT request.
  • OptimizeFor.post is used when making a data map for a POST request.
  • OptimizeFor.dontOptimize is used to get all of the data contained in this object.

Throws InvalidNameException if metadata.name doesn't have 1 to 32 characters (inclusive), and optimizeFor is not set to OptimizeFor.dontOptimize.

Implementation

@override
Map<String, dynamic> toJson({OptimizeFor optimizeFor = OptimizeFor.put}) {
  return {
    ApiFields.type: type.value,
    ApiFields.id: id,
    ApiFields.idV1: idV1,
    ApiFields.description: description,
    ApiFields.configurationSchema: configurationSchema,
    ApiFields.triggerSchema: triggerSchema,
    ApiFields.stateSchema: stateSchema,
    ApiFields.version: version,
    ApiFields.metadata:
        metadata.toJson(optimizeFor: OptimizeFor.dontOptimize),
    ApiFields.supportedFeatures: supportedFeatures,
    ApiFields.maxNumberInstances: maxNumberInstances,
  };
}