software.amazon.awssdk.services.inspector.model.DescribeFindingsRequest Maven / Gradle / Ivy
/*
* 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.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 DescribeFindingsRequest extends InspectorRequest implements
ToCopyableBuilder {
private static final SdkField> FINDING_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("findingArns")
.getter(getter(DescribeFindingsRequest::findingArns))
.setter(setter(Builder::findingArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("findingArns").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 LOCALE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("locale")
.getter(getter(DescribeFindingsRequest::localeAsString)).setter(setter(Builder::locale))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("locale").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FINDING_ARNS_FIELD,
LOCALE_FIELD));
private final List findingArns;
private final String locale;
private DescribeFindingsRequest(BuilderImpl builder) {
super(builder);
this.findingArns = builder.findingArns;
this.locale = builder.locale;
}
/**
* For responses, this returns true if the service returned a value for the FindingArns 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 hasFindingArns() {
return findingArns != null && !(findingArns instanceof SdkAutoConstructList);
}
/**
*
* The ARN that specifies the finding that you want 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 #hasFindingArns} method.
*
*
* @return The ARN that specifies the finding that you want to describe.
*/
public final List findingArns() {
return findingArns;
}
/**
*
* The locale into which you want to translate a finding description, recommendation, and the short description that
* identifies the finding.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #locale} will
* return {@link Locale#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #localeAsString}.
*
*
* @return The locale into which you want to translate a finding description, recommendation, and the short
* description that identifies the finding.
* @see Locale
*/
public final Locale locale() {
return Locale.fromValue(locale);
}
/**
*
* The locale into which you want to translate a finding description, recommendation, and the short description that
* identifies the finding.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #locale} will
* return {@link Locale#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #localeAsString}.
*
*
* @return The locale into which you want to translate a finding description, recommendation, and the short
* description that identifies the finding.
* @see Locale
*/
public final String localeAsString() {
return locale;
}
@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(hasFindingArns() ? findingArns() : null);
hashCode = 31 * hashCode + Objects.hashCode(localeAsString());
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 DescribeFindingsRequest)) {
return false;
}
DescribeFindingsRequest other = (DescribeFindingsRequest) obj;
return hasFindingArns() == other.hasFindingArns() && Objects.equals(findingArns(), other.findingArns())
&& Objects.equals(localeAsString(), other.localeAsString());
}
/**
* 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("DescribeFindingsRequest").add("FindingArns", hasFindingArns() ? findingArns() : null)
.add("Locale", localeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "findingArns":
return Optional.ofNullable(clazz.cast(findingArns()));
case "locale":
return Optional.ofNullable(clazz.cast(localeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeFindingsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends InspectorRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ARN that specifies the finding that you want to describe.
*
*
* @param findingArns
* The ARN that specifies the finding that you want to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder findingArns(Collection findingArns);
/**
*
* The ARN that specifies the finding that you want to describe.
*
*
* @param findingArns
* The ARN that specifies the finding that you want to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder findingArns(String... findingArns);
/**
*
* The locale into which you want to translate a finding description, recommendation, and the short description
* that identifies the finding.
*
*
* @param locale
* The locale into which you want to translate a finding description, recommendation, and the short
* description that identifies the finding.
* @see Locale
* @return Returns a reference to this object so that method calls can be chained together.
* @see Locale
*/
Builder locale(String locale);
/**
*
* The locale into which you want to translate a finding description, recommendation, and the short description
* that identifies the finding.
*
*
* @param locale
* The locale into which you want to translate a finding description, recommendation, and the short
* description that identifies the finding.
* @see Locale
* @return Returns a reference to this object so that method calls can be chained together.
* @see Locale
*/
Builder locale(Locale locale);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends InspectorRequest.BuilderImpl implements Builder {
private List findingArns = DefaultSdkAutoConstructList.getInstance();
private String locale;
private BuilderImpl() {
}
private BuilderImpl(DescribeFindingsRequest model) {
super(model);
findingArns(model.findingArns);
locale(model.locale);
}
public final Collection getFindingArns() {
if (findingArns instanceof SdkAutoConstructList) {
return null;
}
return findingArns;
}
public final void setFindingArns(Collection findingArns) {
this.findingArns = BatchDescribeArnListCopier.copy(findingArns);
}
@Override
public final Builder findingArns(Collection findingArns) {
this.findingArns = BatchDescribeArnListCopier.copy(findingArns);
return this;
}
@Override
@SafeVarargs
public final Builder findingArns(String... findingArns) {
findingArns(Arrays.asList(findingArns));
return this;
}
public final String getLocale() {
return locale;
}
public final void setLocale(String locale) {
this.locale = locale;
}
@Override
public final Builder locale(String locale) {
this.locale = locale;
return this;
}
@Override
public final Builder locale(Locale locale) {
this.locale(locale == null ? null : locale.toString());
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 DescribeFindingsRequest build() {
return new DescribeFindingsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy