software.amazon.awssdk.services.emr.model.AddJobFlowStepsRequest Maven / Gradle / Ivy
Show all versions of emr Show documentation
/*
* 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.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 java.util.stream.Collectors;
import java.util.stream.Stream;
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;
/**
*
* The input argument to the AddJobFlowSteps operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AddJobFlowStepsRequest extends EmrRequest implements
ToCopyableBuilder {
private static final SdkField JOB_FLOW_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("JobFlowId").getter(getter(AddJobFlowStepsRequest::jobFlowId)).setter(setter(Builder::jobFlowId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("JobFlowId").build()).build();
private static final SdkField> STEPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Steps")
.getter(getter(AddJobFlowStepsRequest::steps))
.setter(setter(Builder::steps))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Steps").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(StepConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField EXECUTION_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExecutionRoleArn").getter(getter(AddJobFlowStepsRequest::executionRoleArn))
.setter(setter(Builder::executionRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExecutionRoleArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(JOB_FLOW_ID_FIELD,
STEPS_FIELD, EXECUTION_ROLE_ARN_FIELD));
private final String jobFlowId;
private final List steps;
private final String executionRoleArn;
private AddJobFlowStepsRequest(BuilderImpl builder) {
super(builder);
this.jobFlowId = builder.jobFlowId;
this.steps = builder.steps;
this.executionRoleArn = builder.executionRoleArn;
}
/**
*
* A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be
* obtained from ListClusters.
*
*
* @return A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can
* also be obtained from ListClusters.
*/
public final String jobFlowId() {
return jobFlowId;
}
/**
* For responses, this returns true if the service returned a value for the Steps 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 hasSteps() {
return steps != null && !(steps instanceof SdkAutoConstructList);
}
/**
*
* A list of StepConfig to be executed by the job flow.
*
*
* 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 #hasSteps} method.
*
*
* @return A list of StepConfig to be executed by the job flow.
*/
public final List steps() {
return steps;
}
/**
*
* The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a
* cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the
* following format: arn:partition:service:region:account:resource.
*
*
* For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.
*
*
* @return The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a
* cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type
* using the following format: arn:partition:service:region:account:resource.
*
* For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role
* ARN.
*/
public final String executionRoleArn() {
return executionRoleArn;
}
@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(jobFlowId());
hashCode = 31 * hashCode + Objects.hashCode(hasSteps() ? steps() : null);
hashCode = 31 * hashCode + Objects.hashCode(executionRoleArn());
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 AddJobFlowStepsRequest)) {
return false;
}
AddJobFlowStepsRequest other = (AddJobFlowStepsRequest) obj;
return Objects.equals(jobFlowId(), other.jobFlowId()) && hasSteps() == other.hasSteps()
&& Objects.equals(steps(), other.steps()) && Objects.equals(executionRoleArn(), other.executionRoleArn());
}
/**
* 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("AddJobFlowStepsRequest").add("JobFlowId", jobFlowId()).add("Steps", hasSteps() ? steps() : null)
.add("ExecutionRoleArn", executionRoleArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "JobFlowId":
return Optional.ofNullable(clazz.cast(jobFlowId()));
case "Steps":
return Optional.ofNullable(clazz.cast(steps()));
case "ExecutionRoleArn":
return Optional.ofNullable(clazz.cast(executionRoleArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AddJobFlowStepsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EmrRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also
* be obtained from ListClusters.
*
*
* @param jobFlowId
* A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and
* can also be obtained from ListClusters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder jobFlowId(String jobFlowId);
/**
*
* A list of StepConfig to be executed by the job flow.
*
*
* @param steps
* A list of StepConfig to be executed by the job flow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder steps(Collection steps);
/**
*
* A list of StepConfig to be executed by the job flow.
*
*
* @param steps
* A list of StepConfig to be executed by the job flow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder steps(StepConfig... steps);
/**
*
* A list of StepConfig to be executed by the job flow.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.emr.model.StepConfig.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.emr.model.StepConfig#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.emr.model.StepConfig.Builder#build()} is called immediately and its
* result is passed to {@link #steps(List)}.
*
* @param steps
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.emr.model.StepConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #steps(java.util.Collection)
*/
Builder steps(Consumer... steps);
/**
*
* The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a
* cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using
* the following format: arn:partition:service:region:account:resource.
*
*
* For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.
*
*
* @param executionRoleArn
* The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be
* a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role
* type using the following format: arn:partition:service:region:account:resource.
*
* For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role
* ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder executionRoleArn(String executionRoleArn);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EmrRequest.BuilderImpl implements Builder {
private String jobFlowId;
private List steps = DefaultSdkAutoConstructList.getInstance();
private String executionRoleArn;
private BuilderImpl() {
}
private BuilderImpl(AddJobFlowStepsRequest model) {
super(model);
jobFlowId(model.jobFlowId);
steps(model.steps);
executionRoleArn(model.executionRoleArn);
}
public final String getJobFlowId() {
return jobFlowId;
}
public final void setJobFlowId(String jobFlowId) {
this.jobFlowId = jobFlowId;
}
@Override
public final Builder jobFlowId(String jobFlowId) {
this.jobFlowId = jobFlowId;
return this;
}
public final List getSteps() {
List result = StepConfigListCopier.copyToBuilder(this.steps);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSteps(Collection steps) {
this.steps = StepConfigListCopier.copyFromBuilder(steps);
}
@Override
public final Builder steps(Collection steps) {
this.steps = StepConfigListCopier.copy(steps);
return this;
}
@Override
@SafeVarargs
public final Builder steps(StepConfig... steps) {
steps(Arrays.asList(steps));
return this;
}
@Override
@SafeVarargs
public final Builder steps(Consumer... steps) {
steps(Stream.of(steps).map(c -> StepConfig.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getExecutionRoleArn() {
return executionRoleArn;
}
public final void setExecutionRoleArn(String executionRoleArn) {
this.executionRoleArn = executionRoleArn;
}
@Override
public final Builder executionRoleArn(String executionRoleArn) {
this.executionRoleArn = executionRoleArn;
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 AddJobFlowStepsRequest build() {
return new AddJobFlowStepsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}