com.amazonaws.services.datasync.model.CreateAgentRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-datasync Show documentation
/*
* Copyright 2017-2022 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.datasync.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* CreateAgentRequest
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateAgentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects
* that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.
*
*
* The redirect URL returned in the response provides you the activation key for your agent in the query string
* parameter activationKey. It might also include other activation-related parameters; however, these
* are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.
*
*
* For more information, see Activating an Agent in the DataSync User Guide.
*
*/
private String activationKey;
/**
*
* The name you configured for your agent. This value is a text reference that is used to identify the agent in the
* console.
*
*/
private String agentName;
/**
*
* The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty
* string. This value helps you manage, filter, and search for your agents.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @.
*
*
*/
private java.util.List tags;
/**
*
* The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC
* endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a
* VPC Endpoint Service Configuration in the Amazon VPC User Guide.
*
*
* VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
*
*/
private String vpcEndpointId;
/**
*
* The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each
* data transfer task. The agent that runs a task must be private. When you start a task that is associated with an
* agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this
* case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the
* agent must be able to route to all these four network interfaces.
*
*/
private java.util.List subnetArns;
/**
*
* The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
*
*/
private java.util.List securityGroupArns;
/**
*
* Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects
* that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.
*
*
* The redirect URL returned in the response provides you the activation key for your agent in the query string
* parameter activationKey. It might also include other activation-related parameters; however, these
* are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.
*
*
* For more information, see Activating an Agent in the DataSync User Guide.
*
*
* @param activationKey
* Your agent activation key. You can get the activation key either by sending an HTTP GET request with
* redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the
* DataSync console.
*
* The redirect URL returned in the response provides you the activation key for your agent in the query
* string parameter activationKey. It might also include other activation-related parameters;
* however, these are merely defaults. The arguments you pass to this API call determine the actual
* configuration of your agent.
*
*
* For more information, see Activating an Agent in the DataSync User Guide.
*/
public void setActivationKey(String activationKey) {
this.activationKey = activationKey;
}
/**
*
* Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects
* that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.
*
*
* The redirect URL returned in the response provides you the activation key for your agent in the query string
* parameter activationKey. It might also include other activation-related parameters; however, these
* are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.
*
*
* For more information, see Activating an Agent in the DataSync User Guide.
*
*
* @return Your agent activation key. You can get the activation key either by sending an HTTP GET request with
* redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the
* DataSync console.
*
* The redirect URL returned in the response provides you the activation key for your agent in the query
* string parameter activationKey. It might also include other activation-related parameters;
* however, these are merely defaults. The arguments you pass to this API call determine the actual
* configuration of your agent.
*
*
* For more information, see Activating an Agent in the DataSync User Guide.
*/
public String getActivationKey() {
return this.activationKey;
}
/**
*
* Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects
* that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.
*
*
* The redirect URL returned in the response provides you the activation key for your agent in the query string
* parameter activationKey. It might also include other activation-related parameters; however, these
* are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.
*
*
* For more information, see Activating an Agent in the DataSync User Guide.
*
*
* @param activationKey
* Your agent activation key. You can get the activation key either by sending an HTTP GET request with
* redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the
* DataSync console.
*
* The redirect URL returned in the response provides you the activation key for your agent in the query
* string parameter activationKey. It might also include other activation-related parameters;
* however, these are merely defaults. The arguments you pass to this API call determine the actual
* configuration of your agent.
*
*
* For more information, see Activating an Agent in the DataSync User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAgentRequest withActivationKey(String activationKey) {
setActivationKey(activationKey);
return this;
}
/**
*
* The name you configured for your agent. This value is a text reference that is used to identify the agent in the
* console.
*
*
* @param agentName
* The name you configured for your agent. This value is a text reference that is used to identify the agent
* in the console.
*/
public void setAgentName(String agentName) {
this.agentName = agentName;
}
/**
*
* The name you configured for your agent. This value is a text reference that is used to identify the agent in the
* console.
*
*
* @return The name you configured for your agent. This value is a text reference that is used to identify the agent
* in the console.
*/
public String getAgentName() {
return this.agentName;
}
/**
*
* The name you configured for your agent. This value is a text reference that is used to identify the agent in the
* console.
*
*
* @param agentName
* The name you configured for your agent. This value is a text reference that is used to identify the agent
* in the console.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAgentRequest withAgentName(String agentName) {
setAgentName(agentName);
return this;
}
/**
*
* The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty
* string. This value helps you manage, filter, and search for your agents.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @.
*
*
*
* @return The key-value pair that represents the tag that you want to associate with the agent. The value can be an
* empty string. This value helps you manage, filter, and search for your agents.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and
* the following special characters: + - = . _ : / @.
*
*/
public java.util.List getTags() {
return tags;
}
/**
*
* The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty
* string. This value helps you manage, filter, and search for your agents.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @.
*
*
*
* @param tags
* The key-value pair that represents the tag that you want to associate with the agent. The value can be an
* empty string. This value helps you manage, filter, and search for your agents.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @.
*
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty
* string. This value helps you manage, filter, and search for your agents.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @.
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* The key-value pair that represents the tag that you want to associate with the agent. The value can be an
* empty string. This value helps you manage, filter, and search for your agents.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAgentRequest withTags(TagListEntry... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (TagListEntry ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty
* string. This value helps you manage, filter, and search for your agents.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @.
*
*
*
* @param tags
* The key-value pair that represents the tag that you want to associate with the agent. The value can be an
* empty string. This value helps you manage, filter, and search for your agents.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAgentRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC
* endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a
* VPC Endpoint Service Configuration in the Amazon VPC User Guide.
*
*
* VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
*
*
* @param vpcEndpointId
* The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side
* VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.
*
* VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
*/
public void setVpcEndpointId(String vpcEndpointId) {
this.vpcEndpointId = vpcEndpointId;
}
/**
*
* The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC
* endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a
* VPC Endpoint Service Configuration in the Amazon VPC User Guide.
*
*
* VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
*
*
* @return The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side
* VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.
*
* VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
*/
public String getVpcEndpointId() {
return this.vpcEndpointId;
}
/**
*
* The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC
* endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a
* VPC Endpoint Service Configuration in the Amazon VPC User Guide.
*
*
* VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
*
*
* @param vpcEndpointId
* The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side
* VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.
*
* VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAgentRequest withVpcEndpointId(String vpcEndpointId) {
setVpcEndpointId(vpcEndpointId);
return this;
}
/**
*
* The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each
* data transfer task. The agent that runs a task must be private. When you start a task that is associated with an
* agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this
* case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the
* agent must be able to route to all these four network interfaces.
*
*
* @return The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces
* for each data transfer task. The agent that runs a task must be private. When you start a task that is
* associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the
* task is also private. In this case, DataSync creates four network interfaces for each task in your
* subnet. For a data transfer to work, the agent must be able to route to all these four network
* interfaces.
*/
public java.util.List getSubnetArns() {
return subnetArns;
}
/**
*
* The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each
* data transfer task. The agent that runs a task must be private. When you start a task that is associated with an
* agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this
* case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the
* agent must be able to route to all these four network interfaces.
*
*
* @param subnetArns
* The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces
* for each data transfer task. The agent that runs a task must be private. When you start a task that is
* associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task
* is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For
* a data transfer to work, the agent must be able to route to all these four network interfaces.
*/
public void setSubnetArns(java.util.Collection subnetArns) {
if (subnetArns == null) {
this.subnetArns = null;
return;
}
this.subnetArns = new java.util.ArrayList(subnetArns);
}
/**
*
* The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each
* data transfer task. The agent that runs a task must be private. When you start a task that is associated with an
* agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this
* case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the
* agent must be able to route to all these four network interfaces.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSubnetArns(java.util.Collection)} or {@link #withSubnetArns(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param subnetArns
* The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces
* for each data transfer task. The agent that runs a task must be private. When you start a task that is
* associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task
* is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For
* a data transfer to work, the agent must be able to route to all these four network interfaces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAgentRequest withSubnetArns(String... subnetArns) {
if (this.subnetArns == null) {
setSubnetArns(new java.util.ArrayList(subnetArns.length));
}
for (String ele : subnetArns) {
this.subnetArns.add(ele);
}
return this;
}
/**
*
* The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each
* data transfer task. The agent that runs a task must be private. When you start a task that is associated with an
* agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this
* case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the
* agent must be able to route to all these four network interfaces.
*
*
* @param subnetArns
* The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces
* for each data transfer task. The agent that runs a task must be private. When you start a task that is
* associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task
* is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For
* a data transfer to work, the agent must be able to route to all these four network interfaces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAgentRequest withSubnetArns(java.util.Collection subnetArns) {
setSubnetArns(subnetArns);
return this;
}
/**
*
* The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
*
*
* @return The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
*/
public java.util.List getSecurityGroupArns() {
return securityGroupArns;
}
/**
*
* The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
*
*
* @param securityGroupArns
* The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
*/
public void setSecurityGroupArns(java.util.Collection securityGroupArns) {
if (securityGroupArns == null) {
this.securityGroupArns = null;
return;
}
this.securityGroupArns = new java.util.ArrayList(securityGroupArns);
}
/**
*
* The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSecurityGroupArns(java.util.Collection)} or {@link #withSecurityGroupArns(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param securityGroupArns
* The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAgentRequest withSecurityGroupArns(String... securityGroupArns) {
if (this.securityGroupArns == null) {
setSecurityGroupArns(new java.util.ArrayList(securityGroupArns.length));
}
for (String ele : securityGroupArns) {
this.securityGroupArns.add(ele);
}
return this;
}
/**
*
* The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
*
*
* @param securityGroupArns
* The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAgentRequest withSecurityGroupArns(java.util.Collection securityGroupArns) {
setSecurityGroupArns(securityGroupArns);
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 (getActivationKey() != null)
sb.append("ActivationKey: ").append(getActivationKey()).append(",");
if (getAgentName() != null)
sb.append("AgentName: ").append(getAgentName()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getVpcEndpointId() != null)
sb.append("VpcEndpointId: ").append(getVpcEndpointId()).append(",");
if (getSubnetArns() != null)
sb.append("SubnetArns: ").append(getSubnetArns()).append(",");
if (getSecurityGroupArns() != null)
sb.append("SecurityGroupArns: ").append(getSecurityGroupArns());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateAgentRequest == false)
return false;
CreateAgentRequest other = (CreateAgentRequest) obj;
if (other.getActivationKey() == null ^ this.getActivationKey() == null)
return false;
if (other.getActivationKey() != null && other.getActivationKey().equals(this.getActivationKey()) == false)
return false;
if (other.getAgentName() == null ^ this.getAgentName() == null)
return false;
if (other.getAgentName() != null && other.getAgentName().equals(this.getAgentName()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getVpcEndpointId() == null ^ this.getVpcEndpointId() == null)
return false;
if (other.getVpcEndpointId() != null && other.getVpcEndpointId().equals(this.getVpcEndpointId()) == false)
return false;
if (other.getSubnetArns() == null ^ this.getSubnetArns() == null)
return false;
if (other.getSubnetArns() != null && other.getSubnetArns().equals(this.getSubnetArns()) == false)
return false;
if (other.getSecurityGroupArns() == null ^ this.getSecurityGroupArns() == null)
return false;
if (other.getSecurityGroupArns() != null && other.getSecurityGroupArns().equals(this.getSecurityGroupArns()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getActivationKey() == null) ? 0 : getActivationKey().hashCode());
hashCode = prime * hashCode + ((getAgentName() == null) ? 0 : getAgentName().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getVpcEndpointId() == null) ? 0 : getVpcEndpointId().hashCode());
hashCode = prime * hashCode + ((getSubnetArns() == null) ? 0 : getSubnetArns().hashCode());
hashCode = prime * hashCode + ((getSecurityGroupArns() == null) ? 0 : getSecurityGroupArns().hashCode());
return hashCode;
}
@Override
public CreateAgentRequest clone() {
return (CreateAgentRequest) super.clone();
}
}