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

Class BackendUpdateParameterProperties

java.lang.Object

com.azure.resourcemanager.apimanagement.models.BackendBaseParameters

com.azure.resourcemanager.apimanagement.fluent.models.BackendUpdateParameterProperties

All Implemented Interfaces:

com.azure.json.JsonSerializable<BackendBaseParameters>

public final class BackendUpdateParameterProperties
extends BackendBaseParameters

Parameters supplied to the Update Backend operation.

Constructor Summary

Constructors

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

Method Summary

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

BackendUpdateParameterProperties

public BackendUpdateParameterProperties()

Creates an instance of BackendUpdateParameterProperties class.

Method Details

url

public String url()

Get the url property: Runtime Url of the Backend.

Returns:

the url value.

withUrl

public BackendUpdateParameterProperties withUrl(String url)

Set the url property: Runtime Url of the Backend.

Parameters:

url - the url value to set.

Returns:

the BackendUpdateParameterProperties object itself.

protocol

public BackendProtocol protocol()

Get the protocol property: Backend communication protocol.

Returns:

the protocol value.

withProtocol

public BackendUpdateParameterProperties withProtocol(BackendProtocol protocol)

Set the protocol property: Backend communication protocol.

Parameters:

protocol - the protocol value to set.

Returns:

the BackendUpdateParameterProperties object itself.

withTitle

public BackendUpdateParameterProperties 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 BackendUpdateParameterProperties 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 BackendUpdateParameterProperties 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 BackendUpdateParameterProperties 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 BackendUpdateParameterProperties 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 BackendUpdateParameterProperties 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 BackendUpdateParameterProperties 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 BackendUpdateParameterProperties 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 BackendUpdateParameterProperties 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 BackendUpdateParameterProperties 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 BackendUpdateParameterProperties fromJson(com.azure.json.JsonReader jsonReader)
                                                 throws IOException

Reads an instance of BackendUpdateParameterProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BackendUpdateParameterProperties 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 BackendUpdateParameterProperties.