Class LoadBalancerInfo

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

Information about the Elastic Load Balancing load balancer or target group used in a deployment.

You can use load balancers and target groups in combination. For example, if you have two Classic Load Balancers, and five target groups tied to an Application Load Balancer, you can specify the two Classic Load Balancers in elbInfoList, and the five target groups in targetGroupInfoList.

See Also:

  • Method Details

    • hasElbInfoList

      public final boolean hasElbInfoList()
      For responses, this returns true if the service returned a value for the ElbInfoList 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.

    • elbInfoList

      public final List<ELBInfo> elbInfoList()

      An array that contains information about the load balancers to use for load balancing in a deployment. If you're using Classic Load Balancers, specify those load balancers in this array.

      You can add up to 10 load balancers to the array.

      If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.

      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 hasElbInfoList() method.

      Returns:
      An array that contains information about the load balancers to use for load balancing in a deployment. If you're using Classic Load Balancers, specify those load balancers in this array.

      You can add up to 10 load balancers to the array.

      If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.

    • hasTargetGroupInfoList

      public final boolean hasTargetGroupInfoList()
      For responses, this returns true if the service returned a value for the TargetGroupInfoList 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.

    • targetGroupInfoList

      public final List<TargetGroupInfo> targetGroupInfoList()

      An array that contains information about the target groups to use for load balancing in a deployment. If you're using Application Load Balancers and Network Load Balancers, specify their associated target groups in this array.

      You can add up to 10 target groups to the array.

      If you're using Classic Load Balancers, use the elbInfoList array instead of this one.

      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 hasTargetGroupInfoList() method.

      Returns:
      An array that contains information about the target groups to use for load balancing in a deployment. If you're using Application Load Balancers and Network Load Balancers, specify their associated target groups in this array.

      You can add up to 10 target groups to the array.

      If you're using Classic Load Balancers, use the elbInfoList array instead of this one.

    • hasTargetGroupPairInfoList

      public final boolean hasTargetGroupPairInfoList()
      For responses, this returns true if the service returned a value for the TargetGroupPairInfoList 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.

    • targetGroupPairInfoList

      public final List<TargetGroupPairInfo> targetGroupPairInfoList()

      The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.

      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 hasTargetGroupPairInfoList() method.

      Returns:
      The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.

    • toBuilder

      public LoadBalancerInfo.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<LoadBalancerInfo.Builder,LoadBalancerInfo>
      Returns:
      a builder for type T

    • builder

      public static LoadBalancerInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LoadBalancerInfo.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.