Share via

ProbeInner Class

  • Reference
Package:
com.azure.resourcemanager.network.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-network:2.44.0

public final class ProbeInner
extends SubResource

A load balancer probe.

Constructor Summary

Constructor Description
ProbeInner()

Creates an instance of ProbeInner class.

Method Summary

Modifier and Type Method and Description
String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.
static ProbeInner fromJson(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<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.
JsonWriter toJson(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 SubResource

fromJson id toJson withId

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ProbeInner

public ProbeInner()

Creates an instance of ProbeInner class.

Method Details

etag

public String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.

Returns:

the etag value.

fromJson

public static ProbeInner fromJson(JsonReader jsonReader)

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.

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.

loadBalancingRules

public List loadBalancingRules()

Get the loadBalancingRules property: The load balancer rules that use this probe.

Returns:

the loadBalancingRules value.

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.

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.

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.

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.

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.

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.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the probe resource.

Returns:

the provisioningState value.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ProbeInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Type of the resource.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withId

public ProbeInner withId(String id)

Overrides:

ProbeInner.withId(String id)

Parameters:

id

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.

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.

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.

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.

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.

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.

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.

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.

Applies to