software.amazon.awssdk.services.pinpoint.model.EventStream Maven / Gradle / Ivy
Show all versions of pinpoint Show documentation
/*
* 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.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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose
* delivery stream.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EventStream implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField APPLICATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApplicationId").getter(getter(EventStream::applicationId)).setter(setter(Builder::applicationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApplicationId").build()).build();
private static final SdkField DESTINATION_STREAM_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DestinationStreamArn").getter(getter(EventStream::destinationStreamArn))
.setter(setter(Builder::destinationStreamArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DestinationStreamArn").build())
.build();
private static final SdkField EXTERNAL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExternalId").getter(getter(EventStream::externalId)).setter(setter(Builder::externalId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExternalId").build()).build();
private static final SdkField LAST_MODIFIED_DATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LastModifiedDate").getter(getter(EventStream::lastModifiedDate))
.setter(setter(Builder::lastModifiedDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedDate").build()).build();
private static final SdkField LAST_UPDATED_BY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LastUpdatedBy").getter(getter(EventStream::lastUpdatedBy)).setter(setter(Builder::lastUpdatedBy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastUpdatedBy").build()).build();
private static final SdkField ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RoleArn").getter(getter(EventStream::roleArn)).setter(setter(Builder::roleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoleArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(APPLICATION_ID_FIELD,
DESTINATION_STREAM_ARN_FIELD, EXTERNAL_ID_FIELD, LAST_MODIFIED_DATE_FIELD, LAST_UPDATED_BY_FIELD, ROLE_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final String applicationId;
private final String destinationStreamArn;
private final String externalId;
private final String lastModifiedDate;
private final String lastUpdatedBy;
private final String roleArn;
private EventStream(BuilderImpl builder) {
this.applicationId = builder.applicationId;
this.destinationStreamArn = builder.destinationStreamArn;
this.externalId = builder.externalId;
this.lastModifiedDate = builder.lastModifiedDate;
this.lastUpdatedBy = builder.lastUpdatedBy;
this.roleArn = builder.roleArn;
}
/**
*
* The unique identifier for the application to publish event data for.
*
*
* @return The unique identifier for the application to publish event data for.
*/
public final String applicationId() {
return applicationId;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream
* to publish event data to.
*
*
* For a Kinesis data stream, the ARN format is:
* arn:aws:kinesis:region :account
* -id :stream/stream_name
*
*
* For a Kinesis Data Firehose delivery stream, the ARN format is:
* arn:aws:firehose:region
* :account-id :deliverystream/stream_name
*
*
* @return The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery
* stream to publish event data to.
*
* For a Kinesis data stream, the ARN format is:
* arn:aws:kinesis:region :account-id :stream/stream_name
*
*
* For a Kinesis Data Firehose delivery stream, the ARN format is:
* arn:aws:firehose:region :account-id :deliverystream/stream_name
*/
public final String destinationStreamArn() {
return destinationStreamArn;
}
/**
*
* (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon
* Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this
* requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*
*
* @return (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon
* Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this
* requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*/
public final String externalId() {
return externalId;
}
/**
*
* The date, in ISO 8601 format, when the event stream was last modified.
*
*
* @return The date, in ISO 8601 format, when the event stream was last modified.
*/
public final String lastModifiedDate() {
return lastModifiedDate;
}
/**
*
* The IAM user who last modified the event stream.
*
*
* @return The IAM user who last modified the event stream.
*/
public final String lastUpdatedBy() {
return lastUpdatedBy;
}
/**
*
* The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the
* stream in your AWS account.
*
*
* @return The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data
* to the stream in your AWS account.
*/
public final String roleArn() {
return roleArn;
}
@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(destinationStreamArn());
hashCode = 31 * hashCode + Objects.hashCode(externalId());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedDate());
hashCode = 31 * hashCode + Objects.hashCode(lastUpdatedBy());
hashCode = 31 * hashCode + Objects.hashCode(roleArn());
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 EventStream)) {
return false;
}
EventStream other = (EventStream) obj;
return Objects.equals(applicationId(), other.applicationId())
&& Objects.equals(destinationStreamArn(), other.destinationStreamArn())
&& Objects.equals(externalId(), other.externalId())
&& Objects.equals(lastModifiedDate(), other.lastModifiedDate())
&& Objects.equals(lastUpdatedBy(), other.lastUpdatedBy()) && Objects.equals(roleArn(), other.roleArn());
}
/**
* 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("EventStream").add("ApplicationId", applicationId())
.add("DestinationStreamArn", destinationStreamArn()).add("ExternalId", externalId())
.add("LastModifiedDate", lastModifiedDate()).add("LastUpdatedBy", lastUpdatedBy()).add("RoleArn", roleArn())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ApplicationId":
return Optional.ofNullable(clazz.cast(applicationId()));
case "DestinationStreamArn":
return Optional.ofNullable(clazz.cast(destinationStreamArn()));
case "ExternalId":
return Optional.ofNullable(clazz.cast(externalId()));
case "LastModifiedDate":
return Optional.ofNullable(clazz.cast(lastModifiedDate()));
case "LastUpdatedBy":
return Optional.ofNullable(clazz.cast(lastUpdatedBy()));
case "RoleArn":
return Optional.ofNullable(clazz.cast(roleArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((EventStream) 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 to publish event data for.
*
*
* @param applicationId
* The unique identifier for the application to publish event data for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applicationId(String applicationId);
/**
*
* The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery
* stream to publish event data to.
*
*
* For a Kinesis data stream, the ARN format is:
* arn:aws:kinesis:region :account
* -id :stream/stream_name
*
*
* For a Kinesis Data Firehose delivery stream, the ARN format is:
* arn:aws:firehose:region :account-id :deliverystream/stream_name
*
*
* @param destinationStreamArn
* The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose
* delivery stream to publish event data to.
*
* For a Kinesis data stream, the ARN format is:
* arn:aws:kinesis:region :account-id :stream/stream_name
*
*
* For a Kinesis Data Firehose delivery stream, the ARN format is:
* arn:aws:firehose:region :account-id :deliverystream/stream_name
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder destinationStreamArn(String destinationStreamArn);
/**
*
* (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon
* Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this
* requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*
*
* @param externalId
* (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.
* Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we
* removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by
* Amazon Pinpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder externalId(String externalId);
/**
*
* The date, in ISO 8601 format, when the event stream was last modified.
*
*
* @param lastModifiedDate
* The date, in ISO 8601 format, when the event stream was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedDate(String lastModifiedDate);
/**
*
* The IAM user who last modified the event stream.
*
*
* @param lastUpdatedBy
* The IAM user who last modified the event stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastUpdatedBy(String lastUpdatedBy);
/**
*
* The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to
* the stream in your AWS account.
*
*
* @param roleArn
* The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event
* data to the stream in your AWS account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roleArn(String roleArn);
}
static final class BuilderImpl implements Builder {
private String applicationId;
private String destinationStreamArn;
private String externalId;
private String lastModifiedDate;
private String lastUpdatedBy;
private String roleArn;
private BuilderImpl() {
}
private BuilderImpl(EventStream model) {
applicationId(model.applicationId);
destinationStreamArn(model.destinationStreamArn);
externalId(model.externalId);
lastModifiedDate(model.lastModifiedDate);
lastUpdatedBy(model.lastUpdatedBy);
roleArn(model.roleArn);
}
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 String getDestinationStreamArn() {
return destinationStreamArn;
}
public final void setDestinationStreamArn(String destinationStreamArn) {
this.destinationStreamArn = destinationStreamArn;
}
@Override
public final Builder destinationStreamArn(String destinationStreamArn) {
this.destinationStreamArn = destinationStreamArn;
return this;
}
public final String getExternalId() {
return externalId;
}
public final void setExternalId(String externalId) {
this.externalId = externalId;
}
@Override
public final Builder externalId(String externalId) {
this.externalId = externalId;
return this;
}
public final String getLastModifiedDate() {
return lastModifiedDate;
}
public final void setLastModifiedDate(String lastModifiedDate) {
this.lastModifiedDate = lastModifiedDate;
}
@Override
public final Builder lastModifiedDate(String lastModifiedDate) {
this.lastModifiedDate = lastModifiedDate;
return this;
}
public final String getLastUpdatedBy() {
return lastUpdatedBy;
}
public final void setLastUpdatedBy(String lastUpdatedBy) {
this.lastUpdatedBy = lastUpdatedBy;
}
@Override
public final Builder lastUpdatedBy(String lastUpdatedBy) {
this.lastUpdatedBy = lastUpdatedBy;
return this;
}
public final String getRoleArn() {
return roleArn;
}
public final void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
@Override
public final Builder roleArn(String roleArn) {
this.roleArn = roleArn;
return this;
}
@Override
public EventStream build() {
return new EventStream(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}