Package com.azure.resourcemanager.network.fluent.models

Class ProbePropertiesFormat

java.lang.Object
com.azure.resourcemanager.network.fluent.models.ProbePropertiesFormat
All Implemented Interfaces:
com.azure.json.JsonSerializable<ProbePropertiesFormat>
public final class ProbePropertiesFormat extends Object implements com.azure.json.JsonSerializable<ProbePropertiesFormat>
Load balancer probe resource.

  • Constructor Details

    • ProbePropertiesFormat

      public ProbePropertiesFormat()
      Creates an instance of ProbePropertiesFormat class.

  • Method Details

    • loadBalancingRules

      public List<com.azure.core.management.SubResource> loadBalancingRules()
      Get the loadBalancingRules property: The load balancer rules that use this probe.
      Returns:
      the loadBalancingRules value.

    • protocol

      public ProbeProtocol protocol()
      Get the protocol property: The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.
      Returns:
      the protocol value.

    • withProtocol

      public ProbePropertiesFormat withProtocol(ProbeProtocol protocol)
      Set the protocol property: The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.
      Parameters:
      protocol - the protocol value to set.
      Returns:
      the ProbePropertiesFormat object itself.

    • port

      public int port()
      Get the port property: The port for communicating the probe. Possible values range from 1 to 65535, inclusive.
      Returns:
      the port value.

    • withPort

      public ProbePropertiesFormat withPort(int port)
      Set the port property: The port for communicating the probe. Possible values range from 1 to 65535, inclusive.
      Parameters:
      port - the port value to set.
      Returns:
      the ProbePropertiesFormat object itself.

    • intervalInSeconds

      public Integer intervalInSeconds()
      Get the intervalInSeconds property: The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.
      Returns:
      the intervalInSeconds value.

    • withIntervalInSeconds

      public ProbePropertiesFormat withIntervalInSeconds(Integer intervalInSeconds)
      Set the intervalInSeconds property: The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.
      Parameters:
      intervalInSeconds - the intervalInSeconds value to set.
      Returns:
      the ProbePropertiesFormat object itself.

    • noHealthyBackendsBehavior

      public ProbeNoHealthyBackendsBehavior noHealthyBackendsBehavior()
      Get the noHealthyBackendsBehavior property: Determines how new connections are handled by the load balancer when all backend instances are probed down.
      Returns:
      the noHealthyBackendsBehavior value.

    • withNoHealthyBackendsBehavior

      public ProbePropertiesFormat withNoHealthyBackendsBehavior(ProbeNoHealthyBackendsBehavior noHealthyBackendsBehavior)
      Set the noHealthyBackendsBehavior property: Determines how new connections are handled by the load balancer when all backend instances are probed down.
      Parameters:
      noHealthyBackendsBehavior - the noHealthyBackendsBehavior value to set.
      Returns:
      the ProbePropertiesFormat object itself.

    • numberOfProbes

      public Integer numberOfProbes()
      Get the numberOfProbes property: The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.
      Returns:
      the numberOfProbes value.

    • withNumberOfProbes

      public ProbePropertiesFormat withNumberOfProbes(Integer numberOfProbes)
      Set the numberOfProbes property: The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.
      Parameters:
      numberOfProbes - the numberOfProbes value to set.
      Returns:
      the ProbePropertiesFormat object itself.

    • probeThreshold

      public Integer probeThreshold()
      Get the probeThreshold property: The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation.
      Returns:
      the probeThreshold value.

    • withProbeThreshold

      public ProbePropertiesFormat withProbeThreshold(Integer probeThreshold)
      Set the probeThreshold property: The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation.
      Parameters:
      probeThreshold - the probeThreshold value to set.
      Returns:
      the ProbePropertiesFormat object itself.

    • requestPath

      public String requestPath()
      Get the requestPath property: The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.
      Returns:
      the requestPath value.

    • withRequestPath

      public ProbePropertiesFormat withRequestPath(String requestPath)
      Set the requestPath property: The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.
      Parameters:
      requestPath - the requestPath value to set.
      Returns:
      the ProbePropertiesFormat object itself.

    • provisioningState

      public ProvisioningState provisioningState()
      Get the provisioningState property: The provisioning state of the probe resource.
      Returns:
      the provisioningState value.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ProbePropertiesFormat>
      Throws:
      IOException

    • fromJson

      public static ProbePropertiesFormat fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ProbePropertiesFormat from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ProbePropertiesFormat if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the ProbePropertiesFormat.