Package com.azure.resourcemanager.apimanagement.fluent.models

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>

public final class BackendContractProperties
extends BackendBaseParameters

Parameters supplied to the Create Backend operation.

Constructor Summary

Constructors

Constructor	Description
BackendContractProperties()	Creates an instance of BackendContractProperties class.

Method Summary

Modifier and Type	Method	Description
static BackendContractProperties	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of BackendContractProperties from the JsonReader.
BackendProtocol	protocol()	Get the protocol property: Backend communication protocol.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)
String	url()	Get the url property: Runtime Url of the Backend.
void	validate()	Validates the instance.
BackendContractProperties	withCircuitBreaker(BackendCircuitBreaker circuitBreaker)	Set the circuitBreaker property: Backend Circuit Breaker Configuration.
BackendContractProperties	withCredentials(BackendCredentialsContract credentials)	Set the credentials property: Backend Credentials Contract Properties.
BackendContractProperties	withDescription(String description)	Set the description property: Backend Description.
BackendContractProperties	withPool(BackendBaseParametersPool pool)	Set the pool property: The pool property.
BackendContractProperties	withProperties(BackendProperties properties)	Set the properties property: Backend Properties contract.
BackendContractProperties	withProtocol(BackendProtocol protocol)	Set the protocol property: Backend communication protocol.
BackendContractProperties	withProxy(BackendProxyContract proxy)	Set the proxy property: Backend gateway Contract Properties.
BackendContractProperties	withResourceId(String resourceId)	Set the resourceId property: Management Uri of the Resource in External System.
BackendContractProperties	withTitle(String title)	Set the title property: Backend Title.
BackendContractProperties	withTls(BackendTlsProperties tls)	Set the tls property: Backend TLS Properties.
BackendContractProperties	withType(BackendType type)	Set the type property: Type of the backend.
BackendContractProperties	withUrl(String url)	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, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods 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

public String url()

Get the url property: Runtime Url of the Backend.

Returns:

the url value.

withUrl

public BackendContractProperties withUrl(String url)

Set the url property: Runtime Url of the Backend.

Parameters:

url - the url value to set.

Returns:

the BackendContractProperties object itself.

protocol

public BackendProtocol protocol()

Get the protocol property: Backend communication protocol.

Returns:

the protocol value.

withProtocol

public BackendContractProperties withProtocol(BackendProtocol protocol)

Set the protocol property: Backend communication protocol.

Parameters:

protocol - the protocol value to set.

Returns:

the BackendContractProperties object itself.

withTitle

public BackendContractProperties withTitle(String title)

Set the title property: Backend Title.

Overrides:

withTitle in class BackendBaseParameters

Parameters:

title - the title value to set.

Returns:

the BackendBaseParameters object itself.

withDescription

public BackendContractProperties withDescription(String description)

Set the description property: Backend Description.

Overrides:

withDescription in class BackendBaseParameters

Parameters:

description - the description value to set.

Returns:

the BackendBaseParameters object itself.

withResourceId

public BackendContractProperties 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.

Overrides:

withResourceId in class BackendBaseParameters

Parameters:

resourceId - the resourceId value to set.

Returns:

the BackendBaseParameters object itself.

withProperties

public BackendContractProperties withProperties(BackendProperties properties)

Set the properties property: Backend Properties contract.

Overrides:

withProperties in class BackendBaseParameters

Parameters:

properties - the properties value to set.

Returns:

the BackendBaseParameters object itself.

withCredentials

public BackendContractProperties withCredentials(BackendCredentialsContract credentials)

Set the credentials property: Backend Credentials Contract Properties.

Overrides:

withCredentials in class BackendBaseParameters

Parameters:

credentials - the credentials value to set.

Returns:

the BackendBaseParameters object itself.

withProxy

public BackendContractProperties withProxy(BackendProxyContract proxy)

Set the proxy property: Backend gateway Contract Properties.

Overrides:

withProxy in class BackendBaseParameters

Parameters:

proxy - the proxy value to set.

Returns:

the BackendBaseParameters object itself.

withTls

public BackendContractProperties withTls(BackendTlsProperties tls)

Set the tls property: Backend TLS Properties.

Overrides:

withTls in class BackendBaseParameters

Parameters:

tls - the tls value to set.

Returns:

the BackendBaseParameters object itself.

withCircuitBreaker

public BackendContractProperties withCircuitBreaker(BackendCircuitBreaker circuitBreaker)

Set the circuitBreaker property: Backend Circuit Breaker Configuration.

Overrides:

withCircuitBreaker in class BackendBaseParameters

Parameters:

circuitBreaker - the circuitBreaker value to set.

Returns:

the BackendBaseParameters object itself.

withPool

public BackendContractProperties withPool(BackendBaseParametersPool pool)

Set the pool property: The pool property.

Overrides:

withPool in class BackendBaseParameters

Parameters:

pool - the pool value to set.

Returns:

the BackendBaseParameters object itself.

withType

public BackendContractProperties withType(BackendType type)

Set the type property: Type of the backend. A backend can be either Single or Pool.

Overrides:

withType in class BackendBaseParameters

Parameters:

type - the type value to set.

Returns:

the BackendBaseParameters object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class BackendBaseParameters

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>

Overrides:

toJson in class BackendBaseParameters

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.