@Generated(value="OracleSDKGenerator",
comments="API Version: 20200630")
public final class CreateMonitorDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Details of the request body used to create a new monitor.
Note: Objects should always be created or deserialized using the CreateMonitorDetails.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 CreateMonitorDetails.Builder, which maintain a
set of all explicitly set fields called CreateMonitorDetails.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
CreateMonitorDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
CreateMonitorDetails(String displayName,
MonitorTypes monitorType,
List<String> vantagePoints,
String scriptId,
MonitorStatus status,
Integer repeatIntervalInSeconds,
Boolean isRunOnce,
Integer timeoutInSeconds,
String target,
List<MonitorScriptParameter> scriptParameters,
MonitorConfiguration configuration,
AvailabilityConfiguration availabilityConfiguration,
MaintenanceWindowSchedule maintenanceWindowSchedule,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Boolean isRunNow,
SchedulingPolicy schedulingPolicy,
Integer batchIntervalInSeconds,
Boolean isIPv6)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateMonitorDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
AvailabilityConfiguration |
getAvailabilityConfiguration() |
Integer |
getBatchIntervalInSeconds()
Time interval between two runs in round robin batch mode (SchedulingPolicy -
BATCHED_ROUND_ROBIN).
|
MonitorConfiguration |
getConfiguration() |
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
Unique name that can be edited.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
Boolean |
getIsIPv6()
If enabled, domain name will resolve to an IPv6 address.
|
Boolean |
getIsRunNow()
If isRunNow is enabled, then the monitor will run immediately.
|
Boolean |
getIsRunOnce()
If runOnce is enabled, then the monitor will run once.
|
MaintenanceWindowSchedule |
getMaintenanceWindowSchedule() |
MonitorTypes |
getMonitorType()
Type of monitor.
|
Integer |
getRepeatIntervalInSeconds()
Interval in seconds after the start time when the job should be repeated.
|
SchedulingPolicy |
getSchedulingPolicy()
Scheduling policy to decide the distribution of monitor executions on vantage points.
|
String |
getScriptId()
The OCID of the
script.
|
List<MonitorScriptParameter> |
getScriptParameters()
List of script parameters in the monitor.
|
MonitorStatus |
getStatus()
Enables or disables the monitor.
|
String |
getTarget()
Specify the endpoint on which to run the monitor.
|
Integer |
getTimeoutInSeconds()
Timeout in seconds.
|
List<String> |
getVantagePoints()
A list of public and dedicated vantage points from which to execute the monitor.
|
int |
hashCode() |
CreateMonitorDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"displayName","monitorType","vantagePoints","scriptId","status","repeatIntervalInSeconds","isRunOnce","timeoutInSeconds","target","scriptParameters","configuration","availabilityConfiguration","maintenanceWindowSchedule","freeformTags","definedTags","isRunNow","schedulingPolicy","batchIntervalInSeconds","isIPv6"}) public CreateMonitorDetails(String displayName, MonitorTypes monitorType, List<String> vantagePoints, String scriptId, MonitorStatus status, Integer repeatIntervalInSeconds, Boolean isRunOnce, Integer timeoutInSeconds, String target, List<MonitorScriptParameter> scriptParameters, MonitorConfiguration configuration, AvailabilityConfiguration availabilityConfiguration, MaintenanceWindowSchedule maintenanceWindowSchedule, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Boolean isRunNow, SchedulingPolicy schedulingPolicy, Integer batchIntervalInSeconds, Boolean isIPv6)
public static CreateMonitorDetails.Builder builder()
Create a new builder.
public CreateMonitorDetails.Builder toBuilder()
public String getDisplayName()
Unique name that can be edited. The name should not contain any confidential information.
public MonitorTypes getMonitorType()
Type of monitor.
public List<String> getVantagePoints()
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.
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.
public MonitorStatus getStatus()
Enables or disables the monitor.
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.
public Boolean getIsRunOnce()
If runOnce is enabled, then the monitor will run once.
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.
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.
public List<MonitorScriptParameter> getScriptParameters()
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"}]
public MonitorConfiguration getConfiguration()
public AvailabilityConfiguration getAvailabilityConfiguration()
public MaintenanceWindowSchedule getMaintenanceWindowSchedule()
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"}
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"}}
public Boolean getIsRunNow()
If isRunNow is enabled, then the monitor will run immediately.
public SchedulingPolicy getSchedulingPolicy()
Scheduling policy to decide the distribution of monitor executions on vantage points.
public Integer getBatchIntervalInSeconds()
Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
public Boolean getIsIPv6()
If enabled, domain name will resolve to an IPv6 address.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.