LoadBalancingRuleInner.java
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.network.fluent.models;
import com.azure.core.annotation.Fluent;
import com.azure.core.annotation.JsonFlatten;
import com.azure.core.management.SubResource;
import com.azure.core.util.logging.ClientLogger;
import com.azure.resourcemanager.network.models.LoadDistribution;
import com.azure.resourcemanager.network.models.ProvisioningState;
import com.azure.resourcemanager.network.models.TransportProtocol;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
/** A load balancing rule for a load balancer. */
@JsonFlatten
@Fluent
public class LoadBalancingRuleInner extends SubResource {
@JsonIgnore private final ClientLogger logger = new ClientLogger(LoadBalancingRuleInner.class);
/*
* 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.
*/
@JsonProperty(value = "etag", access = JsonProperty.Access.WRITE_ONLY)
private String etag;
/*
* Type of the resource.
*/
@JsonProperty(value = "type", access = JsonProperty.Access.WRITE_ONLY)
private String type;
/*
* 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.
*/
@JsonProperty(value = "properties.backendAddressPool")
private SubResource backendAddressPool;
/*
* 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.
*/
@JsonProperty(value = "properties.protocol")
private TransportProtocol protocol;
/*
* The load distribution policy for this rule.
*/
@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".
*/
@JsonProperty(value = "properties.frontendPort")
private Integer frontendPort;
/*
* 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.
*/
@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.
*/
@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.
*/
@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.
*/
@JsonProperty(value = "properties.disableOutboundSnat")
private Boolean disableOutboundSnat;
/*
* The provisioning state of the load balancing rule resource.
*/
@JsonProperty(value = "properties.provisioningState", access = JsonProperty.Access.WRITE_ONLY)
private ProvisioningState provisioningState;
/**
* Get the name property: 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 property: 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 the etag property: A unique read-only string that changes whenever the resource is updated.
*
* @return the etag value.
*/
public String etag() {
return this.etag;
}
/**
* Get the type property: Type of the resource.
*
* @return the type value.
*/
public String type() {
return this.type;
}
/**
* Get the frontendIpConfiguration property: A reference to frontend IP addresses.
*
* @return the frontendIpConfiguration value.
*/
public SubResource frontendIpConfiguration() {
return this.frontendIpConfiguration;
}
/**
* Set the frontendIpConfiguration property: 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 the backendAddressPool property: 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 the backendAddressPool property: 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 probe property: 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 probe property: 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 protocol property: The reference to the transport protocol used by the load balancing rule.
*
* @return the protocol value.
*/
public TransportProtocol protocol() {
return this.protocol;
}
/**
* Set the protocol property: The reference to the transport protocol used by the load balancing rule.
*
* @param protocol the protocol value to set.
* @return the LoadBalancingRuleInner object itself.
*/
public LoadBalancingRuleInner withProtocol(TransportProtocol protocol) {
this.protocol = protocol;
return this;
}
/**
* Get the loadDistribution property: The load distribution policy for this rule.
*
* @return the loadDistribution value.
*/
public LoadDistribution loadDistribution() {
return this.loadDistribution;
}
/**
* Set the loadDistribution property: The load distribution policy for this rule.
*
* @param loadDistribution the loadDistribution value to set.
* @return the LoadBalancingRuleInner object itself.
*/
public LoadBalancingRuleInner withLoadDistribution(LoadDistribution loadDistribution) {
this.loadDistribution = loadDistribution;
return this;
}
/**
* Get the frontendPort property: 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 Integer frontendPort() {
return this.frontendPort;
}
/**
* Set the frontendPort property: 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(Integer frontendPort) {
this.frontendPort = frontendPort;
return this;
}
/**
* Get the backendPort property: 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 backendPort property: 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 idleTimeoutInMinutes property: 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 idleTimeoutInMinutes property: 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 the enableFloatingIp property: 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 the enableFloatingIp property: 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 the enableTcpReset property: 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 the enableTcpReset property: 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 the disableOutboundSnat property: 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 the disableOutboundSnat property: 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 provisioningState property: The provisioning state of the load balancing rule resource.
*
* @return the provisioningState value.
*/
public ProvisioningState provisioningState() {
return this.provisioningState;
}
/**
* Validates the instance.
*
* @throws IllegalArgumentException thrown if the instance is not valid.
*/
public void validate() {
}
}