com.oracle.bmc.apmsynthetics.model

Class UpdateMonitorDetails.Builder

java.lang.Object

com.oracle.bmc.apmsynthetics.model.UpdateMonitorDetails.Builder

Enclosing class:

UpdateMonitorDetails

public static class UpdateMonitorDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
UpdateMonitorDetails.Builder	batchIntervalInSeconds(Integer batchIntervalInSeconds) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).
UpdateMonitorDetails	build()
UpdateMonitorDetails.Builder	configuration(MonitorConfiguration configuration)
UpdateMonitorDetails.Builder	copy(UpdateMonitorDetails model)
UpdateMonitorDetails.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
UpdateMonitorDetails.Builder	displayName(String displayName) Unique name that can be edited.
UpdateMonitorDetails.Builder	freeformTags(Map<String,String> freeformTags) Simple key-value pair that is applied without any predefined name, type or scope.
UpdateMonitorDetails.Builder	isRunNow(Boolean isRunNow) If isRunNow is enabled, then the monitor will run now.
UpdateMonitorDetails.Builder	isRunOnce(Boolean isRunOnce) If runOnce is enabled, then the monitor will run once.
UpdateMonitorDetails.Builder	repeatIntervalInSeconds(Integer repeatIntervalInSeconds) Interval in seconds after the start time when the job should be repeated.
UpdateMonitorDetails.Builder	schedulingPolicy(SchedulingPolicy schedulingPolicy) Scheduling policy on Vantage points.
UpdateMonitorDetails.Builder	scriptId(String scriptId) The OCID of the script.
UpdateMonitorDetails.Builder	scriptParameters(List<MonitorScriptParameter> scriptParameters) List of script parameters in the monitor.
UpdateMonitorDetails.Builder	status(MonitorStatus status) Enables or disables the monitor.
UpdateMonitorDetails.Builder	target(String target) Specify the endpoint on which to run the monitor.
UpdateMonitorDetails.Builder	timeoutInSeconds(Integer timeoutInSeconds) Timeout in seconds.
UpdateMonitorDetails.Builder	vantagePoints(List<String> vantagePoints) A list of public and dedicated vantage points from which to execute the monitor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

displayName

public UpdateMonitorDetails.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 UpdateMonitorDetails.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 UpdateMonitorDetails.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

status

public UpdateMonitorDetails.Builder status(MonitorStatus status)

Enables or disables the monitor.

Parameters:

status - the value to set

Returns:

this builder

repeatIntervalInSeconds

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

Timeout in seconds. Timeout cannot be more than 30% 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 UpdateMonitorDetails.Builder target(String target)

Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

Parameters:

target - the value to set

Returns:

this builder

scriptParameters

public UpdateMonitorDetails.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

configuration

public UpdateMonitorDetails.Builder configuration(MonitorConfiguration configuration)

freeformTags

public UpdateMonitorDetails.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 UpdateMonitorDetails.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 UpdateMonitorDetails.Builder isRunNow(Boolean isRunNow)

If isRunNow is enabled, then the monitor will run now.

Parameters:

isRunNow - the value to set

Returns:

this builder

schedulingPolicy

public UpdateMonitorDetails.Builder schedulingPolicy(SchedulingPolicy schedulingPolicy)

Scheduling policy on Vantage points.

Parameters:

schedulingPolicy - the value to set

Returns:

this builder

batchIntervalInSeconds

public UpdateMonitorDetails.Builder batchIntervalInSeconds(Integer batchIntervalInSeconds)

Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

Parameters:

batchIntervalInSeconds - the value to set

Returns:

this builder

build

public UpdateMonitorDetails build()

copy

public UpdateMonitorDetails.Builder copy(UpdateMonitorDetails model)