software.amazon.awssdk.services.inspector.model.DescribeRulesPackagesResponse Maven / Gradle / Ivy
Show all versions of inspector 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.inspector.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
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.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.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
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 DescribeRulesPackagesResponse extends InspectorResponse implements
ToCopyableBuilder {
private static final SdkField> RULES_PACKAGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("rulesPackages")
.getter(getter(DescribeRulesPackagesResponse::rulesPackages))
.setter(setter(Builder::rulesPackages))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("rulesPackages").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RulesPackage::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> FAILED_ITEMS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("failedItems")
.getter(getter(DescribeRulesPackagesResponse::failedItems))
.setter(setter(Builder::failedItems))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("failedItems").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(FailedItemDetails::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RULES_PACKAGES_FIELD,
FAILED_ITEMS_FIELD));
private final List rulesPackages;
private final Map failedItems;
private DescribeRulesPackagesResponse(BuilderImpl builder) {
super(builder);
this.rulesPackages = builder.rulesPackages;
this.failedItems = builder.failedItems;
}
/**
* For responses, this returns true if the service returned a value for the RulesPackages 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 hasRulesPackages() {
return rulesPackages != null && !(rulesPackages instanceof SdkAutoConstructList);
}
/**
*
* Information about the rules package.
*
*
* 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 #hasRulesPackages} method.
*
*
* @return Information about the rules package.
*/
public final List rulesPackages() {
return rulesPackages;
}
/**
* For responses, this returns true if the service returned a value for the FailedItems 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 hasFailedItems() {
return failedItems != null && !(failedItems instanceof SdkAutoConstructMap);
}
/**
*
* Rules package details that cannot be described. An error code is provided for each failed item.
*
*
* 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 #hasFailedItems} method.
*
*
* @return Rules package details that cannot be described. An error code is provided for each failed item.
*/
public final Map failedItems() {
return failedItems;
}
@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(hasRulesPackages() ? rulesPackages() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasFailedItems() ? failedItems() : 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 DescribeRulesPackagesResponse)) {
return false;
}
DescribeRulesPackagesResponse other = (DescribeRulesPackagesResponse) obj;
return hasRulesPackages() == other.hasRulesPackages() && Objects.equals(rulesPackages(), other.rulesPackages())
&& hasFailedItems() == other.hasFailedItems() && Objects.equals(failedItems(), other.failedItems());
}
/**
* 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("DescribeRulesPackagesResponse")
.add("RulesPackages", hasRulesPackages() ? rulesPackages() : null)
.add("FailedItems", hasFailedItems() ? failedItems() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "rulesPackages":
return Optional.ofNullable(clazz.cast(rulesPackages()));
case "failedItems":
return Optional.ofNullable(clazz.cast(failedItems()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeRulesPackagesResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends InspectorResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Information about the rules package.
*
*
* @param rulesPackages
* Information about the rules package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rulesPackages(Collection rulesPackages);
/**
*
* Information about the rules package.
*
*
* @param rulesPackages
* Information about the rules package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rulesPackages(RulesPackage... rulesPackages);
/**
*
* Information about the rules package.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.inspector.model.RulesPackage.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.inspector.model.RulesPackage#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.inspector.model.RulesPackage.Builder#build()} is called immediately
* and its result is passed to {@link #rulesPackages(List)}.
*
* @param rulesPackages
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.inspector.model.RulesPackage.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #rulesPackages(java.util.Collection)
*/
Builder rulesPackages(Consumer... rulesPackages);
/**
*
* Rules package details that cannot be described. An error code is provided for each failed item.
*
*
* @param failedItems
* Rules package details that cannot be described. An error code is provided for each failed item.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failedItems(Map failedItems);
}
static final class BuilderImpl extends InspectorResponse.BuilderImpl implements Builder {
private List rulesPackages = DefaultSdkAutoConstructList.getInstance();
private Map failedItems = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeRulesPackagesResponse model) {
super(model);
rulesPackages(model.rulesPackages);
failedItems(model.failedItems);
}
public final List getRulesPackages() {
List result = RulesPackageListCopier.copyToBuilder(this.rulesPackages);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRulesPackages(Collection rulesPackages) {
this.rulesPackages = RulesPackageListCopier.copyFromBuilder(rulesPackages);
}
@Override
public final Builder rulesPackages(Collection rulesPackages) {
this.rulesPackages = RulesPackageListCopier.copy(rulesPackages);
return this;
}
@Override
@SafeVarargs
public final Builder rulesPackages(RulesPackage... rulesPackages) {
rulesPackages(Arrays.asList(rulesPackages));
return this;
}
@Override
@SafeVarargs
public final Builder rulesPackages(Consumer... rulesPackages) {
rulesPackages(Stream.of(rulesPackages).map(c -> RulesPackage.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Map getFailedItems() {
Map result = FailedItemsCopier.copyToBuilder(this.failedItems);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setFailedItems(Map failedItems) {
this.failedItems = FailedItemsCopier.copyFromBuilder(failedItems);
}
@Override
public final Builder failedItems(Map failedItems) {
this.failedItems = FailedItemsCopier.copy(failedItems);
return this;
}
@Override
public DescribeRulesPackagesResponse build() {
return new DescribeRulesPackagesResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}