software.amazon.awssdk.services.batch.model.Volume Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.batch.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A data volume used in a job's container properties.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Volume implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField HOST_FIELD = SdkField. builder(MarshallingType.SDK_POJO).memberName("host")
.getter(getter(Volume::host)).setter(setter(Builder::host)).constructor(Host::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("host").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(Volume::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(HOST_FIELD, NAME_FIELD));
private static final long serialVersionUID = 1L;
private final Host host;
private final String name;
private Volume(BuilderImpl builder) {
this.host = builder.host;
this.name = builder.name;
}
/**
*
* The contents of the host parameter determine whether your data volume persists on the host container
* instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for
* your data volume. However, the data isn't guaranteed to persist after the containers associated with it stop
* running.
*
*
*
* This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
*
*
*
* @return The contents of the host parameter determine whether your data volume persists on the host
* container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns
* a host path for your data volume. However, the data isn't guaranteed to persist after the containers
* associated with it stop running.
*
* This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
*
*/
public final Host host() {
return host;
}
/**
*
* The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are
* allowed. This name is referenced in the sourceVolume parameter of container definition
* mountPoints.
*
*
* @return The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores
* are allowed. This name is referenced in the sourceVolume parameter of container definition
* mountPoints.
*/
public final String name() {
return name;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(host());
hashCode = 31 * hashCode + Objects.hashCode(name());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Volume)) {
return false;
}
Volume other = (Volume) obj;
return Objects.equals(host(), other.host()) && Objects.equals(name(), other.name());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("Volume").add("Host", host()).add("Name", name()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "host":
return Optional.ofNullable(clazz.cast(host()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Volume) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The contents of the host parameter determine whether your data volume persists on the host
* container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a
* host path for your data volume. However, the data isn't guaranteed to persist after the containers associated
* with it stop running.
*
*
*
* This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
*
*
*
* @param host
* The contents of the host parameter determine whether your data volume persists on the
* host container instance and where it is stored. If the host parameter is empty, then the Docker daemon
* assigns a host path for your data volume. However, the data isn't guaranteed to persist after the
* containers associated with it stop running.
*
* This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder host(Host host);
/**
*
* The contents of the host parameter determine whether your data volume persists on the host
* container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a
* host path for your data volume. However, the data isn't guaranteed to persist after the containers associated
* with it stop running.
*
*
*
* This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
*
* This is a convenience that creates an instance of the {@link Host.Builder} avoiding the need to
* create one manually via {@link Host#builder()}.
*
* When the {@link Consumer} completes, {@link Host.Builder#build()} is called immediately and its result is
* passed to {@link #host(Host)}.
*
* @param host
* a consumer that will call methods on {@link Host.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #host(Host)
*/
default Builder host(Consumer host) {
return host(Host.builder().applyMutation(host).build());
}
/**
*
* The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are
* allowed. This name is referenced in the sourceVolume parameter of container definition
* mountPoints.
*
*
* @param name
* The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores
* are allowed. This name is referenced in the sourceVolume parameter of container
* definition mountPoints.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
}
static final class BuilderImpl implements Builder {
private Host host;
private String name;
private BuilderImpl() {
}
private BuilderImpl(Volume model) {
host(model.host);
name(model.name);
}
public final Host.Builder getHost() {
return host != null ? host.toBuilder() : null;
}
@Override
public final Builder host(Host host) {
this.host = host;
return this;
}
public final void setHost(Host.BuilderImpl host) {
this.host = host != null ? host.build() : null;
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
@Override
public Volume build() {
return new Volume(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}