Package com.azure.resourcemanager.network.models

Class ApplicationGatewayBackendHttpSettings

java.lang.Object
com.azure.core.management.SubResource
com.azure.resourcemanager.network.models.ApplicationGatewayBackendHttpSettings
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.SubResource>
public final class ApplicationGatewayBackendHttpSettings extends com.azure.core.management.SubResource
Backend address pool settings of an application gateway.

  • Constructor Details

    • ApplicationGatewayBackendHttpSettings

      public ApplicationGatewayBackendHttpSettings()
      Creates an instance of ApplicationGatewayBackendHttpSettings class.

  • Method Details

    • name

      public String name()
      Get the name property: Name of the backend http settings that is unique within an Application Gateway.
      Returns:
      the name value.

    • withName

      public ApplicationGatewayBackendHttpSettings withName(String name)
      Set the name property: 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 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 ApplicationGatewayBackendHttpSettings withId(String id)
      Overrides:
      withId in class com.azure.core.management.SubResource

    • port

      public Integer port()
      Get the port property: The destination port on the backend.
      Returns:
      the port value.

    • withPort

      public ApplicationGatewayBackendHttpSettings withPort(Integer port)
      Set the port property: 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 property: The protocol used to communicate with the backend.
      Returns:
      the protocol value.

    • withProtocol

      public ApplicationGatewayBackendHttpSettings withProtocol(ApplicationGatewayProtocol protocol)
      Set the protocol property: The protocol used to communicate with the backend.
      Parameters:
      protocol - the protocol value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettings object itself.

    • cookieBasedAffinity

      public ApplicationGatewayCookieBasedAffinity cookieBasedAffinity()
      Get the cookieBasedAffinity property: Cookie based affinity.
      Returns:
      the cookieBasedAffinity value.

    • withCookieBasedAffinity

      public ApplicationGatewayBackendHttpSettings withCookieBasedAffinity(ApplicationGatewayCookieBasedAffinity cookieBasedAffinity)
      Set the cookieBasedAffinity property: Cookie based affinity.
      Parameters:
      cookieBasedAffinity - the cookieBasedAffinity value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettings object itself.

    • requestTimeout

      public Integer requestTimeout()
      Get the requestTimeout property: 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 the requestTimeout property: 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.azure.core.management.SubResource probe()
      Get the probe property: Probe resource of an application gateway.
      Returns:
      the probe value.

    • withProbe

      public ApplicationGatewayBackendHttpSettings withProbe(com.azure.core.management.SubResource probe)
      Set the probe property: Probe resource of an application gateway.
      Parameters:
      probe - the probe value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettings object itself.

    • authenticationCertificates

      public List<com.azure.core.management.SubResource> authenticationCertificates()
      Get the authenticationCertificates property: Array of references to application gateway authentication certificates.
      Returns:
      the authenticationCertificates value.

    • withAuthenticationCertificates

      public ApplicationGatewayBackendHttpSettings withAuthenticationCertificates(List<com.azure.core.management.SubResource> authenticationCertificates)
      Set the authenticationCertificates property: Array of references to application gateway authentication certificates.
      Parameters:
      authenticationCertificates - the authenticationCertificates value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettings object itself.

    • trustedRootCertificates

      public List<com.azure.core.management.SubResource> trustedRootCertificates()
      Get the trustedRootCertificates property: Array of references to application gateway trusted root certificates.
      Returns:
      the trustedRootCertificates value.

    • withTrustedRootCertificates

      public ApplicationGatewayBackendHttpSettings withTrustedRootCertificates(List<com.azure.core.management.SubResource> trustedRootCertificates)
      Set the trustedRootCertificates property: 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 the connectionDraining property: Connection draining of the backend http settings resource.
      Returns:
      the connectionDraining value.

    • withConnectionDraining

      public ApplicationGatewayBackendHttpSettings withConnectionDraining(ApplicationGatewayConnectionDraining connectionDraining)
      Set the connectionDraining property: 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 the hostname property: Host header to be sent to the backend servers.
      Returns:
      the hostname value.

    • withHostname

      public ApplicationGatewayBackendHttpSettings withHostname(String hostname)
      Set the hostname property: 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 the pickHostnameFromBackendAddress property: 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 the pickHostnameFromBackendAddress property: 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 the affinityCookieName property: Cookie name to use for the affinity cookie.
      Returns:
      the affinityCookieName value.

    • withAffinityCookieName

      public ApplicationGatewayBackendHttpSettings withAffinityCookieName(String affinityCookieName)
      Set the affinityCookieName property: 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 the probeEnabled property: Whether the probe is enabled. Default value is false.
      Returns:
      the probeEnabled value.

    • withProbeEnabled

      public ApplicationGatewayBackendHttpSettings withProbeEnabled(Boolean probeEnabled)
      Set the probeEnabled property: 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 the path property: 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 the path property: 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 ProvisioningState provisioningState()
      Get the provisioningState property: The provisioning state of the backend HTTP settings 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 ApplicationGatewayBackendHttpSettings fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ApplicationGatewayBackendHttpSettings from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ApplicationGatewayBackendHttpSettings 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 ApplicationGatewayBackendHttpSettings.