ApplicationGatewayBackendHttpSettings (Microsoft Azure Management Libraries for Java 1.30.0)

java.lang.Object
- com.microsoft.azure.SubResource
- - com.microsoft.azure.management.network.ApplicationGatewayBackendHttpSettings

public class ApplicationGatewayBackendHttpSettings
extends com.microsoft.azure.SubResource

Backend address pool settings of an application gateway.

Constructor Summary

Constructors
Constructor and Description

ApplicationGatewayBackendHttpSettings()

Constructors
Constructor and Description
`ApplicationGatewayBackendHttpSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`affinityCookieName()` Get cookie name to use for the affinity cookie.
`List<com.microsoft.azure.SubResource>`	`authenticationCertificates()` Get array of references to application gateway authentication certificates.
`ApplicationGatewayConnectionDraining`	`connectionDraining()` Get connection draining of the backend http settings resource.
`ApplicationGatewayCookieBasedAffinity`	`cookieBasedAffinity()` Get cookie based affinity.
`String`	`etag()` Get a unique read-only string that changes whenever the resource is updated.
`String`	`hostName()` Get host header to be sent to the backend servers.
`String`	`name()` Get name of the backend http settings that is unique within an Application Gateway.
`String`	`path()` Get path which should be used as a prefix for all HTTP requests.
`Boolean`	`pickHostNameFromBackendAddress()` Get whether to pick host header should be picked from the host name of the backend server.
`Integer`	`port()` Get the destination port on the backend.
`com.microsoft.azure.SubResource`	`probe()` Get probe resource of an application gateway.
`Boolean`	`probeEnabled()` Get whether the probe is enabled.
`ApplicationGatewayProtocol`	`protocol()` Get the protocol used to communicate with the backend.
`String`	`provisioningState()` Get provisioning state of the backend http settings resource.
`Integer`	`requestTimeout()` Get request timeout in seconds.
`List<com.microsoft.azure.SubResource>`	`trustedRootCertificates()` Get array of references to application gateway trusted root certificates.
`String`	`type()` Get type of the resource.
`ApplicationGatewayBackendHttpSettings`	`withAffinityCookieName(String affinityCookieName)` Set cookie name to use for the affinity cookie.
`ApplicationGatewayBackendHttpSettings`	`withAuthenticationCertificates(List<com.microsoft.azure.SubResource> authenticationCertificates)` Set array of references to application gateway authentication certificates.
`ApplicationGatewayBackendHttpSettings`	`withConnectionDraining(ApplicationGatewayConnectionDraining connectionDraining)` Set connection draining of the backend http settings resource.
`ApplicationGatewayBackendHttpSettings`	`withCookieBasedAffinity(ApplicationGatewayCookieBasedAffinity cookieBasedAffinity)` Set cookie based affinity.
`ApplicationGatewayBackendHttpSettings`	`withEtag(String etag)` Set a unique read-only string that changes whenever the resource is updated.
`ApplicationGatewayBackendHttpSettings`	`withHostName(String hostName)` Set host header to be sent to the backend servers.
`ApplicationGatewayBackendHttpSettings`	`withName(String name)` Set name of the backend http settings that is unique within an Application Gateway.
`ApplicationGatewayBackendHttpSettings`	`withPath(String path)` Set path which should be used as a prefix for all HTTP requests.
`ApplicationGatewayBackendHttpSettings`	`withPickHostNameFromBackendAddress(Boolean pickHostNameFromBackendAddress)` Set whether to pick host header should be picked from the host name of the backend server.
`ApplicationGatewayBackendHttpSettings`	`withPort(Integer port)` Set the destination port on the backend.
`ApplicationGatewayBackendHttpSettings`	`withProbe(com.microsoft.azure.SubResource probe)` Set probe resource of an application gateway.
`ApplicationGatewayBackendHttpSettings`	`withProbeEnabled(Boolean probeEnabled)` Set whether the probe is enabled.
`ApplicationGatewayBackendHttpSettings`	`withProtocol(ApplicationGatewayProtocol protocol)` Set the protocol used to communicate with the backend.
`ApplicationGatewayBackendHttpSettings`	`withProvisioningState(String provisioningState)` Set provisioning state of the backend http settings resource.
`ApplicationGatewayBackendHttpSettings`	`withRequestTimeout(Integer requestTimeout)` Set request timeout in seconds.
`ApplicationGatewayBackendHttpSettings`	`withTrustedRootCertificates(List<com.microsoft.azure.SubResource> trustedRootCertificates)` Set array of references to application gateway trusted root certificates.
`ApplicationGatewayBackendHttpSettings`	`withType(String type)` Set type of the resource.

Methods inherited from class com.microsoft.azure.SubResource
id, withId

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

- Constructor Detail
  - ApplicationGatewayBackendHttpSettings
```
public ApplicationGatewayBackendHttpSettings()
```
- Method Detail
  - port
```
public Integer port()
```
    Get the destination port on the backend.
    
    Returns:
    
    the port value
  - withPort
```
public ApplicationGatewayBackendHttpSettings withPort(Integer port)
```
    Set the destination port on the backend.
    
    Parameters:
    
    port - the port value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - protocol
```
public ApplicationGatewayProtocol protocol()
```
    Get the protocol used to communicate with the backend. Possible values include: 'Http', 'Https'.
    
    Returns:
    
    the protocol value
  - withProtocol
```
public ApplicationGatewayBackendHttpSettings withProtocol(ApplicationGatewayProtocol protocol)
```
    Set the protocol used to communicate with the backend. Possible values include: 'Http', 'Https'.
    
    Parameters:
    
    protocol - the protocol value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - cookieBasedAffinity
```
public ApplicationGatewayCookieBasedAffinity cookieBasedAffinity()
```
    Get cookie based affinity. Possible values include: 'Enabled', 'Disabled'.
    
    Returns:
    
    the cookieBasedAffinity value
  - withCookieBasedAffinity
```
public ApplicationGatewayBackendHttpSettings withCookieBasedAffinity(ApplicationGatewayCookieBasedAffinity cookieBasedAffinity)
```
    Set cookie based affinity. Possible values include: 'Enabled', 'Disabled'.
    
    Parameters:
    
    cookieBasedAffinity - the cookieBasedAffinity value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - requestTimeout
```
public Integer requestTimeout()
```
    Get request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.
    
    Returns:
    
    the requestTimeout value
  - withRequestTimeout
```
public ApplicationGatewayBackendHttpSettings withRequestTimeout(Integer requestTimeout)
```
    Set request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.
    
    Parameters:
    
    requestTimeout - the requestTimeout value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - probe
```
public com.microsoft.azure.SubResource probe()
```
    Get probe resource of an application gateway.
    
    Returns:
    
    the probe value
  - withProbe
```
public ApplicationGatewayBackendHttpSettings withProbe(com.microsoft.azure.SubResource probe)
```
    Set probe resource of an application gateway.
    
    Parameters:
    
    probe - the probe value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - authenticationCertificates
```
public List<com.microsoft.azure.SubResource> authenticationCertificates()
```
    Get array of references to application gateway authentication certificates.
    
    Returns:
    
    the authenticationCertificates value
  - withAuthenticationCertificates
```
public ApplicationGatewayBackendHttpSettings withAuthenticationCertificates(List<com.microsoft.azure.SubResource> authenticationCertificates)
```
    Set array of references to application gateway authentication certificates.
    
    Parameters:
    
    authenticationCertificates - the authenticationCertificates value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - trustedRootCertificates
```
public List<com.microsoft.azure.SubResource> trustedRootCertificates()
```
    Get array of references to application gateway trusted root certificates.
    
    Returns:
    
    the trustedRootCertificates value
  - withTrustedRootCertificates
```
public ApplicationGatewayBackendHttpSettings withTrustedRootCertificates(List<com.microsoft.azure.SubResource> trustedRootCertificates)
```
    Set array of references to application gateway trusted root certificates.
    
    Parameters:
    
    trustedRootCertificates - the trustedRootCertificates value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - connectionDraining
```
public ApplicationGatewayConnectionDraining connectionDraining()
```
    Get connection draining of the backend http settings resource.
    
    Returns:
    
    the connectionDraining value
  - withConnectionDraining
```
public ApplicationGatewayBackendHttpSettings withConnectionDraining(ApplicationGatewayConnectionDraining connectionDraining)
```
    Set connection draining of the backend http settings resource.
    
    Parameters:
    
    connectionDraining - the connectionDraining value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - hostName
```
public String hostName()
```
    Get host header to be sent to the backend servers.
    
    Returns:
    
    the hostName value
  - withHostName
```
public ApplicationGatewayBackendHttpSettings withHostName(String hostName)
```
    Set host header to be sent to the backend servers.
    
    Parameters:
    
    hostName - the hostName value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - pickHostNameFromBackendAddress
```
public Boolean pickHostNameFromBackendAddress()
```
    Get whether to pick host header should be picked from the host name of the backend server. Default value is false.
    
    Returns:
    
    the pickHostNameFromBackendAddress value
  - withPickHostNameFromBackendAddress
```
public ApplicationGatewayBackendHttpSettings withPickHostNameFromBackendAddress(Boolean pickHostNameFromBackendAddress)
```
    Set whether to pick host header should be picked from the host name of the backend server. Default value is false.
    
    Parameters:
    
    pickHostNameFromBackendAddress - the pickHostNameFromBackendAddress value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - affinityCookieName
```
public String affinityCookieName()
```
    Get cookie name to use for the affinity cookie.
    
    Returns:
    
    the affinityCookieName value
  - withAffinityCookieName
```
public ApplicationGatewayBackendHttpSettings withAffinityCookieName(String affinityCookieName)
```
    Set cookie name to use for the affinity cookie.
    
    Parameters:
    
    affinityCookieName - the affinityCookieName value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - probeEnabled
```
public Boolean probeEnabled()
```
    Get whether the probe is enabled. Default value is false.
    
    Returns:
    
    the probeEnabled value
  - withProbeEnabled
```
public ApplicationGatewayBackendHttpSettings withProbeEnabled(Boolean probeEnabled)
```
    Set whether the probe is enabled. Default value is false.
    
    Parameters:
    
    probeEnabled - the probeEnabled value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - path
```
public String path()
```
    Get path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.
    
    Returns:
    
    the path value
  - withPath
```
public ApplicationGatewayBackendHttpSettings withPath(String path)
```
    Set path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.
    
    Parameters:
    
    path - the path value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - provisioningState
```
public String provisioningState()
```
    Get provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
    
    Returns:
    
    the provisioningState value
  - withProvisioningState
```
public ApplicationGatewayBackendHttpSettings withProvisioningState(String provisioningState)
```
    Set provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
    
    Parameters:
    
    provisioningState - the provisioningState value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - name
```
public String name()
```
    Get name of the backend http settings that is unique within an Application Gateway.
    
    Returns:
    
    the name value
  - withName
```
public ApplicationGatewayBackendHttpSettings withName(String name)
```
    Set name of the backend http settings that is unique within an Application Gateway.
    
    Parameters:
    
    name - the name value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - etag
```
public String etag()
```
    Get a unique read-only string that changes whenever the resource is updated.
    
    Returns:
    
    the etag value
  - withEtag
```
public ApplicationGatewayBackendHttpSettings withEtag(String etag)
```
    Set a unique read-only string that changes whenever the resource is updated.
    
    Parameters:
    
    etag - the etag value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.
  - type
```
public String type()
```
    Get type of the resource.
    
    Returns:
    
    the type value
  - withType
```
public ApplicationGatewayBackendHttpSettings withType(String type)
```
    Set type of the resource.
    
    Parameters:
    
    type - the type value to set
    
    Returns:
    
    the ApplicationGatewayBackendHttpSettings object itself.

/** 
* Copyright (c) Microsoft Corporation. All rights reserved. 
* Licensed under the MIT License. See License.txt in the project root for 
* license information. 
*/

Class ApplicationGatewayBackendHttpSettings

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.azure.SubResource

Methods inherited from class java.lang.Object

Constructor Detail

ApplicationGatewayBackendHttpSettings

Method Detail

port

withPort

protocol

withProtocol

cookieBasedAffinity

withCookieBasedAffinity

requestTimeout

withRequestTimeout

probe

withProbe

authenticationCertificates

withAuthenticationCertificates

trustedRootCertificates

withTrustedRootCertificates

connectionDraining

withConnectionDraining

hostName

withHostName

pickHostNameFromBackendAddress

withPickHostNameFromBackendAddress

affinityCookieName

withAffinityCookieName

probeEnabled

withProbeEnabled

path

withPath

provisioningState

withProvisioningState

name

withName

etag

withEtag

type

withType