software.amazon.awssdk.services.ivs.model.ChannelSummary Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ivs Show documentation
Show all versions of ivs Show documentation
The AWS Java SDK for Ivs module holds the client classes that are used for
communicating with Ivs.
/*
* 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.ivs.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;
/**
*
* Summary information about a channel.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ChannelSummary implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn")
.getter(getter(ChannelSummary::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField AUTHORIZED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("authorized").getter(getter(ChannelSummary::authorized)).setter(setter(Builder::authorized))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("authorized").build()).build();
private static final SdkField LATENCY_MODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("latencyMode").getter(getter(ChannelSummary::latencyModeAsString)).setter(setter(Builder::latencyMode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("latencyMode").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(ChannelSummary::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField RECORDING_CONFIGURATION_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("recordingConfigurationArn").getter(getter(ChannelSummary::recordingConfigurationArn))
.setter(setter(Builder::recordingConfigurationArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("recordingConfigurationArn").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(ChannelSummary::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, AUTHORIZED_FIELD,
LATENCY_MODE_FIELD, NAME_FIELD, RECORDING_CONFIGURATION_ARN_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final Boolean authorized;
private final String latencyMode;
private final String name;
private final String recordingConfigurationArn;
private final Map tags;
private ChannelSummary(BuilderImpl builder) {
this.arn = builder.arn;
this.authorized = builder.authorized;
this.latencyMode = builder.latencyMode;
this.name = builder.name;
this.recordingConfigurationArn = builder.recordingConfigurationArn;
this.tags = builder.tags;
}
/**
*
* Channel ARN.
*
*
* @return Channel ARN.
*/
public final String arn() {
return arn;
}
/**
*
* Whether the channel is private (enabled for playback authorization). Default: false.
*
*
* @return Whether the channel is private (enabled for playback authorization). Default: false.
*/
public final Boolean authorized() {
return authorized;
}
/**
*
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS
* console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #latencyMode} will
* return {@link ChannelLatencyMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #latencyModeAsString}.
*
*
* @return Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the
* Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard,
* respectively.)
* @see ChannelLatencyMode
*/
public final ChannelLatencyMode latencyMode() {
return ChannelLatencyMode.fromValue(latencyMode);
}
/**
*
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS
* console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #latencyMode} will
* return {@link ChannelLatencyMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #latencyModeAsString}.
*
*
* @return Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the
* Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard,
* respectively.)
* @see ChannelLatencyMode
*/
public final String latencyModeAsString() {
return latencyMode;
}
/**
*
* Channel name.
*
*
* @return Channel name.
*/
public final String name() {
return name;
}
/**
*
* Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: ""
* (empty string, recording is disabled).
*
*
* @return Recording-configuration ARN. A value other than an empty string indicates that recording is enabled.
* Default: "" (empty string, recording is disabled).
*/
public final String recordingConfigurationArn() {
return recordingConfigurationArn;
}
/**
* 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);
}
/**
*
* Array of 1-50 maps, each of the form string:string (key: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 #hasTags} method.
*
*
* @return Array of 1-50 maps, each of the form string:string (key:value).
*/
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(authorized());
hashCode = 31 * hashCode + Objects.hashCode(latencyModeAsString());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(recordingConfigurationArn());
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 ChannelSummary)) {
return false;
}
ChannelSummary other = (ChannelSummary) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(authorized(), other.authorized())
&& Objects.equals(latencyModeAsString(), other.latencyModeAsString()) && Objects.equals(name(), other.name())
&& Objects.equals(recordingConfigurationArn(), other.recordingConfigurationArn()) && 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("ChannelSummary").add("Arn", arn()).add("Authorized", authorized())
.add("LatencyMode", latencyModeAsString()).add("Name", name())
.add("RecordingConfigurationArn", recordingConfigurationArn()).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 "authorized":
return Optional.ofNullable(clazz.cast(authorized()));
case "latencyMode":
return Optional.ofNullable(clazz.cast(latencyModeAsString()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "recordingConfigurationArn":
return Optional.ofNullable(clazz.cast(recordingConfigurationArn()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ChannelSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Channel ARN.
*
*
* @param arn
* Channel ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* Whether the channel is private (enabled for playback authorization). Default: false.
*
*
* @param authorized
* Whether the channel is private (enabled for playback authorization). Default: false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder authorized(Boolean authorized);
/**
*
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon
* IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
*
*
* @param latencyMode
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the
* Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard,
* respectively.)
* @see ChannelLatencyMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChannelLatencyMode
*/
Builder latencyMode(String latencyMode);
/**
*
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon
* IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
*
*
* @param latencyMode
* Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
* LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the
* Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard,
* respectively.)
* @see ChannelLatencyMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChannelLatencyMode
*/
Builder latencyMode(ChannelLatencyMode latencyMode);
/**
*
* Channel name.
*
*
* @param name
* Channel name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default:
* "" (empty string, recording is disabled).
*
*
* @param recordingConfigurationArn
* Recording-configuration ARN. A value other than an empty string indicates that recording is enabled.
* Default: "" (empty string, recording is disabled).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recordingConfigurationArn(String recordingConfigurationArn);
/**
*
* Array of 1-50 maps, each of the form string:string (key:value).
*
*
* @param tags
* Array of 1-50 maps, each of the form string:string (key:value).
* @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 Boolean authorized;
private String latencyMode;
private String name;
private String recordingConfigurationArn;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ChannelSummary model) {
arn(model.arn);
authorized(model.authorized);
latencyMode(model.latencyMode);
name(model.name);
recordingConfigurationArn(model.recordingConfigurationArn);
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 Boolean getAuthorized() {
return authorized;
}
public final void setAuthorized(Boolean authorized) {
this.authorized = authorized;
}
@Override
public final Builder authorized(Boolean authorized) {
this.authorized = authorized;
return this;
}
public final String getLatencyMode() {
return latencyMode;
}
public final void setLatencyMode(String latencyMode) {
this.latencyMode = latencyMode;
}
@Override
public final Builder latencyMode(String latencyMode) {
this.latencyMode = latencyMode;
return this;
}
@Override
public final Builder latencyMode(ChannelLatencyMode latencyMode) {
this.latencyMode(latencyMode == null ? null : latencyMode.toString());
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 String getRecordingConfigurationArn() {
return recordingConfigurationArn;
}
public final void setRecordingConfigurationArn(String recordingConfigurationArn) {
this.recordingConfigurationArn = recordingConfigurationArn;
}
@Override
public final Builder recordingConfigurationArn(String recordingConfigurationArn) {
this.recordingConfigurationArn = recordingConfigurationArn;
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 ChannelSummary build() {
return new ChannelSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy