software.amazon.awssdk.services.ecr.model.CreatePullThroughCacheRuleRequest 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 CreatePullThroughCacheRuleRequest extends EcrRequest implements
ToCopyableBuilder {
private static final SdkField ECR_REPOSITORY_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ecrRepositoryPrefix").getter(getter(CreatePullThroughCacheRuleRequest::ecrRepositoryPrefix))
.setter(setter(Builder::ecrRepositoryPrefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ecrRepositoryPrefix").build())
.build();
private static final SdkField UPSTREAM_REGISTRY_URL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("upstreamRegistryUrl").getter(getter(CreatePullThroughCacheRuleRequest::upstreamRegistryUrl))
.setter(setter(Builder::upstreamRegistryUrl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("upstreamRegistryUrl").build())
.build();
private static final SdkField REGISTRY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("registryId").getter(getter(CreatePullThroughCacheRuleRequest::registryId))
.setter(setter(Builder::registryId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("registryId").build()).build();
private static final SdkField UPSTREAM_REGISTRY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("upstreamRegistry").getter(getter(CreatePullThroughCacheRuleRequest::upstreamRegistryAsString))
.setter(setter(Builder::upstreamRegistry))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("upstreamRegistry").build()).build();
private static final SdkField CREDENTIAL_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("credentialArn").getter(getter(CreatePullThroughCacheRuleRequest::credentialArn))
.setter(setter(Builder::credentialArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("credentialArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ECR_REPOSITORY_PREFIX_FIELD,
UPSTREAM_REGISTRY_URL_FIELD, REGISTRY_ID_FIELD, UPSTREAM_REGISTRY_FIELD, CREDENTIAL_ARN_FIELD));
private final String ecrRepositoryPrefix;
private final String upstreamRegistryUrl;
private final String registryId;
private final String upstreamRegistry;
private final String credentialArn;
private CreatePullThroughCacheRuleRequest(BuilderImpl builder) {
super(builder);
this.ecrRepositoryPrefix = builder.ecrRepositoryPrefix;
this.upstreamRegistryUrl = builder.upstreamRegistryUrl;
this.registryId = builder.registryId;
this.upstreamRegistry = builder.upstreamRegistry;
this.credentialArn = builder.credentialArn;
}
/**
*
* The repository name prefix to use when caching images from the source registry.
*
*
* @return The repository name prefix to use when caching images from the source registry.
*/
public final String ecrRepositoryPrefix() {
return ecrRepositoryPrefix;
}
/**
*
* The registry URL of the upstream public registry to use as the source for the pull through cache rule. The
* following is the syntax to use for each supported upstream registry.
*
*
* -
*
* Amazon ECR Public (ecr-public) - public.ecr.aws
*
*
* -
*
* Docker Hub (docker-hub) - registry-1.docker.io
*
*
* -
*
* Quay (quay) - quay.io
*
*
* -
*
* Kubernetes (k8s) - registry.k8s.io
*
*
* -
*
* GitHub Container Registry (github-container-registry) - ghcr.io
*
*
* -
*
* Microsoft Azure Container Registry (azure-container-registry) -
* <custom>.azurecr.io
*
*
*
*
* @return The registry URL of the upstream public registry to use as the source for the pull through cache rule.
* The following is the syntax to use for each supported upstream registry.
*
* -
*
* Amazon ECR Public (ecr-public) - public.ecr.aws
*
*
* -
*
* Docker Hub (docker-hub) - registry-1.docker.io
*
*
* -
*
* Quay (quay) - quay.io
*
*
* -
*
* Kubernetes (k8s) - registry.k8s.io
*
*
* -
*
* GitHub Container Registry (github-container-registry) - ghcr.io
*
*
* -
*
* Microsoft Azure Container Registry (azure-container-registry) -
* <custom>.azurecr.io
*
*
*/
public final String upstreamRegistryUrl() {
return upstreamRegistryUrl;
}
/**
*
* The Amazon Web Services account ID associated with the registry to create the pull through cache rule for. If you
* do not specify a registry, the default registry is assumed.
*
*
* @return The Amazon Web Services account ID associated with the registry to create the pull through cache rule
* for. If you do not specify a registry, the default registry is assumed.
*/
public final String registryId() {
return registryId;
}
/**
*
* The name of the upstream registry.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #upstreamRegistry}
* will return {@link UpstreamRegistry#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #upstreamRegistryAsString}.
*
*
* @return The name of the upstream registry.
* @see UpstreamRegistry
*/
public final UpstreamRegistry upstreamRegistry() {
return UpstreamRegistry.fromValue(upstreamRegistry);
}
/**
*
* The name of the upstream registry.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #upstreamRegistry}
* will return {@link UpstreamRegistry#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #upstreamRegistryAsString}.
*
*
* @return The name of the upstream registry.
* @see UpstreamRegistry
*/
public final String upstreamRegistryAsString() {
return upstreamRegistry;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials
* to authenticate to the upstream registry.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the
* credentials to authenticate to the upstream registry.
*/
public final String credentialArn() {
return credentialArn;
}
@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(ecrRepositoryPrefix());
hashCode = 31 * hashCode + Objects.hashCode(upstreamRegistryUrl());
hashCode = 31 * hashCode + Objects.hashCode(registryId());
hashCode = 31 * hashCode + Objects.hashCode(upstreamRegistryAsString());
hashCode = 31 * hashCode + Objects.hashCode(credentialArn());
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 CreatePullThroughCacheRuleRequest)) {
return false;
}
CreatePullThroughCacheRuleRequest other = (CreatePullThroughCacheRuleRequest) obj;
return Objects.equals(ecrRepositoryPrefix(), other.ecrRepositoryPrefix())
&& Objects.equals(upstreamRegistryUrl(), other.upstreamRegistryUrl())
&& Objects.equals(registryId(), other.registryId())
&& Objects.equals(upstreamRegistryAsString(), other.upstreamRegistryAsString())
&& Objects.equals(credentialArn(), other.credentialArn());
}
/**
* 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("CreatePullThroughCacheRuleRequest").add("EcrRepositoryPrefix", ecrRepositoryPrefix())
.add("UpstreamRegistryUrl", upstreamRegistryUrl()).add("RegistryId", registryId())
.add("UpstreamRegistry", upstreamRegistryAsString()).add("CredentialArn", credentialArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ecrRepositoryPrefix":
return Optional.ofNullable(clazz.cast(ecrRepositoryPrefix()));
case "upstreamRegistryUrl":
return Optional.ofNullable(clazz.cast(upstreamRegistryUrl()));
case "registryId":
return Optional.ofNullable(clazz.cast(registryId()));
case "upstreamRegistry":
return Optional.ofNullable(clazz.cast(upstreamRegistryAsString()));
case "credentialArn":
return Optional.ofNullable(clazz.cast(credentialArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreatePullThroughCacheRuleRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcrRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The repository name prefix to use when caching images from the source registry.
*
*
* @param ecrRepositoryPrefix
* The repository name prefix to use when caching images from the source registry.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ecrRepositoryPrefix(String ecrRepositoryPrefix);
/**
*
* The registry URL of the upstream public registry to use as the source for the pull through cache rule. The
* following is the syntax to use for each supported upstream registry.
*
*
* -
*
* Amazon ECR Public (ecr-public) - public.ecr.aws
*
*
* -
*
* Docker Hub (docker-hub) - registry-1.docker.io
*
*
* -
*
* Quay (quay) - quay.io
*
*
* -
*
* Kubernetes (k8s) - registry.k8s.io
*
*
* -
*
* GitHub Container Registry (github-container-registry) - ghcr.io
*
*
* -
*
* Microsoft Azure Container Registry (azure-container-registry) -
* <custom>.azurecr.io
*
*
*
*
* @param upstreamRegistryUrl
* The registry URL of the upstream public registry to use as the source for the pull through cache rule.
* The following is the syntax to use for each supported upstream registry.
*
* -
*
* Amazon ECR Public (ecr-public) - public.ecr.aws
*
*
* -
*
* Docker Hub (docker-hub) - registry-1.docker.io
*
*
* -
*
* Quay (quay) - quay.io
*
*
* -
*
* Kubernetes (k8s) - registry.k8s.io
*
*
* -
*
* GitHub Container Registry (github-container-registry) - ghcr.io
*
*
* -
*
* Microsoft Azure Container Registry (azure-container-registry) -
* <custom>.azurecr.io
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder upstreamRegistryUrl(String upstreamRegistryUrl);
/**
*
* The Amazon Web Services account ID associated with the registry to create the pull through cache rule for. If
* you do not specify a registry, the default registry is assumed.
*
*
* @param registryId
* The Amazon Web Services account ID associated with the registry to create the pull through cache rule
* 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 name of the upstream registry.
*
*
* @param upstreamRegistry
* The name of the upstream registry.
* @see UpstreamRegistry
* @return Returns a reference to this object so that method calls can be chained together.
* @see UpstreamRegistry
*/
Builder upstreamRegistry(String upstreamRegistry);
/**
*
* The name of the upstream registry.
*
*
* @param upstreamRegistry
* The name of the upstream registry.
* @see UpstreamRegistry
* @return Returns a reference to this object so that method calls can be chained together.
* @see UpstreamRegistry
*/
Builder upstreamRegistry(UpstreamRegistry upstreamRegistry);
/**
*
* The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the
* credentials to authenticate to the upstream registry.
*
*
* @param credentialArn
* The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the
* credentials to authenticate to the upstream registry.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder credentialArn(String credentialArn);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EcrRequest.BuilderImpl implements Builder {
private String ecrRepositoryPrefix;
private String upstreamRegistryUrl;
private String registryId;
private String upstreamRegistry;
private String credentialArn;
private BuilderImpl() {
}
private BuilderImpl(CreatePullThroughCacheRuleRequest model) {
super(model);
ecrRepositoryPrefix(model.ecrRepositoryPrefix);
upstreamRegistryUrl(model.upstreamRegistryUrl);
registryId(model.registryId);
upstreamRegistry(model.upstreamRegistry);
credentialArn(model.credentialArn);
}
public final String getEcrRepositoryPrefix() {
return ecrRepositoryPrefix;
}
public final void setEcrRepositoryPrefix(String ecrRepositoryPrefix) {
this.ecrRepositoryPrefix = ecrRepositoryPrefix;
}
@Override
public final Builder ecrRepositoryPrefix(String ecrRepositoryPrefix) {
this.ecrRepositoryPrefix = ecrRepositoryPrefix;
return this;
}
public final String getUpstreamRegistryUrl() {
return upstreamRegistryUrl;
}
public final void setUpstreamRegistryUrl(String upstreamRegistryUrl) {
this.upstreamRegistryUrl = upstreamRegistryUrl;
}
@Override
public final Builder upstreamRegistryUrl(String upstreamRegistryUrl) {
this.upstreamRegistryUrl = upstreamRegistryUrl;
return this;
}
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 getUpstreamRegistry() {
return upstreamRegistry;
}
public final void setUpstreamRegistry(String upstreamRegistry) {
this.upstreamRegistry = upstreamRegistry;
}
@Override
public final Builder upstreamRegistry(String upstreamRegistry) {
this.upstreamRegistry = upstreamRegistry;
return this;
}
@Override
public final Builder upstreamRegistry(UpstreamRegistry upstreamRegistry) {
this.upstreamRegistry(upstreamRegistry == null ? null : upstreamRegistry.toString());
return this;
}
public final String getCredentialArn() {
return credentialArn;
}
public final void setCredentialArn(String credentialArn) {
this.credentialArn = credentialArn;
}
@Override
public final Builder credentialArn(String credentialArn) {
this.credentialArn = credentialArn;
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 CreatePullThroughCacheRuleRequest build() {
return new CreatePullThroughCacheRuleRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}