Package com.oracle.bmc.apmsynthetics.model

Class Monitor

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public final class Monitor
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The information about a monitor.
    Note: Objects should always be created or deserialized using the Monitor.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Monitor.Builder, which maintain a set of all explicitly set fields called Monitor.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the monitor.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        Unique name that can be edited.

        The name should not contain any confidential information.

        Returns:
        the value

      • getMonitorType

        public MonitorTypes getMonitorType()
        Type of monitor.
        Returns:
        the value

      • getVantagePoints

        public List<VantagePointInfo> getVantagePoints()
        List of public, dedicated and onPremise vantage points where the monitor is running.
        Returns:
        the value

      • getVantagePointCount

        public Integer getVantagePointCount()
        Number of vantage points where monitor is running.
        Returns:
        the value

      • getScriptId

        public String getScriptId()
        The OCID of the script.

        scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

        Returns:
        the value

      • getScriptName

        public String getScriptName()
        Name of the script.
        Returns:
        the value

      • getStatus

        public MonitorStatus getStatus()
        Enables or disables the monitor.
        Returns:
        the value

      • getRepeatIntervalInSeconds

        public Integer getRepeatIntervalInSeconds()
        Interval in seconds after the start time when the job should be repeated.

        Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

        Returns:
        the value

      • getIsRunOnce

        public Boolean getIsRunOnce()
        If runOnce is enabled, then the monitor will run once.
        Returns:
        the value

      • getTimeoutInSeconds

        public Integer getTimeoutInSeconds()
        Timeout in seconds.

        If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

        Returns:
        the value

      • getTarget

        public String getTarget()
        Specify the endpoint on which to run the monitor.

        For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.

        Returns:
        the value

      • getScriptParameters

        public List<MonitorScriptParameterInfo> getScriptParameters()
        List of script parameters.

        Example: [{“monitorScriptParameter”: {“paramName”: “userid”, “paramValue”:“testuser”}, “isSecret”: false, “isOverwritten”: false}]

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the resource was created, expressed in RFC 3339 timestamp format.

        Example: 2020-02-12T22:47:12.613Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the resource was updated, expressed in RFC 3339 timestamp format.

        Example: 2020-02-13T22:47:12.613Z

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getIsRunNow

        public Boolean getIsRunNow()
        If isRunNow is enabled, then the monitor will run immediately.
        Returns:
        the value

      • getSchedulingPolicy

        public SchedulingPolicy getSchedulingPolicy()
        Scheduling policy to decide the distribution of monitor executions on vantage points.
        Returns:
        the value

      • getBatchIntervalInSeconds

        public Integer getBatchIntervalInSeconds()
        Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
        Returns:
        the value

      • getIsIPv6

        public Boolean getIsIPv6()
        If enabled, domain name will resolve to an IPv6 address.
        Returns:
        the value

      • getCreatedBy

        public String getCreatedBy()
        Name of the user that created the monitor.
        Returns:
        the value

      • getLastUpdatedBy

        public String getLastUpdatedBy()
        Name of the user that recently updated the monitor.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel