Package com.azure.resourcemanager.apimanagement.models

Class BackendBaseParameters

java.lang.Object
com.azure.resourcemanager.apimanagement.models.BackendBaseParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<BackendBaseParameters>
Direct Known Subclasses:
BackendContractProperties, BackendUpdateParameterProperties
public class BackendBaseParameters extends Object implements com.azure.json.JsonSerializable<BackendBaseParameters>
Backend entity base Parameter set.

  • Constructor Details

    • BackendBaseParameters

      public BackendBaseParameters()
      Creates an instance of BackendBaseParameters class.

  • Method Details

    • title

      public String title()
      Get the title property: Backend Title.
      Returns:
      the title value.

    • withTitle

      public BackendBaseParameters withTitle(String title)
      Set the title property: Backend Title.
      Parameters:
      title - the title value to set.
      Returns:
      the BackendBaseParameters object itself.

    • description

      public String description()
      Get the description property: Backend Description.
      Returns:
      the description value.

    • withDescription

      public BackendBaseParameters withDescription(String description)
      Set the description property: Backend Description.
      Parameters:
      description - the description value to set.
      Returns:
      the BackendBaseParameters object itself.

    • resourceId

      public String resourceId()
      Get the resourceId property: Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
      Returns:
      the resourceId value.

    • withResourceId

      public BackendBaseParameters withResourceId(String resourceId)
      Set the resourceId property: Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
      Parameters:
      resourceId - the resourceId value to set.
      Returns:
      the BackendBaseParameters object itself.

    • properties

      public BackendProperties properties()
      Get the properties property: Backend Properties contract.
      Returns:
      the properties value.

    • withProperties

      public BackendBaseParameters withProperties(BackendProperties properties)
      Set the properties property: Backend Properties contract.
      Parameters:
      properties - the properties value to set.
      Returns:
      the BackendBaseParameters object itself.

    • credentials

      public BackendCredentialsContract credentials()
      Get the credentials property: Backend Credentials Contract Properties.
      Returns:
      the credentials value.

    • withCredentials

      public BackendBaseParameters withCredentials(BackendCredentialsContract credentials)
      Set the credentials property: Backend Credentials Contract Properties.
      Parameters:
      credentials - the credentials value to set.
      Returns:
      the BackendBaseParameters object itself.

    • proxy

      public BackendProxyContract proxy()
      Get the proxy property: Backend gateway Contract Properties.
      Returns:
      the proxy value.

    • withProxy

      public BackendBaseParameters withProxy(BackendProxyContract proxy)
      Set the proxy property: Backend gateway Contract Properties.
      Parameters:
      proxy - the proxy value to set.
      Returns:
      the BackendBaseParameters object itself.

    • tls

      public BackendTlsProperties tls()
      Get the tls property: Backend TLS Properties.
      Returns:
      the tls value.

    • withTls

      public BackendBaseParameters withTls(BackendTlsProperties tls)
      Set the tls property: Backend TLS Properties.
      Parameters:
      tls - the tls value to set.
      Returns:
      the BackendBaseParameters object itself.

    • circuitBreaker

      public BackendCircuitBreaker circuitBreaker()
      Get the circuitBreaker property: Backend Circuit Breaker Configuration.
      Returns:
      the circuitBreaker value.

    • withCircuitBreaker

      public BackendBaseParameters withCircuitBreaker(BackendCircuitBreaker circuitBreaker)
      Set the circuitBreaker property: Backend Circuit Breaker Configuration.
      Parameters:
      circuitBreaker - the circuitBreaker value to set.
      Returns:
      the BackendBaseParameters object itself.

    • pool

      public BackendBaseParametersPool pool()
      Get the pool property: The pool property.
      Returns:
      the pool value.

    • withPool

      public BackendBaseParameters withPool(BackendBaseParametersPool pool)
      Set the pool property: The pool property.
      Parameters:
      pool - the pool value to set.
      Returns:
      the BackendBaseParameters object itself.

    • type

      public BackendType type()
      Get the type property: Type of the backend. A backend can be either Single or Pool.
      Returns:
      the type value.

    • withType

      public BackendBaseParameters withType(BackendType type)
      Set the type property: Type of the backend. A backend can be either Single or Pool.
      Parameters:
      type - the type value to set.
      Returns:
      the BackendBaseParameters object itself.

    • 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<BackendBaseParameters>
      Throws:
      IOException

    • fromJson

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