com.amazonaws.services.ecs.model.ResourceRequirement Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecs 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.ecs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic
* Inference accelerators. For more information, see Working with GPUs on Amazon ECS
* or Working with Amazon
* Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ResourceRequirement implements Serializable, Cloneable, StructuredPojo {
/**
*
* The value for the specified resource type.
*
*
* If the GPU type is used, the value is the number of physical GPUs the Amazon ECS
* container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't
* exceed the number of available GPUs on the container instance that the task is launched on.
*
*
* If the InferenceAccelerator type is used, the value matches the deviceName
* for an
* InferenceAccelerator specified in a task definition.
*
*/
private String value;
/**
*
* The type of resource to assign to a container. The supported values are GPU or
* InferenceAccelerator.
*
*/
private String type;
/**
*
* The value for the specified resource type.
*
*
* If the GPU type is used, the value is the number of physical GPUs the Amazon ECS
* container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't
* exceed the number of available GPUs on the container instance that the task is launched on.
*
*
* If the InferenceAccelerator type is used, the value matches the deviceName
* for an
* InferenceAccelerator specified in a task definition.
*
*
* @param value
* The value for the specified resource type.
*
* If the GPU type is used, the value is the number of physical GPUs the Amazon ECS
* container agent reserves for the container. The number of GPUs that's reserved for all containers in a
* task can't exceed the number of available GPUs on the container instance that the task is launched on.
*
*
* If the InferenceAccelerator type is used, the value matches the
* deviceName for an InferenceAccelerator specified in a task definition.
*/
public void setValue(String value) {
this.value = value;
}
/**
*
* The value for the specified resource type.
*
*
* If the GPU type is used, the value is the number of physical GPUs the Amazon ECS
* container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't
* exceed the number of available GPUs on the container instance that the task is launched on.
*
*
* If the InferenceAccelerator type is used, the value matches the deviceName
* for an
* InferenceAccelerator specified in a task definition.
*
*
* @return The value for the specified resource type.
*
* If the GPU type is used, the value is the number of physical GPUs the Amazon
* ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in
* a task can't exceed the number of available GPUs on the container instance that the task is launched on.
*
*
* If the InferenceAccelerator type is used, the value matches the
* deviceName for an InferenceAccelerator specified in a task definition.
*/
public String getValue() {
return this.value;
}
/**
*
* The value for the specified resource type.
*
*
* If the GPU type is used, the value is the number of physical GPUs the Amazon ECS
* container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't
* exceed the number of available GPUs on the container instance that the task is launched on.
*
*
* If the InferenceAccelerator type is used, the value matches the deviceName
* for an
* InferenceAccelerator specified in a task definition.
*
*
* @param value
* The value for the specified resource type.
*
* If the GPU type is used, the value is the number of physical GPUs the Amazon ECS
* container agent reserves for the container. The number of GPUs that's reserved for all containers in a
* task can't exceed the number of available GPUs on the container instance that the task is launched on.
*
*
* If the InferenceAccelerator type is used, the value matches the
* deviceName for an InferenceAccelerator specified in a task definition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceRequirement withValue(String value) {
setValue(value);
return this;
}
/**
*
* The type of resource to assign to a container. The supported values are GPU or
* InferenceAccelerator.
*
*
* @param type
* The type of resource to assign to a container. The supported values are GPU or
* InferenceAccelerator.
* @see ResourceType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of resource to assign to a container. The supported values are GPU or
* InferenceAccelerator.
*
*
* @return The type of resource to assign to a container. The supported values are GPU or
* InferenceAccelerator.
* @see ResourceType
*/
public String getType() {
return this.type;
}
/**
*
* The type of resource to assign to a container. The supported values are GPU or
* InferenceAccelerator.
*
*
* @param type
* The type of resource to assign to a container. The supported values are GPU or
* InferenceAccelerator.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceType
*/
public ResourceRequirement withType(String type) {
setType(type);
return this;
}
/**
*
* The type of resource to assign to a container. The supported values are GPU or
* InferenceAccelerator.
*
*
* @param type
* The type of resource to assign to a container. The supported values are GPU or
* InferenceAccelerator.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceType
*/
public ResourceRequirement withType(ResourceType type) {
this.type = type.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 (getValue() != null)
sb.append("Value: ").append(getValue()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ResourceRequirement == false)
return false;
ResourceRequirement other = (ResourceRequirement) obj;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public ResourceRequirement clone() {
try {
return (ResourceRequirement) 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.ecs.model.transform.ResourceRequirementMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}