com.amazonaws.services.ec2.model.CreateNetworkInsightsPathRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.CreateNetworkInsightsPathRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateNetworkInsightsPathRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The IP address of the source.
*
*/
private String sourceIp;
/**
*
* The IP address of the destination.
*
*/
private String destinationIp;
/**
*
* The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
*
*/
private String source;
/**
*
* The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
*
*/
private String destination;
/**
*
* The protocol.
*
*/
private String protocol;
/**
*
* The destination port.
*
*/
private Integer destinationPort;
/**
*
* The tags to add to the path.
*
*/
private com.amazonaws.internal.SdkInternalList tagSpecifications;
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to ensure
* idempotency.
*
*/
private String clientToken;
/**
*
* Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter,
* you can't specify the parameters for the source IP address or the destination port.
*
*/
private PathRequestFilter filterAtSource;
/**
*
* Scopes the analysis to network paths that match specific filters at the destination. If you specify this
* parameter, you can't specify the parameter for the destination IP address.
*
*/
private PathRequestFilter filterAtDestination;
/**
*
* The IP address of the source.
*
*
* @param sourceIp
* The IP address of the source.
*/
public void setSourceIp(String sourceIp) {
this.sourceIp = sourceIp;
}
/**
*
* The IP address of the source.
*
*
* @return The IP address of the source.
*/
public String getSourceIp() {
return this.sourceIp;
}
/**
*
* The IP address of the source.
*
*
* @param sourceIp
* The IP address of the source.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkInsightsPathRequest withSourceIp(String sourceIp) {
setSourceIp(sourceIp);
return this;
}
/**
*
* The IP address of the destination.
*
*
* @param destinationIp
* The IP address of the destination.
*/
public void setDestinationIp(String destinationIp) {
this.destinationIp = destinationIp;
}
/**
*
* The IP address of the destination.
*
*
* @return The IP address of the destination.
*/
public String getDestinationIp() {
return this.destinationIp;
}
/**
*
* The IP address of the destination.
*
*
* @param destinationIp
* The IP address of the destination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkInsightsPathRequest withDestinationIp(String destinationIp) {
setDestinationIp(destinationIp);
return this;
}
/**
*
* The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
*
*
* @param source
* The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
*/
public void setSource(String source) {
this.source = source;
}
/**
*
* The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
*
*
* @return The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
*/
public String getSource() {
return this.source;
}
/**
*
* The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
*
*
* @param source
* The ID or ARN of the source. If the resource is in another account, you must specify an ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkInsightsPathRequest withSource(String source) {
setSource(source);
return this;
}
/**
*
* The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
*
*
* @param destination
* The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
*/
public void setDestination(String destination) {
this.destination = destination;
}
/**
*
* The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
*
*
* @return The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
*/
public String getDestination() {
return this.destination;
}
/**
*
* The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
*
*
* @param destination
* The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkInsightsPathRequest withDestination(String destination) {
setDestination(destination);
return this;
}
/**
*
* The protocol.
*
*
* @param protocol
* The protocol.
* @see Protocol
*/
public void setProtocol(String protocol) {
this.protocol = protocol;
}
/**
*
* The protocol.
*
*
* @return The protocol.
* @see Protocol
*/
public String getProtocol() {
return this.protocol;
}
/**
*
* The protocol.
*
*
* @param protocol
* The protocol.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Protocol
*/
public CreateNetworkInsightsPathRequest withProtocol(String protocol) {
setProtocol(protocol);
return this;
}
/**
*
* The protocol.
*
*
* @param protocol
* The protocol.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Protocol
*/
public CreateNetworkInsightsPathRequest withProtocol(Protocol protocol) {
this.protocol = protocol.toString();
return this;
}
/**
*
* The destination port.
*
*
* @param destinationPort
* The destination port.
*/
public void setDestinationPort(Integer destinationPort) {
this.destinationPort = destinationPort;
}
/**
*
* The destination port.
*
*
* @return The destination port.
*/
public Integer getDestinationPort() {
return this.destinationPort;
}
/**
*
* The destination port.
*
*
* @param destinationPort
* The destination port.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkInsightsPathRequest withDestinationPort(Integer destinationPort) {
setDestinationPort(destinationPort);
return this;
}
/**
*
* The tags to add to the path.
*
*
* @return The tags to add to the path.
*/
public java.util.List getTagSpecifications() {
if (tagSpecifications == null) {
tagSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return tagSpecifications;
}
/**
*
* The tags to add to the path.
*
*
* @param tagSpecifications
* The tags to add to the path.
*/
public void setTagSpecifications(java.util.Collection tagSpecifications) {
if (tagSpecifications == null) {
this.tagSpecifications = null;
return;
}
this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(tagSpecifications);
}
/**
*
* The tags to add to the path.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param tagSpecifications
* The tags to add to the path.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkInsightsPathRequest withTagSpecifications(TagSpecification... tagSpecifications) {
if (this.tagSpecifications == null) {
setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length));
}
for (TagSpecification ele : tagSpecifications) {
this.tagSpecifications.add(ele);
}
return this;
}
/**
*
* The tags to add to the path.
*
*
* @param tagSpecifications
* The tags to add to the path.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkInsightsPathRequest withTagSpecifications(java.util.Collection tagSpecifications) {
setTagSpecifications(tagSpecifications);
return this;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to ensure
* idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to
* ensure idempotency.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to ensure
* idempotency.
*
*
* @return Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How
* to ensure idempotency.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to ensure
* idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to
* ensure idempotency.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkInsightsPathRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter,
* you can't specify the parameters for the source IP address or the destination port.
*
*
* @param filterAtSource
* Scopes the analysis to network paths that match specific filters at the source. If you specify this
* parameter, you can't specify the parameters for the source IP address or the destination port.
*/
public void setFilterAtSource(PathRequestFilter filterAtSource) {
this.filterAtSource = filterAtSource;
}
/**
*
* Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter,
* you can't specify the parameters for the source IP address or the destination port.
*
*
* @return Scopes the analysis to network paths that match specific filters at the source. If you specify this
* parameter, you can't specify the parameters for the source IP address or the destination port.
*/
public PathRequestFilter getFilterAtSource() {
return this.filterAtSource;
}
/**
*
* Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter,
* you can't specify the parameters for the source IP address or the destination port.
*
*
* @param filterAtSource
* Scopes the analysis to network paths that match specific filters at the source. If you specify this
* parameter, you can't specify the parameters for the source IP address or the destination port.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkInsightsPathRequest withFilterAtSource(PathRequestFilter filterAtSource) {
setFilterAtSource(filterAtSource);
return this;
}
/**
*
* Scopes the analysis to network paths that match specific filters at the destination. If you specify this
* parameter, you can't specify the parameter for the destination IP address.
*
*
* @param filterAtDestination
* Scopes the analysis to network paths that match specific filters at the destination. If you specify this
* parameter, you can't specify the parameter for the destination IP address.
*/
public void setFilterAtDestination(PathRequestFilter filterAtDestination) {
this.filterAtDestination = filterAtDestination;
}
/**
*
* Scopes the analysis to network paths that match specific filters at the destination. If you specify this
* parameter, you can't specify the parameter for the destination IP address.
*
*
* @return Scopes the analysis to network paths that match specific filters at the destination. If you specify this
* parameter, you can't specify the parameter for the destination IP address.
*/
public PathRequestFilter getFilterAtDestination() {
return this.filterAtDestination;
}
/**
*
* Scopes the analysis to network paths that match specific filters at the destination. If you specify this
* parameter, you can't specify the parameter for the destination IP address.
*
*
* @param filterAtDestination
* Scopes the analysis to network paths that match specific filters at the destination. If you specify this
* parameter, you can't specify the parameter for the destination IP address.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateNetworkInsightsPathRequest withFilterAtDestination(PathRequestFilter filterAtDestination) {
setFilterAtDestination(filterAtDestination);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new CreateNetworkInsightsPathRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getSourceIp() != null)
sb.append("SourceIp: ").append(getSourceIp()).append(",");
if (getDestinationIp() != null)
sb.append("DestinationIp: ").append(getDestinationIp()).append(",");
if (getSource() != null)
sb.append("Source: ").append(getSource()).append(",");
if (getDestination() != null)
sb.append("Destination: ").append(getDestination()).append(",");
if (getProtocol() != null)
sb.append("Protocol: ").append(getProtocol()).append(",");
if (getDestinationPort() != null)
sb.append("DestinationPort: ").append(getDestinationPort()).append(",");
if (getTagSpecifications() != null)
sb.append("TagSpecifications: ").append(getTagSpecifications()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getFilterAtSource() != null)
sb.append("FilterAtSource: ").append(getFilterAtSource()).append(",");
if (getFilterAtDestination() != null)
sb.append("FilterAtDestination: ").append(getFilterAtDestination());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateNetworkInsightsPathRequest == false)
return false;
CreateNetworkInsightsPathRequest other = (CreateNetworkInsightsPathRequest) obj;
if (other.getSourceIp() == null ^ this.getSourceIp() == null)
return false;
if (other.getSourceIp() != null && other.getSourceIp().equals(this.getSourceIp()) == false)
return false;
if (other.getDestinationIp() == null ^ this.getDestinationIp() == null)
return false;
if (other.getDestinationIp() != null && other.getDestinationIp().equals(this.getDestinationIp()) == false)
return false;
if (other.getSource() == null ^ this.getSource() == null)
return false;
if (other.getSource() != null && other.getSource().equals(this.getSource()) == false)
return false;
if (other.getDestination() == null ^ this.getDestination() == null)
return false;
if (other.getDestination() != null && other.getDestination().equals(this.getDestination()) == false)
return false;
if (other.getProtocol() == null ^ this.getProtocol() == null)
return false;
if (other.getProtocol() != null && other.getProtocol().equals(this.getProtocol()) == false)
return false;
if (other.getDestinationPort() == null ^ this.getDestinationPort() == null)
return false;
if (other.getDestinationPort() != null && other.getDestinationPort().equals(this.getDestinationPort()) == false)
return false;
if (other.getTagSpecifications() == null ^ this.getTagSpecifications() == null)
return false;
if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getFilterAtSource() == null ^ this.getFilterAtSource() == null)
return false;
if (other.getFilterAtSource() != null && other.getFilterAtSource().equals(this.getFilterAtSource()) == false)
return false;
if (other.getFilterAtDestination() == null ^ this.getFilterAtDestination() == null)
return false;
if (other.getFilterAtDestination() != null && other.getFilterAtDestination().equals(this.getFilterAtDestination()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSourceIp() == null) ? 0 : getSourceIp().hashCode());
hashCode = prime * hashCode + ((getDestinationIp() == null) ? 0 : getDestinationIp().hashCode());
hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().hashCode());
hashCode = prime * hashCode + ((getDestination() == null) ? 0 : getDestination().hashCode());
hashCode = prime * hashCode + ((getProtocol() == null) ? 0 : getProtocol().hashCode());
hashCode = prime * hashCode + ((getDestinationPort() == null) ? 0 : getDestinationPort().hashCode());
hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getFilterAtSource() == null) ? 0 : getFilterAtSource().hashCode());
hashCode = prime * hashCode + ((getFilterAtDestination() == null) ? 0 : getFilterAtDestination().hashCode());
return hashCode;
}
@Override
public CreateNetworkInsightsPathRequest clone() {
return (CreateNetworkInsightsPathRequest) super.clone();
}
}