Package software.amazon.awssdk.services.dlm.model

Class ShareRule

java.lang.Object

software.amazon.awssdk.services.dlm.model.ShareRule

All Implemented Interfaces:

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

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

[Custom snapshot policies only] Specifies a rule for sharing snapshots across Amazon Web Services accounts.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShareRule.Builder

Method Summary

Modifier and Type	Method	Description
static ShareRule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargetAccounts()	For responses, this returns true if the service returned a value for the TargetAccounts property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ShareRule.Builder>	serializableBuilderClass()
List<String>	targetAccounts()	The IDs of the Amazon Web Services accounts with which to share the snapshots.
ShareRule.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	unshareInterval()	The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
RetentionIntervalUnitValues	unshareIntervalUnit()	The unit of time for the automatic unsharing interval.
String	unshareIntervalUnitAsString()	The unit of time for the automatic unsharing interval.

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

hasTargetAccounts

public final boolean hasTargetAccounts()

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

targetAccounts

public final List<String> targetAccounts()

The IDs of the Amazon Web Services accounts with which to share the snapshots.

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

Returns:

The IDs of the Amazon Web Services accounts with which to share the snapshots.

unshareInterval

public final Integer unshareInterval()

The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.

Returns:

The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.

unshareIntervalUnit

public final RetentionIntervalUnitValues unshareIntervalUnit()

The unit of time for the automatic unsharing interval.

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

Returns:

The unit of time for the automatic unsharing interval.

See Also:

RetentionIntervalUnitValues

unshareIntervalUnitAsString

public final String unshareIntervalUnitAsString()

The unit of time for the automatic unsharing interval.

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

Returns:

The unit of time for the automatic unsharing interval.

See Also:

RetentionIntervalUnitValues

toBuilder

public ShareRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ShareRule.Builder,ShareRule>

builder

public static ShareRule.Builder builder()

serializableBuilderClass

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