com.amazonaws.services.batch.model.NetworkConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-batch 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.batch.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2
* resources must not specify this parameter.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class NetworkConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private
* subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet
* requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task
* networking in the Amazon Elastic Container Service Developer Guide. The default value is "
* DISABLED".
*
*/
private String assignPublicIp;
/**
*
* Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private
* subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet
* requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task
* networking in the Amazon Elastic Container Service Developer Guide. The default value is "
* DISABLED".
*
*
* @param assignPublicIp
* Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a
* private subnet to send outbound traffic to the internet (for example, to pull container images), the
* private subnet requires a NAT gateway be attached to route requests to the internet. For more information,
* see Amazon ECS
* task networking in the Amazon Elastic Container Service Developer Guide. The default value is "
* DISABLED".
* @see AssignPublicIp
*/
public void setAssignPublicIp(String assignPublicIp) {
this.assignPublicIp = assignPublicIp;
}
/**
*
* Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private
* subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet
* requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task
* networking in the Amazon Elastic Container Service Developer Guide. The default value is "
* DISABLED".
*
*
* @return Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a
* private subnet to send outbound traffic to the internet (for example, to pull container images), the
* private subnet requires a NAT gateway be attached to route requests to the internet. For more
* information, see Amazon ECS task
* networking in the Amazon Elastic Container Service Developer Guide. The default value is "
* DISABLED".
* @see AssignPublicIp
*/
public String getAssignPublicIp() {
return this.assignPublicIp;
}
/**
*
* Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private
* subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet
* requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task
* networking in the Amazon Elastic Container Service Developer Guide. The default value is "
* DISABLED".
*
*
* @param assignPublicIp
* Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a
* private subnet to send outbound traffic to the internet (for example, to pull container images), the
* private subnet requires a NAT gateway be attached to route requests to the internet. For more information,
* see Amazon ECS
* task networking in the Amazon Elastic Container Service Developer Guide. The default value is "
* DISABLED".
* @return Returns a reference to this object so that method calls can be chained together.
* @see AssignPublicIp
*/
public NetworkConfiguration withAssignPublicIp(String assignPublicIp) {
setAssignPublicIp(assignPublicIp);
return this;
}
/**
*
* Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private
* subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet
* requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task
* networking in the Amazon Elastic Container Service Developer Guide. The default value is "
* DISABLED".
*
*
* @param assignPublicIp
* Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a
* private subnet to send outbound traffic to the internet (for example, to pull container images), the
* private subnet requires a NAT gateway be attached to route requests to the internet. For more information,
* see Amazon ECS
* task networking in the Amazon Elastic Container Service Developer Guide. The default value is "
* DISABLED".
* @return Returns a reference to this object so that method calls can be chained together.
* @see AssignPublicIp
*/
public NetworkConfiguration withAssignPublicIp(AssignPublicIp assignPublicIp) {
this.assignPublicIp = assignPublicIp.toString();
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 (getAssignPublicIp() != null)
sb.append("AssignPublicIp: ").append(getAssignPublicIp());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof NetworkConfiguration == false)
return false;
NetworkConfiguration other = (NetworkConfiguration) obj;
if (other.getAssignPublicIp() == null ^ this.getAssignPublicIp() == null)
return false;
if (other.getAssignPublicIp() != null && other.getAssignPublicIp().equals(this.getAssignPublicIp()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAssignPublicIp() == null) ? 0 : getAssignPublicIp().hashCode());
return hashCode;
}
@Override
public NetworkConfiguration clone() {
try {
return (NetworkConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.batch.model.transform.NetworkConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}