software.amazon.awssdk.services.ecr.model.PutImageScanningConfigurationRequest Maven / Gradle / Ivy
Show all versions of ecr 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.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 PutImageScanningConfigurationRequest extends EcrRequest implements
ToCopyableBuilder {
private static final SdkField REGISTRY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("registryId").getter(getter(PutImageScanningConfigurationRequest::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)
.memberName("repositoryName").getter(getter(PutImageScanningConfigurationRequest::repositoryName))
.setter(setter(Builder::repositoryName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("repositoryName").build()).build();
private static final SdkField IMAGE_SCANNING_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("imageScanningConfiguration")
.getter(getter(PutImageScanningConfigurationRequest::imageScanningConfiguration))
.setter(setter(Builder::imageScanningConfiguration))
.constructor(ImageScanningConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("imageScanningConfiguration").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REGISTRY_ID_FIELD,
REPOSITORY_NAME_FIELD, IMAGE_SCANNING_CONFIGURATION_FIELD));
private final String registryId;
private final String repositoryName;
private final ImageScanningConfiguration imageScanningConfiguration;
private PutImageScanningConfigurationRequest(BuilderImpl builder) {
super(builder);
this.registryId = builder.registryId;
this.repositoryName = builder.repositoryName;
this.imageScanningConfiguration = builder.imageScanningConfiguration;
}
/**
*
* The Amazon Web Services account ID associated with the registry that contains the repository in which to update
* the image scanning configuration setting. If you do not specify a registry, the default registry is assumed.
*
*
* @return The Amazon Web Services account ID associated with the registry that contains the repository in which to
* update the image scanning configuration setting. If you do not specify a registry, the default registry
* is assumed.
*/
public final String registryId() {
return registryId;
}
/**
*
* The name of the repository in which to update the image scanning configuration setting.
*
*
* @return The name of the repository in which to update the image scanning configuration setting.
*/
public final String repositoryName() {
return repositoryName;
}
/**
*
* The image scanning configuration for the repository. This setting determines whether images are scanned for known
* vulnerabilities after being pushed to the repository.
*
*
* @return The image scanning configuration for the repository. This setting determines whether images are scanned
* for known vulnerabilities after being pushed to the repository.
*/
public final ImageScanningConfiguration imageScanningConfiguration() {
return imageScanningConfiguration;
}
@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(registryId());
hashCode = 31 * hashCode + Objects.hashCode(repositoryName());
hashCode = 31 * hashCode + Objects.hashCode(imageScanningConfiguration());
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 PutImageScanningConfigurationRequest)) {
return false;
}
PutImageScanningConfigurationRequest other = (PutImageScanningConfigurationRequest) obj;
return Objects.equals(registryId(), other.registryId()) && Objects.equals(repositoryName(), other.repositoryName())
&& Objects.equals(imageScanningConfiguration(), other.imageScanningConfiguration());
}
/**
* 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("PutImageScanningConfigurationRequest").add("RegistryId", registryId())
.add("RepositoryName", repositoryName()).add("ImageScanningConfiguration", imageScanningConfiguration()).build();
}
public final 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 "imageScanningConfiguration":
return Optional.ofNullable(clazz.cast(imageScanningConfiguration()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutImageScanningConfigurationRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcrRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Amazon Web Services account ID associated with the registry that contains the repository in which to
* update the image scanning configuration setting. If you do not specify a registry, the default registry is
* assumed.
*
*
* @param registryId
* The Amazon Web Services account ID associated with the registry that contains the repository in which
* to update the image scanning configuration setting. 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 name of the repository in which to update the image scanning configuration setting.
*
*
* @param repositoryName
* The name of the repository in which to update the image scanning configuration setting.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder repositoryName(String repositoryName);
/**
*
* The image scanning configuration for the repository. This setting determines whether images are scanned for
* known vulnerabilities after being pushed to the repository.
*
*
* @param imageScanningConfiguration
* The image scanning configuration for the repository. This setting determines whether images are
* scanned for known vulnerabilities after being pushed to the repository.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder imageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration);
/**
*
* The image scanning configuration for the repository. This setting determines whether images are scanned for
* known vulnerabilities after being pushed to the repository.
*
* This is a convenience method that creates an instance of the {@link ImageScanningConfiguration.Builder}
* avoiding the need to create one manually via {@link ImageScanningConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link ImageScanningConfiguration.Builder#build()} is called immediately
* and its result is passed to {@link #imageScanningConfiguration(ImageScanningConfiguration)}.
*
* @param imageScanningConfiguration
* a consumer that will call methods on {@link ImageScanningConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #imageScanningConfiguration(ImageScanningConfiguration)
*/
default Builder imageScanningConfiguration(Consumer imageScanningConfiguration) {
return imageScanningConfiguration(ImageScanningConfiguration.builder().applyMutation(imageScanningConfiguration)
.build());
}
@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 ImageScanningConfiguration imageScanningConfiguration;
private BuilderImpl() {
}
private BuilderImpl(PutImageScanningConfigurationRequest model) {
super(model);
registryId(model.registryId);
repositoryName(model.repositoryName);
imageScanningConfiguration(model.imageScanningConfiguration);
}
public final String getRegistryId() {
return registryId;
}
public final void setRegistryId(String registryId) {
this.registryId = registryId;
}
@Override
public final Builder registryId(String registryId) {
this.registryId = registryId;
return this;
}
public final String getRepositoryName() {
return repositoryName;
}
public final void setRepositoryName(String repositoryName) {
this.repositoryName = repositoryName;
}
@Override
public final Builder repositoryName(String repositoryName) {
this.repositoryName = repositoryName;
return this;
}
public final ImageScanningConfiguration.Builder getImageScanningConfiguration() {
return imageScanningConfiguration != null ? imageScanningConfiguration.toBuilder() : null;
}
public final void setImageScanningConfiguration(ImageScanningConfiguration.BuilderImpl imageScanningConfiguration) {
this.imageScanningConfiguration = imageScanningConfiguration != null ? imageScanningConfiguration.build() : null;
}
@Override
public final Builder imageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration) {
this.imageScanningConfiguration = imageScanningConfiguration;
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 PutImageScanningConfigurationRequest build() {
return new PutImageScanningConfigurationRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}