Class ListDomainDeliverabilityCampaignsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListDomainDeliverabilityCampaignsRequest.Builder,
ListDomainDeliverabilityCampaignsRequest>
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
endDate()
The last day that you want to obtain deliverability data for.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 token that’s returned from a previous call to theListDomainDeliverabilityCampaigns
operation.final Integer
pageSize()
The maximum number of results to include in response to a single call to theListDomainDeliverabilityCampaigns
operation.static Class
<? extends ListDomainDeliverabilityCampaignsRequest.Builder> final Instant
The first day that you want to obtain deliverability data for.final String
The domain to obtain deliverability data for.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
-
startDate
The first day that you want to obtain deliverability data for.
- Returns:
- The first day that you want to obtain deliverability data for.
-
endDate
The last day that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the
StartDate
parameter.- Returns:
- The last day that you want to obtain deliverability data for. This value has to be less than or equal to
30 days after the value of the
StartDate
parameter.
-
subscribedDomain
The domain to obtain deliverability data for.
- Returns:
- The domain to obtain deliverability data for.
-
nextToken
A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaigns
operation. This token indicates the position of a campaign in the list of campaigns.- Returns:
- A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaigns
operation. This token indicates the position of a campaign in the list of campaigns.
-
pageSize
The maximum number of results to include in response to a single call to the
ListDomainDeliverabilityCampaigns
operation. If the number of results is larger than the number that you specify in this parameter, the response includes aNextToken
element, which you can use to obtain additional results.- Returns:
- The maximum number of results to include in response to a single call to the
ListDomainDeliverabilityCampaigns
operation. If the number of results is larger than the number that you specify in this parameter, the response includes aNextToken
element, which you can use to obtain additional results.
-
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<ListDomainDeliverabilityCampaignsRequest.Builder,
ListDomainDeliverabilityCampaignsRequest> - Specified by:
toBuilder
in classSesV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ListDomainDeliverabilityCampaignsRequest.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
-