software.amazon.awssdk.services.emr.model.ListStepsRequest 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.beans.Transient;
import java.util.Arrays;
import java.util.Collection;
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.awscore.AwsRequestOverrideConfiguration;
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.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* This input determines which steps to list.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListStepsRequest extends EmrRequest implements ToCopyableBuilder {
private static final SdkField CLUSTER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ClusterId").getter(getter(ListStepsRequest::clusterId)).setter(setter(Builder::clusterId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClusterId").build()).build();
private static final SdkField> STEP_STATES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("StepStates")
.getter(getter(ListStepsRequest::stepStatesAsStrings))
.setter(setter(Builder::stepStatesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StepStates").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> STEP_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("StepIds")
.getter(getter(ListStepsRequest::stepIds))
.setter(setter(Builder::stepIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StepIds").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 MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(ListStepsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLUSTER_ID_FIELD,
STEP_STATES_FIELD, STEP_IDS_FIELD, MARKER_FIELD));
private final String clusterId;
private final List stepStates;
private final List stepIds;
private final String marker;
private ListStepsRequest(BuilderImpl builder) {
super(builder);
this.clusterId = builder.clusterId;
this.stepStates = builder.stepStates;
this.stepIds = builder.stepIds;
this.marker = builder.marker;
}
/**
*
* The identifier of the cluster for which to list the steps.
*
*
* @return The identifier of the cluster for which to list the steps.
*/
public final String clusterId() {
return clusterId;
}
/**
*
* The filter to limit the step list based on certain states.
*
*
* 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 #hasStepStates} method.
*
*
* @return The filter to limit the step list based on certain states.
*/
public final List stepStates() {
return StepStateListCopier.copyStringToEnum(stepStates);
}
/**
* For responses, this returns true if the service returned a value for the StepStates 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 hasStepStates() {
return stepStates != null && !(stepStates instanceof SdkAutoConstructList);
}
/**
*
* The filter to limit the step list based on certain states.
*
*
* 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 #hasStepStates} method.
*
*
* @return The filter to limit the step list based on certain states.
*/
public final List stepStatesAsStrings() {
return stepStates;
}
/**
* For responses, this returns true if the service returned a value for the StepIds 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 hasStepIds() {
return stepIds != null && !(stepIds instanceof SdkAutoConstructList);
}
/**
*
* The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step
* IDs. The character constraint applies to the overall length of the array.
*
*
* 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 #hasStepIds} method.
*
*
* @return The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten
* Step IDs. The character constraint applies to the overall length of the array.
*/
public final List stepIds() {
return stepIds;
}
/**
*
* The maximum number of steps that a single ListSteps action returns is 50. To return a longer list of
* steps, use multiple ListSteps actions along with the Marker parameter, which is a
* pagination token that indicates the next set of results to retrieve.
*
*
* @return The maximum number of steps that a single ListSteps action returns is 50. To return a longer
* list of steps, use multiple ListSteps actions along with the Marker parameter,
* which is a pagination token that indicates the next set of results to retrieve.
*/
public final String marker() {
return marker;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(clusterId());
hashCode = 31 * hashCode + Objects.hashCode(hasStepStates() ? stepStatesAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasStepIds() ? stepIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(marker());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListStepsRequest)) {
return false;
}
ListStepsRequest other = (ListStepsRequest) obj;
return Objects.equals(clusterId(), other.clusterId()) && hasStepStates() == other.hasStepStates()
&& Objects.equals(stepStatesAsStrings(), other.stepStatesAsStrings()) && hasStepIds() == other.hasStepIds()
&& Objects.equals(stepIds(), other.stepIds()) && Objects.equals(marker(), other.marker());
}
/**
* 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("ListStepsRequest").add("ClusterId", clusterId())
.add("StepStates", hasStepStates() ? stepStatesAsStrings() : null)
.add("StepIds", hasStepIds() ? stepIds() : null).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ClusterId":
return Optional.ofNullable(clazz.cast(clusterId()));
case "StepStates":
return Optional.ofNullable(clazz.cast(stepStatesAsStrings()));
case "StepIds":
return Optional.ofNullable(clazz.cast(stepIds()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListStepsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EmrRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the cluster for which to list the steps.
*
*
* @param clusterId
* The identifier of the cluster for which to list the steps.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clusterId(String clusterId);
/**
*
* The filter to limit the step list based on certain states.
*
*
* @param stepStates
* The filter to limit the step list based on certain states.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stepStatesWithStrings(Collection stepStates);
/**
*
* The filter to limit the step list based on certain states.
*
*
* @param stepStates
* The filter to limit the step list based on certain states.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stepStatesWithStrings(String... stepStates);
/**
*
* The filter to limit the step list based on certain states.
*
*
* @param stepStates
* The filter to limit the step list based on certain states.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stepStates(Collection stepStates);
/**
*
* The filter to limit the step list based on certain states.
*
*
* @param stepStates
* The filter to limit the step list based on certain states.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stepStates(StepState... stepStates);
/**
*
* The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step
* IDs. The character constraint applies to the overall length of the array.
*
*
* @param stepIds
* The filter to limit the step list based on the identifier of the steps. You can specify a maximum of
* ten Step IDs. The character constraint applies to the overall length of the array.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stepIds(Collection stepIds);
/**
*
* The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step
* IDs. The character constraint applies to the overall length of the array.
*
*
* @param stepIds
* The filter to limit the step list based on the identifier of the steps. You can specify a maximum of
* ten Step IDs. The character constraint applies to the overall length of the array.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stepIds(String... stepIds);
/**
*
* The maximum number of steps that a single ListSteps action returns is 50. To return a longer
* list of steps, use multiple ListSteps actions along with the Marker parameter,
* which is a pagination token that indicates the next set of results to retrieve.
*
*
* @param marker
* The maximum number of steps that a single ListSteps action returns is 50. To return a
* longer list of steps, use multiple ListSteps actions along with the Marker
* parameter, which is a pagination token that indicates the next set of results to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EmrRequest.BuilderImpl implements Builder {
private String clusterId;
private List stepStates = DefaultSdkAutoConstructList.getInstance();
private List stepIds = DefaultSdkAutoConstructList.getInstance();
private String marker;
private BuilderImpl() {
}
private BuilderImpl(ListStepsRequest model) {
super(model);
clusterId(model.clusterId);
stepStatesWithStrings(model.stepStates);
stepIds(model.stepIds);
marker(model.marker);
}
public final String getClusterId() {
return clusterId;
}
public final void setClusterId(String clusterId) {
this.clusterId = clusterId;
}
@Override
@Transient
public final Builder clusterId(String clusterId) {
this.clusterId = clusterId;
return this;
}
public final Collection getStepStates() {
if (stepStates instanceof SdkAutoConstructList) {
return null;
}
return stepStates;
}
public final void setStepStates(Collection stepStates) {
this.stepStates = StepStateListCopier.copy(stepStates);
}
@Override
@Transient
public final Builder stepStatesWithStrings(Collection stepStates) {
this.stepStates = StepStateListCopier.copy(stepStates);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder stepStatesWithStrings(String... stepStates) {
stepStatesWithStrings(Arrays.asList(stepStates));
return this;
}
@Override
@Transient
public final Builder stepStates(Collection stepStates) {
this.stepStates = StepStateListCopier.copyEnumToString(stepStates);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder stepStates(StepState... stepStates) {
stepStates(Arrays.asList(stepStates));
return this;
}
public final Collection getStepIds() {
if (stepIds instanceof SdkAutoConstructList) {
return null;
}
return stepIds;
}
public final void setStepIds(Collection stepIds) {
this.stepIds = XmlStringListCopier.copy(stepIds);
}
@Override
@Transient
public final Builder stepIds(Collection stepIds) {
this.stepIds = XmlStringListCopier.copy(stepIds);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder stepIds(String... stepIds) {
stepIds(Arrays.asList(stepIds));
return this;
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
@Transient
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListStepsRequest build() {
return new ListStepsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy