Class ApplicationGatewayBackendHttpSettingsPropertiesFormat

java.lang.Object
com.azure.resourcemanager.network.fluent.models.ApplicationGatewayBackendHttpSettingsPropertiesFormat
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApplicationGatewayBackendHttpSettingsPropertiesFormat>
public final class ApplicationGatewayBackendHttpSettingsPropertiesFormat extends Object implements com.azure.json.JsonSerializable<ApplicationGatewayBackendHttpSettingsPropertiesFormat>
Properties of Backend address pool settings of an application gateway.

  • Constructor Details

    • ApplicationGatewayBackendHttpSettingsPropertiesFormat

      public ApplicationGatewayBackendHttpSettingsPropertiesFormat()
      Creates an instance of ApplicationGatewayBackendHttpSettingsPropertiesFormat class.

  • Method Details

    • port

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

    • withPort

      public ApplicationGatewayBackendHttpSettingsPropertiesFormat withPort(Integer port)
      Set the port property: The destination port on the backend.
      Parameters:
      port - the port value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

    • protocol

      public ApplicationGatewayProtocol protocol()
      Get the protocol property: The protocol used to communicate with the backend.
      Returns:
      the protocol value.

    • withProtocol

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

    • cookieBasedAffinity

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

    • withCookieBasedAffinity

      public ApplicationGatewayBackendHttpSettingsPropertiesFormat withCookieBasedAffinity(ApplicationGatewayCookieBasedAffinity cookieBasedAffinity)
      Set the cookieBasedAffinity property: Cookie based affinity.
      Parameters:
      cookieBasedAffinity - the cookieBasedAffinity value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

    • connectionDraining

      public ApplicationGatewayConnectionDraining connectionDraining()
      Get the connectionDraining property: Connection draining of the backend http settings resource.
      Returns:
      the connectionDraining value.

    • withConnectionDraining

      public ApplicationGatewayBackendHttpSettingsPropertiesFormat withConnectionDraining(ApplicationGatewayConnectionDraining connectionDraining)
      Set the connectionDraining property: Connection draining of the backend http settings resource.
      Parameters:
      connectionDraining - the connectionDraining value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

    • affinityCookieName

      public String affinityCookieName()
      Get the affinityCookieName property: Cookie name to use for the affinity cookie.
      Returns:
      the affinityCookieName value.

    • withAffinityCookieName

      public ApplicationGatewayBackendHttpSettingsPropertiesFormat withAffinityCookieName(String affinityCookieName)
      Set the affinityCookieName property: Cookie name to use for the affinity cookie.
      Parameters:
      affinityCookieName - the affinityCookieName value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

    • dedicatedBackendConnection

      public Boolean dedicatedBackendConnection()
      Get the dedicatedBackendConnection property: Enable or disable dedicated connection per backend server. Default is set to false.
      Returns:
      the dedicatedBackendConnection value.

    • withDedicatedBackendConnection

      public ApplicationGatewayBackendHttpSettingsPropertiesFormat withDedicatedBackendConnection(Boolean dedicatedBackendConnection)
      Set the dedicatedBackendConnection property: Enable or disable dedicated connection per backend server. Default is set to false.
      Parameters:
      dedicatedBackendConnection - the dedicatedBackendConnection value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

    • validateCertChainAndExpiry

      public Boolean validateCertChainAndExpiry()
      Get the validateCertChainAndExpiry property: Verify or skip both chain and expiry validations of the certificate on the backend server. Default is set to true.
      Returns:
      the validateCertChainAndExpiry value.

    • withValidateCertChainAndExpiry

      public ApplicationGatewayBackendHttpSettingsPropertiesFormat withValidateCertChainAndExpiry(Boolean validateCertChainAndExpiry)
      Set the validateCertChainAndExpiry property: Verify or skip both chain and expiry validations of the certificate on the backend server. Default is set to true.
      Parameters:
      validateCertChainAndExpiry - the validateCertChainAndExpiry value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

    • validateSni

      public Boolean validateSni()
      Get the validateSni property: When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value. Default value is true.
      Returns:
      the validateSni value.

    • withValidateSni

      public ApplicationGatewayBackendHttpSettingsPropertiesFormat withValidateSni(Boolean validateSni)
      Set the validateSni property: When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value. Default value is true.
      Parameters:
      validateSni - the validateSni value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettingsPropertiesFormat object itself.

    • sniName

      public String sniName()
      Get the sniName property: Specify an SNI value to match the common name of the certificate on the backend. By default, the application gateway uses the incoming request’s host header as the SNI. Default value is null.
      Returns:
      the sniName value.

    • withSniName

      public ApplicationGatewayBackendHttpSettingsPropertiesFormat withSniName(String sniName)
      Set the sniName property: Specify an SNI value to match the common name of the certificate on the backend. By default, the application gateway uses the incoming request’s host header as the SNI. Default value is null.
      Parameters:
      sniName - the sniName value to set.
      Returns:
      the ApplicationGatewayBackendHttpSettingsPropertiesFormat 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<ApplicationGatewayBackendHttpSettingsPropertiesFormat>
      Throws:
      IOException

    • fromJson

      public static ApplicationGatewayBackendHttpSettingsPropertiesFormat fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ApplicationGatewayBackendHttpSettingsPropertiesFormat from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ApplicationGatewayBackendHttpSettingsPropertiesFormat 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 ApplicationGatewayBackendHttpSettingsPropertiesFormat.