software.amazon.awssdk.services.pinpoint.model.MessageResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pinpoint Show documentation
Show all versions of pinpoint Show documentation
The AWS Java SDK for Amazon Pinpoint module holds the client classes that are used for communicating
with Amazon Pinpoint Service
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.pinpoint.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Provides information about the results of a request to send a message to an endpoint address.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MessageResponse implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField APPLICATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApplicationId").getter(getter(MessageResponse::applicationId)).setter(setter(Builder::applicationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApplicationId").build()).build();
private static final SdkField> ENDPOINT_RESULT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("EndpointResult")
.getter(getter(MessageResponse::endpointResult))
.setter(setter(Builder::endpointResult))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointResult").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EndpointMessageResult::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField REQUEST_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RequestId").getter(getter(MessageResponse::requestId)).setter(setter(Builder::requestId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RequestId").build()).build();
private static final SdkField> RESULT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Result")
.getter(getter(MessageResponse::result))
.setter(setter(Builder::result))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Result").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MessageResult::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(APPLICATION_ID_FIELD,
ENDPOINT_RESULT_FIELD, REQUEST_ID_FIELD, RESULT_FIELD));
private static final long serialVersionUID = 1L;
private final String applicationId;
private final Map endpointResult;
private final String requestId;
private final Map result;
private MessageResponse(BuilderImpl builder) {
this.applicationId = builder.applicationId;
this.endpointResult = builder.endpointResult;
this.requestId = builder.requestId;
this.result = builder.result;
}
/**
*
* The unique identifier for the application that was used to send the message.
*
*
* @return The unique identifier for the application that was used to send the message.
*/
public final String applicationId() {
return applicationId;
}
/**
* For responses, this returns true if the service returned a value for the EndpointResult property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasEndpointResult() {
return endpointResult != null && !(endpointResult instanceof SdkAutoConstructMap);
}
/**
*
* A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint
* ID is the key and the result is the value.
*
*
* 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 {@link #hasEndpointResult} method.
*
*
* @return A map that contains a multipart response for each address that the message was sent to. In the map, the
* endpoint ID is the key and the result is the value.
*/
public final Map endpointResult() {
return endpointResult;
}
/**
*
* The identifier for the original request that the message was delivered for.
*
*
* @return The identifier for the original request that the message was delivered for.
*/
public final String requestId() {
return requestId;
}
/**
* For responses, this returns true if the service returned a value for the Result property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasResult() {
return result != null && !(result instanceof SdkAutoConstructMap);
}
/**
*
* A map that contains a multipart response for each address (email address, phone number, or push notification
* token) that the message was sent to. In the map, the address is the key and the result is the value.
*
*
* 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 {@link #hasResult} method.
*
*
* @return A map that contains a multipart response for each address (email address, phone number, or push
* notification token) that the message was sent to. In the map, the address is the key and the result is
* the value.
*/
public final Map result() {
return result;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(applicationId());
hashCode = 31 * hashCode + Objects.hashCode(hasEndpointResult() ? endpointResult() : null);
hashCode = 31 * hashCode + Objects.hashCode(requestId());
hashCode = 31 * hashCode + Objects.hashCode(hasResult() ? result() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof MessageResponse)) {
return false;
}
MessageResponse other = (MessageResponse) obj;
return Objects.equals(applicationId(), other.applicationId()) && hasEndpointResult() == other.hasEndpointResult()
&& Objects.equals(endpointResult(), other.endpointResult()) && Objects.equals(requestId(), other.requestId())
&& hasResult() == other.hasResult() && Objects.equals(result(), other.result());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("MessageResponse").add("ApplicationId", applicationId())
.add("EndpointResult", hasEndpointResult() ? endpointResult() : null).add("RequestId", requestId())
.add("Result", hasResult() ? result() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ApplicationId":
return Optional.ofNullable(clazz.cast(applicationId()));
case "EndpointResult":
return Optional.ofNullable(clazz.cast(endpointResult()));
case "RequestId":
return Optional.ofNullable(clazz.cast(requestId()));
case "Result":
return Optional.ofNullable(clazz.cast(result()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MessageResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique identifier for the application that was used to send the message.
*
*
* @param applicationId
* The unique identifier for the application that was used to send the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applicationId(String applicationId);
/**
*
* A map that contains a multipart response for each address that the message was sent to. In the map, the
* endpoint ID is the key and the result is the value.
*
*
* @param endpointResult
* A map that contains a multipart response for each address that the message was sent to. In the map,
* the endpoint ID is the key and the result is the value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointResult(Map endpointResult);
/**
*
* The identifier for the original request that the message was delivered for.
*
*
* @param requestId
* The identifier for the original request that the message was delivered for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder requestId(String requestId);
/**
*
* A map that contains a multipart response for each address (email address, phone number, or push notification
* token) that the message was sent to. In the map, the address is the key and the result is the value.
*
*
* @param result
* A map that contains a multipart response for each address (email address, phone number, or push
* notification token) that the message was sent to. In the map, the address is the key and the result is
* the value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder result(Map result);
}
static final class BuilderImpl implements Builder {
private String applicationId;
private Map endpointResult = DefaultSdkAutoConstructMap.getInstance();
private String requestId;
private Map result = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(MessageResponse model) {
applicationId(model.applicationId);
endpointResult(model.endpointResult);
requestId(model.requestId);
result(model.result);
}
public final String getApplicationId() {
return applicationId;
}
public final void setApplicationId(String applicationId) {
this.applicationId = applicationId;
}
@Override
public final Builder applicationId(String applicationId) {
this.applicationId = applicationId;
return this;
}
public final Map getEndpointResult() {
Map result = MapOfEndpointMessageResultCopier
.copyToBuilder(this.endpointResult);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setEndpointResult(Map endpointResult) {
this.endpointResult = MapOfEndpointMessageResultCopier.copyFromBuilder(endpointResult);
}
@Override
public final Builder endpointResult(Map endpointResult) {
this.endpointResult = MapOfEndpointMessageResultCopier.copy(endpointResult);
return this;
}
public final String getRequestId() {
return requestId;
}
public final void setRequestId(String requestId) {
this.requestId = requestId;
}
@Override
public final Builder requestId(String requestId) {
this.requestId = requestId;
return this;
}
public final Map getResult() {
Map result = MapOfMessageResultCopier.copyToBuilder(this.result);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setResult(Map result) {
this.result = MapOfMessageResultCopier.copyFromBuilder(result);
}
@Override
public final Builder result(Map result) {
this.result = MapOfMessageResultCopier.copy(result);
return this;
}
@Override
public MessageResponse build() {
return new MessageResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy