software.amazon.awssdk.services.securityhub.model.GetInsightsRequest 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.securityhub.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 GetInsightsRequest extends SecurityHubRequest implements
ToCopyableBuilder {
private static final SdkField> INSIGHT_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("InsightArns")
.getter(getter(GetInsightsRequest::insightArns))
.setter(setter(Builder::insightArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InsightArns").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 NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(GetInsightsRequest::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(GetInsightsRequest::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(INSIGHT_ARNS_FIELD,
NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final List insightArns;
private final String nextToken;
private final Integer maxResults;
private GetInsightsRequest(BuilderImpl builder) {
super(builder);
this.insightArns = builder.insightArns;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
* For responses, this returns true if the service returned a value for the InsightArns 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 hasInsightArns() {
return insightArns != null && !(insightArns instanceof SdkAutoConstructList);
}
/**
*
* The ARNs of the insights to describe. If you don't provide any insight ARNs, then GetInsights
* returns all of your custom insights. It does not return any managed insights.
*
*
* 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 #hasInsightArns} method.
*
*
* @return The ARNs of the insights to describe. If you don't provide any insight ARNs, then
* GetInsights returns all of your custom insights. It does not return any managed insights.
*/
public final List insightArns() {
return insightArns;
}
/**
*
* The token that is required for pagination. On your first call to the GetInsights operation, set the
* value of this parameter to NULL.
*
*
* For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value
* returned from the previous response.
*
*
* @return The token that is required for pagination. On your first call to the GetInsights operation,
* set the value of this parameter to NULL.
*
* For subsequent calls to the operation, to continue listing data, set the value of this parameter to the
* value returned from the previous response.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of items to return in the response.
*
*
* @return The maximum number of items to return in the response.
*/
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(hasInsightArns() ? insightArns() : null);
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 GetInsightsRequest)) {
return false;
}
GetInsightsRequest other = (GetInsightsRequest) obj;
return hasInsightArns() == other.hasInsightArns() && Objects.equals(insightArns(), other.insightArns())
&& 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("GetInsightsRequest").add("InsightArns", hasInsightArns() ? insightArns() : null)
.add("NextToken", nextToken()).add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InsightArns":
return Optional.ofNullable(clazz.cast(insightArns()));
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((GetInsightsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SecurityHubRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ARNs of the insights to describe. If you don't provide any insight ARNs, then GetInsights
* returns all of your custom insights. It does not return any managed insights.
*
*
* @param insightArns
* The ARNs of the insights to describe. If you don't provide any insight ARNs, then
* GetInsights returns all of your custom insights. It does not return any managed insights.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder insightArns(Collection insightArns);
/**
*
* The ARNs of the insights to describe. If you don't provide any insight ARNs, then GetInsights
* returns all of your custom insights. It does not return any managed insights.
*
*
* @param insightArns
* The ARNs of the insights to describe. If you don't provide any insight ARNs, then
* GetInsights returns all of your custom insights. It does not return any managed insights.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder insightArns(String... insightArns);
/**
*
* The token that is required for pagination. On your first call to the GetInsights operation, set
* the value of this parameter to NULL.
*
*
* For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value
* returned from the previous response.
*
*
* @param nextToken
* The token that is required for pagination. On your first call to the GetInsights
* operation, set the value of this parameter to NULL.
*
* For subsequent calls to the operation, to continue listing data, set the value of this parameter to
* the value returned from the previous response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of items to return in the response.
*
*
* @param maxResults
* The maximum number of items to return in the response.
* @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 SecurityHubRequest.BuilderImpl implements Builder {
private List insightArns = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(GetInsightsRequest model) {
super(model);
insightArns(model.insightArns);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final Collection getInsightArns() {
if (insightArns instanceof SdkAutoConstructList) {
return null;
}
return insightArns;
}
public final void setInsightArns(Collection insightArns) {
this.insightArns = ArnListCopier.copy(insightArns);
}
@Override
public final Builder insightArns(Collection insightArns) {
this.insightArns = ArnListCopier.copy(insightArns);
return this;
}
@Override
@SafeVarargs
public final Builder insightArns(String... insightArns) {
insightArns(Arrays.asList(insightArns));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
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
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 GetInsightsRequest build() {
return new GetInsightsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy