com.amazonaws.services.autoscaling.model.TrafficSourceIdentifier Maven / Gradle / Ivy
Show all versions of aws-java-sdk-autoscaling Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.autoscaling.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Identifying information for a traffic source.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TrafficSourceIdentifier implements Serializable, Cloneable {
/**
*
* Identifies the traffic source.
*
*
* For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the
* Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will
* be the name of the Classic Load Balancer in this account and Region.
*
*
* For example:
*
*
* -
*
* Application Load Balancer ARN:
* arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
*
*
* -
*
* Classic Load Balancer name: my-classic-load-balancer
*
*
* -
*
* VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
*
*
*
*
* To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load
* Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
*
*
* To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API
* operation.
*
*/
private String identifier;
/**
*
* Provides additional context for the value of Identifier.
*
*
* The following lists the valid values:
*
*
* -
*
* elb if Identifier is the name of a Classic Load Balancer.
*
*
* -
*
* elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer,
* or Network Load Balancer target group.
*
*
* -
*
* vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
*
*
*
*
* Required if the identifier is the name of a Classic Load Balancer.
*
*/
private String type;
/**
*
* Identifies the traffic source.
*
*
* For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the
* Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will
* be the name of the Classic Load Balancer in this account and Region.
*
*
* For example:
*
*
* -
*
* Application Load Balancer ARN:
* arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
*
*
* -
*
* Classic Load Balancer name: my-classic-load-balancer
*
*
* -
*
* VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
*
*
*
*
* To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load
* Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
*
*
* To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API
* operation.
*
*
* @param identifier
* Identifies the traffic source.
*
* For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will
* be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load
* Balancers, this will be the name of the Classic Load Balancer in this account and Region.
*
*
* For example:
*
*
* -
*
* Application Load Balancer ARN:
* arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
*
*
* -
*
* Classic Load Balancer name: my-classic-load-balancer
*
*
* -
*
* VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
*
*
*
*
* To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load
* Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
*
*
* To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.
*/
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
/**
*
* Identifies the traffic source.
*
*
* For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the
* Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will
* be the name of the Classic Load Balancer in this account and Region.
*
*
* For example:
*
*
* -
*
* Application Load Balancer ARN:
* arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
*
*
* -
*
* Classic Load Balancer name: my-classic-load-balancer
*
*
* -
*
* VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
*
*
*
*
* To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load
* Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
*
*
* To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API
* operation.
*
*
* @return Identifies the traffic source.
*
* For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this
* will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load
* Balancers, this will be the name of the Classic Load Balancer in this account and Region.
*
*
* For example:
*
*
* -
*
* Application Load Balancer ARN:
* arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
*
*
* -
*
* Classic Load Balancer name: my-classic-load-balancer
*
*
* -
*
* VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
*
*
*
*
* To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load
* Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
*
*
* To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.
*/
public String getIdentifier() {
return this.identifier;
}
/**
*
* Identifies the traffic source.
*
*
* For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the
* Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will
* be the name of the Classic Load Balancer in this account and Region.
*
*
* For example:
*
*
* -
*
* Application Load Balancer ARN:
* arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
*
*
* -
*
* Classic Load Balancer name: my-classic-load-balancer
*
*
* -
*
* VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
*
*
*
*
* To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load
* Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
*
*
* To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API
* operation.
*
*
* @param identifier
* Identifies the traffic source.
*
* For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will
* be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load
* Balancers, this will be the name of the Classic Load Balancer in this account and Region.
*
*
* For example:
*
*
* -
*
* Application Load Balancer ARN:
* arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
*
*
* -
*
* Classic Load Balancer name: my-classic-load-balancer
*
*
* -
*
* VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
*
*
*
*
* To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load
* Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
*
*
* To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TrafficSourceIdentifier withIdentifier(String identifier) {
setIdentifier(identifier);
return this;
}
/**
*
* Provides additional context for the value of Identifier.
*
*
* The following lists the valid values:
*
*
* -
*
* elb if Identifier is the name of a Classic Load Balancer.
*
*
* -
*
* elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer,
* or Network Load Balancer target group.
*
*
* -
*
* vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
*
*
*
*
* Required if the identifier is the name of a Classic Load Balancer.
*
*
* @param type
* Provides additional context for the value of Identifier.
*
* The following lists the valid values:
*
*
* -
*
* elb if Identifier is the name of a Classic Load Balancer.
*
*
* -
*
* elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load
* Balancer, or Network Load Balancer target group.
*
*
* -
*
* vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
*
*
*
*
* Required if the identifier is the name of a Classic Load Balancer.
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Provides additional context for the value of Identifier.
*
*
* The following lists the valid values:
*
*
* -
*
* elb if Identifier is the name of a Classic Load Balancer.
*
*
* -
*
* elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer,
* or Network Load Balancer target group.
*
*
* -
*
* vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
*
*
*
*
* Required if the identifier is the name of a Classic Load Balancer.
*
*
* @return Provides additional context for the value of Identifier.
*
* The following lists the valid values:
*
*
* -
*
* elb if Identifier is the name of a Classic Load Balancer.
*
*
* -
*
* elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load
* Balancer, or Network Load Balancer target group.
*
*
* -
*
* vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
*
*
*
*
* Required if the identifier is the name of a Classic Load Balancer.
*/
public String getType() {
return this.type;
}
/**
*
* Provides additional context for the value of Identifier.
*
*
* The following lists the valid values:
*
*
* -
*
* elb if Identifier is the name of a Classic Load Balancer.
*
*
* -
*
* elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer,
* or Network Load Balancer target group.
*
*
* -
*
* vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
*
*
*
*
* Required if the identifier is the name of a Classic Load Balancer.
*
*
* @param type
* Provides additional context for the value of Identifier.
*
* The following lists the valid values:
*
*
* -
*
* elb if Identifier is the name of a Classic Load Balancer.
*
*
* -
*
* elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load
* Balancer, or Network Load Balancer target group.
*
*
* -
*
* vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
*
*
*
*
* Required if the identifier is the name of a Classic Load Balancer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TrafficSourceIdentifier withType(String type) {
setType(type);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getIdentifier() != null)
sb.append("Identifier: ").append(getIdentifier()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TrafficSourceIdentifier == false)
return false;
TrafficSourceIdentifier other = (TrafficSourceIdentifier) obj;
if (other.getIdentifier() == null ^ this.getIdentifier() == null)
return false;
if (other.getIdentifier() != null && other.getIdentifier().equals(this.getIdentifier()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIdentifier() == null) ? 0 : getIdentifier().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public TrafficSourceIdentifier clone() {
try {
return (TrafficSourceIdentifier) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}