Class LoadBalancerDescription

java.lang.Object
software.amazon.awssdk.services.elasticloadbalancing.model.LoadBalancerDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LoadBalancerDescription.Builder,LoadBalancerDescription>
@Generated("software.amazon.awssdk:codegen") public final class LoadBalancerDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LoadBalancerDescription.Builder,LoadBalancerDescription>

Information about a load balancer.

See Also:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LoadBalancerDescription.Builder,LoadBalancerDescription>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.