software.amazon.awssdk.services.detective.model.Indicator Maven / Gradle / Ivy
Show all versions of detective 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.detective.model;
import java.io.Serializable;
import java.util.Arrays;
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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Detective investigations triages indicators of compromises such as a finding and surfaces only the most critical and
* suspicious issues, so you can focus on high-level investigations. An Indicator lets you determine if an
* Amazon Web Services resource is involved in unusual activity that could indicate malicious behavior and its impact.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Indicator implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField INDICATOR_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IndicatorType").getter(getter(Indicator::indicatorTypeAsString)).setter(setter(Builder::indicatorType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IndicatorType").build()).build();
private static final SdkField INDICATOR_DETAIL_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("IndicatorDetail")
.getter(getter(Indicator::indicatorDetail)).setter(setter(Builder::indicatorDetail))
.constructor(IndicatorDetail::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IndicatorDetail").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INDICATOR_TYPE_FIELD,
INDICATOR_DETAIL_FIELD));
private static final long serialVersionUID = 1L;
private final String indicatorType;
private final IndicatorDetail indicatorDetail;
private Indicator(BuilderImpl builder) {
this.indicatorType = builder.indicatorType;
this.indicatorDetail = builder.indicatorDetail;
}
/**
*
* The type of indicator.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #indicatorType}
* will return {@link IndicatorType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #indicatorTypeAsString}.
*
*
* @return The type of indicator.
* @see IndicatorType
*/
public final IndicatorType indicatorType() {
return IndicatorType.fromValue(indicatorType);
}
/**
*
* The type of indicator.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #indicatorType}
* will return {@link IndicatorType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #indicatorTypeAsString}.
*
*
* @return The type of indicator.
* @see IndicatorType
*/
public final String indicatorTypeAsString() {
return indicatorType;
}
/**
*
* Details about the indicators of compromise that are used to determine if a resource is involved in a security
* incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment
* that can (with a high level of confidence) identify malicious activity or a security incident.
*
*
* @return Details about the indicators of compromise that are used to determine if a resource is involved in a
* security incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system,
* or environment that can (with a high level of confidence) identify malicious activity or a security
* incident.
*/
public final IndicatorDetail indicatorDetail() {
return indicatorDetail;
}
@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 + Objects.hashCode(indicatorTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(indicatorDetail());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Indicator)) {
return false;
}
Indicator other = (Indicator) obj;
return Objects.equals(indicatorTypeAsString(), other.indicatorTypeAsString())
&& Objects.equals(indicatorDetail(), other.indicatorDetail());
}
/**
* 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("Indicator").add("IndicatorType", indicatorTypeAsString())
.add("IndicatorDetail", indicatorDetail()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "IndicatorType":
return Optional.ofNullable(clazz.cast(indicatorTypeAsString()));
case "IndicatorDetail":
return Optional.ofNullable(clazz.cast(indicatorDetail()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Indicator) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The type of indicator.
*
*
* @param indicatorType
* The type of indicator.
* @see IndicatorType
* @return Returns a reference to this object so that method calls can be chained together.
* @see IndicatorType
*/
Builder indicatorType(String indicatorType);
/**
*
* The type of indicator.
*
*
* @param indicatorType
* The type of indicator.
* @see IndicatorType
* @return Returns a reference to this object so that method calls can be chained together.
* @see IndicatorType
*/
Builder indicatorType(IndicatorType indicatorType);
/**
*
* Details about the indicators of compromise that are used to determine if a resource is involved in a security
* incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment
* that can (with a high level of confidence) identify malicious activity or a security incident.
*
*
* @param indicatorDetail
* Details about the indicators of compromise that are used to determine if a resource is involved in a
* security incident. An indicator of compromise (IOC) is an artifact observed in or on a network,
* system, or environment that can (with a high level of confidence) identify malicious activity or a
* security incident.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder indicatorDetail(IndicatorDetail indicatorDetail);
/**
*
* Details about the indicators of compromise that are used to determine if a resource is involved in a security
* incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment
* that can (with a high level of confidence) identify malicious activity or a security incident.
*
* This is a convenience method that creates an instance of the {@link IndicatorDetail.Builder} avoiding the
* need to create one manually via {@link IndicatorDetail#builder()}.
*
*
* When the {@link Consumer} completes, {@link IndicatorDetail.Builder#build()} is called immediately and its
* result is passed to {@link #indicatorDetail(IndicatorDetail)}.
*
* @param indicatorDetail
* a consumer that will call methods on {@link IndicatorDetail.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #indicatorDetail(IndicatorDetail)
*/
default Builder indicatorDetail(Consumer indicatorDetail) {
return indicatorDetail(IndicatorDetail.builder().applyMutation(indicatorDetail).build());
}
}
static final class BuilderImpl implements Builder {
private String indicatorType;
private IndicatorDetail indicatorDetail;
private BuilderImpl() {
}
private BuilderImpl(Indicator model) {
indicatorType(model.indicatorType);
indicatorDetail(model.indicatorDetail);
}
public final String getIndicatorType() {
return indicatorType;
}
public final void setIndicatorType(String indicatorType) {
this.indicatorType = indicatorType;
}
@Override
public final Builder indicatorType(String indicatorType) {
this.indicatorType = indicatorType;
return this;
}
@Override
public final Builder indicatorType(IndicatorType indicatorType) {
this.indicatorType(indicatorType == null ? null : indicatorType.toString());
return this;
}
public final IndicatorDetail.Builder getIndicatorDetail() {
return indicatorDetail != null ? indicatorDetail.toBuilder() : null;
}
public final void setIndicatorDetail(IndicatorDetail.BuilderImpl indicatorDetail) {
this.indicatorDetail = indicatorDetail != null ? indicatorDetail.build() : null;
}
@Override
public final Builder indicatorDetail(IndicatorDetail indicatorDetail) {
this.indicatorDetail = indicatorDetail;
return this;
}
@Override
public Indicator build() {
return new Indicator(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}