Package com.oracle.bmc.healthchecks.model

Class HttpMonitor

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.healthchecks.model.HttpMonitor

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180501")
public final class HttpMonitor
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

This model contains all of the mutable and immutable properties for an HTTP monitor.
Note: Objects should always be created or deserialized using the HttpMonitor.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 HttpMonitor.Builder, which maintain a set of all explicitly set fields called HttpMonitor.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpMonitor.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

HttpMonitor(String id, String resultsUrl, String homeRegion, Date timeCreated, String compartmentId, List<String> targets, List<String> vantagePointNames, Integer port, Integer timeoutInSeconds, HttpProbeProtocol protocol, HttpProbeMethod method, String path, Map<String,String> headers, String displayName, Integer intervalInSeconds, Boolean isEnabled, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static HttpMonitor.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDisplayName()	A user-friendly and mutable name suitable for display in a user interface.
Map<String,String>	getFreeformTags()	Free-form tags for this resource.
Map<String,String>	getHeaders()	A dictionary of HTTP request headers.
String	getHomeRegion()	The region where updates must be made and where results must be fetched from.
String	getId()	The OCID of the resource.
Integer	getIntervalInSeconds()	The monitor interval in seconds.
Boolean	getIsEnabled()	Enables or disables the monitor.
HttpProbeMethod	getMethod()
String	getPath()	The optional URL path to probe, including query parameters.
Integer	getPort()	The port on which to probe endpoints.
HttpProbeProtocol	getProtocol()
String	getResultsUrl()	A URL for fetching the probe results.
List<String>	getTargets()	A list of targets (hostnames or IP addresses) of the probe.
Date	getTimeCreated()	The RFC 3339-formatted creation date and time of the probe.
Integer	getTimeoutInSeconds()	The probe timeout in seconds.
List<String>	getVantagePointNames()	A list of names of vantage points from which to execute the probe.
int	hashCode()
HttpMonitor.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpMonitor

@Deprecated
@ConstructorProperties({"id","resultsUrl","homeRegion","timeCreated","compartmentId","targets","vantagePointNames","port","timeoutInSeconds","protocol","method","path","headers","displayName","intervalInSeconds","isEnabled","freeformTags","definedTags"})
public HttpMonitor(String id,
                   String resultsUrl,
                   String homeRegion,
                   Date timeCreated,
                   String compartmentId,
                   List<String> targets,
                   List<String> vantagePointNames,
                   Integer port,
                   Integer timeoutInSeconds,
                   HttpProbeProtocol protocol,
                   HttpProbeMethod method,
                   String path,
                   Map<String,String> headers,
                   String displayName,
                   Integer intervalInSeconds,
                   Boolean isEnabled,
                   Map<String,String> freeformTags,
                   Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static HttpMonitor.Builder builder()

Create a new builder.

toBuilder

public HttpMonitor.Builder toBuilder()

getId

public String getId()

The OCID of the resource.

Returns:

the value

getResultsUrl

public String getResultsUrl()

A URL for fetching the probe results.

Returns:

the value

getHomeRegion

public String getHomeRegion()

The region where updates must be made and where results must be fetched from.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The RFC 3339-formatted creation date and time of the probe.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

Returns:

the value

getTargets

public List<String> getTargets()

A list of targets (hostnames or IP addresses) of the probe.

Returns:

the value

getVantagePointNames

public List<String> getVantagePointNames()

A list of names of vantage points from which to execute the probe.

Returns:

the value

getPort

public Integer getPort()

The port on which to probe endpoints.

If unspecified, probes will use the default port of their protocol.

Returns:

the value

getTimeoutInSeconds

public Integer getTimeoutInSeconds()

The probe timeout in seconds.

Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.

Returns:

the value

getProtocol

public HttpProbeProtocol getProtocol()

getMethod

public HttpProbeMethod getMethod()

getPath

public String getPath()

The optional URL path to probe, including query parameters.

Returns:

the value

getHeaders

public Map<String,String> getHeaders()

A dictionary of HTTP request headers.

Note:* Monitors and probes do not support the use of the Authorization HTTP header.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly and mutable name suitable for display in a user interface.

Returns:

the value

getIntervalInSeconds

public Integer getIntervalInSeconds()

The monitor interval in seconds.

Valid values: 10, 30, and 60.

Returns:

the value

getIsEnabled

public Boolean getIsEnabled()

Enables or disables the monitor.

Set to ‘true’ to launch monitoring.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Free-form tags for this resource.

Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel