software.amazon.awssdk.services.codegurusecurity.model.GetFindingsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of codegurusecurity Show documentation
Show all versions of codegurusecurity Show documentation
The AWS Java SDK for Code Guru Security module holds the client classes that are used for
communicating with Code Guru Security.
/*
* 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.codegurusecurity.model;
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.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.LocationTrait;
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 GetFindingsRequest extends CodeGuruSecurityRequest implements
ToCopyableBuilder {
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxResults").getter(getter(GetFindingsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("maxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(GetFindingsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("nextToken").build()).build();
private static final SdkField SCAN_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("scanName").getter(getter(GetFindingsRequest::scanName)).setter(setter(Builder::scanName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("scanName").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(GetFindingsRequest::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MAX_RESULTS_FIELD,
NEXT_TOKEN_FIELD, SCAN_NAME_FIELD, STATUS_FIELD));
private final Integer maxResults;
private final String nextToken;
private final String scanName;
private final String status;
private GetFindingsRequest(BuilderImpl builder) {
super(builder);
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.scanName = builder.scanName;
this.status = builder.status;
}
/**
*
* The maximum number of results to return in the response. Use this parameter when paginating results. If
* additional results exist beyond the number you specify, the nextToken element is returned in the
* response. Use nextToken in a subsequent request to retrieve additional results. If not specified,
* returns 1000 results.
*
*
* @return The maximum number of results to return in the response. Use this parameter when paginating results. If
* additional results exist beyond the number you specify, the nextToken element is returned in
* the response. Use nextToken in a subsequent request to retrieve additional results. If not
* specified, returns 1000 results.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* A token to use for paginating results that are returned in the response. Set the value of this parameter to null
* for the first request. For subsequent calls, use the nextToken value returned from the previous
* request to continue listing results after the first page.
*
*
* @return A token to use for paginating results that are returned in the response. Set the value of this parameter
* to null for the first request. For subsequent calls, use the nextToken value returned from
* the previous request to continue listing results after the first page.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The name of the scan you want to retrieve findings from.
*
*
* @return The name of the scan you want to retrieve findings from.
*/
public final String scanName() {
return scanName;
}
/**
*
* The status of the findings you want to get. Pass either Open, Closed, or
* All.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link Status#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the findings you want to get. Pass either Open, Closed, or
* All.
* @see Status
*/
public final Status status() {
return Status.fromValue(status);
}
/**
*
* The status of the findings you want to get. Pass either Open, Closed, or
* All.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link Status#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the findings you want to get. Pass either Open, Closed, or
* All.
* @see Status
*/
public final String statusAsString() {
return status;
}
@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(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(scanName());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
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 GetFindingsRequest)) {
return false;
}
GetFindingsRequest other = (GetFindingsRequest) obj;
return Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(scanName(), other.scanName()) && Objects.equals(statusAsString(), other.statusAsString());
}
/**
* 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("GetFindingsRequest").add("MaxResults", maxResults()).add("NextToken", nextToken())
.add("ScanName", scanName()).add("Status", statusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "scanName":
return Optional.ofNullable(clazz.cast(scanName()));
case "status":
return Optional.ofNullable(clazz.cast(statusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetFindingsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CodeGuruSecurityRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The maximum number of results to return in the response. Use this parameter when paginating results. If
* additional results exist beyond the number you specify, the nextToken element is returned in the
* response. Use nextToken in a subsequent request to retrieve additional results. If not
* specified, returns 1000 results.
*
*
* @param maxResults
* The maximum number of results to return in the response. Use this parameter when paginating results.
* If additional results exist beyond the number you specify, the nextToken element is
* returned in the response. Use nextToken in a subsequent request to retrieve additional
* results. If not specified, returns 1000 results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* A token to use for paginating results that are returned in the response. Set the value of this parameter to
* null for the first request. For subsequent calls, use the nextToken value returned from the
* previous request to continue listing results after the first page.
*
*
* @param nextToken
* A token to use for paginating results that are returned in the response. Set the value of this
* parameter to null for the first request. For subsequent calls, use the nextToken value
* returned from the previous request to continue listing results after the first page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The name of the scan you want to retrieve findings from.
*
*
* @param scanName
* The name of the scan you want to retrieve findings from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scanName(String scanName);
/**
*
* The status of the findings you want to get. Pass either Open, Closed, or
* All.
*
*
* @param status
* The status of the findings you want to get. Pass either Open, Closed, or
* All.
* @see Status
* @return Returns a reference to this object so that method calls can be chained together.
* @see Status
*/
Builder status(String status);
/**
*
* The status of the findings you want to get. Pass either Open, Closed, or
* All.
*
*
* @param status
* The status of the findings you want to get. Pass either Open, Closed, or
* All.
* @see Status
* @return Returns a reference to this object so that method calls can be chained together.
* @see Status
*/
Builder status(Status status);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CodeGuruSecurityRequest.BuilderImpl implements Builder {
private Integer maxResults;
private String nextToken;
private String scanName;
private String status;
private BuilderImpl() {
}
private BuilderImpl(GetFindingsRequest model) {
super(model);
maxResults(model.maxResults);
nextToken(model.nextToken);
scanName(model.scanName);
status(model.status);
}
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;
}
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 String getScanName() {
return scanName;
}
public final void setScanName(String scanName) {
this.scanName = scanName;
}
@Override
public final Builder scanName(String scanName) {
this.scanName = scanName;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(Status status) {
this.status(status == null ? null : status.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 GetFindingsRequest build() {
return new GetFindingsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}