com.microsoft.azure.management.network.implementation.ApplicationGatewayProbeInner Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-mgmt-network Show documentation
Show all versions of azure-mgmt-network Show documentation
This package contains Microsoft Azure Network Management SDK.
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
*/
package com.microsoft.azure.management.network.implementation;
import com.microsoft.azure.management.network.ApplicationGatewayProtocol;
import com.microsoft.azure.management.network.ApplicationGatewayProbeHealthResponseMatch;
import com.microsoft.azure.management.network.ProvisioningState;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.microsoft.rest.serializer.JsonFlatten;
import com.microsoft.azure.SubResource;
/**
* Probe of the application gateway.
*/
@JsonFlatten
public class ApplicationGatewayProbeInner extends SubResource {
/**
* The protocol used for the probe. Possible values include: 'Http',
* 'Https'.
*/
@JsonProperty(value = "properties.protocol")
private ApplicationGatewayProtocol protocol;
/**
* Host name to send the probe to.
*/
@JsonProperty(value = "properties.host")
private String host;
/**
* Relative path of probe. Valid path starts from '/'. Probe is sent to
* <Protocol>://<host>:<port><path>.
*/
@JsonProperty(value = "properties.path")
private String path;
/**
* The probing interval in seconds. This is the time interval between two
* consecutive probes. Acceptable values are from 1 second to 86400
* seconds.
*/
@JsonProperty(value = "properties.interval")
private Integer interval;
/**
* 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.
*/
@JsonProperty(value = "properties.timeout")
private Integer timeout;
/**
* The probe retry count. Backend server is marked down after consecutive
* probe failure count reaches UnhealthyThreshold. Acceptable values are
* from 1 second to 20.
*/
@JsonProperty(value = "properties.unhealthyThreshold")
private Integer unhealthyThreshold;
/**
* Whether the host header should be picked from the backend http settings.
* Default value is false.
*/
@JsonProperty(value = "properties.pickHostNameFromBackendHttpSettings")
private Boolean pickHostNameFromBackendHttpSettings;
/**
* Minimum number of servers that are always marked healthy. Default value
* is 0.
*/
@JsonProperty(value = "properties.minServers")
private Integer minServers;
/**
* Criterion for classifying a healthy probe response.
*/
@JsonProperty(value = "properties.match")
private ApplicationGatewayProbeHealthResponseMatch match;
/**
* The provisioning state of the probe resource. Possible values include:
* 'Succeeded', 'Updating', 'Deleting', 'Failed'.
*/
@JsonProperty(value = "properties.provisioningState", access = JsonProperty.Access.WRITE_ONLY)
private ProvisioningState provisioningState;
/**
* 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.
*/
@JsonProperty(value = "properties.port")
private Integer port;
/**
* Name of the probe that is unique within an Application Gateway.
*/
@JsonProperty(value = "name")
private String name;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
@JsonProperty(value = "etag", access = JsonProperty.Access.WRITE_ONLY)
private String etag;
/**
* Type of the resource.
*/
@JsonProperty(value = "type", access = JsonProperty.Access.WRITE_ONLY)
private String type;
/**
* Get the protocol used for the probe. Possible values include: 'Http', 'Https'.
*
* @return the protocol value
*/
public ApplicationGatewayProtocol protocol() {
return this.protocol;
}
/**
* Set the protocol used for the probe. Possible values include: 'Http', 'Https'.
*
* @param protocol the protocol value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withProtocol(ApplicationGatewayProtocol protocol) {
this.protocol = protocol;
return this;
}
/**
* Get host name to send the probe to.
*
* @return the host value
*/
public String host() {
return this.host;
}
/**
* Set host name to send the probe to.
*
* @param host the host value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withHost(String host) {
this.host = host;
return this;
}
/**
* Get relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>.
*
* @return the path value
*/
public String path() {
return this.path;
}
/**
* Set relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>.
*
* @param path the path value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withPath(String path) {
this.path = path;
return this;
}
/**
* Get the probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.
*
* @return the interval value
*/
public Integer interval() {
return this.interval;
}
/**
* Set the probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.
*
* @param interval the interval value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withInterval(Integer interval) {
this.interval = interval;
return this;
}
/**
* Get 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.
*
* @return the timeout value
*/
public Integer timeout() {
return this.timeout;
}
/**
* Set 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.
*
* @param timeout the timeout value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withTimeout(Integer timeout) {
this.timeout = timeout;
return this;
}
/**
* Get the probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.
*
* @return the unhealthyThreshold value
*/
public Integer unhealthyThreshold() {
return this.unhealthyThreshold;
}
/**
* Set the probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.
*
* @param unhealthyThreshold the unhealthyThreshold value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withUnhealthyThreshold(Integer unhealthyThreshold) {
this.unhealthyThreshold = unhealthyThreshold;
return this;
}
/**
* Get whether the host header should be picked from the backend http settings. Default value is false.
*
* @return the pickHostNameFromBackendHttpSettings value
*/
public Boolean pickHostNameFromBackendHttpSettings() {
return this.pickHostNameFromBackendHttpSettings;
}
/**
* Set whether the host header should be picked from the backend http settings. Default value is false.
*
* @param pickHostNameFromBackendHttpSettings the pickHostNameFromBackendHttpSettings value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withPickHostNameFromBackendHttpSettings(Boolean pickHostNameFromBackendHttpSettings) {
this.pickHostNameFromBackendHttpSettings = pickHostNameFromBackendHttpSettings;
return this;
}
/**
* Get minimum number of servers that are always marked healthy. Default value is 0.
*
* @return the minServers value
*/
public Integer minServers() {
return this.minServers;
}
/**
* Set minimum number of servers that are always marked healthy. Default value is 0.
*
* @param minServers the minServers value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withMinServers(Integer minServers) {
this.minServers = minServers;
return this;
}
/**
* Get criterion for classifying a healthy probe response.
*
* @return the match value
*/
public ApplicationGatewayProbeHealthResponseMatch match() {
return this.match;
}
/**
* Set criterion for classifying a healthy probe response.
*
* @param match the match value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withMatch(ApplicationGatewayProbeHealthResponseMatch match) {
this.match = match;
return this;
}
/**
* Get the provisioning state of the probe resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'.
*
* @return the provisioningState value
*/
public ProvisioningState provisioningState() {
return this.provisioningState;
}
/**
* Get 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.
*
* @return the port value
*/
public Integer port() {
return this.port;
}
/**
* Set 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.
*
* @param port the port value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withPort(Integer port) {
this.port = port;
return this;
}
/**
* Get name of the probe that is unique within an Application Gateway.
*
* @return the name value
*/
public String name() {
return this.name;
}
/**
* Set name of the probe that is unique within an Application Gateway.
*
* @param name the name value to set
* @return the ApplicationGatewayProbeInner object itself.
*/
public ApplicationGatewayProbeInner withName(String name) {
this.name = name;
return this;
}
/**
* Get a unique read-only string that changes whenever the resource is updated.
*
* @return the etag value
*/
public String etag() {
return this.etag;
}
/**
* Get type of the resource.
*
* @return the type value
*/
public String type() {
return this.type;
}
}