package Torello.Browser.JavaScriptAPI;

// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// Java-HTML Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import Torello.Browser.*;
import Torello.Browser.helper.*;
import Torello.Browser.BrowserAPI.*;
import Torello.JSON.*;

import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlyArrayList;

import Torello.JavaDoc.Annotations.StaticFunctional;
import Torello.JavaDoc.Annotations.JDHeaderBackgroundImg;

import Torello.Browser.JavaScriptAPI.NestedHelpers.Commands.HeapProfiler$$Commands;


// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// JDK Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import javax.json.JsonObject;
import javax.json.JsonValue;

/**
 * <SPAN CLASS=COPIEDJDK><B><CODE>[No Description Provided by Google]</CODE></B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class HeapProfiler
{
    // No Pubic Constructors
    private HeapProfiler() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Eliminated Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Heap snapshot object id.

     * <EMBED CLASS='external-html' DATA-CTAS='String' DATA-FILE-ID=CDP.EliminatedType
     *     DATA-NAME=HeapSnapshotObjectId>
     */
    public static final String HeapSnapshotObjectId =
        "HeapSnapshotObjectId has been eliminated.\n" +
        "It was replaced with the standard Java-Type: String";


    // ********************************************************************************************
    // ********************************************************************************************
    // Marker Events
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * <CODE>[No Description Provided by Google]</CODE>

     * 
     * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.MarkerEvent
     *     DATA-NAME=resetProfiles>
     */
    public static final String resetProfiles = "HeapProfiler.resetProfiles Marker Event";



    // ********************************************************************************************
    // ********************************************************************************************
    // Basic Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Sampling profile.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=HeapProfiler DATA-API=JavaScriptAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class SamplingHeapProfile
        extends BaseType<SamplingHeapProfile>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<HeapProfiler.SamplingHeapProfile> singleton =
            Torello.Browser.JavaScriptAPI.NestedHelpers.Types.
                HeapProfiler$$SamplingHeapProfile$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final HeapProfiler.SamplingHeapProfileNode head;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final HeapProfiler.SamplingHeapProfileSample[] samples;

        /** Constructor.  Please review this class' fields for documentation. */
        public SamplingHeapProfile(
                ReadOnlyList<Boolean> isPresent, SamplingHeapProfileNode head,
                SamplingHeapProfileSample[] samples
            )
        {
            super(singleton, Domains.HeapProfiler, "SamplingHeapProfile", 2);

            this.head       = head;
            this.samples    = samples;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "HeapProfiler.SamplingHeapProfile");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static SamplingHeapProfile fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<SamplingHeapProfile> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=HeapProfiler DATA-API=JavaScriptAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class SamplingHeapProfileNode
        extends BaseType<SamplingHeapProfileNode>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<HeapProfiler.SamplingHeapProfileNode> singleton =
            Torello.Browser.JavaScriptAPI.NestedHelpers.Types.
                HeapProfiler$$SamplingHeapProfileNode$$.singleton;

        /** Function location. */
        public final RunTime.CallFrame callFrame;

        /** Allocations size in bytes for the node excluding children. */
        public final Number selfSize;

        /** Node id. Ids are unique across all profiles collected between startSampling and stopSampling. */
        public final int id;

        /** Child nodes. */
        public final HeapProfiler.SamplingHeapProfileNode[] children;

        /** Constructor.  Please review this class' fields for documentation. */
        public SamplingHeapProfileNode(
                ReadOnlyList<Boolean> isPresent, RunTime.CallFrame callFrame, Number selfSize,
                int id, SamplingHeapProfileNode[] children
            )
        {
            super(singleton, Domains.HeapProfiler, "SamplingHeapProfileNode", 4);

            this.callFrame  = callFrame;
            this.selfSize   = selfSize;
            this.id         = id;
            this.children   = children;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 4, "HeapProfiler.SamplingHeapProfileNode");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static SamplingHeapProfileNode fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<SamplingHeapProfileNode> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * A single sample from a sampling profile.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=HeapProfiler DATA-API=JavaScriptAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class SamplingHeapProfileSample
        extends BaseType<SamplingHeapProfileSample>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<HeapProfiler.SamplingHeapProfileSample> singleton =
            Torello.Browser.JavaScriptAPI.NestedHelpers.Types.
                HeapProfiler$$SamplingHeapProfileSample$$.singleton;

        /** Allocation size in bytes attributed to the sample. */
        public final Number size;

        /** Id of the corresponding profile tree node. */
        public final int nodeId;

        /**
         * Time-ordered sample ordinal number. It is unique across all profiles retrieved
         * between startSampling and stopSampling.
         */
        public final Number ordinal;

        /** Constructor.  Please review this class' fields for documentation. */
        public SamplingHeapProfileSample
            (ReadOnlyList<Boolean> isPresent, Number size, int nodeId, Number ordinal)
        {
            super(singleton, Domains.HeapProfiler, "SamplingHeapProfileSample", 3);

            this.size       = size;
            this.nodeId     = nodeId;
            this.ordinal    = ordinal;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 3, "HeapProfiler.SamplingHeapProfileSample");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static SamplingHeapProfileSample fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<SamplingHeapProfileSample> descriptor()
        { return singleton.descriptor(); }
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Event Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=HeapProfiler DATA-API=JavaScriptAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class addHeapSnapshotChunk
        extends BrowserEvent<addHeapSnapshotChunk>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<HeapProfiler.addHeapSnapshotChunk> singleton =
            Torello.Browser.JavaScriptAPI.NestedHelpers.Events.
                HeapProfiler$$addHeapSnapshotChunk$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String chunk;

        /** Constructor.  Please review this class' fields for documentation. */
        public addHeapSnapshotChunk(ReadOnlyList<Boolean> isPresent, String chunk)
        {
            super(singleton, Domains.HeapProfiler, "addHeapSnapshotChunk", 1);

            this.chunk = chunk;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 1, "HeapProfiler.addHeapSnapshotChunk");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static addHeapSnapshotChunk fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<addHeapSnapshotChunk> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * If heap objects tracking has been started then backend may send update for one or more fragments
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=HeapProfiler DATA-API=JavaScriptAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class heapStatsUpdate
        extends BrowserEvent<heapStatsUpdate>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<HeapProfiler.heapStatsUpdate> singleton =
            Torello.Browser.JavaScriptAPI.NestedHelpers.Events.
                HeapProfiler$$heapStatsUpdate$$.singleton;

        /**
         * An array of triplets. Each triplet describes a fragment. The first integer is the fragment
         * index, the second integer is a total count of objects for the fragment, the third integer is
         * a total size of the objects for the fragment.
         */
        public final int[] statsUpdate;

        /** Constructor.  Please review this class' fields for documentation. */
        public heapStatsUpdate(ReadOnlyList<Boolean> isPresent, int[] statsUpdate)
        {
            super(singleton, Domains.HeapProfiler, "heapStatsUpdate", 1);

            this.statsUpdate = statsUpdate;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 1, "HeapProfiler.heapStatsUpdate");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static heapStatsUpdate fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<heapStatsUpdate> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * If heap objects tracking has been started then backend regularly sends a current value for last
     * seen object id and corresponding timestamp. If the were changes in the heap since last event
     * then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=HeapProfiler DATA-API=JavaScriptAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class lastSeenObjectId
        extends BrowserEvent<lastSeenObjectId>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<HeapProfiler.lastSeenObjectId> singleton =
            Torello.Browser.JavaScriptAPI.NestedHelpers.Events.
                HeapProfiler$$lastSeenObjectId$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final int lastSeenObjectId;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Number timestamp;

        /** Constructor.  Please review this class' fields for documentation. */
        public lastSeenObjectId
            (ReadOnlyList<Boolean> isPresent, int lastSeenObjectId, Number timestamp)
        {
            super(singleton, Domains.HeapProfiler, "lastSeenObjectId", 2);

            this.lastSeenObjectId   = lastSeenObjectId;
            this.timestamp          = timestamp;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "HeapProfiler.lastSeenObjectId");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static lastSeenObjectId fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<lastSeenObjectId> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=HeapProfiler DATA-API=JavaScriptAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class reportHeapSnapshotProgress
        extends BrowserEvent<reportHeapSnapshotProgress>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<HeapProfiler.reportHeapSnapshotProgress> singleton =
            Torello.Browser.JavaScriptAPI.NestedHelpers.Events.
                HeapProfiler$$reportHeapSnapshotProgress$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final int done;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final int total;

        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final Boolean finished;

        /** Constructor.  Please review this class' fields for documentation. */
        public reportHeapSnapshotProgress
            (ReadOnlyList<Boolean> isPresent, int done, int total, Boolean finished)
        {
            super(singleton, Domains.HeapProfiler, "reportHeapSnapshotProgress", 3);

            this.done       = done;
            this.total      = total;
            this.finished   = finished;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 3, "HeapProfiler.reportHeapSnapshotProgress");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static reportHeapSnapshotProgress fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<reportHeapSnapshotProgress> descriptor()
        { return singleton.descriptor(); }
    }




    // ********************************************************************************************
    // ********************************************************************************************
    // Commands
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Enables console to refer to the node with given id via $x (see Command Line API for more details
     * $x functions).
     * 
     * @param heapObjectId Heap snapshot object id to be accessible by means of $x command line API.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> addInspectedHeapObject(String heapObjectId)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.STRING, "heapObjectId", false, "HeapProfiler.addInspectedHeapObject",
            heapObjectId
        );

        return Script.NO_RET(Domains.HeapProfiler, "addInspectedHeapObject", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> collectGarbage()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"HeapProfiler.collectGarbage\"}";

        return Script.NO_RET(Domains.HeapProfiler, "collectGarbage", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> disable()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"HeapProfiler.disable\"}";

        return Script.NO_RET(Domains.HeapProfiler, "disable", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> enable()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"HeapProfiler.enable\"}";

        return Script.NO_RET(Domains.HeapProfiler, "enable", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param objectId Identifier of the object to get heap object id for.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;String&gt;</CODE> will be returned
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>String (<B>heapSnapshotObjectId</B>)</CODE>
     * <BR />
     * Id of the heap snapshot object corresponding to the passed remote object id.
     * </DIV>
     */
    public static Script<String> getHeapObjectId(String objectId)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "objectId", false, "HeapProfiler.getHeapObjectId", objectId);

        return new Script<>(
            Domains.HeapProfiler, "getHeapObjectId", requestJSON,
            jo -> ReadJSON.getString(jo, "heapSnapshotObjectId", true, false),
            String.class
        );
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param objectId -
     * 
     * @param objectGroup Symbolic group name that can be used to release multiple objects.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link RunTime.RemoteObject}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link RunTime.RemoteObject}&gt;</CODE> will be returned
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>{@link RunTime.RemoteObject} (<B>result</B>)</CODE>
     * <BR />
     * Evaluation result.
     * </DIV>
     */
    public static Script<RunTime.RemoteObject> getObjectByHeapObjectId
        (String objectId, String objectGroup)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            HeapProfiler$$Commands.getObjectByHeapObjectId$$,
            "HeapProfiler.getObjectByHeapObjectId",
            objectId, objectGroup
        );

        return new Script<>(
            Domains.HeapProfiler, "getObjectByHeapObjectId", requestJSON,
            HeapProfiler$$Commands::getObjectByHeapObjectId,
            RunTime.RemoteObject.class
        );
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @return An instance of <CODE>{@link Script}
     * &lt;{@link HeapProfiler.SamplingHeapProfile}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link HeapProfiler.SamplingHeapProfile}&gt;</CODE> will be returned
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>{@link HeapProfiler.SamplingHeapProfile} (<B>profile</B>)</CODE>
     * <BR />
     * Return the sampling profile being collected.
     * </DIV>
     */
    public static Script<HeapProfiler.SamplingHeapProfile> getSamplingProfile()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"HeapProfiler.getSamplingProfile\"}";

        return new Script<>(
            Domains.HeapProfiler, "getSamplingProfile", requestJSON,
            HeapProfiler$$Commands::getSamplingProfile,
            HeapProfiler.SamplingHeapProfile.class
        );
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param samplingInterval 
     * Average sample interval in bytes. Poisson distribution is used for the intervals. The
     * default value is 32768 bytes.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param includeObjectsCollectedByMajorGC 
     * By default, the sampling heap profiler reports only objects which are
     * still alive when the profile is returned via getSamplingProfile or
     * stopSampling, which is useful for determining what functions contribute
     * the most to steady-state memory usage. This flag instructs the sampling
     * heap profiler to also include information about objects discarded by
     * major GC, which will show which functions cause large temporary memory
     * usage or long GC pauses.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param includeObjectsCollectedByMinorGC 
     * By default, the sampling heap profiler reports only objects which are
     * still alive when the profile is returned via getSamplingProfile or
     * stopSampling, which is useful for determining what functions contribute
     * the most to steady-state memory usage. This flag instructs the sampling
     * heap profiler to also include information about objects discarded by
     * minor GC, which is useful when tuning a latency-sensitive application
     * for minimal GC activity.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> startSampling(
            Number samplingInterval, Boolean includeObjectsCollectedByMajorGC,
            Boolean includeObjectsCollectedByMinorGC
        )
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            HeapProfiler$$Commands.startSampling$$, "HeapProfiler.startSampling",
            samplingInterval, includeObjectsCollectedByMajorGC, includeObjectsCollectedByMinorGC
        );

        return Script.NO_RET(Domains.HeapProfiler, "startSampling", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param trackAllocations -
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> startTrackingHeapObjects(Boolean trackAllocations)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.BOXED_BOOLEAN, "trackAllocations", true,
            "HeapProfiler.startTrackingHeapObjects", trackAllocations
        );

        return Script.NO_RET(Domains.HeapProfiler, "startTrackingHeapObjects", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @return An instance of <CODE>{@link Script}
     * &lt;{@link HeapProfiler.SamplingHeapProfile}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link HeapProfiler.SamplingHeapProfile}&gt;</CODE> will be returned
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>{@link HeapProfiler.SamplingHeapProfile} (<B>profile</B>)</CODE>
     * <BR />
     * Recorded sampling heap profile.
     * </DIV>
     */
    public static Script<HeapProfiler.SamplingHeapProfile> stopSampling()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"HeapProfiler.stopSampling\"}";

        return new Script<>(
            Domains.HeapProfiler, "stopSampling", requestJSON,
            HeapProfiler$$Commands::stopSampling,
            HeapProfiler.SamplingHeapProfile.class
        );
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param reportProgress 
     * If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken
     * when the tracking is stopped.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param treatGlobalObjectsAsRoots Deprecated in favor of <CODE>exposeInternals</CODE>.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Dep-Top>DEPRECATED</B>
     * 
     * @param captureNumericValue If true, numerical values are included in the snapshot
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param exposeInternals If true, exposes internals of the snapshot.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> stopTrackingHeapObjects(
            Boolean reportProgress, Boolean treatGlobalObjectsAsRoots, Boolean captureNumericValue,
            Boolean exposeInternals
        )
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            HeapProfiler$$Commands.stopTrackingHeapObjects$$,
            "HeapProfiler.stopTrackingHeapObjects",
            reportProgress, treatGlobalObjectsAsRoots, captureNumericValue, exposeInternals
        );

        return Script.NO_RET(Domains.HeapProfiler, "stopTrackingHeapObjects", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param reportProgress If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param treatGlobalObjectsAsRoots 
     * If true, a raw snapshot without artificial roots will be generated.
     * Deprecated in favor of <CODE>exposeInternals</CODE>.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Dep-Top>DEPRECATED</B>
     * 
     * @param captureNumericValue If true, numerical values are included in the snapshot
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param exposeInternals If true, exposes internals of the snapshot.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B><B CLASS=Exp-Top>EXPERIMENTAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> takeHeapSnapshot(
            Boolean reportProgress, Boolean treatGlobalObjectsAsRoots, Boolean captureNumericValue,
            Boolean exposeInternals
        )
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            HeapProfiler$$Commands.takeHeapSnapshot$$, "HeapProfiler.takeHeapSnapshot",
            reportProgress, treatGlobalObjectsAsRoots, captureNumericValue, exposeInternals
        );

        return Script.NO_RET(Domains.HeapProfiler, "takeHeapSnapshot", requestJSON);
    }


}