Package com.oracle.bmc.apmsynthetics.model

Class CreateMonitorDetails.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • displayName

        public CreateMonitorDetails.Builder displayName​(String displayName)
        Unique name that can be edited.

        The name should not contain any confidential information.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • vantagePoints

        public CreateMonitorDetails.Builder vantagePoints​(List<String> vantagePoints)
        A list of public and dedicated vantage points from which to execute the monitor.

        Use /publicVantagePoints to fetch public vantage points, and /dedicatedVantagePoints to fetch dedicated vantage points.

        Parameters:
        vantagePoints - the value to set
        Returns:
        this builder

      • scriptId

        public CreateMonitorDetails.Builder scriptId​(String scriptId)
        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.

        Parameters:
        scriptId - the value to set
        Returns:
        this builder

      • repeatIntervalInSeconds

        public CreateMonitorDetails.Builder repeatIntervalInSeconds​(Integer repeatIntervalInSeconds)
        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.

        Parameters:
        repeatIntervalInSeconds - the value to set
        Returns:
        this builder

      • isRunOnce

        public CreateMonitorDetails.Builder isRunOnce​(Boolean isRunOnce)
        If runOnce is enabled, then the monitor will run once.
        Parameters:
        isRunOnce - the value to set
        Returns:
        this builder

      • timeoutInSeconds

        public CreateMonitorDetails.Builder timeoutInSeconds​(Integer timeoutInSeconds)
        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.

        Parameters:
        timeoutInSeconds - the value to set
        Returns:
        this builder

      • target

        public CreateMonitorDetails.Builder target​(String target)
        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.

        Parameters:
        target - the value to set
        Returns:
        this builder

      • scriptParameters

        public CreateMonitorDetails.Builder scriptParameters​(List<MonitorScriptParameter> scriptParameters)
        List of script parameters in the monitor.

        This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{“paramName”: “userid”, “paramValue”:“testuser”}]

        Parameters:
        scriptParameters - the value to set
        Returns:
        this builder

      • freeformTags

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

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

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

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

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

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • isRunNow

        public CreateMonitorDetails.Builder isRunNow​(Boolean isRunNow)
        If isRunNow is enabled, then the monitor will run immediately.
        Parameters:
        isRunNow - the value to set
        Returns:
        this builder

      • schedulingPolicy

        public CreateMonitorDetails.Builder schedulingPolicy​(SchedulingPolicy schedulingPolicy)
        Scheduling policy to decide the distribution of monitor executions on vantage points.
        Parameters:
        schedulingPolicy - the value to set
        Returns:
        this builder

      • batchIntervalInSeconds

        public CreateMonitorDetails.Builder batchIntervalInSeconds​(Integer batchIntervalInSeconds)
        Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
        Parameters:
        batchIntervalInSeconds - the value to set
        Returns:
        this builder

      • isIPv6

        public CreateMonitorDetails.Builder isIPv6​(Boolean isIPv6)
        If enabled, domain name will resolve to an IPv6 address.
        Parameters:
        isIPv6 - the value to set
        Returns:
        this builder