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

Class ProbeInner

java.lang.Object
com.azure.core.management.SubResource
com.azure.resourcemanager.network.fluent.models.ProbeInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.SubResource>
public final class ProbeInner extends com.azure.core.management.SubResource
A load balancer probe.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProbeInner()
    Creates an instance of ProbeInner class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    etag()
    Get the etag property: A unique read-only string that changes whenever the resource is updated.
    static ProbeInner
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ProbeInner from the JsonReader.
    Integer
    intervalInSeconds()
    Get the intervalInSeconds property: The interval, in seconds, for how frequently to probe the endpoint for health status.
    List<com.azure.core.management.SubResource>
    loadBalancingRules()
    Get the loadBalancingRules property: The load balancer rules that use this probe.
    String
    name()
    Get the name property: The name of the resource that is unique within the set of probes used by the load balancer.
    ProbeNoHealthyBackendsBehavior
    noHealthyBackendsBehavior()
    Get the noHealthyBackendsBehavior property: Determines how new connections are handled by the load balancer when all backend instances are probed down.
    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.
    Integer
    port()
    Get the port property: The port for communicating the probe.
    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.
    ProbeProtocol
    protocol()
    Get the protocol property: The protocol of the end point.
    ProvisioningState
    provisioningState()
    Get the provisioningState property: The provisioning state of the probe resource.
    String
    requestPath()
    Get the requestPath property: The URI used for requesting health status from the VM.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    String
    type()
    Get the type property: Type of the resource.
    void
    validate()
    Validates the instance.
    ProbeInner
    withId(String id)
    ProbeInner
    withIntervalInSeconds(Integer intervalInSeconds)
    Set the intervalInSeconds property: The interval, in seconds, for how frequently to probe the endpoint for health status.
    ProbeInner
    withName(String name)
    Set the name property: The name of the resource that is unique within the set of probes used by the load balancer.
    ProbeInner
    withNoHealthyBackendsBehavior(ProbeNoHealthyBackendsBehavior noHealthyBackendsBehavior)
    Set the noHealthyBackendsBehavior property: Determines how new connections are handled by the load balancer when all backend instances are probed down.
    ProbeInner
    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.
    ProbeInner
    withPort(Integer port)
    Set the port property: The port for communicating the probe.
    ProbeInner
    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.
    ProbeInner
    withProtocol(ProbeProtocol protocol)
    Set the protocol property: The protocol of the end point.
    ProbeInner
    withRequestPath(String requestPath)
    Set the requestPath property: The URI used for requesting health status from the VM.

    Methods inherited from class com.azure.core.management.SubResource

    id

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • ProbeInner

      public ProbeInner()
      Creates an instance of ProbeInner class.

  • Method Details

    • name

      public String name()
      Get the name property: The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.
      Returns:
      the name value.

    • withName

      public ProbeInner withName(String name)
      Set the name property: The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.
      Parameters:
      name - the name value to set.
      Returns:
      the ProbeInner object itself.

    • etag

      public String etag()
      Get the etag property: A unique read-only string that changes whenever the resource is updated.
      Returns:
      the etag value.

    • type

      public String type()
      Get the type property: Type of the resource.
      Returns:
      the type value.

    • withId

      public ProbeInner withId(String id)
      Overrides:
      withId in class com.azure.core.management.SubResource

    • 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 ProbeInner 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 ProbeInner object itself.

    • port

      public Integer 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 ProbeInner withPort(Integer 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 ProbeInner 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 ProbeInner 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 ProbeInner 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 ProbeInner 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 ProbeInner 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 ProbeInner 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 ProbeInner 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 ProbeInner 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 ProbeInner 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 ProbeInner 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 ProbeInner 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<com.azure.core.management.SubResource>
      Overrides:
      toJson in class com.azure.core.management.SubResource
      Throws:
      IOException

    • fromJson

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