software.amazon.awssdk.services.workmail.model

Class DescribeResourceResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.workmail.model.WorkMailResponse

software.amazon.awssdk.services.workmail.model.DescribeResourceResponse

All Implemented Interfaces:

ToCopyableBuilder<DescribeResourceResponse.Builder,DescribeResourceResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeResourceResponse
extends WorkMailResponse
implements ToCopyableBuilder<DescribeResourceResponse.Builder,DescribeResourceResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeResourceResponse.Builder

Method Summary

Modifier and Type	Method and Description
BookingOptions	bookingOptions() The booking options for the described resource.
static DescribeResourceResponse.Builder	builder()
Instant	disabledDate() The date and time when a resource was registered from Amazon WorkMail, in UNIX epoch time format.
String	email() The email of the described resource.
Instant	enabledDate() The date and time when a resource was registered to Amazon WorkMail, in UNIX epoch time format.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	name() The name of the described resource.
String	resourceId() The identifier of the described resource.
static Class<? extends DescribeResourceResponse.Builder>	serializableBuilderClass()
EntityState	state() The state of the resource: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).
String	stateAsString() The state of the resource: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).
DescribeResourceResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
ResourceType	type() The type of the described resource.
String	typeAsString() The type of the described resource.

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

resourceId

public String resourceId()

The identifier of the described resource.

Returns:

The identifier of the described resource.

email

public String email()

The email of the described resource.

Returns:

The email of the described resource.

name

public String name()

The name of the described resource.

Returns:

The name of the described resource.

type

public ResourceType 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 return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the described resource.

See Also:

ResourceType

typeAsString

public String 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 return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the described resource.

See Also:

ResourceType

bookingOptions

public BookingOptions bookingOptions()

The booking options for the described resource.

Returns:

The booking options for the described resource.

state

public EntityState state()

The state of the resource: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).

If the service returns an enum value that is not available in the current SDK version, state will return EntityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the resource: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).

See Also:

EntityState

stateAsString

public String stateAsString()

The state of the resource: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).

If the service returns an enum value that is not available in the current SDK version, state will return EntityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the resource: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).

See Also:

EntityState

enabledDate

public Instant enabledDate()

The date and time when a resource was registered to Amazon WorkMail, in UNIX epoch time format.

Returns:

The date and time when a resource was registered to Amazon WorkMail, in UNIX epoch time format.

disabledDate

public Instant disabledDate()

The date and time when a resource was registered from Amazon WorkMail, in UNIX epoch time format.

Returns:

The date and time when a resource was registered from Amazon WorkMail, in UNIX epoch time format.

toBuilder

public DescribeResourceResponse.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<DescribeResourceResponse.Builder,DescribeResourceResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeResourceResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeResourceResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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