software.amazon.awssdk.services.datapipeline.model.SetStatusRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of datapipeline Show documentation
Show all versions of datapipeline Show documentation
The AWS Java SDK for AWS Data Pipeline module holds the client classes that are used for communicating
with AWS Data
Pipeline 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.datapipeline.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 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;
/**
*
* Contains the parameters for SetStatus.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SetStatusRequest extends DataPipelineRequest implements
ToCopyableBuilder {
private static final SdkField PIPELINE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("pipelineId").getter(getter(SetStatusRequest::pipelineId)).setter(setter(Builder::pipelineId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("pipelineId").build()).build();
private static final SdkField> OBJECT_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("objectIds")
.getter(getter(SetStatusRequest::objectIds))
.setter(setter(Builder::objectIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("objectIds").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 STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(SetStatusRequest::status)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PIPELINE_ID_FIELD,
OBJECT_IDS_FIELD, STATUS_FIELD));
private final String pipelineId;
private final List objectIds;
private final String status;
private SetStatusRequest(BuilderImpl builder) {
super(builder);
this.pipelineId = builder.pipelineId;
this.objectIds = builder.objectIds;
this.status = builder.status;
}
/**
*
* The ID of the pipeline that contains the objects.
*
*
* @return The ID of the pipeline that contains the objects.
*/
public final String pipelineId() {
return pipelineId;
}
/**
* For responses, this returns true if the service returned a value for the ObjectIds 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 hasObjectIds() {
return objectIds != null && !(objectIds instanceof SdkAutoConstructList);
}
/**
*
* The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both
* types.
*
*
* 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 #hasObjectIds} method.
*
*
* @return The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of
* both types.
*/
public final List objectIds() {
return objectIds;
}
/**
*
* The status to be set on all the objects specified in objectIds. For components, use
* PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or
* MARK_FINISHED.
*
*
* @return The status to be set on all the objects specified in objectIds. For components, use
* PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN
* , or MARK_FINISHED.
*/
public final String status() {
return status;
}
@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(pipelineId());
hashCode = 31 * hashCode + Objects.hashCode(hasObjectIds() ? objectIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(status());
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 SetStatusRequest)) {
return false;
}
SetStatusRequest other = (SetStatusRequest) obj;
return Objects.equals(pipelineId(), other.pipelineId()) && hasObjectIds() == other.hasObjectIds()
&& Objects.equals(objectIds(), other.objectIds()) && Objects.equals(status(), other.status());
}
/**
* 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("SetStatusRequest").add("PipelineId", pipelineId())
.add("ObjectIds", hasObjectIds() ? objectIds() : null).add("Status", status()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "pipelineId":
return Optional.ofNullable(clazz.cast(pipelineId()));
case "objectIds":
return Optional.ofNullable(clazz.cast(objectIds()));
case "status":
return Optional.ofNullable(clazz.cast(status()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SetStatusRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DataPipelineRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the pipeline that contains the objects.
*
*
* @param pipelineId
* The ID of the pipeline that contains the objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineId(String pipelineId);
/**
*
* The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both
* types.
*
*
* @param objectIds
* The IDs of the objects. The corresponding objects can be either physical or components, but not a mix
* of both types.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder objectIds(Collection objectIds);
/**
*
* The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both
* types.
*
*
* @param objectIds
* The IDs of the objects. The corresponding objects can be either physical or components, but not a mix
* of both types.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder objectIds(String... objectIds);
/**
*
* The status to be set on all the objects specified in objectIds. For components, use
* PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or
* MARK_FINISHED.
*
*
* @param status
* The status to be set on all the objects specified in objectIds. For components, use
* PAUSE or RESUME. For instances, use TRY_CANCEL,
* RERUN, or MARK_FINISHED.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(String status);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DataPipelineRequest.BuilderImpl implements Builder {
private String pipelineId;
private List objectIds = DefaultSdkAutoConstructList.getInstance();
private String status;
private BuilderImpl() {
}
private BuilderImpl(SetStatusRequest model) {
super(model);
pipelineId(model.pipelineId);
objectIds(model.objectIds);
status(model.status);
}
public final String getPipelineId() {
return pipelineId;
}
public final void setPipelineId(String pipelineId) {
this.pipelineId = pipelineId;
}
@Override
public final Builder pipelineId(String pipelineId) {
this.pipelineId = pipelineId;
return this;
}
public final Collection getObjectIds() {
if (objectIds instanceof SdkAutoConstructList) {
return null;
}
return objectIds;
}
public final void setObjectIds(Collection objectIds) {
this.objectIds = _idListCopier.copy(objectIds);
}
@Override
public final Builder objectIds(Collection objectIds) {
this.objectIds = _idListCopier.copy(objectIds);
return this;
}
@Override
@SafeVarargs
public final Builder objectIds(String... objectIds) {
objectIds(Arrays.asList(objectIds));
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
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 SetStatusRequest build() {
return new SetStatusRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}