com.amazonaws.services.ec2.model.SearchTransitGatewayRoutesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 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.SearchTransitGatewayRoutesRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SearchTransitGatewayRoutesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The ID of the transit gateway route table.
*
*/
private String transitGatewayRouteTableId;
/**
*
* One or more filters. The possible values are:
*
*
* -
*
* attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-id - The resource id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-type - The attachment resource type. Valid values are vpc |
* vpn | direct-connect-gateway | peering | connect.
*
*
* -
*
* prefix-list-id - The ID of the prefix list.
*
*
* -
*
* route-search.exact-match - The exact match of the specified filter.
*
*
* -
*
* route-search.longest-prefix-match - The longest prefix that matches the route.
*
*
* -
*
* route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
*
*
* -
*
* route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example,
* if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as
* 10.0.1.0/30, then the result returns 10.0.1.0/29.
*
*
* -
*
* state - The state of the route (active | blackhole).
*
*
* -
*
* type - The type of route (propagated | static).
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The maximum number of routes to return.
*
*/
private Integer maxResults;
/**
*
* The ID of the transit gateway route table.
*
*
* @param transitGatewayRouteTableId
* The ID of the transit gateway route table.
*/
public void setTransitGatewayRouteTableId(String transitGatewayRouteTableId) {
this.transitGatewayRouteTableId = transitGatewayRouteTableId;
}
/**
*
* The ID of the transit gateway route table.
*
*
* @return The ID of the transit gateway route table.
*/
public String getTransitGatewayRouteTableId() {
return this.transitGatewayRouteTableId;
}
/**
*
* The ID of the transit gateway route table.
*
*
* @param transitGatewayRouteTableId
* The ID of the transit gateway route table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchTransitGatewayRoutesRequest withTransitGatewayRouteTableId(String transitGatewayRouteTableId) {
setTransitGatewayRouteTableId(transitGatewayRouteTableId);
return this;
}
/**
*
* One or more filters. The possible values are:
*
*
* -
*
* attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-id - The resource id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-type - The attachment resource type. Valid values are vpc |
* vpn | direct-connect-gateway | peering | connect.
*
*
* -
*
* prefix-list-id - The ID of the prefix list.
*
*
* -
*
* route-search.exact-match - The exact match of the specified filter.
*
*
* -
*
* route-search.longest-prefix-match - The longest prefix that matches the route.
*
*
* -
*
* route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
*
*
* -
*
* route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example,
* if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as
* 10.0.1.0/30, then the result returns 10.0.1.0/29.
*
*
* -
*
* state - The state of the route (active | blackhole).
*
*
* -
*
* type - The type of route (propagated | static).
*
*
*
*
* @return One or more filters. The possible values are:
*
* -
*
* attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-id - The resource id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-type - The attachment resource type. Valid values are vpc |
* vpn | direct-connect-gateway | peering | connect.
*
*
* -
*
* prefix-list-id - The ID of the prefix list.
*
*
* -
*
* route-search.exact-match - The exact match of the specified filter.
*
*
* -
*
* route-search.longest-prefix-match - The longest prefix that matches the route.
*
*
* -
*
* route-search.subnet-of-match - The routes with a subnet that match the specified CIDR
* filter.
*
*
* -
*
* route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For
* example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify
* supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
*
*
* -
*
* state - The state of the route (active | blackhole).
*
*
* -
*
* type - The type of route (propagated | static).
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters. The possible values are:
*
*
* -
*
* attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-id - The resource id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-type - The attachment resource type. Valid values are vpc |
* vpn | direct-connect-gateway | peering | connect.
*
*
* -
*
* prefix-list-id - The ID of the prefix list.
*
*
* -
*
* route-search.exact-match - The exact match of the specified filter.
*
*
* -
*
* route-search.longest-prefix-match - The longest prefix that matches the route.
*
*
* -
*
* route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
*
*
* -
*
* route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example,
* if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as
* 10.0.1.0/30, then the result returns 10.0.1.0/29.
*
*
* -
*
* state - The state of the route (active | blackhole).
*
*
* -
*
* type - The type of route (propagated | static).
*
*
*
*
* @param filters
* One or more filters. The possible values are:
*
* -
*
* attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-id - The resource id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-type - The attachment resource type. Valid values are vpc |
* vpn | direct-connect-gateway | peering | connect.
*
*
* -
*
* prefix-list-id - The ID of the prefix list.
*
*
* -
*
* route-search.exact-match - The exact match of the specified filter.
*
*
* -
*
* route-search.longest-prefix-match - The longest prefix that matches the route.
*
*
* -
*
* route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
*
*
* -
*
* route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For
* example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify
* supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
*
*
* -
*
* state - The state of the route (active | blackhole).
*
*
* -
*
* type - The type of route (propagated | static).
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* One or more filters. The possible values are:
*
*
* -
*
* attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-id - The resource id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-type - The attachment resource type. Valid values are vpc |
* vpn | direct-connect-gateway | peering | connect.
*
*
* -
*
* prefix-list-id - The ID of the prefix list.
*
*
* -
*
* route-search.exact-match - The exact match of the specified filter.
*
*
* -
*
* route-search.longest-prefix-match - The longest prefix that matches the route.
*
*
* -
*
* route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
*
*
* -
*
* route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example,
* if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as
* 10.0.1.0/30, then the result returns 10.0.1.0/29.
*
*
* -
*
* state - The state of the route (active | blackhole).
*
*
* -
*
* type - The type of route (propagated | static).
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param filters
* One or more filters. The possible values are:
*
* -
*
* attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-id - The resource id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-type - The attachment resource type. Valid values are vpc |
* vpn | direct-connect-gateway | peering | connect.
*
*
* -
*
* prefix-list-id - The ID of the prefix list.
*
*
* -
*
* route-search.exact-match - The exact match of the specified filter.
*
*
* -
*
* route-search.longest-prefix-match - The longest prefix that matches the route.
*
*
* -
*
* route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
*
*
* -
*
* route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For
* example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify
* supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
*
*
* -
*
* state - The state of the route (active | blackhole).
*
*
* -
*
* type - The type of route (propagated | static).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchTransitGatewayRoutesRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* One or more filters. The possible values are:
*
*
* -
*
* attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-id - The resource id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-type - The attachment resource type. Valid values are vpc |
* vpn | direct-connect-gateway | peering | connect.
*
*
* -
*
* prefix-list-id - The ID of the prefix list.
*
*
* -
*
* route-search.exact-match - The exact match of the specified filter.
*
*
* -
*
* route-search.longest-prefix-match - The longest prefix that matches the route.
*
*
* -
*
* route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
*
*
* -
*
* route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example,
* if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as
* 10.0.1.0/30, then the result returns 10.0.1.0/29.
*
*
* -
*
* state - The state of the route (active | blackhole).
*
*
* -
*
* type - The type of route (propagated | static).
*
*
*
*
* @param filters
* One or more filters. The possible values are:
*
* -
*
* attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-id - The resource id of the transit gateway attachment.
*
*
* -
*
* attachment.resource-type - The attachment resource type. Valid values are vpc |
* vpn | direct-connect-gateway | peering | connect.
*
*
* -
*
* prefix-list-id - The ID of the prefix list.
*
*
* -
*
* route-search.exact-match - The exact match of the specified filter.
*
*
* -
*
* route-search.longest-prefix-match - The longest prefix that matches the route.
*
*
* -
*
* route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
*
*
* -
*
* route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For
* example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify
* supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
*
*
* -
*
* state - The state of the route (active | blackhole).
*
*
* -
*
* type - The type of route (propagated | static).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchTransitGatewayRoutesRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The maximum number of routes to return.
*
*
* @param maxResults
* The maximum number of routes to return.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of routes to return.
*
*
* @return The maximum number of routes to return.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of routes to return.
*
*
* @param maxResults
* The maximum number of routes to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchTransitGatewayRoutesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 SearchTransitGatewayRoutesRequestMarshaller().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 (getTransitGatewayRouteTableId() != null)
sb.append("TransitGatewayRouteTableId: ").append(getTransitGatewayRouteTableId()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SearchTransitGatewayRoutesRequest == false)
return false;
SearchTransitGatewayRoutesRequest other = (SearchTransitGatewayRoutesRequest) obj;
if (other.getTransitGatewayRouteTableId() == null ^ this.getTransitGatewayRouteTableId() == null)
return false;
if (other.getTransitGatewayRouteTableId() != null && other.getTransitGatewayRouteTableId().equals(this.getTransitGatewayRouteTableId()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTransitGatewayRouteTableId() == null) ? 0 : getTransitGatewayRouteTableId().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public SearchTransitGatewayRoutesRequest clone() {
return (SearchTransitGatewayRoutesRequest) super.clone();
}
}