Class BackendContractProperties
java.lang.Object
com.azure.resourcemanager.apimanagement.models.BackendBaseParameters
com.azure.resourcemanager.apimanagement.fluent.models.BackendContractProperties
- All Implemented Interfaces:
com.azure.json.JsonSerializable<BackendBaseParameters>
Parameters supplied to the Create Backend operation.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of BackendContractProperties class. -
Method Summary
Modifier and TypeMethodDescriptionstatic BackendContractPropertiesfromJson(com.azure.json.JsonReader jsonReader) Reads an instance of BackendContractProperties from the JsonReader.protocol()Get the protocol property: Backend communication protocol.com.azure.json.JsonWritertoJson(com.azure.json.JsonWriter jsonWriter) url()Get the url property: Runtime Url of the Backend.voidvalidate()Validates the instance.withCircuitBreaker(BackendCircuitBreaker circuitBreaker) Set the circuitBreaker property: Backend Circuit Breaker Configuration.withCredentials(BackendCredentialsContract credentials) Set the credentials property: Backend Credentials Contract Properties.withDescription(String description) Set the description property: Backend Description.Set the pool property: The pool property.withProperties(BackendProperties properties) Set the properties property: Backend Properties contract.withProtocol(BackendProtocol protocol) Set the protocol property: Backend communication protocol.withProxy(BackendProxyContract proxy) Set the proxy property: Backend gateway Contract Properties.withResourceId(String resourceId) Set the resourceId property: Management Uri of the Resource in External System.Set the title property: Backend Title.Set the tls property: Backend TLS Properties.withType(BackendType type) Set the type property: Type of the backend.Set the url property: Runtime Url of the Backend.Methods inherited from class com.azure.resourcemanager.apimanagement.models.BackendBaseParameters
circuitBreaker, credentials, description, pool, properties, proxy, resourceId, title, tls, typeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
BackendContractProperties
public BackendContractProperties()Creates an instance of BackendContractProperties class.
-
-
Method Details
-
url
Get the url property: Runtime Url of the Backend.- Returns:
- the url value.
-
withUrl
Set the url property: Runtime Url of the Backend.- Parameters:
url- the url value to set.- Returns:
- the BackendContractProperties object itself.
-
protocol
Get the protocol property: Backend communication protocol.- Returns:
- the protocol value.
-
withProtocol
Set the protocol property: Backend communication protocol.- Parameters:
protocol- the protocol value to set.- Returns:
- the BackendContractProperties object itself.
-
withTitle
Set the title property: Backend Title.- Overrides:
withTitlein classBackendBaseParameters- Parameters:
title- the title value to set.- Returns:
- the BackendBaseParameters object itself.
-
withDescription
Set the description property: Backend Description.- Overrides:
withDescriptionin classBackendBaseParameters- Parameters:
description- the description value to set.- Returns:
- the BackendBaseParameters object itself.
-
withResourceId
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.- Overrides:
withResourceIdin classBackendBaseParameters- Parameters:
resourceId- the resourceId value to set.- Returns:
- the BackendBaseParameters object itself.
-
withProperties
Set the properties property: Backend Properties contract.- Overrides:
withPropertiesin classBackendBaseParameters- Parameters:
properties- the properties value to set.- Returns:
- the BackendBaseParameters object itself.
-
withCredentials
Set the credentials property: Backend Credentials Contract Properties.- Overrides:
withCredentialsin classBackendBaseParameters- Parameters:
credentials- the credentials value to set.- Returns:
- the BackendBaseParameters object itself.
-
withProxy
Set the proxy property: Backend gateway Contract Properties.- Overrides:
withProxyin classBackendBaseParameters- Parameters:
proxy- the proxy value to set.- Returns:
- the BackendBaseParameters object itself.
-
withTls
Set the tls property: Backend TLS Properties.- Overrides:
withTlsin classBackendBaseParameters- Parameters:
tls- the tls value to set.- Returns:
- the BackendBaseParameters object itself.
-
withCircuitBreaker
Set the circuitBreaker property: Backend Circuit Breaker Configuration.- Overrides:
withCircuitBreakerin classBackendBaseParameters- Parameters:
circuitBreaker- the circuitBreaker value to set.- Returns:
- the BackendBaseParameters object itself.
-
withPool
Set the pool property: The pool property.- Overrides:
withPoolin classBackendBaseParameters- Parameters:
pool- the pool value to set.- Returns:
- the BackendBaseParameters object itself.
-
withType
Set the type property: Type of the backend. A backend can be either Single or Pool.- Overrides:
withTypein classBackendBaseParameters- Parameters:
type- the type value to set.- Returns:
- the BackendBaseParameters object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validatein classBackendBaseParameters- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
toJson
- Specified by:
toJsonin interfacecom.azure.json.JsonSerializable<BackendBaseParameters>- Overrides:
toJsonin classBackendBaseParameters- Throws:
IOException
-
fromJson
public static BackendContractProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of BackendContractProperties from the JsonReader.- Parameters:
jsonReader- The JsonReader being read.- Returns:
- An instance of BackendContractProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
- Throws:
IllegalStateException- If the deserialized JSON object was missing any required properties.IOException- If an error occurs while reading the BackendContractProperties.
-