https://github.com/Azure/azure-sdk-for-java: This package contains Microsoft Azure Network Management SDK. A new set of management libraries are now Generally Available. For documentation on how to use the new libraries, please see https://aka.ms/azsdk/java/mgmt
  • Microsoft 
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
Code generated by Microsoft (R) AutoRest Code Generator.

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 */

package com.microsoft.azure.management.network.implementation;

import com.microsoft.azure.SubResource;
import com.microsoft.azure.management.network.TransportProtocol;
import com.microsoft.azure.management.network.LoadDistribution;
import com.microsoft.azure.management.network.ProvisioningState;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.microsoft.rest.serializer.JsonFlatten;


A load balancing rule for a load balancer.

/**
 * A load balancing rule for a load balancer.
 */
@JsonFlatten
public class LoadBalancingRuleInner extends SubResource {
    
A reference to frontend IP addresses.

/**
     * A reference to frontend IP addresses.
     */
    @JsonProperty(value = "properties.frontendIPConfiguration")
    private SubResource frontendIPConfiguration;

    
A reference to a pool of DIPs. Inbound traffic is randomly load balanced
across IPs in the backend IPs.

/**
     * A reference to a pool of DIPs. Inbound traffic is randomly load balanced
     * across IPs in the backend IPs.
     */
    @JsonProperty(value = "properties.backendAddressPool")
    private SubResource backendAddressPool;

    
The reference to the load balancer probe used by the load balancing
rule.

/**
     * The reference to the load balancer probe used by the load balancing
     * rule.
     */
    @JsonProperty(value = "properties.probe")
    private SubResource probe;

    
The reference to the transport protocol used by the load balancing rule.
Possible values include: 'Udp', 'Tcp', 'All'.

/**
     * The reference to the transport protocol used by the load balancing rule.
     * Possible values include: 'Udp', 'Tcp', 'All'.
     */
    @JsonProperty(value = "properties.protocol", required = true)
    private TransportProtocol protocol;

    
The load distribution policy for this rule. Possible values include:
'Default', 'SourceIP', 'SourceIPProtocol'.

/**
     * The load distribution policy for this rule. Possible values include:
     * 'Default', 'SourceIP', 'SourceIPProtocol'.
     */
    @JsonProperty(value = "properties.loadDistribution")
    private LoadDistribution loadDistribution;

    
The port for the external endpoint. Port numbers for each rule must be
unique within the Load Balancer. Acceptable values are between 0 and
65534. Note that value 0 enables "Any Port".

/**
     * The port for the external endpoint. Port numbers for each rule must be
     * unique within the Load Balancer. Acceptable values are between 0 and
     * 65534. Note that value 0 enables "Any Port".
     */
    @JsonProperty(value = "properties.frontendPort", required = true)
    private int frontendPort;

    
The port used for internal connections on the endpoint. Acceptable
values are between 0 and 65535. Note that value 0 enables "Any Port".

/**
     * The port used for internal connections on the endpoint. Acceptable
     * values are between 0 and 65535. Note that value 0 enables "Any Port".
     */
    @JsonProperty(value = "properties.backendPort")
    private Integer backendPort;

    
The timeout for the TCP idle connection. The value can be set between 4
and 30 minutes. The default value is 4 minutes. This element is only
used when the protocol is set to TCP.

/**
     * The timeout for the TCP idle connection. The value can be set between 4
     * and 30 minutes. The default value is 4 minutes. This element is only
     * used when the protocol is set to TCP.
     */
    @JsonProperty(value = "properties.idleTimeoutInMinutes")
    private Integer idleTimeoutInMinutes;

    
Configures a virtual machine's endpoint for the floating IP capability
required to configure a SQL AlwaysOn Availability Group. This setting is
required when using the SQL AlwaysOn Availability Groups in SQL server.
This setting can't be changed after you create the endpoint.

/**
     * Configures a virtual machine's endpoint for the floating IP capability
     * required to configure a SQL AlwaysOn Availability Group. This setting is
     * required when using the SQL AlwaysOn Availability Groups in SQL server.
     * This setting can't be changed after you create the endpoint.
     */
    @JsonProperty(value = "properties.enableFloatingIP")
    private Boolean enableFloatingIP;

    
Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected
connection termination. This element is only used when the protocol is
set to TCP.

/**
     * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected
     * connection termination. This element is only used when the protocol is
     * set to TCP.
     */
    @JsonProperty(value = "properties.enableTcpReset")
    private Boolean enableTcpReset;

    
Configures SNAT for the VMs in the backend pool to use the publicIP
address specified in the frontend of the load balancing rule.

/**
     * Configures SNAT for the VMs in the backend pool to use the publicIP
     * address specified in the frontend of the load balancing rule.
     */
    @JsonProperty(value = "properties.disableOutboundSnat")
    private Boolean disableOutboundSnat;

    
The provisioning state of the load balancing rule resource. Possible
values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'.

/**
     * The provisioning state of the load balancing rule resource. Possible
     * values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'.
     */
    @JsonProperty(value = "properties.provisioningState", access = JsonProperty.Access.WRITE_ONLY)
    private ProvisioningState provisioningState;

    
The name of the resource that is unique within the set of load balancing
rules used by the load balancer. This name can be used to access the
resource.

/**
     * The name of the resource that is unique within the set of load balancing
     * rules used by the load balancer. This name can be used to access the
     * resource.
     */
    @JsonProperty(value = "name")
    private String name;

    
A unique read-only string that changes whenever the resource is updated.

/**
     * A unique read-only string that changes whenever the resource is updated.
     */
    @JsonProperty(value = "etag", access = JsonProperty.Access.WRITE_ONLY)
    private String etag;

    
Type of the resource.

/**
     * Type of the resource.
     */
    @JsonProperty(value = "type", access = JsonProperty.Access.WRITE_ONLY)
    private String type;

    
Get a reference to frontend IP addresses.

Returns:the frontendIPConfiguration value
/**
     * Get a reference to frontend IP addresses.
     *
     * @return the frontendIPConfiguration value
     */
    public SubResource frontendIPConfiguration() {
        return this.frontendIPConfiguration;
    }

    
Set a reference to frontend IP addresses.

Params:
  • frontendIPConfiguration – the frontendIPConfiguration value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set a reference to frontend IP addresses.
     *
     * @param frontendIPConfiguration the frontendIPConfiguration value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withFrontendIPConfiguration(SubResource frontendIPConfiguration) {
        this.frontendIPConfiguration = frontendIPConfiguration;
        return this;
    }

    
Get a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.

Returns:the backendAddressPool value
/**
     * Get a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.
     *
     * @return the backendAddressPool value
     */
    public SubResource backendAddressPool() {
        return this.backendAddressPool;
    }

    
Set a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.

Params:
  • backendAddressPool – the backendAddressPool value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.
     *
     * @param backendAddressPool the backendAddressPool value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withBackendAddressPool(SubResource backendAddressPool) {
        this.backendAddressPool = backendAddressPool;
        return this;
    }

    
Get the reference to the load balancer probe used by the load balancing rule.

Returns:the probe value
/**
     * Get the reference to the load balancer probe used by the load balancing rule.
     *
     * @return the probe value
     */
    public SubResource probe() {
        return this.probe;
    }

    
Set the reference to the load balancer probe used by the load balancing rule.

Params:
  • probe – the probe value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set the reference to the load balancer probe used by the load balancing rule.
     *
     * @param probe the probe value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withProbe(SubResource probe) {
        this.probe = probe;
        return this;
    }

    
Get the reference to the transport protocol used by the load balancing rule. Possible values include: 'Udp', 'Tcp', 'All'.

Returns:the protocol value
/**
     * Get the reference to the transport protocol used by the load balancing rule. Possible values include: 'Udp', 'Tcp', 'All'.
     *
     * @return the protocol value
     */
    public TransportProtocol protocol() {
        return this.protocol;
    }

    
Set the reference to the transport protocol used by the load balancing rule. Possible values include: 'Udp', 'Tcp', 'All'.

Params:
  • protocol – the protocol value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set the reference to the transport protocol used by the load balancing rule. Possible values include: 'Udp', 'Tcp', 'All'.
     *
     * @param protocol the protocol value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withProtocol(TransportProtocol protocol) {
        this.protocol = protocol;
        return this;
    }

    
Get the load distribution policy for this rule. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'.

Returns:the loadDistribution value
/**
     * Get the load distribution policy for this rule. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'.
     *
     * @return the loadDistribution value
     */
    public LoadDistribution loadDistribution() {
        return this.loadDistribution;
    }

    
Set the load distribution policy for this rule. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'.

Params:
  • loadDistribution – the loadDistribution value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set the load distribution policy for this rule. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'.
     *
     * @param loadDistribution the loadDistribution value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withLoadDistribution(LoadDistribution loadDistribution) {
        this.loadDistribution = loadDistribution;
        return this;
    }

    
Get the port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".

Returns:the frontendPort value
/**
     * Get the port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".
     *
     * @return the frontendPort value
     */
    public int frontendPort() {
        return this.frontendPort;
    }

    
Set the port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".

Params:
  • frontendPort – the frontendPort value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set the port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".
     *
     * @param frontendPort the frontendPort value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withFrontendPort(int frontendPort) {
        this.frontendPort = frontendPort;
        return this;
    }

    
Get the port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".

Returns:the backendPort value
/**
     * Get the port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".
     *
     * @return the backendPort value
     */
    public Integer backendPort() {
        return this.backendPort;
    }

    
Set the port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".

Params:
  • backendPort – the backendPort value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set the port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".
     *
     * @param backendPort the backendPort value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withBackendPort(Integer backendPort) {
        this.backendPort = backendPort;
        return this;
    }

    
Get the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Returns:the idleTimeoutInMinutes value
/**
     * Get the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.
     *
     * @return the idleTimeoutInMinutes value
     */
    public Integer idleTimeoutInMinutes() {
        return this.idleTimeoutInMinutes;
    }

    
Set the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Params:
  • idleTimeoutInMinutes – the idleTimeoutInMinutes value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.
     *
     * @param idleTimeoutInMinutes the idleTimeoutInMinutes value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withIdleTimeoutInMinutes(Integer idleTimeoutInMinutes) {
        this.idleTimeoutInMinutes = idleTimeoutInMinutes;
        return this;
    }

    
Get configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Returns:the enableFloatingIP value
/**
     * Get configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.
     *
     * @return the enableFloatingIP value
     */
    public Boolean enableFloatingIP() {
        return this.enableFloatingIP;
    }

    
Set configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Params:
  • enableFloatingIP – the enableFloatingIP value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.
     *
     * @param enableFloatingIP the enableFloatingIP value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withEnableFloatingIP(Boolean enableFloatingIP) {
        this.enableFloatingIP = enableFloatingIP;
        return this;
    }

    
Get receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Returns:the enableTcpReset value
/**
     * Get receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
     *
     * @return the enableTcpReset value
     */
    public Boolean enableTcpReset() {
        return this.enableTcpReset;
    }

    
Set receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Params:
  • enableTcpReset – the enableTcpReset value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
     *
     * @param enableTcpReset the enableTcpReset value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withEnableTcpReset(Boolean enableTcpReset) {
        this.enableTcpReset = enableTcpReset;
        return this;
    }

    
Get configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.

Returns:the disableOutboundSnat value
/**
     * Get configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.
     *
     * @return the disableOutboundSnat value
     */
    public Boolean disableOutboundSnat() {
        return this.disableOutboundSnat;
    }

    
Set configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.

Params:
  • disableOutboundSnat – the disableOutboundSnat value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.
     *
     * @param disableOutboundSnat the disableOutboundSnat value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withDisableOutboundSnat(Boolean disableOutboundSnat) {
        this.disableOutboundSnat = disableOutboundSnat;
        return this;
    }

    
Get the provisioning state of the load balancing rule resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'.

Returns:the provisioningState value
/**
     * Get the provisioning state of the load balancing rule resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'.
     *
     * @return the provisioningState value
     */
    public ProvisioningState provisioningState() {
        return this.provisioningState;
    }

    
Get the name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.

Returns:the name value
/**
     * Get the name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.
     *
     * @return the name value
     */
    public String name() {
        return this.name;
    }

    
Set the name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.

Params:
  • name – the name value to set
Returns:the LoadBalancingRuleInner object itself.
/**
     * Set the name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.
     *
     * @param name the name value to set
     * @return the LoadBalancingRuleInner object itself.
     */
    public LoadBalancingRuleInner withName(String name) {
        this.name = name;
        return this;
    }

    
Get a unique read-only string that changes whenever the resource is updated.

Returns:the etag value
/**
     * Get a unique read-only string that changes whenever the resource is updated.
     *
     * @return the etag value
     */
    public String etag() {
        return this.etag;
    }

    
Get type of the resource.

Returns:the type value
/**
     * Get type of the resource.
     *
     * @return the type value
     */
    public String type() {
        return this.type;
    }

}