ContextEntry (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.iam.model.ContextEntry

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ContextEntry.Builder,ContextEntry>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ContextEntry
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ContextEntry.Builder,ContextEntry>
```
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 SimulatePrincipalPolicy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ContextEntry.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ContextEntry.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ContextEntry.Builder`	`builder()`
`String`	`contextKeyName()` The full name of a condition context key, including the service prefix.
`ContextKeyTypeEnum`	`contextKeyType()` The data type of the value (or values) specified in the `ContextKeyValues` parameter.
`String`	`contextKeyTypeAsString()` The data type of the value (or values) specified in the `ContextKeyValues` parameter.
`List<String>`	`contextKeyValues()` The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a `Condition` element in an input policy.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasContextKeyValues()` For responses, this returns true if the service returned a value for the ContextKeyValues property.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ContextEntry.Builder>`	`serializableBuilderClass()`
`ContextEntry.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - contextKeyName
```
public final String contextKeyName()
```
    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.
  - hasContextKeyValues
```
public final boolean hasContextKeyValues()
```
    For responses, this returns true if the service returned a value for the ContextKeyValues 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.
  - contextKeyValues
```
public final List<String> contextKeyValues()
```
    The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy.
    
    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 hasContextKeyValues() method.
    
    Returns:
    
    The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy.
  - contextKeyType
```
public final ContextKeyTypeEnum contextKeyType()
```
    The data type of the value (or values) specified in the ContextKeyValues parameter.
    
    If the service returns an enum value that is not available in the current SDK version, contextKeyType will return ContextKeyTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contextKeyTypeAsString().
    
    Returns:
    
    The data type of the value (or values) specified in the ContextKeyValues parameter.
    
    See Also:
    
    ContextKeyTypeEnum
  - contextKeyTypeAsString
```
public final String contextKeyTypeAsString()
```
    The data type of the value (or values) specified in the ContextKeyValues parameter.
    
    If the service returns an enum value that is not available in the current SDK version, contextKeyType will return ContextKeyTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contextKeyTypeAsString().
    
    Returns:
    
    The data type of the value (or values) specified in the ContextKeyValues parameter.
    
    See Also:
    
    ContextKeyTypeEnum
  - toBuilder
```
public ContextEntry.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ContextEntry.Builder,ContextEntry>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ContextEntry.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ContextEntry.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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.43

Class ContextEntry

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

contextKeyName

hasContextKeyValues

contextKeyValues

contextKeyType

contextKeyTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields