Package software.amazon.awssdk.services.ecr.model

Class DescribeRepositoriesRequest

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.DescribeRepositoriesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeRepositoriesRequest.Builder,DescribeRepositoriesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeRepositoriesRequest
extends EcrRequest
implements ToCopyableBuilder<DescribeRepositoriesRequest.Builder,DescribeRepositoriesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeRepositoriesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeRepositoriesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRepositoryNames()	For responses, this returns true if the service returned a value for the RepositoryNames property.
Integer	maxResults()	The maximum number of repository results returned by DescribeRepositories in paginated output.
String	nextToken()	The nextToken value returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter.
String	registryId()	The Amazon Web Services account ID associated with the registry that contains the repositories to be described.
List<String>	repositoryNames()	A list of repositories to describe.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeRepositoriesRequest.Builder>	serializableBuilderClass()
DescribeRepositoriesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

registryId

public final String registryId()

The Amazon Web Services account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

Returns:

The Amazon Web Services account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

hasRepositoryNames

public final boolean hasRepositoryNames()

For responses, this returns true if the service returned a value for the RepositoryNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

repositoryNames

public final List<String> repositoryNames()

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRepositoryNames() method.

Returns:

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

nextToken

public final String nextToken()

The nextToken value returned from a previous paginated DescribeRepositories 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. This option cannot be used when you specify repositories with repositoryNames.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

The nextToken value returned from a previous paginated DescribeRepositories 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. This option cannot be used when you specify repositories with repositoryNames.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

maxResults

public final Integer maxResults()

The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories 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 DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.

Returns:

The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories 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 DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.

toBuilder

public DescribeRepositoriesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeRepositoriesRequest.Builder,DescribeRepositoriesRequest>

Specified by:

toBuilder in class EcrRequest

builder

public static DescribeRepositoriesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeRepositoriesRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo