CreatePullThroughCacheRuleRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.ecr.model

Class CreatePullThroughCacheRuleRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ecr.model.CreatePullThroughCacheRuleRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreatePullThroughCacheRuleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreatePullThroughCacheRuleRequest ()

Constructors
Constructor and Description
`CreatePullThroughCacheRuleRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreatePullThroughCacheRuleRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getCredentialArn ()` The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
`String`	`getEcrRepositoryPrefix ()` The repository name prefix to use when caching images from the source registry.
`String`	`getRegistryId ()` The Amazon Web Services account ID associated with the registry to create the pull through cache rule for.
`String`	`getUpstreamRegistry ()` The name of the upstream registry.
`String`	`getUpstreamRegistryUrl ()` The registry URL of the upstream public registry to use as the source for the pull through cache rule.
`int`	`hashCode ()`
`void`	`setCredentialArn (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.
`void`	`setEcrRepositoryPrefix (String ecrRepositoryPrefix)` The repository name prefix to use when caching images from the source registry.
`void`	`setRegistryId (String registryId)` The Amazon Web Services account ID associated with the registry to create the pull through cache rule for.
`void`	`setUpstreamRegistry (String upstreamRegistry)` The name of the upstream registry.
`void`	`setUpstreamRegistryUrl (String upstreamRegistryUrl)` The registry URL of the upstream public registry to use as the source for the pull through cache rule.
`String`	`toString ()` Returns a string representation of this object.
`CreatePullThroughCacheRuleRequest`	`withCredentialArn (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.
`CreatePullThroughCacheRuleRequest`	`withEcrRepositoryPrefix (String ecrRepositoryPrefix)` The repository name prefix to use when caching images from the source registry.
`CreatePullThroughCacheRuleRequest`	`withRegistryId (String registryId)` The Amazon Web Services account ID associated with the registry to create the pull through cache rule for.
`CreatePullThroughCacheRuleRequest`	`withUpstreamRegistry (String upstreamRegistry)` The name of the upstream registry.
`CreatePullThroughCacheRuleRequest`	`withUpstreamRegistry (UpstreamRegistry upstreamRegistry)` The name of the upstream registry.
`CreatePullThroughCacheRuleRequest`	`withUpstreamRegistryUrl (String upstreamRegistryUrl)` The registry URL of the upstream public registry to use as the source for the pull through cache rule.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreatePullThroughCacheRuleRequest
```
public CreatePullThroughCacheRuleRequest()
```
- Method Detail
  - setEcrRepositoryPrefix
```
public void setEcrRepositoryPrefix(String ecrRepositoryPrefix)
```
    The repository name prefix to use when caching images from the source registry.
    
    Parameters:
    
    ecrRepositoryPrefix - The repository name prefix to use when caching images from the source registry.
  - getEcrRepositoryPrefix
```
public String getEcrRepositoryPrefix()
```
    The repository name prefix to use when caching images from the source registry.
    
    Returns:
    
    The repository name prefix to use when caching images from the source registry.
  - withEcrRepositoryPrefix
```
public CreatePullThroughCacheRuleRequest withEcrRepositoryPrefix(String ecrRepositoryPrefix)
```
    The repository name prefix to use when caching images from the source registry.
    
    Parameters:
    
    ecrRepositoryPrefix - The repository name prefix to use when caching images from the source registry.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpstreamRegistryUrl
```
public void setUpstreamRegistryUrl(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 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
    Parameters:
    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
  - getUpstreamRegistryUrl
```
public String getUpstreamRegistryUrl()
```
    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
    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 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
  - withUpstreamRegistryUrl
```
public CreatePullThroughCacheRuleRequest withUpstreamRegistryUrl(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 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegistryId
```
public void setRegistryId(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.
    
    Parameters:
    
    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.
  - getRegistryId
```
public String getRegistryId()
```
    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.
  - withRegistryId
```
public CreatePullThroughCacheRuleRequest withRegistryId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpstreamRegistry
```
public void setUpstreamRegistry(String upstreamRegistry)
```
    The name of the upstream registry.
    
    Parameters:
    
    upstreamRegistry - The name of the upstream registry.
    
    See Also:
    
    UpstreamRegistry
  - getUpstreamRegistry
```
public String getUpstreamRegistry()
```
    The name of the upstream registry.
    
    Returns:
    
    The name of the upstream registry.
    
    See Also:
    
    UpstreamRegistry
  - withUpstreamRegistry
```
public CreatePullThroughCacheRuleRequest withUpstreamRegistry(String upstreamRegistry)
```
    The name of the upstream registry.
    
    Parameters:
    
    upstreamRegistry - The name of the upstream registry.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UpstreamRegistry
  - withUpstreamRegistry
```
public CreatePullThroughCacheRuleRequest withUpstreamRegistry(UpstreamRegistry upstreamRegistry)
```
    The name of the upstream registry.
    
    Parameters:
    
    upstreamRegistry - The name of the upstream registry.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UpstreamRegistry
  - setCredentialArn
```
public void setCredentialArn(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.
    
    Parameters:
    
    credentialArn - The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
  - getCredentialArn
```
public String getCredentialArn()
```
    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.
  - withCredentialArn
```
public CreatePullThroughCacheRuleRequest withCredentialArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreatePullThroughCacheRuleRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class CreatePullThroughCacheRuleRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreatePullThroughCacheRuleRequest

Method Detail

setEcrRepositoryPrefix

getEcrRepositoryPrefix

withEcrRepositoryPrefix

setUpstreamRegistryUrl

getUpstreamRegistryUrl

withUpstreamRegistryUrl

setRegistryId

getRegistryId

withRegistryId

setUpstreamRegistry

getUpstreamRegistry

withUpstreamRegistry

withUpstreamRegistry

setCredentialArn

getCredentialArn

withCredentialArn

toString

equals

hashCode

clone