software.amazon.awssdk.services.chime.model

Class InviteUsersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.chime.model.ChimeRequest

software.amazon.awssdk.services.chime.model.InviteUsersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<InviteUsersRequest.Builder,InviteUsersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InviteUsersRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The Amazon Chime account ID.
static InviteUsersRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUserEmailList() For responses, this returns true if the service returned a value for the UserEmailList property.
List<SdkField<?>>	sdkFields()
static Class<? extends InviteUsersRequest.Builder>	serializableBuilderClass()
InviteUsersRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	userEmailList() The user email addresses to which to send the email invitation.
UserType	userType() The user type.
String	userTypeAsString() The user type.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

accountId

public final String accountId()

The Amazon Chime account ID.

Returns:

The Amazon Chime account ID.

hasUserEmailList

public final boolean hasUserEmailList()

For responses, this returns true if the service returned a value for the UserEmailList 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.

userEmailList

public final List<String> userEmailList()

The user email addresses to which to send the email invitation.

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 hasUserEmailList() method.

Returns:

The user email addresses to which to send the email invitation.

userType

public final UserType userType()

The user type.

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

Returns:

The user type.

See Also:

UserType

userTypeAsString

public final String userTypeAsString()

The user type.

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

Returns:

The user type.

See Also:

UserType

toBuilder

public InviteUsersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InviteUsersRequest.Builder,InviteUsersRequest>

Specified by:

toBuilder in class ChimeRequest

builder

public static InviteUsersRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo