com.amazonaws.services.ec2.model.DescribeDhcpOptionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2011-2016 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 com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeDhcpOptionsRequestMarshaller;
/**
*
* Contains the parameters for DescribeDhcpOptions.
*
*/
public class DescribeDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The IDs of one or more DHCP options sets.
*
*
* Default: Describes all your DHCP options sets.
*
*/
private com.amazonaws.internal.SdkInternalList dhcpOptionsIds;
/**
*
* One or more filters.
*
*
* -
*
* dhcp-options-id - The ID of a set of DHCP options.
*
*
* -
*
* key - The key for one of the options (for example, domain-name).
*
*
* -
*
* value - The value for one of the options.
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This filter is independent of the
* tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
* and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
* see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource. This filter is independent of the
* tag-key filter.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The IDs of one or more DHCP options sets.
*
*
* Default: Describes all your DHCP options sets.
*
*
* @return The IDs of one or more DHCP options sets.
*
* Default: Describes all your DHCP options sets.
*/
public java.util.List getDhcpOptionsIds() {
if (dhcpOptionsIds == null) {
dhcpOptionsIds = new com.amazonaws.internal.SdkInternalList();
}
return dhcpOptionsIds;
}
/**
*
* The IDs of one or more DHCP options sets.
*
*
* Default: Describes all your DHCP options sets.
*
*
* @param dhcpOptionsIds
* The IDs of one or more DHCP options sets.
*
* Default: Describes all your DHCP options sets.
*/
public void setDhcpOptionsIds(java.util.Collection dhcpOptionsIds) {
if (dhcpOptionsIds == null) {
this.dhcpOptionsIds = null;
return;
}
this.dhcpOptionsIds = new com.amazonaws.internal.SdkInternalList(dhcpOptionsIds);
}
/**
*
* The IDs of one or more DHCP options sets.
*
*
* Default: Describes all your DHCP options sets.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDhcpOptionsIds(java.util.Collection)} or {@link #withDhcpOptionsIds(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param dhcpOptionsIds
* The IDs of one or more DHCP options sets.
*
* Default: Describes all your DHCP options sets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDhcpOptionsRequest withDhcpOptionsIds(String... dhcpOptionsIds) {
if (this.dhcpOptionsIds == null) {
setDhcpOptionsIds(new com.amazonaws.internal.SdkInternalList(dhcpOptionsIds.length));
}
for (String ele : dhcpOptionsIds) {
this.dhcpOptionsIds.add(ele);
}
return this;
}
/**
*
* The IDs of one or more DHCP options sets.
*
*
* Default: Describes all your DHCP options sets.
*
*
* @param dhcpOptionsIds
* The IDs of one or more DHCP options sets.
*
* Default: Describes all your DHCP options sets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDhcpOptionsRequest withDhcpOptionsIds(java.util.Collection dhcpOptionsIds) {
setDhcpOptionsIds(dhcpOptionsIds);
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* dhcp-options-id - The ID of a set of DHCP options.
*
*
* -
*
* key - The key for one of the options (for example, domain-name).
*
*
* -
*
* value - The value for one of the options.
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This filter is independent of the
* tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
* and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
* see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource. This filter is independent of the
* tag-key filter.
*
*
*
*
* @return One or more filters.
*
* -
*
* dhcp-options-id - The ID of a set of DHCP options.
*
*
* -
*
* key - The key for one of the options (for example, domain-name).
*
*
* -
*
* value - The value for one of the options.
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This filter is independent of the
* tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's
* value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources
* where Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource. This filter is independent of the
* tag-key filter.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters.
*
*
* -
*
* dhcp-options-id - The ID of a set of DHCP options.
*
*
* -
*
* key - The key for one of the options (for example, domain-name).
*
*
* -
*
* value - The value for one of the options.
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This filter is independent of the
* tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
* and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
* see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource. This filter is independent of the
* tag-key filter.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* dhcp-options-id - The ID of a set of DHCP options.
*
*
* -
*
* key - The key for one of the options (for example, domain-name).
*
*
* -
*
* value - The value for one of the options.
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This filter is independent of the
* tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value
* is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource. This filter is independent of the
* tag-key filter.
*
*
*/
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.
*
*
* -
*
* dhcp-options-id - The ID of a set of DHCP options.
*
*
* -
*
* key - The key for one of the options (for example, domain-name).
*
*
* -
*
* value - The value for one of the options.
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This filter is independent of the
* tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
* and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
* see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource. This filter is independent of the
* tag-key filter.
*
*
*
*
* 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.
*
* -
*
* dhcp-options-id - The ID of a set of DHCP options.
*
*
* -
*
* key - The key for one of the options (for example, domain-name).
*
*
* -
*
* value - The value for one of the options.
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This filter is independent of the
* tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value
* is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource. This filter is independent of the
* tag-key filter.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDhcpOptionsRequest 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.
*
*
* -
*
* dhcp-options-id - The ID of a set of DHCP options.
*
*
* -
*
* key - The key for one of the options (for example, domain-name).
*
*
* -
*
* value - The value for one of the options.
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This filter is independent of the
* tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is),
* and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X,
* see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource. This filter is independent of the
* tag-key filter.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* dhcp-options-id - The ID of a set of DHCP options.
*
*
* -
*
* key - The key for one of the options (for example, domain-name).
*
*
* -
*
* value - The value for one of the options.
*
*
* -
*
* tag:key=value - The key/value combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This filter is independent of the
* tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value
* is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource. This filter is independent of the
* tag-key filter.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDhcpOptionsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
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 DescribeDhcpOptionsRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDhcpOptionsIds() != null)
sb.append("DhcpOptionsIds: " + getDhcpOptionsIds() + ",");
if (getFilters() != null)
sb.append("Filters: " + getFilters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeDhcpOptionsRequest == false)
return false;
DescribeDhcpOptionsRequest other = (DescribeDhcpOptionsRequest) obj;
if (other.getDhcpOptionsIds() == null ^ this.getDhcpOptionsIds() == null)
return false;
if (other.getDhcpOptionsIds() != null && other.getDhcpOptionsIds().equals(this.getDhcpOptionsIds()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDhcpOptionsIds() == null) ? 0 : getDhcpOptionsIds().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public DescribeDhcpOptionsRequest clone() {
return (DescribeDhcpOptionsRequest) super.clone();
}
}