@Generated(value="OracleSDKGenerator", comments="API Version: 20200630") public final class Monitor extends Object
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
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Monitor.Builder |
| Constructor and Description |
|---|
Monitor(String id,
String displayName,
MonitorTypes monitorType,
List<VantagePointInfo> vantagePoints,
Integer vantagePointCount,
String scriptId,
String scriptName,
MonitorStatus status,
Integer repeatIntervalInSeconds,
Boolean isRunOnce,
Integer timeoutInSeconds,
String target,
List<MonitorScriptParameterInfo> scriptParameters,
MonitorConfiguration configuration,
Date timeCreated,
Date timeUpdated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Monitor.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
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.
|
String |
getId()
The OCID of the monitor.
|
Boolean |
getIsRunOnce()
If runOnce is enabled, then the monitor will run once.
|
MonitorTypes |
getMonitorType()
Type of the monitor.
|
Integer |
getRepeatIntervalInSeconds()
Interval in seconds after the start time when the job should be repeated.
|
String |
getScriptId()
The OCID of the script.
|
String |
getScriptName()
Name of the script.
|
List<MonitorScriptParameterInfo> |
getScriptParameters()
List of script parameters.
|
MonitorStatus |
getStatus()
Enables or disables the monitor.
|
String |
getTarget()
Specify the endpoint on which to run the monitor.
|
Date |
getTimeCreated()
The time the resource was created, expressed in RFC 3339
timestamp format.
|
Integer |
getTimeoutInSeconds()
Timeout in seconds.
|
Date |
getTimeUpdated()
The time the resource was updated, expressed in RFC 3339
timestamp format.
|
Integer |
getVantagePointCount()
Number of vantage points where monitor is running.
|
List<VantagePointInfo> |
getVantagePoints()
List of public and dedicated vantage points where the monitor is running.
|
int |
hashCode() |
Monitor.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","displayName","monitorType","vantagePoints","vantagePointCount","scriptId","scriptName","status","repeatIntervalInSeconds","isRunOnce","timeoutInSeconds","target","scriptParameters","configuration","timeCreated","timeUpdated","freeformTags","definedTags"}) @Deprecated public Monitor(String id, String displayName, MonitorTypes monitorType, List<VantagePointInfo> vantagePoints, Integer vantagePointCount, String scriptId, String scriptName, MonitorStatus status, Integer repeatIntervalInSeconds, Boolean isRunOnce, Integer timeoutInSeconds, String target, List<MonitorScriptParameterInfo> scriptParameters, MonitorConfiguration configuration, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static Monitor.Builder builder()
Create a new builder.
public Monitor.Builder toBuilder()
public String getDisplayName()
Unique name that can be edited. The name should not contain any confidential information.
public MonitorTypes getMonitorType()
Type of the monitor.
public List<VantagePointInfo> getVantagePoints()
List of public and dedicated vantage points where the monitor is running.
public Integer getVantagePointCount()
Number of vantage points where monitor is running.
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 String getScriptName()
Name of the script.
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. 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.
public String getTarget()
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.
public List<MonitorScriptParameterInfo> getScriptParameters()
List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, “isSecret”: false, “isOverwritten”: false}]
public MonitorConfiguration getConfiguration()
public Date getTimeCreated()
The time the resource was created, expressed in RFC 3339
timestamp format.
Example: 2020-02-12T22:47:12.613Z
public Date getTimeUpdated()
The time the resource was updated, expressed in RFC 3339
timestamp format.
Example: 2020-02-13T22:47:12.613Z
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"}}
Copyright © 2016–2022. All rights reserved.