Package software.amazon.awssdk.services.workmail.model

Class DescribeGroupResponse

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.DescribeGroupResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeGroupResponse.Builder,DescribeGroupResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeGroupResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeGroupResponse.Builder	builder()
Instant	disabledDate()	The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.
String	email()	The email of the described group.
Instant	enabledDate()	The date and time when a user was registered to WorkMail, in UNIX epoch time format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupId()	The identifier of the described group.
int	hashCode()
Boolean	hiddenFromGlobalAddressList()	If the value is set to true, the group is hidden from the address book.
String	name()	The name of the described group.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeGroupResponse.Builder>	serializableBuilderClass()
EntityState	state()	The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
String	stateAsString()	The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
DescribeGroupResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

groupId

public final String groupId()

The identifier of the described group.

Returns:

The identifier of the described group.

name

public final String name()

The name of the described group.

Returns:

The name of the described group.

email

public final String email()

The email of the described group.

Returns:

The email of the described group.

state

public final EntityState state()

The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to 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 user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

See Also:

EntityState

stateAsString

public final String stateAsString()

The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to 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 user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

See Also:

EntityState

enabledDate

public final Instant enabledDate()

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

Returns:

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

disabledDate

public final Instant disabledDate()

The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

Returns:

The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

hiddenFromGlobalAddressList

public final Boolean hiddenFromGlobalAddressList()

If the value is set to true, the group is hidden from the address book.

Returns:

If the value is set to true, the group is hidden from the address book.

toBuilder

public DescribeGroupResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeGroupResponse.Builder,DescribeGroupResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeGroupResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo