com.amazonaws.services.backup.model

Class FrameworkControl

java.lang.Object

com.amazonaws.services.backup.model.FrameworkControl

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FrameworkControl()

Method Summary

Modifier and Type	Method and Description
FrameworkControl	clone()
boolean	equals(Object obj)
List<ControlInputParameter>	getControlInputParameters() A list of ParameterName and ParameterValue pairs.
String	getControlName() The name of a control.
ControlScope	getControlScope() The scope of a control.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setControlInputParameters(Collection<ControlInputParameter> controlInputParameters) A list of ParameterName and ParameterValue pairs.
void	setControlName(String controlName) The name of a control.
void	setControlScope(ControlScope controlScope) The scope of a control.
String	toString() Returns a string representation of this object.
FrameworkControl	withControlInputParameters(Collection<ControlInputParameter> controlInputParameters) A list of ParameterName and ParameterValue pairs.
FrameworkControl	withControlInputParameters(ControlInputParameter... controlInputParameters) A list of ParameterName and ParameterValue pairs.
FrameworkControl	withControlName(String controlName) The name of a control.
FrameworkControl	withControlScope(ControlScope controlScope) The scope of a control.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FrameworkControl

public FrameworkControl()

Method Detail

setControlName

public void setControlName(String controlName)

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

Parameters:

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

getControlName

public String getControlName()

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.

withControlName

public FrameworkControl withControlName(String controlName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getControlInputParameters

public List<ControlInputParameter> getControlInputParameters()

A list of ParameterName and ParameterValue pairs.

Returns:

A list of ParameterName and ParameterValue pairs.

setControlInputParameters

public void setControlInputParameters(Collection<ControlInputParameter> controlInputParameters)

A list of ParameterName and ParameterValue pairs.

Parameters:

controlInputParameters - A list of ParameterName and ParameterValue pairs.

withControlInputParameters

public FrameworkControl withControlInputParameters(ControlInputParameter... controlInputParameters)

A list of ParameterName and ParameterValue pairs.

NOTE: This method appends the values to the existing list (if any). Use setControlInputParameters(java.util.Collection) or withControlInputParameters(java.util.Collection) if you want to override the existing values.

Parameters:

controlInputParameters - A list of ParameterName and ParameterValue pairs.

Returns:

Returns a reference to this object so that method calls can be chained together.

withControlInputParameters

public FrameworkControl withControlInputParameters(Collection<ControlInputParameter> controlInputParameters)

A list of ParameterName and ParameterValue pairs.

Parameters:

controlInputParameters - A list of ParameterName and ParameterValue pairs.

Returns:

Returns a reference to this object so that method calls can be chained together.

setControlScope

public void setControlScope(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.

Parameters:

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.

getControlScope

public ControlScope getControlScope()

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.

withControlScope

public FrameworkControl withControlScope(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.

Parameters:

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:

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 FrameworkControl clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.