com.amazonaws.services.ec2.model.CreateNetworkInterfaceRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-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.CreateNetworkInterfaceRequestMarshaller;
/**
*
* Contains the parameters for CreateNetworkInterface.
*
*/
public class CreateNetworkInterfaceRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The ID of the subnet to associate with the network interface.
*
*/
private String subnetId;
/**
*
* A description for the network interface.
*
*/
private String description;
/**
*
* The primary private IP address of the network interface. If you don't
* specify an IP address, Amazon EC2 selects one for you from the subnet
* range. If you specify an IP address, you cannot indicate any IP addresses
* specified in privateIpAddresses as primary (only one IP
* address can be designated as primary).
*
*/
private String privateIpAddress;
/**
*
* The IDs of one or more security groups.
*
*/
private com.amazonaws.internal.SdkInternalList groups;
/**
*
* One or more private IP addresses.
*
*/
private com.amazonaws.internal.SdkInternalList privateIpAddresses;
/**
*
* The number of secondary private IP addresses to assign to a network
* interface. When you specify a number of secondary IP addresses, Amazon
* EC2 selects these IP addresses within the subnet range. You can't specify
* this option and specify more than one private IP address using
* privateIpAddresses.
*
*
* The number of IP addresses you can assign to a network interface varies
* by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon
* Elastic Compute Cloud User Guide.
*
*/
private Integer secondaryPrivateIpAddressCount;
/**
*
* The ID of the subnet to associate with the network interface.
*
*
* @param subnetId
* The ID of the subnet to associate with the network interface.
*/
public void setSubnetId(String subnetId) {
this.subnetId = subnetId;
}
/**
*
* The ID of the subnet to associate with the network interface.
*
*
* @return The ID of the subnet to associate with the network interface.
*/
public String getSubnetId() {
return this.subnetId;
}
/**
*
* The ID of the subnet to associate with the network interface.
*
*
* @param subnetId
* The ID of the subnet to associate with the network interface.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateNetworkInterfaceRequest withSubnetId(String subnetId) {
setSubnetId(subnetId);
return this;
}
/**
*
* A description for the network interface.
*
*
* @param description
* A description for the network interface.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description for the network interface.
*
*
* @return A description for the network interface.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description for the network interface.
*
*
* @param description
* A description for the network interface.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateNetworkInterfaceRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The primary private IP address of the network interface. If you don't
* specify an IP address, Amazon EC2 selects one for you from the subnet
* range. If you specify an IP address, you cannot indicate any IP addresses
* specified in privateIpAddresses as primary (only one IP
* address can be designated as primary).
*
*
* @param privateIpAddress
* The primary private IP address of the network interface. If you
* don't specify an IP address, Amazon EC2 selects one for you from
* the subnet range. If you specify an IP address, you cannot
* indicate any IP addresses specified in
* privateIpAddresses as primary (only one IP address
* can be designated as primary).
*/
public void setPrivateIpAddress(String privateIpAddress) {
this.privateIpAddress = privateIpAddress;
}
/**
*
* The primary private IP address of the network interface. If you don't
* specify an IP address, Amazon EC2 selects one for you from the subnet
* range. If you specify an IP address, you cannot indicate any IP addresses
* specified in privateIpAddresses as primary (only one IP
* address can be designated as primary).
*
*
* @return The primary private IP address of the network interface. If you
* don't specify an IP address, Amazon EC2 selects one for you from
* the subnet range. If you specify an IP address, you cannot
* indicate any IP addresses specified in
* privateIpAddresses as primary (only one IP address
* can be designated as primary).
*/
public String getPrivateIpAddress() {
return this.privateIpAddress;
}
/**
*
* The primary private IP address of the network interface. If you don't
* specify an IP address, Amazon EC2 selects one for you from the subnet
* range. If you specify an IP address, you cannot indicate any IP addresses
* specified in privateIpAddresses as primary (only one IP
* address can be designated as primary).
*
*
* @param privateIpAddress
* The primary private IP address of the network interface. If you
* don't specify an IP address, Amazon EC2 selects one for you from
* the subnet range. If you specify an IP address, you cannot
* indicate any IP addresses specified in
* privateIpAddresses as primary (only one IP address
* can be designated as primary).
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateNetworkInterfaceRequest withPrivateIpAddress(
String privateIpAddress) {
setPrivateIpAddress(privateIpAddress);
return this;
}
/**
*
* The IDs of one or more security groups.
*
*
* @return The IDs of one or more security groups.
*/
public java.util.List getGroups() {
if (groups == null) {
groups = new com.amazonaws.internal.SdkInternalList();
}
return groups;
}
/**
*
* The IDs of one or more security groups.
*
*
* @param groups
* The IDs of one or more security groups.
*/
public void setGroups(java.util.Collection groups) {
if (groups == null) {
this.groups = null;
return;
}
this.groups = new com.amazonaws.internal.SdkInternalList(groups);
}
/**
*
* The IDs of one or more security groups.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setGroups(java.util.Collection)} or
* {@link #withGroups(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param groups
* The IDs of one or more security groups.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateNetworkInterfaceRequest withGroups(String... groups) {
if (this.groups == null) {
setGroups(new com.amazonaws.internal.SdkInternalList(
groups.length));
}
for (String ele : groups) {
this.groups.add(ele);
}
return this;
}
/**
*
* The IDs of one or more security groups.
*
*
* @param groups
* The IDs of one or more security groups.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateNetworkInterfaceRequest withGroups(
java.util.Collection groups) {
setGroups(groups);
return this;
}
/**
*
* One or more private IP addresses.
*
*
* @return One or more private IP addresses.
*/
public java.util.List getPrivateIpAddresses() {
if (privateIpAddresses == null) {
privateIpAddresses = new com.amazonaws.internal.SdkInternalList();
}
return privateIpAddresses;
}
/**
*
* One or more private IP addresses.
*
*
* @param privateIpAddresses
* One or more private IP addresses.
*/
public void setPrivateIpAddresses(
java.util.Collection privateIpAddresses) {
if (privateIpAddresses == null) {
this.privateIpAddresses = null;
return;
}
this.privateIpAddresses = new com.amazonaws.internal.SdkInternalList(
privateIpAddresses);
}
/**
*
* One or more private IP addresses.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setPrivateIpAddresses(java.util.Collection)} or
* {@link #withPrivateIpAddresses(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param privateIpAddresses
* One or more private IP addresses.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateNetworkInterfaceRequest withPrivateIpAddresses(
PrivateIpAddressSpecification... privateIpAddresses) {
if (this.privateIpAddresses == null) {
setPrivateIpAddresses(new com.amazonaws.internal.SdkInternalList(
privateIpAddresses.length));
}
for (PrivateIpAddressSpecification ele : privateIpAddresses) {
this.privateIpAddresses.add(ele);
}
return this;
}
/**
*
* One or more private IP addresses.
*
*
* @param privateIpAddresses
* One or more private IP addresses.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateNetworkInterfaceRequest withPrivateIpAddresses(
java.util.Collection privateIpAddresses) {
setPrivateIpAddresses(privateIpAddresses);
return this;
}
/**
*
* The number of secondary private IP addresses to assign to a network
* interface. When you specify a number of secondary IP addresses, Amazon
* EC2 selects these IP addresses within the subnet range. You can't specify
* this option and specify more than one private IP address using
* privateIpAddresses.
*
*
* The number of IP addresses you can assign to a network interface varies
* by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon
* Elastic Compute Cloud User Guide.
*
*
* @param secondaryPrivateIpAddressCount
* The number of secondary private IP addresses to assign to a
* network interface. When you specify a number of secondary IP
* addresses, Amazon EC2 selects these IP addresses within the subnet
* range. You can't specify this option and specify more than one
* private IP address using privateIpAddresses.
*
* The number of IP addresses you can assign to a network interface
* varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the
* Amazon Elastic Compute Cloud User Guide.
*/
public void setSecondaryPrivateIpAddressCount(
Integer secondaryPrivateIpAddressCount) {
this.secondaryPrivateIpAddressCount = secondaryPrivateIpAddressCount;
}
/**
*
* The number of secondary private IP addresses to assign to a network
* interface. When you specify a number of secondary IP addresses, Amazon
* EC2 selects these IP addresses within the subnet range. You can't specify
* this option and specify more than one private IP address using
* privateIpAddresses.
*
*
* The number of IP addresses you can assign to a network interface varies
* by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon
* Elastic Compute Cloud User Guide.
*
*
* @return The number of secondary private IP addresses to assign to a
* network interface. When you specify a number of secondary IP
* addresses, Amazon EC2 selects these IP addresses within the
* subnet range. You can't specify this option and specify more than
* one private IP address using privateIpAddresses.
*
* The number of IP addresses you can assign to a network interface
* varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the
* Amazon Elastic Compute Cloud User Guide.
*/
public Integer getSecondaryPrivateIpAddressCount() {
return this.secondaryPrivateIpAddressCount;
}
/**
*
* The number of secondary private IP addresses to assign to a network
* interface. When you specify a number of secondary IP addresses, Amazon
* EC2 selects these IP addresses within the subnet range. You can't specify
* this option and specify more than one private IP address using
* privateIpAddresses.
*
*
* The number of IP addresses you can assign to a network interface varies
* by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon
* Elastic Compute Cloud User Guide.
*
*
* @param secondaryPrivateIpAddressCount
* The number of secondary private IP addresses to assign to a
* network interface. When you specify a number of secondary IP
* addresses, Amazon EC2 selects these IP addresses within the subnet
* range. You can't specify this option and specify more than one
* private IP address using privateIpAddresses.
*
* The number of IP addresses you can assign to a network interface
* varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the
* Amazon Elastic Compute Cloud User Guide.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateNetworkInterfaceRequest withSecondaryPrivateIpAddressCount(
Integer secondaryPrivateIpAddressCount) {
setSecondaryPrivateIpAddressCount(secondaryPrivateIpAddressCount);
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 CreateNetworkInterfaceRequestMarshaller()
.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 (getSubnetId() != null)
sb.append("SubnetId: " + getSubnetId() + ",");
if (getDescription() != null)
sb.append("Description: " + getDescription() + ",");
if (getPrivateIpAddress() != null)
sb.append("PrivateIpAddress: " + getPrivateIpAddress() + ",");
if (getGroups() != null)
sb.append("Groups: " + getGroups() + ",");
if (getPrivateIpAddresses() != null)
sb.append("PrivateIpAddresses: " + getPrivateIpAddresses() + ",");
if (getSecondaryPrivateIpAddressCount() != null)
sb.append("SecondaryPrivateIpAddressCount: "
+ getSecondaryPrivateIpAddressCount());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateNetworkInterfaceRequest == false)
return false;
CreateNetworkInterfaceRequest other = (CreateNetworkInterfaceRequest) obj;
if (other.getSubnetId() == null ^ this.getSubnetId() == null)
return false;
if (other.getSubnetId() != null
&& other.getSubnetId().equals(this.getSubnetId()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null
&& other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getPrivateIpAddress() == null
^ this.getPrivateIpAddress() == null)
return false;
if (other.getPrivateIpAddress() != null
&& other.getPrivateIpAddress().equals(
this.getPrivateIpAddress()) == false)
return false;
if (other.getGroups() == null ^ this.getGroups() == null)
return false;
if (other.getGroups() != null
&& other.getGroups().equals(this.getGroups()) == false)
return false;
if (other.getPrivateIpAddresses() == null
^ this.getPrivateIpAddresses() == null)
return false;
if (other.getPrivateIpAddresses() != null
&& other.getPrivateIpAddresses().equals(
this.getPrivateIpAddresses()) == false)
return false;
if (other.getSecondaryPrivateIpAddressCount() == null
^ this.getSecondaryPrivateIpAddressCount() == null)
return false;
if (other.getSecondaryPrivateIpAddressCount() != null
&& other.getSecondaryPrivateIpAddressCount().equals(
this.getSecondaryPrivateIpAddressCount()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getSubnetId() == null) ? 0 : getSubnetId().hashCode());
hashCode = prime
* hashCode
+ ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime
* hashCode
+ ((getPrivateIpAddress() == null) ? 0 : getPrivateIpAddress()
.hashCode());
hashCode = prime * hashCode
+ ((getGroups() == null) ? 0 : getGroups().hashCode());
hashCode = prime
* hashCode
+ ((getPrivateIpAddresses() == null) ? 0
: getPrivateIpAddresses().hashCode());
hashCode = prime
* hashCode
+ ((getSecondaryPrivateIpAddressCount() == null) ? 0
: getSecondaryPrivateIpAddressCount().hashCode());
return hashCode;
}
@Override
public CreateNetworkInterfaceRequest clone() {
return (CreateNetworkInterfaceRequest) super.clone();
}
}