software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest 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.ecr.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 DescribeImageScanFindingsRequest extends EcrRequest implements
ToCopyableBuilder {
private static final SdkField REGISTRY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeImageScanFindingsRequest::registryId)).setter(setter(Builder::registryId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("registryId").build()).build();
private static final SdkField REPOSITORY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeImageScanFindingsRequest::repositoryName)).setter(setter(Builder::repositoryName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("repositoryName").build()).build();
private static final SdkField IMAGE_ID_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.getter(getter(DescribeImageScanFindingsRequest::imageId)).setter(setter(Builder::imageId))
.constructor(ImageIdentifier::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("imageId").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeImageScanFindingsRequest::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)
.getter(getter(DescribeImageScanFindingsRequest::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(REGISTRY_ID_FIELD,
REPOSITORY_NAME_FIELD, IMAGE_ID_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final String registryId;
private final String repositoryName;
private final ImageIdentifier imageId;
private final String nextToken;
private final Integer maxResults;
private DescribeImageScanFindingsRequest(BuilderImpl builder) {
super(builder);
this.registryId = builder.registryId;
this.repositoryName = builder.repositoryName;
this.imageId = builder.imageId;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* The AWS account ID associated with the registry that contains the repository in which to describe the image scan
* findings for. If you do not specify a registry, the default registry is assumed.
*
*
* @return The AWS account ID associated with the registry that contains the repository in which to describe the
* image scan findings for. If you do not specify a registry, the default registry is assumed.
*/
public String registryId() {
return registryId;
}
/**
*
* The repository for the image for which to describe the scan findings.
*
*
* @return The repository for the image for which to describe the scan findings.
*/
public String repositoryName() {
return repositoryName;
}
/**
* Returns the value of the ImageId property for this object.
*
* @return The value of the ImageId property for this object.
*/
public ImageIdentifier imageId() {
return imageId;
}
/**
*
* The nextToken value returned from a previous paginated DescribeImageScanFindings
* request where maxResults was used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the nextToken value. This value is null
* when there are no more results to return.
*
*
* @return The nextToken value returned from a previous paginated
* DescribeImageScanFindings request where maxResults was used and the results
* exceeded the value of that parameter. Pagination continues from the end of the previous results that
* returned the nextToken value. This value is null when there are no more results to return.
*/
public String nextToken() {
return nextToken;
}
/**
*
* The maximum number of image scan results returned by DescribeImageScanFindings in paginated output.
* When this parameter is used, DescribeImageScanFindings only returns maxResults results
* in a single page along with a nextToken response element. The remaining results of the initial
* request can be seen by sending another DescribeImageScanFindings request with the returned
* nextToken value. This value can be between 1 and 1000. If this parameter is not used, then
* DescribeImageScanFindings returns up to 100 results and a nextToken value, if
* applicable.
*
*
* @return The maximum number of image scan results returned by DescribeImageScanFindings in paginated
* output. When this parameter is used, DescribeImageScanFindings only returns
* maxResults results in a single page along with a nextToken response element.
* The remaining results of the initial request can be seen by sending another
* DescribeImageScanFindings request with the returned nextToken value. This value
* can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings
* returns up to 100 results and a nextToken value, if applicable.
*/
public 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 int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(registryId());
hashCode = 31 * hashCode + Objects.hashCode(repositoryName());
hashCode = 31 * hashCode + Objects.hashCode(imageId());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeImageScanFindingsRequest)) {
return false;
}
DescribeImageScanFindingsRequest other = (DescribeImageScanFindingsRequest) obj;
return Objects.equals(registryId(), other.registryId()) && Objects.equals(repositoryName(), other.repositoryName())
&& Objects.equals(imageId(), other.imageId()) && 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 String toString() {
return ToString.builder("DescribeImageScanFindingsRequest").add("RegistryId", registryId())
.add("RepositoryName", repositoryName()).add("ImageId", imageId()).add("NextToken", nextToken())
.add("MaxResults", maxResults()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "registryId":
return Optional.ofNullable(clazz.cast(registryId()));
case "repositoryName":
return Optional.ofNullable(clazz.cast(repositoryName()));
case "imageId":
return Optional.ofNullable(clazz.cast(imageId()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeImageScanFindingsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcrRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The AWS account ID associated with the registry that contains the repository in which to describe the image
* scan findings for. If you do not specify a registry, the default registry is assumed.
*
*
* @param registryId
* The AWS account ID associated with the registry that contains the repository in which to describe the
* image scan findings for. If you do not specify a registry, the default registry is assumed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder registryId(String registryId);
/**
*
* The repository for the image for which to describe the scan findings.
*
*
* @param repositoryName
* The repository for the image for which to describe the scan findings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder repositoryName(String repositoryName);
/**
* Sets the value of the ImageId property for this object.
*
* @param imageId
* The new value for the ImageId property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder imageId(ImageIdentifier imageId);
/**
* Sets the value of the ImageId property for this object.
*
* This is a convenience that creates an instance of the {@link ImageIdentifier.Builder} avoiding the need to
* create one manually via {@link ImageIdentifier#builder()}.
*
* When the {@link Consumer} completes, {@link ImageIdentifier.Builder#build()} is called immediately and its
* result is passed to {@link #imageId(ImageIdentifier)}.
*
* @param imageId
* a consumer that will call methods on {@link ImageIdentifier.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #imageId(ImageIdentifier)
*/
default Builder imageId(Consumer imageId) {
return imageId(ImageIdentifier.builder().applyMutation(imageId).build());
}
/**
*
* The nextToken value returned from a previous paginated DescribeImageScanFindings
* request where maxResults was used and the results exceeded the value of that parameter.
* Pagination continues from the end of the previous results that returned the nextToken value.
* This value is null when there are no more results to return.
*
*
* @param nextToken
* The nextToken value returned from a previous paginated
* DescribeImageScanFindings request where maxResults was used and the results
* exceeded the value of that parameter. Pagination continues from the end of the previous results that
* returned the nextToken value. This value is null when there are no more results to
* return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of image scan results returned by DescribeImageScanFindings in paginated
* output. When this parameter is used, DescribeImageScanFindings only returns
* maxResults results in a single page along with a nextToken response element. The
* remaining results of the initial request can be seen by sending another
* DescribeImageScanFindings request with the returned nextToken value. This value can
* be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up
* to 100 results and a nextToken value, if applicable.
*
*
* @param maxResults
* The maximum number of image scan results returned by DescribeImageScanFindings in
* paginated output. When this parameter is used, DescribeImageScanFindings only returns
* maxResults results in a single page along with a nextToken response element.
* The remaining results of the initial request can be seen by sending another
* DescribeImageScanFindings request with the returned nextToken value. This
* value can be between 1 and 1000. If this parameter is not used, then
* DescribeImageScanFindings returns up to 100 results and a nextToken value,
* if applicable.
* @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 EcrRequest.BuilderImpl implements Builder {
private String registryId;
private String repositoryName;
private ImageIdentifier imageId;
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(DescribeImageScanFindingsRequest model) {
super(model);
registryId(model.registryId);
repositoryName(model.repositoryName);
imageId(model.imageId);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final String getRegistryId() {
return registryId;
}
@Override
public final Builder registryId(String registryId) {
this.registryId = registryId;
return this;
}
public final void setRegistryId(String registryId) {
this.registryId = registryId;
}
public final String getRepositoryName() {
return repositoryName;
}
@Override
public final Builder repositoryName(String repositoryName) {
this.repositoryName = repositoryName;
return this;
}
public final void setRepositoryName(String repositoryName) {
this.repositoryName = repositoryName;
}
public final ImageIdentifier.Builder getImageId() {
return imageId != null ? imageId.toBuilder() : null;
}
@Override
public final Builder imageId(ImageIdentifier imageId) {
this.imageId = imageId;
return this;
}
public final void setImageId(ImageIdentifier.BuilderImpl imageId) {
this.imageId = imageId != null ? imageId.build() : null;
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
public final Integer getMaxResults() {
return maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeImageScanFindingsRequest build() {
return new DescribeImageScanFindingsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy