Class DescribeResourceResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeResourceResponse.Builder,
DescribeResourceResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal BookingOptions
The booking options for the described resource.builder()
final String
Description of the resource.final Instant
The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.final String
email()
The email of the described resource.final Instant
The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.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) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final Boolean
If enabled, the resource is hidden from the global address list.final String
name()
The name of the described resource.final String
The identifier of the described resource.static Class
<? extends DescribeResourceResponse.Builder> final EntityState
state()
The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.final String
The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.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 ResourceType
type()
The type of the described resource.final String
The type of the described resource.Methods inherited from class software.amazon.awssdk.services.workmail.model.WorkMailResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
resourceId
The identifier of the described resource.
- Returns:
- The identifier of the described resource.
-
email
The email of the described resource.
- Returns:
- The email of the described resource.
-
name
The name of the described resource.
- Returns:
- The name of the described resource.
-
type
The type of the described resource.
If the service returns an enum value that is not available in the current SDK version,
type
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the described resource.
- See Also:
-
typeAsString
The type of the described resource.
If the service returns an enum value that is not available in the current SDK version,
type
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the described resource.
- See Also:
-
bookingOptions
The booking options for the described resource.
- Returns:
- The booking options for the described resource.
-
state
The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
If the service returns an enum value that is not available in the current SDK version,
state
will returnEntityState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
- See Also:
-
stateAsString
The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
If the service returns an enum value that is not available in the current SDK version,
state
will returnEntityState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
- See Also:
-
enabledDate
The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.
- Returns:
- The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.
-
disabledDate
The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.
- Returns:
- The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.
-
description
Description of the resource.
- Returns:
- Description of the resource.
-
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<DescribeResourceResponse.Builder,
DescribeResourceResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-