Backend Class

Package:

com.azure.resourcemanager.frontdoor.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-frontdoor:1.0.0-beta.3

• java.lang.Object
• • com.azure.resourcemanager.frontdoor.models.Backend

public final class Backend

Backend address of a frontDoor load balancer.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
String	address() Get the address property: Location of the backend (IP address or FQDN).
String	backendHostHeader() Get the backendHostHeader property: The value to use as the host header sent to the backend.
BackendEnabledState	enabledState() Get the enabledState property: Whether to enable use of this backend.
Integer	httpPort() Get the httpPort property: The HTTP TCP port number.
Integer	httpsPort() Get the httpsPort property: The HTTPS TCP port number.
Integer	priority() Get the priority property: Priority to use for load balancing.
PrivateEndpointStatus	privateEndpointStatus() Get the privateEndpointStatus property: The Approval status for the connection to the Private Link.
String	privateLinkAlias() Get the privateLinkAlias property: The Alias of the Private Link resource.
String	privateLinkApprovalMessage() Get the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link.
String	privateLinkLocation() Get the privateLinkLocation property: The location of the Private Link resource.
String	privateLinkResourceId() Get the privateLinkResourceId property: The Resource Id of the Private Link resource.
void	validate() Validates the instance.
Integer	weight() Get the weight property: Weight of this endpoint for load balancing purposes.
Backend	withAddress(String address) Set the address property: Location of the backend (IP address or FQDN).
Backend	withBackendHostHeader(String backendHostHeader) Set the backendHostHeader property: The value to use as the host header sent to the backend.
Backend	withEnabledState(BackendEnabledState enabledState) Set the enabledState property: Whether to enable use of this backend.
Backend	withHttpPort(Integer httpPort) Set the httpPort property: The HTTP TCP port number.
Backend	withHttpsPort(Integer httpsPort) Set the httpsPort property: The HTTPS TCP port number.
Backend	withPriority(Integer priority) Set the priority property: Priority to use for load balancing.
Backend	withPrivateLinkAlias(String privateLinkAlias) Set the privateLinkAlias property: The Alias of the Private Link resource.
Backend	withPrivateLinkApprovalMessage(String privateLinkApprovalMessage) Set the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link.
Backend	withPrivateLinkLocation(String privateLinkLocation) Set the privateLinkLocation property: The location of the Private Link resource.
Backend	withPrivateLinkResourceId(String privateLinkResourceId) Set the privateLinkResourceId property: The Resource Id of the Private Link resource.
Backend	withWeight(Integer weight) Set the weight property: Weight of this endpoint for load balancing purposes.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Backend

public Backend()

Creates an instance of Backend class.

Method Details

address

public String address()

Get the address property: Location of the backend (IP address or FQDN).

Returns:

the address value.

backendHostHeader

public String backendHostHeader()

Get the backendHostHeader property: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.

Returns:

the backendHostHeader value.

enabledState

public BackendEnabledState enabledState()

Get the enabledState property: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'.

Returns:

the enabledState value.

httpPort

public Integer httpPort()

Get the httpPort property: The HTTP TCP port number. Must be between 1 and 65535.

Returns:

the httpPort value.

httpsPort

public Integer httpsPort()

Get the httpsPort property: The HTTPS TCP port number. Must be between 1 and 65535.

Returns:

the httpsPort value.

priority

public Integer priority()

Get the priority property: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.

Returns:

the priority value.

privateEndpointStatus

public PrivateEndpointStatus privateEndpointStatus()

Get the privateEndpointStatus property: The Approval status for the connection to the Private Link.

Returns:

the privateEndpointStatus value.

privateLinkAlias

public String privateLinkAlias()

Get the privateLinkAlias property: The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.

Returns:

the privateLinkAlias value.

privateLinkApprovalMessage

public String privateLinkApprovalMessage()

Get the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link.

Returns:

the privateLinkApprovalMessage value.

privateLinkLocation

public String privateLinkLocation()

Get the privateLinkLocation property: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.

Returns:

the privateLinkLocation value.

privateLinkResourceId

public String privateLinkResourceId()

Get the privateLinkResourceId property: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.

Returns:

the privateLinkResourceId value.

validate

public void validate()

Validates the instance.

weight

public Integer weight()

Get the weight property: Weight of this endpoint for load balancing purposes.

Returns:

the weight value.

withAddress

public Backend withAddress(String address)

Set the address property: Location of the backend (IP address or FQDN).

Parameters:

address - the address value to set.

Returns:

the Backend object itself.

withBackendHostHeader

public Backend withBackendHostHeader(String backendHostHeader)

Set the backendHostHeader property: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.

Parameters:

backendHostHeader - the backendHostHeader value to set.

Returns:

the Backend object itself.

withEnabledState

public Backend withEnabledState(BackendEnabledState enabledState)

Set the enabledState property: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'.

Parameters:

enabledState - the enabledState value to set.

Returns:

the Backend object itself.

withHttpPort

public Backend withHttpPort(Integer httpPort)

Set the httpPort property: The HTTP TCP port number. Must be between 1 and 65535.

Parameters:

httpPort - the httpPort value to set.

Returns:

the Backend object itself.

withHttpsPort

public Backend withHttpsPort(Integer httpsPort)

Set the httpsPort property: The HTTPS TCP port number. Must be between 1 and 65535.

Parameters:

httpsPort - the httpsPort value to set.

Returns:

the Backend object itself.

withPriority

public Backend withPriority(Integer priority)

Set the priority property: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.

Parameters:

priority - the priority value to set.

Returns:

the Backend object itself.

withPrivateLinkAlias

public Backend withPrivateLinkAlias(String privateLinkAlias)

Set the privateLinkAlias property: The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.

Parameters:

privateLinkAlias - the privateLinkAlias value to set.

Returns:

the Backend object itself.

withPrivateLinkApprovalMessage

public Backend withPrivateLinkApprovalMessage(String privateLinkApprovalMessage)

Set the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link.

Parameters:

privateLinkApprovalMessage - the privateLinkApprovalMessage value to set.

Returns:

the Backend object itself.

withPrivateLinkLocation

public Backend withPrivateLinkLocation(String privateLinkLocation)

Set the privateLinkLocation property: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.

Parameters:

privateLinkLocation - the privateLinkLocation value to set.

Returns:

the Backend object itself.

withPrivateLinkResourceId

public Backend withPrivateLinkResourceId(String privateLinkResourceId)

Set the privateLinkResourceId property: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.

Parameters:

privateLinkResourceId - the privateLinkResourceId value to set.

Returns:

the Backend object itself.

withWeight

public Backend withWeight(Integer weight)

Set the weight property: Weight of this endpoint for load balancing purposes.

Parameters:

weight - the weight value to set.

Returns:

the Backend object itself.