software.amazon.awssdk.services.ivschat.model.LoggingConfigurationSummary Maven / Gradle / Ivy
Show all versions of ivschat 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.ivschat.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
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.Consumer;
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.traits.TimestampFormatTrait;
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;
/**
*
* Summary information about a logging configuration.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class LoggingConfigurationSummary implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn")
.getter(getter(LoggingConfigurationSummary::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("id")
.getter(getter(LoggingConfigurationSummary::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("id").build()).build();
private static final SdkField CREATE_TIME_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("createTime")
.getter(getter(LoggingConfigurationSummary::createTime))
.setter(setter(Builder::createTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("createTime").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final SdkField UPDATE_TIME_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("updateTime")
.getter(getter(LoggingConfigurationSummary::updateTime))
.setter(setter(Builder::updateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("updateTime").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(LoggingConfigurationSummary::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField DESTINATION_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("destinationConfiguration")
.getter(getter(LoggingConfigurationSummary::destinationConfiguration))
.setter(setter(Builder::destinationConfiguration)).constructor(DestinationConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("destinationConfiguration").build())
.build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("state")
.getter(getter(LoggingConfigurationSummary::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("state").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(LoggingConfigurationSummary::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, ID_FIELD,
CREATE_TIME_FIELD, UPDATE_TIME_FIELD, NAME_FIELD, DESTINATION_CONFIGURATION_FIELD, STATE_FIELD, TAGS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("arn", ARN_FIELD);
put("id", ID_FIELD);
put("createTime", CREATE_TIME_FIELD);
put("updateTime", UPDATE_TIME_FIELD);
put("name", NAME_FIELD);
put("destinationConfiguration", DESTINATION_CONFIGURATION_FIELD);
put("state", STATE_FIELD);
put("tags", TAGS_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String arn;
private final String id;
private final Instant createTime;
private final Instant updateTime;
private final String name;
private final DestinationConfiguration destinationConfiguration;
private final String state;
private final Map tags;
private LoggingConfigurationSummary(BuilderImpl builder) {
this.arn = builder.arn;
this.id = builder.id;
this.createTime = builder.createTime;
this.updateTime = builder.updateTime;
this.name = builder.name;
this.destinationConfiguration = builder.destinationConfiguration;
this.state = builder.state;
this.tags = builder.tags;
}
/**
*
* Logging-configuration ARN.
*
*
* @return Logging-configuration ARN.
*/
public final String arn() {
return arn;
}
/**
*
* Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that
* uniquely identifies the room.
*
*
* @return Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN
* that uniquely identifies the room.
*/
public final String id() {
return id;
}
/**
*
* Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as
* a string.
*
*
* @return Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is
* returned as a string.
*/
public final Instant createTime() {
return createTime;
}
/**
*
* Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as
* a string.
*
*
* @return Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is
* returned as a string.
*/
public final Instant updateTime() {
return updateTime;
}
/**
*
* Logging-configuration name. The value does not need to be unique.
*
*
* @return Logging-configuration name. The value does not need to be unique.
*/
public final String name() {
return name;
}
/**
*
* A complex type that contains a destination configuration for where chat content will be logged.
*
*
* @return A complex type that contains a destination configuration for where chat content will be logged.
*/
public final DestinationConfiguration destinationConfiguration() {
return destinationConfiguration;
}
/**
*
* The state of the logging configuration. When this is ACTIVE, the configuration is ready for logging
* chat content.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link LoggingConfigurationState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The state of the logging configuration. When this is ACTIVE, the configuration is ready for
* logging chat content.
* @see LoggingConfigurationState
*/
public final LoggingConfigurationState state() {
return LoggingConfigurationState.fromValue(state);
}
/**
*
* The state of the logging configuration. When this is ACTIVE, the configuration is ready for logging
* chat content.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link LoggingConfigurationState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The state of the logging configuration. When this is ACTIVE, the configuration is ready for
* logging chat content.
* @see LoggingConfigurationState
*/
public final String stateAsString() {
return state;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Best practices and
* strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions
* that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints on tags beyond
* what is documented there.
*
*
* 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 #hasTags} method.
*
*
* @return Tags to attach to the resource. Array of maps, each of the form string:string (key:value).
* See Best
* practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details,
* including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has
* no constraints on tags beyond what is documented there.
*/
public final Map tags() {
return tags;
}
@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(arn());
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(createTime());
hashCode = 31 * hashCode + Objects.hashCode(updateTime());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(destinationConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : 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 LoggingConfigurationSummary)) {
return false;
}
LoggingConfigurationSummary other = (LoggingConfigurationSummary) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(id(), other.id())
&& Objects.equals(createTime(), other.createTime()) && Objects.equals(updateTime(), other.updateTime())
&& Objects.equals(name(), other.name())
&& Objects.equals(destinationConfiguration(), other.destinationConfiguration())
&& Objects.equals(stateAsString(), other.stateAsString()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("LoggingConfigurationSummary").add("Arn", arn()).add("Id", id()).add("CreateTime", createTime())
.add("UpdateTime", updateTime()).add("Name", name()).add("DestinationConfiguration", destinationConfiguration())
.add("State", stateAsString()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "arn":
return Optional.ofNullable(clazz.cast(arn()));
case "id":
return Optional.ofNullable(clazz.cast(id()));
case "createTime":
return Optional.ofNullable(clazz.cast(createTime()));
case "updateTime":
return Optional.ofNullable(clazz.cast(updateTime()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "destinationConfiguration":
return Optional.ofNullable(clazz.cast(destinationConfiguration()));
case "state":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((LoggingConfigurationSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Logging-configuration ARN.
*
*
* @param arn
* Logging-configuration ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that
* uniquely identifies the room.
*
*
* @param id
* Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN
* that uniquely identifies the room.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned
* as a string.
*
*
* @param createTime
* Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is
* returned as a string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createTime(Instant createTime);
/**
*
* Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned
* as a string.
*
*
* @param updateTime
* Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is
* returned as a string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder updateTime(Instant updateTime);
/**
*
* Logging-configuration name. The value does not need to be unique.
*
*
* @param name
* Logging-configuration name. The value does not need to be unique.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* A complex type that contains a destination configuration for where chat content will be logged.
*
*
* @param destinationConfiguration
* A complex type that contains a destination configuration for where chat content will be logged.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder destinationConfiguration(DestinationConfiguration destinationConfiguration);
/**
*
* A complex type that contains a destination configuration for where chat content will be logged.
*
* This is a convenience method that creates an instance of the {@link DestinationConfiguration.Builder}
* avoiding the need to create one manually via {@link DestinationConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link DestinationConfiguration.Builder#build()} is called immediately
* and its result is passed to {@link #destinationConfiguration(DestinationConfiguration)}.
*
* @param destinationConfiguration
* a consumer that will call methods on {@link DestinationConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #destinationConfiguration(DestinationConfiguration)
*/
default Builder destinationConfiguration(Consumer destinationConfiguration) {
return destinationConfiguration(DestinationConfiguration.builder().applyMutation(destinationConfiguration).build());
}
/**
*
* The state of the logging configuration. When this is ACTIVE, the configuration is ready for
* logging chat content.
*
*
* @param state
* The state of the logging configuration. When this is ACTIVE, the configuration is ready
* for logging chat content.
* @see LoggingConfigurationState
* @return Returns a reference to this object so that method calls can be chained together.
* @see LoggingConfigurationState
*/
Builder state(String state);
/**
*
* The state of the logging configuration. When this is ACTIVE, the configuration is ready for
* logging chat content.
*
*
* @param state
* The state of the logging configuration. When this is ACTIVE, the configuration is ready
* for logging chat content.
* @see LoggingConfigurationState
* @return Returns a reference to this object so that method calls can be chained together.
* @see LoggingConfigurationState
*/
Builder state(LoggingConfigurationState state);
/**
*
* Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See
* Best
* practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details,
* including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no
* constraints on tags beyond what is documented there.
*
*
* @param tags
* Tags to attach to the resource. Array of maps, each of the form string:string (key:value)
* . See Best
* practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for
* details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon
* IVS Chat has no constraints on tags beyond what is documented there.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
}
static final class BuilderImpl implements Builder {
private String arn;
private String id;
private Instant createTime;
private Instant updateTime;
private String name;
private DestinationConfiguration destinationConfiguration;
private String state;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(LoggingConfigurationSummary model) {
arn(model.arn);
id(model.id);
createTime(model.createTime);
updateTime(model.updateTime);
name(model.name);
destinationConfiguration(model.destinationConfiguration);
state(model.state);
tags(model.tags);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final Instant getCreateTime() {
return createTime;
}
public final void setCreateTime(Instant createTime) {
this.createTime = createTime;
}
@Override
public final Builder createTime(Instant createTime) {
this.createTime = createTime;
return this;
}
public final Instant getUpdateTime() {
return updateTime;
}
public final void setUpdateTime(Instant updateTime) {
this.updateTime = updateTime;
}
@Override
public final Builder updateTime(Instant updateTime) {
this.updateTime = updateTime;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final DestinationConfiguration.Builder getDestinationConfiguration() {
return destinationConfiguration != null ? destinationConfiguration.toBuilder() : null;
}
public final void setDestinationConfiguration(DestinationConfiguration.BuilderImpl destinationConfiguration) {
this.destinationConfiguration = destinationConfiguration != null ? destinationConfiguration.build() : null;
}
@Override
public final Builder destinationConfiguration(DestinationConfiguration destinationConfiguration) {
this.destinationConfiguration = destinationConfiguration;
return this;
}
public final String getState() {
return state;
}
public final void setState(String state) {
this.state = state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
public final Builder state(LoggingConfigurationState state) {
this.state(state == null ? null : state.toString());
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagsCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
public LoggingConfigurationSummary build() {
return new LoggingConfigurationSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}