Class CreatePullThroughCacheRuleRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ecr.model.EcrRequest
software.amazon.awssdk.services.ecr.model.CreatePullThroughCacheRuleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePullThroughCacheRuleRequest.Builder,CreatePullThroughCacheRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePullThroughCacheRuleRequest extends EcrRequest implements ToCopyableBuilder<CreatePullThroughCacheRuleRequest.Builder,CreatePullThroughCacheRuleRequest>

  • Method Details

    • ecrRepositoryPrefix

      public final String ecrRepositoryPrefix()

      The repository name prefix to use when caching images from the source registry.

      There is always an assumed / applied to the end of the prefix. If you specify ecr-public as the prefix, Amazon ECR treats that as ecr-public/.

      Returns:
      The repository name prefix to use when caching images from the source registry.

      There is always an assumed / applied to the end of the prefix. If you specify ecr-public as the prefix, Amazon ECR treats that as ecr-public/.

    • upstreamRegistryUrl

      public final String 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 (ecr) – <accountId>.dkr.ecr.<region>.amazonaws.com

      • Amazon ECR Public (ecr-public) – public.ecr.aws

      • Docker Hub (docker-hub) – registry-1.docker.io

      • GitHub Container Registry (github-container-registry) – ghcr.io

      • GitLab Container Registry (gitlab-container-registry) – registry.gitlab.com

      • Kubernetes (k8s) – registry.k8s.io

      • Microsoft Azure Container Registry (azure-container-registry) – <custom>.azurecr.io

      • Quay (quay) – quay.io

      Returns:
      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 (ecr) – <accountId>.dkr.ecr.<region>.amazonaws.com

      • Amazon ECR Public (ecr-public) – public.ecr.aws

      • Docker Hub (docker-hub) – registry-1.docker.io

      • GitHub Container Registry (github-container-registry) – ghcr.io

      • GitLab Container Registry (gitlab-container-registry) – registry.gitlab.com

      • Kubernetes (k8s) – registry.k8s.io

      • Microsoft Azure Container Registry (azure-container-registry) – <custom>.azurecr.io

      • Quay (quay) – quay.io

    • registryId

      public final String 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.

      Returns:
      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.

    • upstreamRegistry

      public final UpstreamRegistry upstreamRegistry()

      The name of the upstream registry.

      If the service returns an enum value that is not available in the current SDK version, upstreamRegistry will return UpstreamRegistry.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from upstreamRegistryAsString().

      Returns:
      The name of the upstream registry.
      See Also:

    • upstreamRegistryAsString

      public final String upstreamRegistryAsString()

      The name of the upstream registry.

      If the service returns an enum value that is not available in the current SDK version, upstreamRegistry will return UpstreamRegistry.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from upstreamRegistryAsString().

      Returns:
      The name of the upstream registry.
      See Also:

    • credentialArn

      public final String credentialArn()

      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.

    • customRoleArn

      public final String customRoleArn()

      Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to the ECR upstream registry. This role must be in the same account as the registry that you are configuring.

      Returns:
      Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to the ECR upstream registry. This role must be in the same account as the registry that you are configuring.

    • upstreamRepositoryPrefix

      public final String upstreamRepositoryPrefix()

      The repository name prefix of the upstream registry to match with the upstream repository name. When this field isn't specified, Amazon ECR will use the ROOT.

      Returns:
      The repository name prefix of the upstream registry to match with the upstream repository name. When this field isn't specified, Amazon ECR will use the ROOT.

    • toBuilder

      public CreatePullThroughCacheRuleRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreatePullThroughCacheRuleRequest.Builder,CreatePullThroughCacheRuleRequest>
      Specified by:
      toBuilder in class EcrRequest
      Returns:
      a builder for type T

    • builder

      public static CreatePullThroughCacheRuleRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreatePullThroughCacheRuleRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.