sdk/lib/model/transition_result.dart

//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.18

// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars

part of hanzoai.cloud;

class TransitionResult {
  /// Returns a new [TransitionResult] instance.
  TransitionResult({
    this.distribution,
    this.doctype,
    this.from,
    this.name,
    this.storefront,
    this.to,
  });
  /// Distribution is the channel fan-out this move triggered. Present ONLY on the move to published, the single edge that distributes — so its absence means no fan-out was attempted, never that one failed quietly. A fan-out that DID fail is present carrying its own honest status, because distribution never rolls the status change back.
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  PublishResult? distribution;

  /// DocType is the content type that moved — Campaign, SocialPost or Asset — echoed from the path.
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  String? doctype;

  /// From is the state the item held when it was read. A document carrying no status yet reads as \"draft\".
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  String? from;

  /// Name is the document that moved, echoed from the path.
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  String? name;

  /// Storefront is the catalog side effect, present only when a published Asset was product imagery — it carries a design and a kind of ecom, product or lifestyle. Absent for everything else, so absence reads as \"not catalog imagery\" rather than \"the catalog failed\".
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  StorefrontResult? storefront;

  /// To is the state it holds now. From == To on an idempotent re-transition, which is legal and is where a caller that lost a publish race lands.
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  String? to;

  @override
  bool operator ==(Object other) => identical(this, other) || other is TransitionResult &&
    other.distribution == distribution &&
    other.doctype == doctype &&
    other.from == from &&
    other.name == name &&
    other.storefront == storefront &&
    other.to == to;

  @override
  int get hashCode =>
    // ignore: unnecessary_parenthesis
    (distribution == null ? 0 : distribution!.hashCode) +
    (doctype == null ? 0 : doctype!.hashCode) +
    (from == null ? 0 : from!.hashCode) +
    (name == null ? 0 : name!.hashCode) +
    (storefront == null ? 0 : storefront!.hashCode) +
    (to == null ? 0 : to!.hashCode);

  @override
  String toString() => 'TransitionResult[distribution=$distribution, doctype=$doctype, from=$from, name=$name, storefront=$storefront, to=$to]';

  Map<String, dynamic> toJson() {
    final json = <String, dynamic>{};
    if (this.distribution != null) {
      json[r'distribution'] = this.distribution;
    } else {
      json[r'distribution'] = null;
    }
    if (this.doctype != null) {
      json[r'doctype'] = this.doctype;
    } else {
      json[r'doctype'] = null;
    }
    if (this.from != null) {
      json[r'from'] = this.from;
    } else {
      json[r'from'] = null;
    }
    if (this.name != null) {
      json[r'name'] = this.name;
    } else {
      json[r'name'] = null;
    }
    if (this.storefront != null) {
      json[r'storefront'] = this.storefront;
    } else {
      json[r'storefront'] = null;
    }
    if (this.to != null) {
      json[r'to'] = this.to;
    } else {
      json[r'to'] = null;
    }
    return json;
  }

  /// Returns a new [TransitionResult] instance and imports its values from
  /// [value] if it's a [Map], null otherwise.
  // ignore: prefer_constructors_over_static_methods
  static TransitionResult? fromJson(dynamic value) {
    if (value is Map) {
      final json = value.cast<String, dynamic>();

      // Ensure that the map contains the required keys.
      // Note 1: the values aren't checked for validity beyond being non-null.
      // Note 2: this code is stripped in release mode!
      assert(() {
        requiredKeys.forEach((key) {
          assert(json.containsKey(key), 'Required key "TransitionResult[$key]" is missing from JSON.');
          assert(json[key] != null, 'Required key "TransitionResult[$key]" has a null value in JSON.');
        });
        return true;
      }());

      return TransitionResult(
        distribution: PublishResult.fromJson(json[r'distribution']),
        doctype: mapValueOfType<String>(json, r'doctype'),
        from: mapValueOfType<String>(json, r'from'),
        name: mapValueOfType<String>(json, r'name'),
        storefront: StorefrontResult.fromJson(json[r'storefront']),
        to: mapValueOfType<String>(json, r'to'),
      );
    }
    return null;
  }

  static List<TransitionResult> listFromJson(dynamic json, {bool growable = false,}) {
    final result = <TransitionResult>[];
    if (json is List && json.isNotEmpty) {
      for (final row in json) {
        final value = TransitionResult.fromJson(row);
        if (value != null) {
          result.add(value);
        }
      }
    }
    return result.toList(growable: growable);
  }

  static Map<String, TransitionResult> mapFromJson(dynamic json) {
    final map = <String, TransitionResult>{};
    if (json is Map && json.isNotEmpty) {
      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
      for (final entry in json.entries) {
        final value = TransitionResult.fromJson(entry.value);
        if (value != null) {
          map[entry.key] = value;
        }
      }
    }
    return map;
  }

  // maps a json object with a list of TransitionResult-objects as value to a dart map
  static Map<String, List<TransitionResult>> mapListFromJson(dynamic json, {bool growable = false,}) {
    final map = <String, List<TransitionResult>>{};
    if (json is Map && json.isNotEmpty) {
      // ignore: parameter_assignments
      json = json.cast<String, dynamic>();
      for (final entry in json.entries) {
        map[entry.key] = TransitionResult.listFromJson(entry.value, growable: growable,);
      }
    }
    return map;
  }

  /// The list of required keys that must be present in a JSON.
  static const requiredKeys = <String>{
  };
}