software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest 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 DescribeInstancesRequest extends OpsWorksRequest implements
ToCopyableBuilder {
private static final SdkField STACK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackId").getter(getter(DescribeInstancesRequest::stackId)).setter(setter(Builder::stackId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackId").build()).build();
private static final SdkField LAYER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LayerId").getter(getter(DescribeInstancesRequest::layerId)).setter(setter(Builder::layerId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LayerId").build()).build();
private static final SdkField> INSTANCE_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("InstanceIds")
.getter(getter(DescribeInstancesRequest::instanceIds))
.setter(setter(Builder::instanceIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceIds").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(STACK_ID_FIELD,
LAYER_ID_FIELD, INSTANCE_IDS_FIELD));
private final String stackId;
private final String layerId;
private final List instanceIds;
private DescribeInstancesRequest(BuilderImpl builder) {
super(builder);
this.stackId = builder.stackId;
this.layerId = builder.layerId;
this.instanceIds = builder.instanceIds;
}
/**
*
* A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances
* associated with the specified stack.
*
*
* @return A stack ID. If you use this parameter, DescribeInstances returns descriptions of the
* instances associated with the specified stack.
*/
public final String stackId() {
return stackId;
}
/**
*
* A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances
* associated with the specified layer.
*
*
* @return A layer ID. If you use this parameter, DescribeInstances returns descriptions of the
* instances associated with the specified layer.
*/
public final String layerId() {
return layerId;
}
/**
* Returns true if the InstanceIds property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasInstanceIds() {
return instanceIds != null && !(instanceIds instanceof SdkAutoConstructList);
}
/**
*
* An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a
* description of the specified instances. Otherwise, it returns a description of every instance.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasInstanceIds()} to see if a value was sent in this field.
*
*
* @return An array of instance IDs to be described. If you use this parameter, DescribeInstances
* returns a description of the specified instances. Otherwise, it returns a description of every instance.
*/
public final List instanceIds() {
return instanceIds;
}
@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(stackId());
hashCode = 31 * hashCode + Objects.hashCode(layerId());
hashCode = 31 * hashCode + Objects.hashCode(hasInstanceIds() ? instanceIds() : 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 DescribeInstancesRequest)) {
return false;
}
DescribeInstancesRequest other = (DescribeInstancesRequest) obj;
return Objects.equals(stackId(), other.stackId()) && Objects.equals(layerId(), other.layerId())
&& hasInstanceIds() == other.hasInstanceIds() && Objects.equals(instanceIds(), other.instanceIds());
}
/**
* 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("DescribeInstancesRequest").add("StackId", stackId()).add("LayerId", layerId())
.add("InstanceIds", hasInstanceIds() ? instanceIds() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StackId":
return Optional.ofNullable(clazz.cast(stackId()));
case "LayerId":
return Optional.ofNullable(clazz.cast(layerId()));
case "InstanceIds":
return Optional.ofNullable(clazz.cast(instanceIds()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeInstancesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends OpsWorksRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances
* associated with the specified stack.
*
*
* @param stackId
* A stack ID. If you use this parameter, DescribeInstances returns descriptions of the
* instances associated with the specified stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackId(String stackId);
/**
*
* A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances
* associated with the specified layer.
*
*
* @param layerId
* A layer ID. If you use this parameter, DescribeInstances returns descriptions of the
* instances associated with the specified layer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder layerId(String layerId);
/**
*
* An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a
* description of the specified instances. Otherwise, it returns a description of every instance.
*
*
* @param instanceIds
* An array of instance IDs to be described. If you use this parameter, DescribeInstances
* returns a description of the specified instances. Otherwise, it returns a description of every
* instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceIds(Collection instanceIds);
/**
*
* An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a
* description of the specified instances. Otherwise, it returns a description of every instance.
*
*
* @param instanceIds
* An array of instance IDs to be described. If you use this parameter, DescribeInstances
* returns a description of the specified instances. Otherwise, it returns a description of every
* instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceIds(String... instanceIds);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends OpsWorksRequest.BuilderImpl implements Builder {
private String stackId;
private String layerId;
private List instanceIds = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeInstancesRequest model) {
super(model);
stackId(model.stackId);
layerId(model.layerId);
instanceIds(model.instanceIds);
}
public final String getStackId() {
return stackId;
}
@Override
public final Builder stackId(String stackId) {
this.stackId = stackId;
return this;
}
public final void setStackId(String stackId) {
this.stackId = stackId;
}
public final String getLayerId() {
return layerId;
}
@Override
public final Builder layerId(String layerId) {
this.layerId = layerId;
return this;
}
public final void setLayerId(String layerId) {
this.layerId = layerId;
}
public final Collection getInstanceIds() {
if (instanceIds instanceof SdkAutoConstructList) {
return null;
}
return instanceIds;
}
@Override
public final Builder instanceIds(Collection instanceIds) {
this.instanceIds = StringsCopier.copy(instanceIds);
return this;
}
@Override
@SafeVarargs
public final Builder instanceIds(String... instanceIds) {
instanceIds(Arrays.asList(instanceIds));
return this;
}
public final void setInstanceIds(Collection instanceIds) {
this.instanceIds = StringsCopier.copy(instanceIds);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeInstancesRequest build() {
return new DescribeInstancesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy