software.amazon.awssdk.services.appstream.model.DescribeImagesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of appstream Show documentation
Show all versions of appstream Show documentation
The AWS Java SDK for Amazon AppStream module holds the client classes that are used for communicating
with Amazon AppStream.
/*
* 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.appstream.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeImagesRequest extends AppStreamRequest implements
ToCopyableBuilder {
private static final SdkField> NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Names")
.getter(getter(DescribeImagesRequest::names))
.setter(setter(Builder::names))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Names").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> ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Arns")
.getter(getter(DescribeImagesRequest::arns))
.setter(setter(Builder::arns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arns").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 TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(DescribeImagesRequest::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeImagesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(DescribeImagesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAMES_FIELD, ARNS_FIELD,
TYPE_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final List names;
private final List arns;
private final String type;
private final String nextToken;
private final Integer maxResults;
private DescribeImagesRequest(BuilderImpl builder) {
super(builder);
this.names = builder.names;
this.arns = builder.arns;
this.type = builder.type;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
* For responses, this returns true if the service returned a value for the Names 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 hasNames() {
return names != null && !(names instanceof SdkAutoConstructList);
}
/**
*
* The names of the public or private images to describe.
*
*
* 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 #hasNames} method.
*
*
* @return The names of the public or private images to describe.
*/
public final List names() {
return names;
}
/**
* For responses, this returns true if the service returned a value for the Arns 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 hasArns() {
return arns != null && !(arns instanceof SdkAutoConstructList);
}
/**
*
* The ARNs of the public, private, and shared images to describe.
*
*
* 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 #hasArns} method.
*
*
* @return The ARNs of the public, private, and shared images to describe.
*/
public final List arns() {
return arns;
}
/**
*
* The type of image (public, private, or shared) to describe.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link VisibilityType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of image (public, private, or shared) to describe.
* @see VisibilityType
*/
public final VisibilityType type() {
return VisibilityType.fromValue(type);
}
/**
*
* The type of image (public, private, or shared) to describe.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link VisibilityType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of image (public, private, or shared) to describe.
* @see VisibilityType
*/
public final String typeAsString() {
return type;
}
/**
*
* The pagination token to use to retrieve the next page of results for this operation. If this value is null, it
* retrieves the first page.
*
*
* @return The pagination token to use to retrieve the next page of results for this operation. If this value is
* null, it retrieves the first page.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum size of each page of results.
*
*
* @return The maximum size of each page of results.
*/
public final Integer maxResults() {
return maxResults;
}
@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(hasNames() ? names() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasArns() ? arns() : null);
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 DescribeImagesRequest)) {
return false;
}
DescribeImagesRequest other = (DescribeImagesRequest) obj;
return hasNames() == other.hasNames() && Objects.equals(names(), other.names()) && hasArns() == other.hasArns()
&& Objects.equals(arns(), other.arns()) && Objects.equals(typeAsString(), other.typeAsString())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("DescribeImagesRequest").add("Names", hasNames() ? names() : null)
.add("Arns", hasArns() ? arns() : null).add("Type", typeAsString()).add("NextToken", nextToken())
.add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Names":
return Optional.ofNullable(clazz.cast(names()));
case "Arns":
return Optional.ofNullable(clazz.cast(arns()));
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeImagesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AppStreamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The names of the public or private images to describe.
*
*
* @param names
* The names of the public or private images to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder names(Collection names);
/**
*
* The names of the public or private images to describe.
*
*
* @param names
* The names of the public or private images to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder names(String... names);
/**
*
* The ARNs of the public, private, and shared images to describe.
*
*
* @param arns
* The ARNs of the public, private, and shared images to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arns(Collection arns);
/**
*
* The ARNs of the public, private, and shared images to describe.
*
*
* @param arns
* The ARNs of the public, private, and shared images to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arns(String... arns);
/**
*
* The type of image (public, private, or shared) to describe.
*
*
* @param type
* The type of image (public, private, or shared) to describe.
* @see VisibilityType
* @return Returns a reference to this object so that method calls can be chained together.
* @see VisibilityType
*/
Builder type(String type);
/**
*
* The type of image (public, private, or shared) to describe.
*
*
* @param type
* The type of image (public, private, or shared) to describe.
* @see VisibilityType
* @return Returns a reference to this object so that method calls can be chained together.
* @see VisibilityType
*/
Builder type(VisibilityType type);
/**
*
* The pagination token to use to retrieve the next page of results for this operation. If this value is null,
* it retrieves the first page.
*
*
* @param nextToken
* The pagination token to use to retrieve the next page of results for this operation. If this value is
* null, it retrieves the first page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum size of each page of results.
*
*
* @param maxResults
* The maximum size of each page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AppStreamRequest.BuilderImpl implements Builder {
private List names = DefaultSdkAutoConstructList.getInstance();
private List arns = DefaultSdkAutoConstructList.getInstance();
private String type;
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(DescribeImagesRequest model) {
super(model);
names(model.names);
arns(model.arns);
type(model.type);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final Collection getNames() {
if (names instanceof SdkAutoConstructList) {
return null;
}
return names;
}
public final void setNames(Collection names) {
this.names = StringListCopier.copy(names);
}
@Override
@Transient
public final Builder names(Collection names) {
this.names = StringListCopier.copy(names);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder names(String... names) {
names(Arrays.asList(names));
return this;
}
public final Collection getArns() {
if (arns instanceof SdkAutoConstructList) {
return null;
}
return arns;
}
public final void setArns(Collection arns) {
this.arns = ArnListCopier.copy(arns);
}
@Override
@Transient
public final Builder arns(Collection arns) {
this.arns = ArnListCopier.copy(arns);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder arns(String... arns) {
arns(Arrays.asList(arns));
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
@Transient
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
@Transient
public final Builder type(VisibilityType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
@Transient
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
@Transient
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
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 DescribeImagesRequest build() {
return new DescribeImagesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy