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

Class RegistryScanningRule

java.lang.Object

software.amazon.awssdk.services.ecr.model.RegistryScanningRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RegistryScanningRule.Builder,RegistryScanningRule>

@Generated("software.amazon.awssdk:codegen")
public final class RegistryScanningRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RegistryScanningRule.Builder,RegistryScanningRule>

The details of a scanning rule for a private registry.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegistryScanningRule.Builder

Method Summary

Modifier and Type	Method	Description
static RegistryScanningRule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRepositoryFilters()	For responses, this returns true if the service returned a value for the RepositoryFilters property.
List<ScanningRepositoryFilter>	repositoryFilters()	The repository filters associated with the scanning configuration for a private registry.
ScanFrequency	scanFrequency()	The frequency that scans are performed at for a private registry.
String	scanFrequencyAsString()	The frequency that scans are performed at for a private registry.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RegistryScanningRule.Builder>	serializableBuilderClass()
RegistryScanningRule.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

scanFrequency

public final ScanFrequency scanFrequency()

The frequency that scans are performed at for a private registry. When the ENHANCED scan type is specified, the supported scan frequencies are CONTINUOUS_SCAN and SCAN_ON_PUSH. When the BASIC scan type is specified, the SCAN_ON_PUSH scan frequency is supported. If scan on push is not specified, then the MANUAL scan frequency is set by default.

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

Returns:

The frequency that scans are performed at for a private registry. When the ENHANCED scan type is specified, the supported scan frequencies are CONTINUOUS_SCAN and SCAN_ON_PUSH. When the BASIC scan type is specified, the SCAN_ON_PUSH scan frequency is supported. If scan on push is not specified, then the MANUAL scan frequency is set by default.

See Also:

ScanFrequency

scanFrequencyAsString

public final String scanFrequencyAsString()

The frequency that scans are performed at for a private registry. When the ENHANCED scan type is specified, the supported scan frequencies are CONTINUOUS_SCAN and SCAN_ON_PUSH. When the BASIC scan type is specified, the SCAN_ON_PUSH scan frequency is supported. If scan on push is not specified, then the MANUAL scan frequency is set by default.

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

Returns:

The frequency that scans are performed at for a private registry. When the ENHANCED scan type is specified, the supported scan frequencies are CONTINUOUS_SCAN and SCAN_ON_PUSH. When the BASIC scan type is specified, the SCAN_ON_PUSH scan frequency is supported. If scan on push is not specified, then the MANUAL scan frequency is set by default.

See Also:

ScanFrequency

hasRepositoryFilters

public final boolean hasRepositoryFilters()

For responses, this returns true if the service returned a value for the RepositoryFilters 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.

repositoryFilters

public final List<ScanningRepositoryFilter> repositoryFilters()

The repository filters associated with the scanning configuration for a private registry.

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 hasRepositoryFilters() method.

Returns:

The repository filters associated with the scanning configuration for a private registry.

toBuilder

public RegistryScanningRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegistryScanningRule.Builder,RegistryScanningRule>

builder

public static RegistryScanningRule.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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