Package software.amazon.awssdk.services.backup.model

Class FrameworkControl

java.lang.Object

software.amazon.awssdk.services.backup.model.FrameworkControl

All Implemented Interfaces:

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

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

Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FrameworkControl.Builder

Method Summary

Modifier and Type	Method	Description
static FrameworkControl.Builder	builder()
List<ControlInputParameter>	controlInputParameters()	A list of ParameterName and ParameterValue pairs.
String	controlName()	The name of a control.
ControlScope	controlScope()	The scope of a control.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasControlInputParameters()	For responses, this returns true if the service returned a value for the ControlInputParameters property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FrameworkControl.Builder>	serializableBuilderClass()
FrameworkControl.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

controlName

public final String controlName()

The name of a control. This name is between 1 and 256 characters.

Returns:

The name of a control. This name is between 1 and 256 characters.

hasControlInputParameters

public final boolean hasControlInputParameters()

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

controlInputParameters

public final List<ControlInputParameter> controlInputParameters()

A list of ParameterName and ParameterValue pairs.

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

Returns:

A list of ParameterName and ParameterValue pairs.

controlScope

public final ControlScope controlScope()

The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.

For more information, see ControlScope.

Returns:

The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.

For more information, see ControlScope.

toBuilder

public FrameworkControl.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FrameworkControl.Builder,FrameworkControl>

builder

public static FrameworkControl.Builder builder()

serializableBuilderClass

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