TargetGroup (AWS Java SDK :: Services :: Elastic Load Balancing V2 2.20.9 API)

java.lang.Object
- software.amazon.awssdk.services.elasticloadbalancingv2.model.TargetGroup

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

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

Information about a target group.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TargetGroup.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TargetGroup.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLoadBalancerArns()` For responses, this returns true if the service returned a value for the LoadBalancerArns property.
`Boolean`	`healthCheckEnabled()` Indicates whether health checks are enabled.
`Integer`	`healthCheckIntervalSeconds()` The approximate amount of time, in seconds, between health checks of an individual target.
`String`	`healthCheckPath()` The destination for health checks on the targets.
`String`	`healthCheckPort()` The port to use to connect with the target.
`ProtocolEnum`	`healthCheckProtocol()` The protocol to use to connect with the target.
`String`	`healthCheckProtocolAsString()` The protocol to use to connect with the target.
`Integer`	`healthCheckTimeoutSeconds()` The amount of time, in seconds, during which no response means a failed health check.
`Integer`	`healthyThresholdCount()` The number of consecutive health checks successes required before considering an unhealthy target healthy.
`TargetGroupIpAddressTypeEnum`	`ipAddressType()` The type of IP address used for this target group.
`String`	`ipAddressTypeAsString()` The type of IP address used for this target group.
`List<String>`	`loadBalancerArns()` The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
`Matcher`	`matcher()` The HTTP or gRPC codes to use when checking for a successful response from a target.
`Integer`	`port()` The port on which the targets are listening.
`ProtocolEnum`	`protocol()` The protocol to use for routing traffic to the targets.
`String`	`protocolAsString()` The protocol to use for routing traffic to the targets.
`String`	`protocolVersion()` [HTTP/HTTPS protocol] The protocol version.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TargetGroup.Builder>`	`serializableBuilderClass()`
`String`	`targetGroupArn()` The Amazon Resource Name (ARN) of the target group.
`String`	`targetGroupName()` The name of the target group.
`TargetTypeEnum`	`targetType()` The type of target that you must specify when registering targets with this target group.
`String`	`targetTypeAsString()` The type of target that you must specify when registering targets with this target group.
`TargetGroup.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Integer`	`unhealthyThresholdCount()` The number of consecutive health check failures required before considering the target unhealthy.
`String`	`vpcId()` The ID of the VPC for the targets.

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
  - targetGroupArn
```
public final String targetGroupArn()
```
    The Amazon Resource Name (ARN) of the target group.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the target group.
  - targetGroupName
```
public final String targetGroupName()
```
    The name of the target group.
    
    Returns:
    
    The name of the target group.
  - protocol
```
public final ProtocolEnum protocol()
```
    The protocol to use for routing traffic to the targets.
    
    If the service returns an enum value that is not available in the current SDK version, protocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().
    
    Returns:
    
    The protocol to use for routing traffic to the targets.
    
    See Also:
    
    ProtocolEnum
  - protocolAsString
```
public final String protocolAsString()
```
    The protocol to use for routing traffic to the targets.
    
    If the service returns an enum value that is not available in the current SDK version, protocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().
    
    Returns:
    
    The protocol to use for routing traffic to the targets.
    
    See Also:
    
    ProtocolEnum
  - port
```
public final Integer port()
```
    The port on which the targets are listening. Not used if the target is a Lambda function.
    
    Returns:
    
    The port on which the targets are listening. Not used if the target is a Lambda function.
  - vpcId
```
public final String vpcId()
```
    The ID of the VPC for the targets.
    
    Returns:
    
    The ID of the VPC for the targets.
  - healthCheckProtocol
```
public final ProtocolEnum healthCheckProtocol()
```
    The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
    
    If the service returns an enum value that is not available in the current SDK version, healthCheckProtocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().
    
    Returns:
    
    The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
    
    See Also:
    
    ProtocolEnum
  - healthCheckProtocolAsString
```
public final String healthCheckProtocolAsString()
```
    The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
    
    If the service returns an enum value that is not available in the current SDK version, healthCheckProtocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().
    
    Returns:
    
    The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
    
    See Also:
    
    ProtocolEnum
  - healthCheckPort
```
public final String healthCheckPort()
```
    The port to use to connect with the target.
    
    Returns:
    
    The port to use to connect with the target.
  - healthCheckEnabled
```
public final Boolean healthCheckEnabled()
```
    Indicates whether health checks are enabled.
    
    Returns:
    
    Indicates whether health checks are enabled.
  - healthCheckIntervalSeconds
```
public final Integer healthCheckIntervalSeconds()
```
    The approximate amount of time, in seconds, between health checks of an individual target.
    
    Returns:
    
    The approximate amount of time, in seconds, between health checks of an individual target.
  - healthCheckTimeoutSeconds
```
public final Integer healthCheckTimeoutSeconds()
```
    The amount of time, in seconds, during which no response means a failed health check.
    
    Returns:
    
    The amount of time, in seconds, during which no response means a failed health check.
  - healthyThresholdCount
```
public final Integer healthyThresholdCount()
```
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
    
    Returns:
    
    The number of consecutive health checks successes required before considering an unhealthy target healthy.
  - unhealthyThresholdCount
```
public final Integer unhealthyThresholdCount()
```
    The number of consecutive health check failures required before considering the target unhealthy.
    
    Returns:
    
    The number of consecutive health check failures required before considering the target unhealthy.
  - healthCheckPath
```
public final String healthCheckPath()
```
    The destination for health checks on the targets.
    
    Returns:
    
    The destination for health checks on the targets.
  - matcher
```
public final Matcher matcher()
```
    The HTTP or gRPC codes to use when checking for a successful response from a target.
    
    Returns:
    
    The HTTP or gRPC codes to use when checking for a successful response from a target.
  - hasLoadBalancerArns
```
public final boolean hasLoadBalancerArns()
```
    For responses, this returns true if the service returned a value for the LoadBalancerArns 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.
  - loadBalancerArns
```
public final List<String> loadBalancerArns()
```
    The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
    
    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 hasLoadBalancerArns() method.
    
    Returns:
    
    The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
  - targetType
```
public final TargetTypeEnum targetType()
```
    The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).
    
    If the service returns an enum value that is not available in the current SDK version, targetType will return TargetTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().
    
    Returns:
    
    The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).
    
    See Also:
    
    TargetTypeEnum
  - targetTypeAsString
```
public final String targetTypeAsString()
```
    The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).
    
    If the service returns an enum value that is not available in the current SDK version, targetType will return TargetTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().
    
    Returns:
    
    The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).
    
    See Also:
    
    TargetTypeEnum
  - protocolVersion
```
public final String protocolVersion()
```
    [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
    
    Returns:
    
    [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1 , and HTTP2.
  - ipAddressType
```
public final TargetGroupIpAddressTypeEnum ipAddressType()
```
    The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.
    
    If the service returns an enum value that is not available in the current SDK version, ipAddressType will return TargetGroupIpAddressTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().
    
    Returns:
    
    The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.
    
    See Also:
    
    TargetGroupIpAddressTypeEnum
  - ipAddressTypeAsString
```
public final String ipAddressTypeAsString()
```
    The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.
    
    If the service returns an enum value that is not available in the current SDK version, ipAddressType will return TargetGroupIpAddressTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().
    
    Returns:
    
    The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.
    
    See Also:
    
    TargetGroupIpAddressTypeEnum
  - toBuilder
```
public TargetGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TargetGroup.Builder,TargetGroup>
  - builder
```
public static TargetGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TargetGroup.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 TargetGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

targetGroupArn

targetGroupName

protocol

protocolAsString

port

vpcId

healthCheckProtocol

healthCheckProtocolAsString

healthCheckPort

healthCheckEnabled

healthCheckIntervalSeconds

healthCheckTimeoutSeconds

healthyThresholdCount

unhealthyThresholdCount

healthCheckPath

matcher

hasLoadBalancerArns

loadBalancerArns

targetType

targetTypeAsString

protocolVersion

ipAddressType

ipAddressTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields