Class SettingEntry
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SettingEntry.Builder,
SettingEntry>
Contains information about the specified configurable setting for a directory.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The valid range of values for the directory setting.final String
The value of the directory setting that is applied to the directory.static SettingEntry.Builder
builder()
final String
dataType()
The data type of a directory setting.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RequestDetailedStatus property.final Instant
The date and time when the request to update a directory setting was last submitted.final Instant
The date and time when the directory setting was last updated.final String
name()
The name of the directory setting.Details about the status of the request to update the directory setting.Details about the status of the request to update the directory setting.final String
The value that was last requested for the directory setting.The overall status of the request to update the directory setting request.final String
The overall status of the request to update the directory setting request.final String
The last status message for the directory status request.static Class
<? extends SettingEntry.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
type()
The type, or category, of a directory setting.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The type, or category, of a directory setting. Similar settings have the same type. For example,
Protocol
,Cipher
, orCertificate-Based Authentication
.- Returns:
- The type, or category, of a directory setting. Similar settings have the same type. For example,
Protocol
,Cipher
, orCertificate-Based Authentication
.
-
name
The name of the directory setting. For example:
TLS_1_0
- Returns:
- The name of the directory setting. For example:
TLS_1_0
-
allowedValues
The valid range of values for the directory setting. These values depend on the
DataType
of your directory.- Returns:
- The valid range of values for the directory setting. These values depend on the
DataType
of your directory.
-
appliedValue
The value of the directory setting that is applied to the directory.
- Returns:
- The value of the directory setting that is applied to the directory.
-
requestedValue
The value that was last requested for the directory setting.
- Returns:
- The value that was last requested for the directory setting.
-
requestStatus
The overall status of the request to update the directory setting request. If the directory setting is deployed in more than one region, and the request fails in any region, the overall status is
Failed
.If the service returns an enum value that is not available in the current SDK version,
requestStatus
will returnDirectoryConfigurationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestStatusAsString()
.- Returns:
- The overall status of the request to update the directory setting request. If the directory setting is
deployed in more than one region, and the request fails in any region, the overall status is
Failed
. - See Also:
-
requestStatusAsString
The overall status of the request to update the directory setting request. If the directory setting is deployed in more than one region, and the request fails in any region, the overall status is
Failed
.If the service returns an enum value that is not available in the current SDK version,
requestStatus
will returnDirectoryConfigurationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestStatusAsString()
.- Returns:
- The overall status of the request to update the directory setting request. If the directory setting is
deployed in more than one region, and the request fails in any region, the overall status is
Failed
. - See Also:
-
requestDetailedStatus
Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.
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
hasRequestDetailedStatus()
method.- Returns:
- Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.
-
hasRequestDetailedStatus
public final boolean hasRequestDetailedStatus()For responses, this returns true if the service returned a value for the RequestDetailedStatus property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
requestDetailedStatusAsStrings
Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.
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
hasRequestDetailedStatus()
method.- Returns:
- Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.
-
requestStatusMessage
The last status message for the directory status request.
- Returns:
- The last status message for the directory status request.
-
lastUpdatedDateTime
The date and time when the directory setting was last updated.
- Returns:
- The date and time when the directory setting was last updated.
-
lastRequestedDateTime
The date and time when the request to update a directory setting was last submitted.
- Returns:
- The date and time when the request to update a directory setting was last submitted.
-
dataType
The data type of a directory setting. This is used to define the
AllowedValues
of a setting. For example a data type can beBoolean
,DurationInSeconds
, orEnum
.- Returns:
- The data type of a directory setting. This is used to define the
AllowedValues
of a setting. For example a data type can beBoolean
,DurationInSeconds
, orEnum
.
-
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 interfaceToCopyableBuilder<SettingEntry.Builder,
SettingEntry> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-