hydra.ext.com.microsoft.azure.dtld.CommandPayload Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hydra-ext Show documentation
Hydra language extensions in Java; models, coders, and utilities
There is a newer version: 0.8.1
// Note: this is an automatically generated file. Do not edit.

package hydra.ext.com.microsoft.azure.dtld;

import java.io.Serializable;

/**
 * A CommandPayload describes the inputs to or the outputs from a Command.
 */
public class CommandPayload implements Serializable {
  public static final hydra.core.Name TYPE_NAME = new hydra.core.Name("hydra/ext/com/microsoft/azure/dtld.CommandPayload");
  
  public static final hydra.core.Name FIELD_NAME_NAME = new hydra.core.Name("name");
  
  public static final hydra.core.Name FIELD_NAME_SCHEMA = new hydra.core.Name("schema");
  
  public static final hydra.core.Name FIELD_NAME_ID = new hydra.core.Name("id");
  
  public static final hydra.core.Name FIELD_NAME_COMMENT = new hydra.core.Name("comment");
  
  public static final hydra.core.Name FIELD_NAME_DESCRIPTION = new hydra.core.Name("description");
  
  public static final hydra.core.Name FIELD_NAME_DISPLAY_NAME = new hydra.core.Name("displayName");
  
  /**
   * The 'programming' name of the payload. The name may only contain the characters a-z, A-Z, 0-9, and underscore, and must match this regular expression ^[a-zA-Z](?:[a-zA-Z0-9_]*[a-zA-Z0-9])?$.
   */
  public final String name;
  
  /**
   * The data type of the payload
   */
  public final hydra.ext.com.microsoft.azure.dtld.Schema schema;
  
  /**
   * The ID of the payload. If no @id is provided, the digital twin interface processor will assign one.
   */
  public final hydra.util.Opt id;
  
  /**
   * A comment for model authors
   */
  public final hydra.util.Opt comment;
  
  /**
   * A localizable description for display
   */
  public final hydra.util.Opt description;
  
  /**
   * A localizable name for display
   */
  public final hydra.util.Opt displayName;
  
  public CommandPayload (String name, hydra.ext.com.microsoft.azure.dtld.Schema schema, hydra.util.Opt id, hydra.util.Opt comment, hydra.util.Opt description, hydra.util.Opt displayName) {
    java.util.Objects.requireNonNull((name));
    java.util.Objects.requireNonNull((schema));
    java.util.Objects.requireNonNull((id));
    java.util.Objects.requireNonNull((comment));
    java.util.Objects.requireNonNull((description));
    java.util.Objects.requireNonNull((displayName));
    this.name = name;
    this.schema = schema;
    this.id = id;
    this.comment = comment;
    this.description = description;
    this.displayName = displayName;
  }
  
  @Override
  public boolean equals(Object other) {
    if (!(other instanceof CommandPayload)) {
      return false;
    }
    CommandPayload o = (CommandPayload) (other);
    return name.equals(o.name) && schema.equals(o.schema) && id.equals(o.id) && comment.equals(o.comment) && description.equals(o.description) && displayName.equals(o.displayName);
  }
  
  @Override
  public int hashCode() {
    return 2 * name.hashCode() + 3 * schema.hashCode() + 5 * id.hashCode() + 7 * comment.hashCode() + 11 * description.hashCode() + 13 * displayName.hashCode();
  }
  
  public CommandPayload withName(String name) {
    java.util.Objects.requireNonNull((name));
    return new CommandPayload(name, schema, id, comment, description, displayName);
  }
  
  public CommandPayload withSchema(hydra.ext.com.microsoft.azure.dtld.Schema schema) {
    java.util.Objects.requireNonNull((schema));
    return new CommandPayload(name, schema, id, comment, description, displayName);
  }
  
  public CommandPayload withId(hydra.util.Opt id) {
    java.util.Objects.requireNonNull((id));
    return new CommandPayload(name, schema, id, comment, description, displayName);
  }
  
  public CommandPayload withComment(hydra.util.Opt comment) {
    java.util.Objects.requireNonNull((comment));
    return new CommandPayload(name, schema, id, comment, description, displayName);
  }
  
  public CommandPayload withDescription(hydra.util.Opt description) {
    java.util.Objects.requireNonNull((description));
    return new CommandPayload(name, schema, id, comment, description, displayName);
  }
  
  public CommandPayload withDisplayName(hydra.util.Opt displayName) {
    java.util.Objects.requireNonNull((displayName));
    return new CommandPayload(name, schema, id, comment, description, displayName);
  }
}