Class ContextEntry

  • All Implemented Interfaces:
    Serializable, Cloneable

    public class ContextEntry
    extends Object
    implements Serializable, Cloneable

    Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.

    This data type is used as an input parameter to SimulateCustomPolicy and SimulateCustomPolicy .

    See Also:
    Serialized Form
    • Constructor Detail

      • ContextEntry

        public ContextEntry()
    • Method Detail

      • setContextKeyName

        public void setContextKeyName​(String contextKeyName)

        The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.

        Parameters:
        contextKeyName - The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.
      • getContextKeyName

        public String getContextKeyName()

        The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.

        Returns:
        The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.
      • withContextKeyName

        public ContextEntry withContextKeyName​(String contextKeyName)

        The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.

        Parameters:
        contextKeyName - The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getContextKeyValues

        public List<String> getContextKeyValues()

        The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a Condition element in an input policy.

        Returns:
        The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a Condition element in an input policy.
      • setContextKeyValues

        public void setContextKeyValues​(Collection<String> contextKeyValues)

        The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a Condition element in an input policy.

        Parameters:
        contextKeyValues - The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a Condition element in an input policy.
      • withContextKeyValues

        public ContextEntry withContextKeyValues​(String... contextKeyValues)

        The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a Condition element in an input policy.

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

        Parameters:
        contextKeyValues - The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a Condition element in an input policy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withContextKeyValues

        public ContextEntry withContextKeyValues​(Collection<String> contextKeyValues)

        The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a Condition element in an input policy.

        Parameters:
        contextKeyValues - The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a Condition element in an input policy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setContextKeyType

        public void setContextKeyType​(String contextKeyType)

        The data type of the value (or values) specified in the ContextKeyValues parameter.

        Parameters:
        contextKeyType - The data type of the value (or values) specified in the ContextKeyValues parameter.
        See Also:
        ContextKeyTypeEnum
      • getContextKeyType

        public String getContextKeyType()

        The data type of the value (or values) specified in the ContextKeyValues parameter.

        Returns:
        The data type of the value (or values) specified in the ContextKeyValues parameter.
        See Also:
        ContextKeyTypeEnum
      • withContextKeyType

        public ContextEntry withContextKeyType​(String contextKeyType)

        The data type of the value (or values) specified in the ContextKeyValues parameter.

        Parameters:
        contextKeyType - The data type of the value (or values) specified in the ContextKeyValues parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContextKeyTypeEnum
      • setContextKeyType

        public void setContextKeyType​(ContextKeyTypeEnum contextKeyType)

        The data type of the value (or values) specified in the ContextKeyValues parameter.

        Parameters:
        contextKeyType - The data type of the value (or values) specified in the ContextKeyValues parameter.
        See Also:
        ContextKeyTypeEnum
      • withContextKeyType

        public ContextEntry withContextKeyType​(ContextKeyTypeEnum contextKeyType)

        The data type of the value (or values) specified in the ContextKeyValues parameter.

        Parameters:
        contextKeyType - The data type of the value (or values) specified in the ContextKeyValues parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ContextKeyTypeEnum
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object