TargetDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticloadbalancingv2.model.TargetDescription

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TargetDescription
extends Object
implements Serializable, Cloneable

Information about a target.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TargetDescription()

Constructors
Constructor and Description
`TargetDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TargetDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAvailabilityZone()` An Availability Zone or `all`.
`String`	`getId()` The ID of the target.
`Integer`	`getPort()` The port on which the target is listening.
`int`	`hashCode()`
`void`	`setAvailabilityZone(String availabilityZone)` An Availability Zone or `all`.
`void`	`setId(String id)` The ID of the target.
`void`	`setPort(Integer port)` The port on which the target is listening.
`String`	`toString()` Returns a string representation of this object.
`TargetDescription`	`withAvailabilityZone(String availabilityZone)` An Availability Zone or `all`.
`TargetDescription`	`withId(String id)` The ID of the target.
`TargetDescription`	`withPort(Integer port)` The port on which the target is listening.

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

- Constructor Detail
  - TargetDescription
```
public TargetDescription()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.
    
    Parameters:
    
    id - The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.
  - getId
```
public String getId()
```
    The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.
    
    Returns:
    
    The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.
  - withId
```
public TargetDescription withId(String id)
```
    The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.
    
    Parameters:
    
    id - The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPort
```
public void setPort(Integer port)
```
    The port on which the target is listening. Not used if the target is a Lambda function.
    
    Parameters:
    
    port - The port on which the target is listening. Not used if the target is a Lambda function.
  - getPort
```
public Integer getPort()
```
    The port on which the target is listening. Not used if the target is a Lambda function.
    
    Returns:
    
    The port on which the target is listening. Not used if the target is a Lambda function.
  - withPort
```
public TargetDescription withPort(Integer port)
```
    The port on which the target is listening. Not used if the target is a Lambda function.
    
    Parameters:
    
    port - The port on which the target is listening. Not used if the target is a Lambda function.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
    
    This parameter is not supported if the target type of the target group is instance.
    
    If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
    
    With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.
    
    If the target type is lambda, this parameter is optional and the only supported value is all.
    
    Parameters:
    
    availabilityZone - An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
    
    This parameter is not supported if the target type of the target group is instance.
    
    If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
    
    With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.
    
    If the target type is lambda, this parameter is optional and the only supported value is all.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
    
    This parameter is not supported if the target type of the target group is instance.
    
    If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
    
    With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.
    
    If the target type is lambda, this parameter is optional and the only supported value is all.
    
    Returns:
    
    An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
    
    This parameter is not supported if the target type of the target group is instance.
    
    If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
    
    With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.
    
    If the target type is lambda, this parameter is optional and the only supported value is all.
  - withAvailabilityZone
```
public TargetDescription withAvailabilityZone(String availabilityZone)
```
    An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
    
    This parameter is not supported if the target type of the target group is instance.
    
    If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
    
    With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.
    
    If the target type is lambda, this parameter is optional and the only supported value is all.
    
    Parameters:
    
    availabilityZone - An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
    
    This parameter is not supported if the target type of the target group is instance.
    
    If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
    
    With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.
    
    If the target type is lambda, this parameter is optional and the only supported value is all.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TargetDescription clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class TargetDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TargetDescription

Method Detail

setId

getId

withId

setPort

getPort

withPort

setAvailabilityZone

getAvailabilityZone

withAvailabilityZone

toString

equals

hashCode

clone