Class ListContactsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListContactsRequest.Builder,
ListContactsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListContactsRequest.Builder
builder()
final String
The name of the contact list.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ListContactsFilter
filter()
A filter that can be applied to a list of contacts.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
A string token indicating that there might be additional contacts available to be listed.final Integer
pageSize()
The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize.static Class
<? extends ListContactsRequest.Builder> 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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
contactListName
The name of the contact list.
- Returns:
- The name of the contact list.
-
filter
A filter that can be applied to a list of contacts.
- Returns:
- A filter that can be applied to a list of contacts.
-
pageSize
The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the
NextToken
element is sent in the response. Use theNextToken
value in subsequent requests to retrieve additional contacts.- Returns:
- The number of contacts that may be returned at once, which is dependent on if there are more or less
contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts
exist beyond the specified limit, the
NextToken
element is sent in the response. Use theNextToken
value in subsequent requests to retrieve additional contacts.
-
nextToken
A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.
- Returns:
- A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.
-
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<ListContactsRequest.Builder,
ListContactsRequest> - Specified by:
toBuilder
in classSesV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-