software.amazon.awssdk.services.opsworks.model.DescribeVolumesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opsworks Show documentation
Show all versions of opsworks Show documentation
The AWS Java SDK for AWS OpsWorks module holds the client classes that are used for communicating with
AWS OpsWorks 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.opsworks.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeVolumesRequest extends OpsWorksRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(DescribeVolumesRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceId").build()).build();
private static final SdkField STACK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackId").getter(getter(DescribeVolumesRequest::stackId)).setter(setter(Builder::stackId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackId").build()).build();
private static final SdkField RAID_ARRAY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RaidArrayId").getter(getter(DescribeVolumesRequest::raidArrayId)).setter(setter(Builder::raidArrayId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RaidArrayId").build()).build();
private static final SdkField> VOLUME_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("VolumeIds")
.getter(getter(DescribeVolumesRequest::volumeIds))
.setter(setter(Builder::volumeIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VolumeIds").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_ID_FIELD,
STACK_ID_FIELD, RAID_ARRAY_ID_FIELD, VOLUME_IDS_FIELD));
private final String instanceId;
private final String stackId;
private final String raidArrayId;
private final List volumeIds;
private DescribeVolumesRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.stackId = builder.stackId;
this.raidArrayId = builder.raidArrayId;
this.volumeIds = builder.volumeIds;
}
/**
*
* The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes
* associated with the specified instance.
*
*
* @return The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the
* volumes associated with the specified instance.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* A stack ID. The action describes the stack's registered Amazon EBS volumes.
*
*
* @return A stack ID. The action describes the stack's registered Amazon EBS volumes.
*/
public final String stackId() {
return stackId;
}
/**
*
* The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes
* associated with the specified RAID array.
*
*
* @return The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the
* volumes associated with the specified RAID array.
*/
public final String raidArrayId() {
return raidArrayId;
}
/**
* For responses, this returns true if the service returned a value for the VolumeIds 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 hasVolumeIds() {
return volumeIds != null && !(volumeIds instanceof SdkAutoConstructList);
}
/**
*
* Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the
* specified volumes. Otherwise, it returns a description of every volume.
*
*
* 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 #hasVolumeIds} method.
*
*
* @return Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of
* the specified volumes. Otherwise, it returns a description of every volume.
*/
public final List volumeIds() {
return volumeIds;
}
@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(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(stackId());
hashCode = 31 * hashCode + Objects.hashCode(raidArrayId());
hashCode = 31 * hashCode + Objects.hashCode(hasVolumeIds() ? volumeIds() : null);
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 DescribeVolumesRequest)) {
return false;
}
DescribeVolumesRequest other = (DescribeVolumesRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(stackId(), other.stackId())
&& Objects.equals(raidArrayId(), other.raidArrayId()) && hasVolumeIds() == other.hasVolumeIds()
&& Objects.equals(volumeIds(), other.volumeIds());
}
/**
* 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("DescribeVolumesRequest").add("InstanceId", instanceId()).add("StackId", stackId())
.add("RaidArrayId", raidArrayId()).add("VolumeIds", hasVolumeIds() ? volumeIds() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "StackId":
return Optional.ofNullable(clazz.cast(stackId()));
case "RaidArrayId":
return Optional.ofNullable(clazz.cast(raidArrayId()));
case "VolumeIds":
return Optional.ofNullable(clazz.cast(volumeIds()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeVolumesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends OpsWorksRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes
* associated with the specified instance.
*
*
* @param instanceId
* The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the
* volumes associated with the specified instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* A stack ID. The action describes the stack's registered Amazon EBS volumes.
*
*
* @param stackId
* A stack ID. The action describes the stack's registered Amazon EBS volumes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackId(String stackId);
/**
*
* The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the
* volumes associated with the specified RAID array.
*
*
* @param raidArrayId
* The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the
* volumes associated with the specified RAID array.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder raidArrayId(String raidArrayId);
/**
*
* Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the
* specified volumes. Otherwise, it returns a description of every volume.
*
*
* @param volumeIds
* Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions
* of the specified volumes. Otherwise, it returns a description of every volume.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder volumeIds(Collection volumeIds);
/**
*
* Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the
* specified volumes. Otherwise, it returns a description of every volume.
*
*
* @param volumeIds
* Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions
* of the specified volumes. Otherwise, it returns a description of every volume.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder volumeIds(String... volumeIds);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends OpsWorksRequest.BuilderImpl implements Builder {
private String instanceId;
private String stackId;
private String raidArrayId;
private List volumeIds = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeVolumesRequest model) {
super(model);
instanceId(model.instanceId);
stackId(model.stackId);
raidArrayId(model.raidArrayId);
volumeIds(model.volumeIds);
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
public final Builder instanceId(String instanceId) {
this.instanceId = instanceId;
return this;
}
public final String getStackId() {
return stackId;
}
public final void setStackId(String stackId) {
this.stackId = stackId;
}
@Override
public final Builder stackId(String stackId) {
this.stackId = stackId;
return this;
}
public final String getRaidArrayId() {
return raidArrayId;
}
public final void setRaidArrayId(String raidArrayId) {
this.raidArrayId = raidArrayId;
}
@Override
public final Builder raidArrayId(String raidArrayId) {
this.raidArrayId = raidArrayId;
return this;
}
public final Collection getVolumeIds() {
if (volumeIds instanceof SdkAutoConstructList) {
return null;
}
return volumeIds;
}
public final void setVolumeIds(Collection volumeIds) {
this.volumeIds = StringsCopier.copy(volumeIds);
}
@Override
public final Builder volumeIds(Collection volumeIds) {
this.volumeIds = StringsCopier.copy(volumeIds);
return this;
}
@Override
@SafeVarargs
public final Builder volumeIds(String... volumeIds) {
volumeIds(Arrays.asList(volumeIds));
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 DescribeVolumesRequest build() {
return new DescribeVolumesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy