software.amazon.awssdk.services.ssmcontacts.model

Class ListContactsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssmcontacts.model.SsmContactsRequest

software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListContactsRequest.Builder,ListContactsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListContactsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	aliasPrefix() Used to list only contacts who's aliases start with the specified prefix.
static ListContactsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of contacts and escalation plans per page of results.
String	nextToken() The pagination token to continue to the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListContactsRequest.Builder>	serializableBuilderClass()
ListContactsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ContactType	type() The type of contact.
String	typeAsString() The type of contact.

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

nextToken

public final String nextToken()

The pagination token to continue to the next page of results.

Returns:

The pagination token to continue to the next page of results.

maxResults

public final Integer maxResults()

The maximum number of contacts and escalation plans per page of results.

Returns:

The maximum number of contacts and escalation plans per page of results.

aliasPrefix

public final String aliasPrefix()

Used to list only contacts who's aliases start with the specified prefix.

Returns:

Used to list only contacts who's aliases start with the specified prefix.

type

public final ContactType type()

The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

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

Returns:

The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

See Also:

ContactType

typeAsString

public final String typeAsString()

The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

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

Returns:

The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

See Also:

ContactType

toBuilder

public ListContactsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListContactsRequest.Builder,ListContactsRequest>

Specified by:

toBuilder in class SsmContactsRequest

builder

public static ListContactsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListContactsRequest.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