software.amazon.awssdk.services.guardduty.model.UpdateFindingsFeedbackRequest Maven / Gradle / Ivy
Show all versions of guardduty 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.guardduty.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
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 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 UpdateFindingsFeedbackRequest extends GuardDutyRequest implements
ToCopyableBuilder {
private static final SdkField DETECTOR_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DetectorId").getter(getter(UpdateFindingsFeedbackRequest::detectorId))
.setter(setter(Builder::detectorId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("detectorId").build()).build();
private static final SdkField> FINDING_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("FindingIds")
.getter(getter(UpdateFindingsFeedbackRequest::findingIds))
.setter(setter(Builder::findingIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("findingIds").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 FEEDBACK_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Feedback").getter(getter(UpdateFindingsFeedbackRequest::feedbackAsString))
.setter(setter(Builder::feedback))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("feedback").build()).build();
private static final SdkField COMMENTS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Comments").getter(getter(UpdateFindingsFeedbackRequest::comments)).setter(setter(Builder::comments))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("comments").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DETECTOR_ID_FIELD,
FINDING_IDS_FIELD, FEEDBACK_FIELD, COMMENTS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String detectorId;
private final List findingIds;
private final String feedback;
private final String comments;
private UpdateFindingsFeedbackRequest(BuilderImpl builder) {
super(builder);
this.detectorId = builder.detectorId;
this.findingIds = builder.findingIds;
this.feedback = builder.feedback;
this.comments = builder.comments;
}
/**
*
* The ID of the detector that is associated with the findings for which you want to update the feedback.
*
*
* To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run
* the ListDetectors
* API.
*
*
* @return The ID of the detector that is associated with the findings for which you want to update the
* feedback.
*
* To find the detectorId in the current Region, see the Settings page in the GuardDuty
* console, or run the ListDetectors
* API.
*/
public final String detectorId() {
return detectorId;
}
/**
* For responses, this returns true if the service returned a value for the FindingIds 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 hasFindingIds() {
return findingIds != null && !(findingIds instanceof SdkAutoConstructList);
}
/**
*
* The IDs of the findings that you want to mark as useful or not useful.
*
*
* 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 #hasFindingIds} method.
*
*
* @return The IDs of the findings that you want to mark as useful or not useful.
*/
public final List findingIds() {
return findingIds;
}
/**
*
* The feedback for the finding.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #feedback} will
* return {@link Feedback#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #feedbackAsString}.
*
*
* @return The feedback for the finding.
* @see Feedback
*/
public final Feedback feedback() {
return Feedback.fromValue(feedback);
}
/**
*
* The feedback for the finding.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #feedback} will
* return {@link Feedback#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #feedbackAsString}.
*
*
* @return The feedback for the finding.
* @see Feedback
*/
public final String feedbackAsString() {
return feedback;
}
/**
*
* Additional feedback about the GuardDuty findings.
*
*
* @return Additional feedback about the GuardDuty findings.
*/
public final String comments() {
return comments;
}
@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(detectorId());
hashCode = 31 * hashCode + Objects.hashCode(hasFindingIds() ? findingIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(feedbackAsString());
hashCode = 31 * hashCode + Objects.hashCode(comments());
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 UpdateFindingsFeedbackRequest)) {
return false;
}
UpdateFindingsFeedbackRequest other = (UpdateFindingsFeedbackRequest) obj;
return Objects.equals(detectorId(), other.detectorId()) && hasFindingIds() == other.hasFindingIds()
&& Objects.equals(findingIds(), other.findingIds())
&& Objects.equals(feedbackAsString(), other.feedbackAsString()) && Objects.equals(comments(), other.comments());
}
/**
* 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("UpdateFindingsFeedbackRequest").add("DetectorId", detectorId())
.add("FindingIds", hasFindingIds() ? findingIds() : null).add("Feedback", feedbackAsString())
.add("Comments", comments()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DetectorId":
return Optional.ofNullable(clazz.cast(detectorId()));
case "FindingIds":
return Optional.ofNullable(clazz.cast(findingIds()));
case "Feedback":
return Optional.ofNullable(clazz.cast(feedbackAsString()));
case "Comments":
return Optional.ofNullable(clazz.cast(comments()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("detectorId", DETECTOR_ID_FIELD);
map.put("findingIds", FINDING_IDS_FIELD);
map.put("feedback", FEEDBACK_FIELD);
map.put("comments", COMMENTS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateFindingsFeedbackRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends GuardDutyRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the detector that is associated with the findings for which you want to update the feedback.
*
*
* To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or
* run the ListDetectors
* API.
*
*
* @param detectorId
* The ID of the detector that is associated with the findings for which you want to update the
* feedback.
*
* To find the detectorId in the current Region, see the Settings page in the GuardDuty
* console, or run the ListDetectors API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder detectorId(String detectorId);
/**
*
* The IDs of the findings that you want to mark as useful or not useful.
*
*
* @param findingIds
* The IDs of the findings that you want to mark as useful or not useful.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder findingIds(Collection findingIds);
/**
*
* The IDs of the findings that you want to mark as useful or not useful.
*
*
* @param findingIds
* The IDs of the findings that you want to mark as useful or not useful.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder findingIds(String... findingIds);
/**
*
* The feedback for the finding.
*
*
* @param feedback
* The feedback for the finding.
* @see Feedback
* @return Returns a reference to this object so that method calls can be chained together.
* @see Feedback
*/
Builder feedback(String feedback);
/**
*
* The feedback for the finding.
*
*
* @param feedback
* The feedback for the finding.
* @see Feedback
* @return Returns a reference to this object so that method calls can be chained together.
* @see Feedback
*/
Builder feedback(Feedback feedback);
/**
*
* Additional feedback about the GuardDuty findings.
*
*
* @param comments
* Additional feedback about the GuardDuty findings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder comments(String comments);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends GuardDutyRequest.BuilderImpl implements Builder {
private String detectorId;
private List findingIds = DefaultSdkAutoConstructList.getInstance();
private String feedback;
private String comments;
private BuilderImpl() {
}
private BuilderImpl(UpdateFindingsFeedbackRequest model) {
super(model);
detectorId(model.detectorId);
findingIds(model.findingIds);
feedback(model.feedback);
comments(model.comments);
}
public final String getDetectorId() {
return detectorId;
}
public final void setDetectorId(String detectorId) {
this.detectorId = detectorId;
}
@Override
public final Builder detectorId(String detectorId) {
this.detectorId = detectorId;
return this;
}
public final Collection getFindingIds() {
if (findingIds instanceof SdkAutoConstructList) {
return null;
}
return findingIds;
}
public final void setFindingIds(Collection findingIds) {
this.findingIds = FindingIdsCopier.copy(findingIds);
}
@Override
public final Builder findingIds(Collection findingIds) {
this.findingIds = FindingIdsCopier.copy(findingIds);
return this;
}
@Override
@SafeVarargs
public final Builder findingIds(String... findingIds) {
findingIds(Arrays.asList(findingIds));
return this;
}
public final String getFeedback() {
return feedback;
}
public final void setFeedback(String feedback) {
this.feedback = feedback;
}
@Override
public final Builder feedback(String feedback) {
this.feedback = feedback;
return this;
}
@Override
public final Builder feedback(Feedback feedback) {
this.feedback(feedback == null ? null : feedback.toString());
return this;
}
public final String getComments() {
return comments;
}
public final void setComments(String comments) {
this.comments = comments;
}
@Override
public final Builder comments(String comments) {
this.comments = comments;
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 UpdateFindingsFeedbackRequest build() {
return new UpdateFindingsFeedbackRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}