/* * 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; /** *

* Details on a container instance bind mount host volume. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class HostVolumeProperties implements Serializable, Cloneable, StructuredPojo { /** *

* When the host parameter is used, specify a sourcePath to declare the path on the host * container instance that's presented to the container. If this parameter is empty, then the Docker daemon has * assigned a host path for you. If the host parameter contains a sourcePath file * location, then the data volume persists at the specified location on the host container instance until you delete * it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon * creates it. If the location does exist, the contents of the source path folder are exported. *

*

* If you're using the Fargate launch type, the sourcePath parameter is not supported. *

*/ private String sourcePath; /** *

* When the host parameter is used, specify a sourcePath to declare the path on the host * container instance that's presented to the container. If this parameter is empty, then the Docker daemon has * assigned a host path for you. If the host parameter contains a sourcePath file * location, then the data volume persists at the specified location on the host container instance until you delete * it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon * creates it. If the location does exist, the contents of the source path folder are exported. *

*

* If you're using the Fargate launch type, the sourcePath parameter is not supported. *

* * @param sourcePath * When the host parameter is used, specify a sourcePath to declare the path on the * host container instance that's presented to the container. If this parameter is empty, then the Docker * daemon has assigned a host path for you. If the host parameter contains a * sourcePath file location, then the data volume persists at the specified location on the host * container instance until you delete it manually. If the sourcePath value doesn't exist on the * host container instance, the Docker daemon creates it. If the location does exist, the contents of the * source path folder are exported.

*

* If you're using the Fargate launch type, the sourcePath parameter is not supported. */ public void setSourcePath(String sourcePath) { this.sourcePath = sourcePath; } /** *

* When the host parameter is used, specify a sourcePath to declare the path on the host * container instance that's presented to the container. If this parameter is empty, then the Docker daemon has * assigned a host path for you. If the host parameter contains a sourcePath file * location, then the data volume persists at the specified location on the host container instance until you delete * it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon * creates it. If the location does exist, the contents of the source path folder are exported. *

*

* If you're using the Fargate launch type, the sourcePath parameter is not supported. *

* * @return When the host parameter is used, specify a sourcePath to declare the path on * the host container instance that's presented to the container. If this parameter is empty, then the * Docker daemon has assigned a host path for you. If the host parameter contains a * sourcePath file location, then the data volume persists at the specified location on the * host container instance until you delete it manually. If the sourcePath value doesn't exist * on the host container instance, the Docker daemon creates it. If the location does exist, the contents of * the source path folder are exported.

*

* If you're using the Fargate launch type, the sourcePath parameter is not supported. */ public String getSourcePath() { return this.sourcePath; } /** *

* When the host parameter is used, specify a sourcePath to declare the path on the host * container instance that's presented to the container. If this parameter is empty, then the Docker daemon has * assigned a host path for you. If the host parameter contains a sourcePath file * location, then the data volume persists at the specified location on the host container instance until you delete * it manually. If the sourcePath value doesn't exist on the host container instance, the Docker daemon * creates it. If the location does exist, the contents of the source path folder are exported. *

*

* If you're using the Fargate launch type, the sourcePath parameter is not supported. *

* * @param sourcePath * When the host parameter is used, specify a sourcePath to declare the path on the * host container instance that's presented to the container. If this parameter is empty, then the Docker * daemon has assigned a host path for you. If the host parameter contains a * sourcePath file location, then the data volume persists at the specified location on the host * container instance until you delete it manually. If the sourcePath value doesn't exist on the * host container instance, the Docker daemon creates it. If the location does exist, the contents of the * source path folder are exported.

*

* If you're using the Fargate launch type, the sourcePath parameter is not supported. * @return Returns a reference to this object so that method calls can be chained together. */ public HostVolumeProperties withSourcePath(String sourcePath) { setSourcePath(sourcePath); 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 (getSourcePath() != null) sb.append("SourcePath: ").append(getSourcePath()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof HostVolumeProperties == false) return false; HostVolumeProperties other = (HostVolumeProperties) obj; if (other.getSourcePath() == null ^ this.getSourcePath() == null) return false; if (other.getSourcePath() != null && other.getSourcePath().equals(this.getSourcePath()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getSourcePath() == null) ? 0 : getSourcePath().hashCode()); return hashCode; } @Override public HostVolumeProperties clone() { try { return (HostVolumeProperties) 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.HostVolumePropertiesMarshaller.getInstance().marshall(this, protocolMarshaller); } }