Probe (Microsoft Azure SDK for Network Management 0.9.7 API)

java.lang.Object
- com.microsoft.azure.management.network.models.ResourceId
- - com.microsoft.azure.management.network.models.ChildResource
  - - com.microsoft.azure.management.network.models.Probe

public class Probe
extends ChildResource

Load balancer Probe

Constructor Summary

Constructors
Constructor and Description
`Probe()` Initializes a new instance of the Probe class.
`Probe(String protocol, int port)` Initializes a new instance of the Probe class with required arguments.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getIntervalInSeconds()` Optional.
`ArrayList<ResourceId>`	`getLoadBalancingRules()` Optional.
`int`	`getNumberOfProbes()` Optional.
`int`	`getPort()` Required.
`String`	`getProtocol()` Required.
`String`	`getProvisioningState()` Optional.
`String`	`getRequestPath()` Optional.
`void`	`setIntervalInSeconds(int intervalInSecondsValue)` Optional.
`void`	`setLoadBalancingRules(ArrayList<ResourceId> loadBalancingRulesValue)` Optional.
`void`	`setNumberOfProbes(int numberOfProbesValue)` Optional.
`void`	`setPort(int portValue)` Required.
`void`	`setProtocol(String protocolValue)` Required.
`void`	`setProvisioningState(String provisioningStateValue)` Optional.
`void`	`setRequestPath(String requestPathValue)` Optional.

Methods inherited from class com.microsoft.azure.management.network.models.ChildResource
getEtag, getName, setEtag, setName

Methods inherited from class com.microsoft.azure.management.network.models.ResourceId
getId, setId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Probe
```
public Probe()
```
    Initializes a new instance of the Probe class.
  - Probe
```
public Probe(String protocol,
             int port)
```
    Initializes a new instance of the Probe class with required arguments.
    
    Parameters:
    
    protocol - Gets or sets the protocol of the end point. Possible values are http pr Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If http is specified,a 200 OK response from the specifies URI is required for the probe to be successful
    
    port - Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive.
- Method Detail
  - getIntervalInSeconds
```
public int getIntervalInSeconds()
```
    Optional. Gets or sets 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.
  - setIntervalInSeconds
```
public void setIntervalInSeconds(int intervalInSecondsValue)
```
    Optional. Gets or sets 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:
    
    intervalInSecondsValue - The IntervalInSeconds value.
  - getLoadBalancingRules
```
public ArrayList<ResourceId> getLoadBalancingRules()
```
    Optional. Gets Load balancer rules that use this probe
    
    Returns:
    
    The LoadBalancingRules value.
  - setLoadBalancingRules
```
public void setLoadBalancingRules(ArrayList<ResourceId> loadBalancingRulesValue)
```
    Optional. Gets Load balancer rules that use this probe
    
    Parameters:
    
    loadBalancingRulesValue - The LoadBalancingRules value.
  - getNumberOfProbes
```
public int getNumberOfProbes()
```
    Optional. Gets or sets the number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endponints to be taken out of rotation faster or slower than the typical times used in Azure.
    
    Returns:
    
    The NumberOfProbes value.
  - setNumberOfProbes
```
public void setNumberOfProbes(int numberOfProbesValue)
```
    Optional. Gets or sets the number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endponints to be taken out of rotation faster or slower than the typical times used in Azure.
    
    Parameters:
    
    numberOfProbesValue - The NumberOfProbes value.
  - getPort
```
public int getPort()
```
    Required. Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive.
    
    Returns:
    
    The Port value.
  - setPort
```
public void setPort(int portValue)
```
    Required. Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive.
    
    Parameters:
    
    portValue - The Port value.
  - getProtocol
```
public String getProtocol()
```
    Required. Gets or sets the protocol of the end point. Possible values are http pr Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If http is specified,a 200 OK response from the specifies URI is required for the probe to be successful
    
    Returns:
    
    The Protocol value.
  - setProtocol
```
public void setProtocol(String protocolValue)
```
    Required. Gets or sets the protocol of the end point. Possible values are http pr Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If http is specified,a 200 OK response from the specifies URI is required for the probe to be successful
    
    Parameters:
    
    protocolValue - The Protocol value.
  - getProvisioningState
```
public String getProvisioningState()
```
    Optional. Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    
    Returns:
    
    The ProvisioningState value.
  - setProvisioningState
```
public void setProvisioningState(String provisioningStateValue)
```
    Optional. Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    
    Parameters:
    
    provisioningStateValue - The ProvisioningState value.
  - getRequestPath
```
public String getRequestPath()
```
    Optional. Gets or sets 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.
  - setRequestPath
```
public void setRequestPath(String requestPathValue)
```
    Optional. Gets or sets 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:
    
    requestPathValue - The RequestPath value.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class Probe

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.azure.management.network.models.ChildResource

Methods inherited from class com.microsoft.azure.management.network.models.ResourceId

Methods inherited from class java.lang.Object

Constructor Detail

Probe

Probe

Method Detail

getIntervalInSeconds

setIntervalInSeconds

getLoadBalancingRules

setLoadBalancingRules

getNumberOfProbes

setNumberOfProbes

getPort

setPort

getProtocol

setProtocol

getProvisioningState

setProvisioningState

getRequestPath

setRequestPath