LoadBalancerDescription (AWS Java SDK :: Services :: Elastic Load Balancing 2.21.10 API)

java.lang.Object
- software.amazon.awssdk.services.elasticloadbalancing.model.LoadBalancerDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<LoadBalancerDescription.Builder,LoadBalancerDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class LoadBalancerDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LoadBalancerDescription.Builder,LoadBalancerDescription>

Information about a load balancer.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LoadBalancerDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LoadBalancerDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`availabilityZones()` The Availability Zones for the load balancer.
`List<BackendServerDescription>`	`backendServerDescriptions()` Information about your EC2 instances.
`static LoadBalancerDescription.Builder`	`builder()`
`String`	`canonicalHostedZoneName()` The DNS name of the load balancer.
`String`	`canonicalHostedZoneNameID()` The ID of the Amazon Route 53 hosted zone for the load balancer.
`Instant`	`createdTime()` The date and time the load balancer was created.
`String`	`dnsName()` The DNS name of the load balancer.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAvailabilityZones()` For responses, this returns true if the service returned a value for the AvailabilityZones property.
`boolean`	`hasBackendServerDescriptions()` For responses, this returns true if the service returned a value for the BackendServerDescriptions property.
`int`	`hashCode()`
`boolean`	`hasInstances()` For responses, this returns true if the service returned a value for the Instances property.
`boolean`	`hasListenerDescriptions()` For responses, this returns true if the service returned a value for the ListenerDescriptions property.
`boolean`	`hasSecurityGroups()` For responses, this returns true if the service returned a value for the SecurityGroups property.
`boolean`	`hasSubnets()` For responses, this returns true if the service returned a value for the Subnets property.
`HealthCheck`	`healthCheck()` Information about the health checks conducted on the load balancer.
`List<Instance>`	`instances()` The IDs of the instances for the load balancer.
`List<ListenerDescription>`	`listenerDescriptions()` The listeners for the load balancer.
`String`	`loadBalancerName()` The name of the load balancer.
`Policies`	`policies()` The policies defined for the load balancer.
`String`	`scheme()` The type of load balancer.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()` The security groups for the load balancer.
`static Class<? extends LoadBalancerDescription.Builder>`	`serializableBuilderClass()`
`SourceSecurityGroup`	`sourceSecurityGroup()` The security group for the load balancer, which you can use as part of your inbound rules for your registered instances.
`List<String>`	`subnets()` The IDs of the subnets for the load balancer.
`LoadBalancerDescription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcId()` The ID of the VPC for the load balancer.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - loadBalancerName
```
public final String loadBalancerName()
```
    The name of the load balancer.
    
    Returns:
    
    The name of the load balancer.
  - dnsName
```
public final String dnsName()
```
    The DNS name of the load balancer.
    
    Returns:
    
    The DNS name of the load balancer.
  - canonicalHostedZoneName
```
public final String canonicalHostedZoneName()
```
    The DNS name of the load balancer.
    
    For more information, see Configure a Custom Domain Name in the Classic Load Balancers Guide.
    
    Returns:
    
    The DNS name of the load balancer.
    
    For more information, see Configure a Custom Domain Name in the Classic Load Balancers Guide.
  - canonicalHostedZoneNameID
```
public final String canonicalHostedZoneNameID()
```
    The ID of the Amazon Route 53 hosted zone for the load balancer.
    
    Returns:
    
    The ID of the Amazon Route 53 hosted zone for the load balancer.
  - hasListenerDescriptions
```
public final boolean hasListenerDescriptions()
```
    For responses, this returns true if the service returned a value for the ListenerDescriptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - listenerDescriptions
```
public final List<ListenerDescription> listenerDescriptions()
```
    The listeners for the load balancer.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasListenerDescriptions() method.
    
    Returns:
    
    The listeners for the load balancer.
  - policies
```
public final Policies policies()
```
    The policies defined for the load balancer.
    
    Returns:
    
    The policies defined for the load balancer.
  - hasBackendServerDescriptions
```
public final boolean hasBackendServerDescriptions()
```
    For responses, this returns true if the service returned a value for the BackendServerDescriptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - backendServerDescriptions
```
public final List<BackendServerDescription> backendServerDescriptions()
```
    Information about your EC2 instances.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBackendServerDescriptions() method.
    
    Returns:
    
    Information about your EC2 instances.
  - hasAvailabilityZones
```
public final boolean hasAvailabilityZones()
```
    For responses, this returns true if the service returned a value for the AvailabilityZones property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - availabilityZones
```
public final List<String> availabilityZones()
```
    The Availability Zones for the load balancer.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAvailabilityZones() method.
    
    Returns:
    
    The Availability Zones for the load balancer.
  - hasSubnets
```
public final boolean hasSubnets()
```
    For responses, this returns true if the service returned a value for the Subnets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - subnets
```
public final List<String> subnets()
```
    The IDs of the subnets for the load balancer.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnets() method.
    
    Returns:
    
    The IDs of the subnets for the load balancer.
  - vpcId
```
public final String vpcId()
```
    The ID of the VPC for the load balancer.
    
    Returns:
    
    The ID of the VPC for the load balancer.
  - hasInstances
```
public final boolean hasInstances()
```
    For responses, this returns true if the service returned a value for the Instances property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - instances
```
public final List<Instance> instances()
```
    The IDs of the instances for the load balancer.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstances() method.
    
    Returns:
    
    The IDs of the instances for the load balancer.
  - healthCheck
```
public final HealthCheck healthCheck()
```
    Information about the health checks conducted on the load balancer.
    
    Returns:
    
    Information about the health checks conducted on the load balancer.
  - sourceSecurityGroup
```
public final SourceSecurityGroup sourceSecurityGroup()
```
    The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.
    
    Returns:
    
    The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.
  - hasSecurityGroups
```
public final boolean hasSecurityGroups()
```
    For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - securityGroups
```
public final List<String> securityGroups()
```
    The security groups for the load balancer. Valid only for load balancers in a VPC.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.
    
    Returns:
    
    The security groups for the load balancer. Valid only for load balancers in a VPC.
  - createdTime
```
public final Instant createdTime()
```
    The date and time the load balancer was created.
    
    Returns:
    
    The date and time the load balancer was created.
  - scheme
```
public final String scheme()
```
    The type of load balancer. Valid only for load balancers in a VPC.
    
    If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.
    
    If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.
    
    Returns:
    
    The type of load balancer. Valid only for load balancers in a VPC.
    
    If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.
    
    If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.
  - toBuilder
```
public LoadBalancerDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LoadBalancerDescription.Builder,LoadBalancerDescription>
  - builder
```
public static LoadBalancerDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends LoadBalancerDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class LoadBalancerDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

loadBalancerName

dnsName

canonicalHostedZoneName

canonicalHostedZoneNameID

hasListenerDescriptions

listenerDescriptions

policies

hasBackendServerDescriptions

backendServerDescriptions

hasAvailabilityZones

availabilityZones

hasSubnets

subnets

vpcId

hasInstances

instances

healthCheck

sourceSecurityGroup

hasSecurityGroups

securityGroups

createdTime

scheme

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields