Class ApplicationGatewayProbePropertiesFormat
- java.lang.Object
-
- com.azure.resourcemanager.network.fluent.models.ApplicationGatewayProbePropertiesFormat
-
public final class ApplicationGatewayProbePropertiesFormat extends Object
Properties of probe of an application gateway.
-
-
Constructor Summary
Constructors Constructor Description ApplicationGatewayProbePropertiesFormat()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringhost()Get the host property: Host name to send the probe to.Integerinterval()Get the interval property: The probing interval in seconds.ApplicationGatewayProbeHealthResponseMatchmatch()Get the match property: Criterion for classifying a healthy probe response.IntegerminServers()Get the minServers property: Minimum number of servers that are always marked healthy.Stringpath()Get the path property: Relative path of probe.BooleanpickHostnameFromBackendHttpSettings()Get the pickHostnameFromBackendHttpSettings property: Whether the host header should be picked from the backend http settings.Integerport()Get the port property: Custom port which will be used for probing the backend servers.ApplicationGatewayProtocolprotocol()Get the protocol property: The protocol used for the probe.ProvisioningStateprovisioningState()Get the provisioningState property: The provisioning state of the probe resource.Integertimeout()Get the timeout property: The probe timeout in seconds.IntegerunhealthyThreshold()Get the unhealthyThreshold property: The probe retry count.voidvalidate()Validates the instance.ApplicationGatewayProbePropertiesFormatwithHost(String host)Set the host property: Host name to send the probe to.ApplicationGatewayProbePropertiesFormatwithInterval(Integer interval)Set the interval property: The probing interval in seconds.ApplicationGatewayProbePropertiesFormatwithMatch(ApplicationGatewayProbeHealthResponseMatch match)Set the match property: Criterion for classifying a healthy probe response.ApplicationGatewayProbePropertiesFormatwithMinServers(Integer minServers)Set the minServers property: Minimum number of servers that are always marked healthy.ApplicationGatewayProbePropertiesFormatwithPath(String path)Set the path property: Relative path of probe.ApplicationGatewayProbePropertiesFormatwithPickHostnameFromBackendHttpSettings(Boolean pickHostnameFromBackendHttpSettings)Set the pickHostnameFromBackendHttpSettings property: Whether the host header should be picked from the backend http settings.ApplicationGatewayProbePropertiesFormatwithPort(Integer port)Set the port property: Custom port which will be used for probing the backend servers.ApplicationGatewayProbePropertiesFormatwithProtocol(ApplicationGatewayProtocol protocol)Set the protocol property: The protocol used for the probe.ApplicationGatewayProbePropertiesFormatwithTimeout(Integer timeout)Set the timeout property: The probe timeout in seconds.ApplicationGatewayProbePropertiesFormatwithUnhealthyThreshold(Integer unhealthyThreshold)Set the unhealthyThreshold property: The probe retry count.
-
-
-
Method Detail
-
protocol
public ApplicationGatewayProtocol protocol()
Get the protocol property: The protocol used for the probe.- Returns:
- the protocol value.
-
withProtocol
public ApplicationGatewayProbePropertiesFormat withProtocol(ApplicationGatewayProtocol protocol)
Set the protocol property: The protocol used for the probe.- Parameters:
protocol- the protocol value to set.- Returns:
- the ApplicationGatewayProbePropertiesFormat object itself.
-
host
public String host()
Get the host property: Host name to send the probe to.- Returns:
- the host value.
-
withHost
public ApplicationGatewayProbePropertiesFormat withHost(String host)
Set the host property: Host name to send the probe to.- Parameters:
host- the host value to set.- Returns:
- the ApplicationGatewayProbePropertiesFormat object itself.
-
path
public String path()
Get the path property: Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>.- Returns:
- the path value.
-
withPath
public ApplicationGatewayProbePropertiesFormat withPath(String path)
Set the path property: Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>.- Parameters:
path- the path value to set.- Returns:
- the ApplicationGatewayProbePropertiesFormat object itself.
-
interval
public Integer interval()
Get the interval property: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.- Returns:
- the interval value.
-
withInterval
public ApplicationGatewayProbePropertiesFormat withInterval(Integer interval)
Set the interval property: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.- Parameters:
interval- the interval value to set.- Returns:
- the ApplicationGatewayProbePropertiesFormat object itself.
-
timeout
public Integer timeout()
Get the timeout property: The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.- Returns:
- the timeout value.
-
withTimeout
public ApplicationGatewayProbePropertiesFormat withTimeout(Integer timeout)
Set the timeout property: The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.- Parameters:
timeout- the timeout value to set.- Returns:
- the ApplicationGatewayProbePropertiesFormat object itself.
-
unhealthyThreshold
public Integer unhealthyThreshold()
Get the unhealthyThreshold property: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.- Returns:
- the unhealthyThreshold value.
-
withUnhealthyThreshold
public ApplicationGatewayProbePropertiesFormat withUnhealthyThreshold(Integer unhealthyThreshold)
Set the unhealthyThreshold property: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.- Parameters:
unhealthyThreshold- the unhealthyThreshold value to set.- Returns:
- the ApplicationGatewayProbePropertiesFormat object itself.
-
pickHostnameFromBackendHttpSettings
public Boolean pickHostnameFromBackendHttpSettings()
Get the pickHostnameFromBackendHttpSettings property: Whether the host header should be picked from the backend http settings. Default value is false.- Returns:
- the pickHostnameFromBackendHttpSettings value.
-
withPickHostnameFromBackendHttpSettings
public ApplicationGatewayProbePropertiesFormat withPickHostnameFromBackendHttpSettings(Boolean pickHostnameFromBackendHttpSettings)
Set the pickHostnameFromBackendHttpSettings property: Whether the host header should be picked from the backend http settings. Default value is false.- Parameters:
pickHostnameFromBackendHttpSettings- the pickHostnameFromBackendHttpSettings value to set.- Returns:
- the ApplicationGatewayProbePropertiesFormat object itself.
-
minServers
public Integer minServers()
Get the minServers property: Minimum number of servers that are always marked healthy. Default value is 0.- Returns:
- the minServers value.
-
withMinServers
public ApplicationGatewayProbePropertiesFormat withMinServers(Integer minServers)
Set the minServers property: Minimum number of servers that are always marked healthy. Default value is 0.- Parameters:
minServers- the minServers value to set.- Returns:
- the ApplicationGatewayProbePropertiesFormat object itself.
-
match
public ApplicationGatewayProbeHealthResponseMatch match()
Get the match property: Criterion for classifying a healthy probe response.- Returns:
- the match value.
-
withMatch
public ApplicationGatewayProbePropertiesFormat withMatch(ApplicationGatewayProbeHealthResponseMatch match)
Set the match property: Criterion for classifying a healthy probe response.- Parameters:
match- the match value to set.- Returns:
- the ApplicationGatewayProbePropertiesFormat object itself.
-
provisioningState
public ProvisioningState provisioningState()
Get the provisioningState property: The provisioning state of the probe resource.- Returns:
- the provisioningState value.
-
port
public Integer port()
Get the port property: Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.- Returns:
- the port value.
-
withPort
public ApplicationGatewayProbePropertiesFormat withPort(Integer port)
Set the port property: Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.- Parameters:
port- the port value to set.- Returns:
- the ApplicationGatewayProbePropertiesFormat object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
-