software.amazon.awssdk.services.pinpoint.model.SendUsersMessageResponse 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.beans.Transient;
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 which users and endpoints a message was sent to.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SendUsersMessageResponse implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField APPLICATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApplicationId").getter(getter(SendUsersMessageResponse::applicationId))
.setter(setter(Builder::applicationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApplicationId").build()).build();
private static final SdkField REQUEST_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RequestId").getter(getter(SendUsersMessageResponse::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(SendUsersMessageResponse::result))
.setter(setter(Builder::result))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Result").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField.> builder(MarshallingType.MAP)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").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()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(APPLICATION_ID_FIELD,
REQUEST_ID_FIELD, RESULT_FIELD));
private static final long serialVersionUID = 1L;
private final String applicationId;
private final String requestId;
private final Map> result;
private SendUsersMessageResponse(BuilderImpl builder) {
this.applicationId = builder.applicationId;
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;
}
/**
*
* The unique identifier that was assigned to the message request.
*
*
* @return The unique identifier that was assigned to the message request.
*/
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);
}
/**
*
* An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and,
* for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an
* EndpointMessageResult object.
*
*
* 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 An object that indicates which endpoints the message was sent to, for each user. The object lists user
* IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID,
* it provides an EndpointMessageResult object.
*/
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(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 SendUsersMessageResponse)) {
return false;
}
SendUsersMessageResponse other = (SendUsersMessageResponse) obj;
return Objects.equals(applicationId(), other.applicationId()) && 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("SendUsersMessageResponse").add("ApplicationId", applicationId()).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 "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((SendUsersMessageResponse) 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);
/**
*
* The unique identifier that was assigned to the message request.
*
*
* @param requestId
* The unique identifier that was assigned to the message request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder requestId(String requestId);
/**
*
* An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs
* and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it
* provides an EndpointMessageResult object.
*
*
* @param result
* An object that indicates which endpoints the message was sent to, for each user. The object lists user
* IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint
* ID, it provides an EndpointMessageResult object.
* @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 String requestId;
private Map> result = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SendUsersMessageResponse model) {
applicationId(model.applicationId);
requestId(model.requestId);
result(model.result);
}
public final String getApplicationId() {
return applicationId;
}
public final void setApplicationId(String applicationId) {
this.applicationId = applicationId;
}
@Override
@Transient
public final Builder applicationId(String applicationId) {
this.applicationId = applicationId;
return this;
}
public final String getRequestId() {
return requestId;
}
public final void setRequestId(String requestId) {
this.requestId = requestId;
}
@Override
@Transient
public final Builder requestId(String requestId) {
this.requestId = requestId;
return this;
}
public final Map> getResult() {
Map> result = MapOfMapOfEndpointMessageResultCopier
.copyToBuilder(this.result);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setResult(Map> result) {
this.result = MapOfMapOfEndpointMessageResultCopier.copyFromBuilder(result);
}
@Override
@Transient
public final Builder result(Map> result) {
this.result = MapOfMapOfEndpointMessageResultCopier.copy(result);
return this;
}
@Override
public SendUsersMessageResponse build() {
return new SendUsersMessageResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy