MonitorConfig Class

  • java.lang.Object
    • com.microsoft.azure.management.trafficmanager.MonitorConfig

public class MonitorConfig

Class containing endpoint monitoring settings in a Traffic Manager profile.

Constructor Summary

Constructor Description
MonitorConfig()

Method Summary

Modifier and Type Method and Description
java.util.List<MonitorConfigCustomHeadersItem> customHeaders()

Get list of custom headers.

java.util.List<MonitorConfigExpectedStatusCodeRangesItem> expectedStatusCodeRanges()

Get list of expected status code ranges.

java.lang.Long intervalInSeconds()

Get the monitor interval for endpoints in this profile.

java.lang.String path()

Get the path relative to the endpoint domain name used to probe for endpoint health.

java.lang.Long port()

Get the TCP port used to probe for endpoint health.

ProfileMonitorStatus profileMonitorStatus()

Get the profile-level monitoring status of the Traffic Manager profile.

MonitorProtocol protocol()

Get the protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.

java.lang.Long timeoutInSeconds()

Get the monitor timeout for endpoints in this profile.

java.lang.Long toleratedNumberOfFailures()

Get the number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.

MonitorConfig withCustomHeaders(List<MonitorConfigCustomHeadersItem> customHeaders)

Set list of custom headers.

MonitorConfig withExpectedStatusCodeRanges(List<MonitorConfigExpectedStatusCodeRangesItem> expectedStatusCodeRanges)

Set list of expected status code ranges.

MonitorConfig withIntervalInSeconds(Long intervalInSeconds)

Set the monitor interval for endpoints in this profile.

MonitorConfig withPath(String path)

Set the path relative to the endpoint domain name used to probe for endpoint health.

MonitorConfig withPort(Long port)

Set the TCP port used to probe for endpoint health.

MonitorConfig withProfileMonitorStatus(ProfileMonitorStatus profileMonitorStatus)

Set the profile-level monitoring status of the Traffic Manager profile.

MonitorConfig withProtocol(MonitorProtocol protocol)

Set the protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.

MonitorConfig withTimeoutInSeconds(Long timeoutInSeconds)

Set the monitor timeout for endpoints in this profile.

MonitorConfig withToleratedNumberOfFailures(Long toleratedNumberOfFailures)

Set the number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

MonitorConfig

public MonitorConfig()

Method Details

customHeaders

public List customHeaders()

Get list of custom headers.

Returns:

the customHeaders value

expectedStatusCodeRanges

public List expectedStatusCodeRanges()

Get list of expected status code ranges.

Returns:

the expectedStatusCodeRanges value

intervalInSeconds

public Long intervalInSeconds()

Get the monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.

Returns:

the intervalInSeconds value

path

public String path()

Get the path relative to the endpoint domain name used to probe for endpoint health.

Returns:

the path value

port

public Long port()

Get the TCP port used to probe for endpoint health.

Returns:

the port value

profileMonitorStatus

public ProfileMonitorStatus profileMonitorStatus()

Get the profile-level monitoring status of the Traffic Manager profile. Possible values include: 'CheckingEndpoints', 'Online', 'Degraded', 'Disabled', 'Inactive'.

Returns:

the profileMonitorStatus value

protocol

public MonitorProtocol protocol()

Get the protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. Possible values include: 'HTTP', 'HTTPS', 'TCP'.

Returns:

the protocol value

timeoutInSeconds

public Long timeoutInSeconds()

Get the monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.

Returns:

the timeoutInSeconds value

toleratedNumberOfFailures

public Long toleratedNumberOfFailures()

Get the number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.

Returns:

the toleratedNumberOfFailures value

withCustomHeaders

public MonitorConfig withCustomHeaders(List customHeaders)

Set list of custom headers.

Parameters:

customHeaders - the customHeaders value to set

Returns:

the MonitorConfig object itself.

withExpectedStatusCodeRanges

public MonitorConfig withExpectedStatusCodeRanges(List expectedStatusCodeRanges)

Set list of expected status code ranges.

Parameters:

expectedStatusCodeRanges - the expectedStatusCodeRanges value to set

Returns:

the MonitorConfig object itself.

withIntervalInSeconds

public MonitorConfig withIntervalInSeconds(Long intervalInSeconds)

Set the monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.

Parameters:

intervalInSeconds - the intervalInSeconds value to set

Returns:

the MonitorConfig object itself.

withPath

public MonitorConfig withPath(String path)

Set the path relative to the endpoint domain name used to probe for endpoint health.

Parameters:

path - the path value to set

Returns:

the MonitorConfig object itself.

withPort

public MonitorConfig withPort(Long port)

Set the TCP port used to probe for endpoint health.

Parameters:

port - the port value to set

Returns:

the MonitorConfig object itself.

withProfileMonitorStatus

public MonitorConfig withProfileMonitorStatus(ProfileMonitorStatus profileMonitorStatus)

Set the profile-level monitoring status of the Traffic Manager profile. Possible values include: 'CheckingEndpoints', 'Online', 'Degraded', 'Disabled', 'Inactive'.

Parameters:

profileMonitorStatus - the profileMonitorStatus value to set

Returns:

the MonitorConfig object itself.

withProtocol

public MonitorConfig withProtocol(MonitorProtocol protocol)

Set the protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. Possible values include: 'HTTP', 'HTTPS', 'TCP'.

Parameters:

protocol - the protocol value to set

Returns:

the MonitorConfig object itself.

withTimeoutInSeconds

public MonitorConfig withTimeoutInSeconds(Long timeoutInSeconds)

Set the monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.

Parameters:

timeoutInSeconds - the timeoutInSeconds value to set

Returns:

the MonitorConfig object itself.

withToleratedNumberOfFailures

public MonitorConfig withToleratedNumberOfFailures(Long toleratedNumberOfFailures)

Set the number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.

Parameters:

toleratedNumberOfFailures - the toleratedNumberOfFailures value to set

Returns:

the MonitorConfig object itself.

Applies to