software.amazon.awssdk.services.emr.model.Application Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of emr Show documentation
Show all versions of emr Show documentation
The AWS Java SDK for Amazon EMR module holds the client classes that are used for communicating with
Amazon Elastic MapReduce Service
/*
* 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.emr.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* With Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. To pass arguments
* to applications, you use configuration classifications specified using configuration JSON objects. For more
* information, see Configuring
* Applications.
*
*
* With earlier Amazon EMR releases, the application is any Amazon or third-party software that you can add to the
* cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a
* user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as
* bootstrap action argument.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Application implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Application::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField VERSION_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Version")
.getter(getter(Application::version)).setter(setter(Builder::version))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Version").build()).build();
private static final SdkField> ARGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Args")
.getter(getter(Application::args))
.setter(setter(Builder::args))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Args").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ADDITIONAL_INFO_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("AdditionalInfo")
.getter(getter(Application::additionalInfo))
.setter(setter(Builder::additionalInfo))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AdditionalInfo").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, VERSION_FIELD,
ARGS_FIELD, ADDITIONAL_INFO_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String version;
private final List args;
private final Map additionalInfo;
private Application(BuilderImpl builder) {
this.name = builder.name;
this.version = builder.version;
this.args = builder.args;
this.additionalInfo = builder.additionalInfo;
}
/**
*
* The name of the application.
*
*
* @return The name of the application.
*/
public final String name() {
return name;
}
/**
*
* The version of the application.
*
*
* @return The version of the application.
*/
public final String version() {
return version;
}
/**
* For responses, this returns true if the service returned a value for the Args property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasArgs() {
return args != null && !(args instanceof SdkAutoConstructList);
}
/**
*
* Arguments for Amazon EMR to pass to the application.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasArgs} method.
*
*
* @return Arguments for Amazon EMR to pass to the application.
*/
public final List args() {
return args;
}
/**
* For responses, this returns true if the service returned a value for the AdditionalInfo property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasAdditionalInfo() {
return additionalInfo != null && !(additionalInfo instanceof SdkAutoConstructMap);
}
/**
*
* This option is for advanced users only. This is meta information about third-party applications that third-party
* vendors use for testing purposes.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasAdditionalInfo} method.
*
*
* @return This option is for advanced users only. This is meta information about third-party applications that
* third-party vendors use for testing purposes.
*/
public final Map additionalInfo() {
return additionalInfo;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(version());
hashCode = 31 * hashCode + Objects.hashCode(hasArgs() ? args() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAdditionalInfo() ? additionalInfo() : null);
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 Application)) {
return false;
}
Application other = (Application) obj;
return Objects.equals(name(), other.name()) && Objects.equals(version(), other.version()) && hasArgs() == other.hasArgs()
&& Objects.equals(args(), other.args()) && hasAdditionalInfo() == other.hasAdditionalInfo()
&& Objects.equals(additionalInfo(), other.additionalInfo());
}
/**
* 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("Application").add("Name", name()).add("Version", version())
.add("Args", hasArgs() ? args() : null).add("AdditionalInfo", hasAdditionalInfo() ? additionalInfo() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Version":
return Optional.ofNullable(clazz.cast(version()));
case "Args":
return Optional.ofNullable(clazz.cast(args()));
case "AdditionalInfo":
return Optional.ofNullable(clazz.cast(additionalInfo()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Application) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the application.
*
*
* @param name
* The name of the application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The version of the application.
*
*
* @param version
* The version of the application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder version(String version);
/**
*
* Arguments for Amazon EMR to pass to the application.
*
*
* @param args
* Arguments for Amazon EMR to pass to the application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder args(Collection args);
/**
*
* Arguments for Amazon EMR to pass to the application.
*
*
* @param args
* Arguments for Amazon EMR to pass to the application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder args(String... args);
/**
*
* This option is for advanced users only. This is meta information about third-party applications that
* third-party vendors use for testing purposes.
*
*
* @param additionalInfo
* This option is for advanced users only. This is meta information about third-party applications that
* third-party vendors use for testing purposes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder additionalInfo(Map additionalInfo);
}
static final class BuilderImpl implements Builder {
private String name;
private String version;
private List args = DefaultSdkAutoConstructList.getInstance();
private Map additionalInfo = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Application model) {
name(model.name);
version(model.version);
args(model.args);
additionalInfo(model.additionalInfo);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getVersion() {
return version;
}
public final void setVersion(String version) {
this.version = version;
}
@Override
public final Builder version(String version) {
this.version = version;
return this;
}
public final Collection getArgs() {
if (args instanceof SdkAutoConstructList) {
return null;
}
return args;
}
public final void setArgs(Collection args) {
this.args = StringListCopier.copy(args);
}
@Override
public final Builder args(Collection args) {
this.args = StringListCopier.copy(args);
return this;
}
@Override
@SafeVarargs
public final Builder args(String... args) {
args(Arrays.asList(args));
return this;
}
public final Map getAdditionalInfo() {
if (additionalInfo instanceof SdkAutoConstructMap) {
return null;
}
return additionalInfo;
}
public final void setAdditionalInfo(Map additionalInfo) {
this.additionalInfo = StringMapCopier.copy(additionalInfo);
}
@Override
public final Builder additionalInfo(Map additionalInfo) {
this.additionalInfo = StringMapCopier.copy(additionalInfo);
return this;
}
@Override
public Application build() {
return new Application(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy