@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Monitor.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| 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,
AvailabilityConfiguration availabilityConfiguration,
MaintenanceWindowSchedule maintenanceWindowSchedule,
Date timeCreated,
Date timeUpdated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Boolean isRunNow,
SchedulingPolicy schedulingPolicy,
Integer batchIntervalInSeconds,
Boolean isIPv6,
String createdBy,
String lastUpdatedBy)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Monitor.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() |
String |
getCreatedBy()
Name of the user that created the monitor.
|
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 |
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.
|
String |
getLastUpdatedBy()
Name of the user that recently updated the monitor.
|
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.
|
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, dedicated and onPremise vantage points where the monitor is running.
|
int |
hashCode() |
Monitor.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","monitorType","vantagePoints","vantagePointCount","scriptId","scriptName","status","repeatIntervalInSeconds","isRunOnce","timeoutInSeconds","target","scriptParameters","configuration","availabilityConfiguration","maintenanceWindowSchedule","timeCreated","timeUpdated","freeformTags","definedTags","isRunNow","schedulingPolicy","batchIntervalInSeconds","isIPv6","createdBy","lastUpdatedBy"}) 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, AvailabilityConfiguration availabilityConfiguration, MaintenanceWindowSchedule maintenanceWindowSchedule, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Boolean isRunNow, SchedulingPolicy schedulingPolicy, Integer batchIntervalInSeconds, Boolean isIPv6, String createdBy, String lastUpdatedBy)
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 monitor.
public List<VantagePointInfo> getVantagePoints()
List of public, dedicated and onPremise 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. 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<MonitorScriptParameterInfo> getScriptParameters()
List of script parameters. Example: [{"monitorScriptParameter": {"paramName":
"userid", "paramValue":"testuser"}, “isSecret”: false, “isOverwritten”: false}]
public MonitorConfiguration getConfiguration()
public AvailabilityConfiguration getAvailabilityConfiguration()
public MaintenanceWindowSchedule getMaintenanceWindowSchedule()
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"}}
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 getCreatedBy()
Name of the user that created the monitor.
public String getLastUpdatedBy()
Name of the user that recently updated the monitor.
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.