com.amazonaws.services.ivs.model.Stream Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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 com.amazonaws.services.ivs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Specifies a live video stream that has been ingested and distributed.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Stream implements Serializable, Cloneable, StructuredPojo {
/**
*
* Channel ARN for the stream.
*
*/
private String channelArn;
/**
*
* The stream’s health.
*
*/
private String health;
/**
*
* URL of the master playlist, required by the video player to play the HLS stream.
*
*/
private String playbackUrl;
/**
*
* Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
*
*/
private java.util.Date startTime;
/**
*
* The stream’s state.
*
*/
private String state;
/**
*
* Unique identifier for a live or previously live stream in the specified channel.
*
*/
private String streamId;
/**
*
* A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15
* seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when
* video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
*
*/
private Long viewerCount;
/**
*
* Channel ARN for the stream.
*
*
* @param channelArn
* Channel ARN for the stream.
*/
public void setChannelArn(String channelArn) {
this.channelArn = channelArn;
}
/**
*
* Channel ARN for the stream.
*
*
* @return Channel ARN for the stream.
*/
public String getChannelArn() {
return this.channelArn;
}
/**
*
* Channel ARN for the stream.
*
*
* @param channelArn
* Channel ARN for the stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Stream withChannelArn(String channelArn) {
setChannelArn(channelArn);
return this;
}
/**
*
* The stream’s health.
*
*
* @param health
* The stream’s health.
* @see StreamHealth
*/
public void setHealth(String health) {
this.health = health;
}
/**
*
* The stream’s health.
*
*
* @return The stream’s health.
* @see StreamHealth
*/
public String getHealth() {
return this.health;
}
/**
*
* The stream’s health.
*
*
* @param health
* The stream’s health.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamHealth
*/
public Stream withHealth(String health) {
setHealth(health);
return this;
}
/**
*
* The stream’s health.
*
*
* @param health
* The stream’s health.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamHealth
*/
public Stream withHealth(StreamHealth health) {
this.health = health.toString();
return this;
}
/**
*
* URL of the master playlist, required by the video player to play the HLS stream.
*
*
* @param playbackUrl
* URL of the master playlist, required by the video player to play the HLS stream.
*/
public void setPlaybackUrl(String playbackUrl) {
this.playbackUrl = playbackUrl;
}
/**
*
* URL of the master playlist, required by the video player to play the HLS stream.
*
*
* @return URL of the master playlist, required by the video player to play the HLS stream.
*/
public String getPlaybackUrl() {
return this.playbackUrl;
}
/**
*
* URL of the master playlist, required by the video player to play the HLS stream.
*
*
* @param playbackUrl
* URL of the master playlist, required by the video player to play the HLS stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Stream withPlaybackUrl(String playbackUrl) {
setPlaybackUrl(playbackUrl);
return this;
}
/**
*
* Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
*
*
* @param startTime
* Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
*
*
* @return Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
*
*
* @param startTime
* Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Stream withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The stream’s state.
*
*
* @param state
* The stream’s state.
* @see StreamState
*/
public void setState(String state) {
this.state = state;
}
/**
*
* The stream’s state.
*
*
* @return The stream’s state.
* @see StreamState
*/
public String getState() {
return this.state;
}
/**
*
* The stream’s state.
*
*
* @param state
* The stream’s state.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamState
*/
public Stream withState(String state) {
setState(state);
return this;
}
/**
*
* The stream’s state.
*
*
* @param state
* The stream’s state.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamState
*/
public Stream withState(StreamState state) {
this.state = state.toString();
return this;
}
/**
*
* Unique identifier for a live or previously live stream in the specified channel.
*
*
* @param streamId
* Unique identifier for a live or previously live stream in the specified channel.
*/
public void setStreamId(String streamId) {
this.streamId = streamId;
}
/**
*
* Unique identifier for a live or previously live stream in the specified channel.
*
*
* @return Unique identifier for a live or previously live stream in the specified channel.
*/
public String getStreamId() {
return this.streamId;
}
/**
*
* Unique identifier for a live or previously live stream in the specified channel.
*
*
* @param streamId
* Unique identifier for a live or previously live stream in the specified channel.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Stream withStreamId(String streamId) {
setStreamId(streamId);
return this;
}
/**
*
* A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15
* seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when
* video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
*
*
* @param viewerCount
* A count of concurrent views of the stream. Typically, a new view appears in viewerCount
* within 15 seconds of when video playback starts and a view is removed from viewerCount within
* 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case,
* retry.
*/
public void setViewerCount(Long viewerCount) {
this.viewerCount = viewerCount;
}
/**
*
* A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15
* seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when
* video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
*
*
* @return A count of concurrent views of the stream. Typically, a new view appears in viewerCount
* within 15 seconds of when video playback starts and a view is removed from viewerCount
* within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this
* case, retry.
*/
public Long getViewerCount() {
return this.viewerCount;
}
/**
*
* A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15
* seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when
* video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
*
*
* @param viewerCount
* A count of concurrent views of the stream. Typically, a new view appears in viewerCount
* within 15 seconds of when video playback starts and a view is removed from viewerCount within
* 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case,
* retry.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Stream withViewerCount(Long viewerCount) {
setViewerCount(viewerCount);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getChannelArn() != null)
sb.append("ChannelArn: ").append(getChannelArn()).append(",");
if (getHealth() != null)
sb.append("Health: ").append(getHealth()).append(",");
if (getPlaybackUrl() != null)
sb.append("PlaybackUrl: ").append(getPlaybackUrl()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getStreamId() != null)
sb.append("StreamId: ").append(getStreamId()).append(",");
if (getViewerCount() != null)
sb.append("ViewerCount: ").append(getViewerCount());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Stream == false)
return false;
Stream other = (Stream) obj;
if (other.getChannelArn() == null ^ this.getChannelArn() == null)
return false;
if (other.getChannelArn() != null && other.getChannelArn().equals(this.getChannelArn()) == false)
return false;
if (other.getHealth() == null ^ this.getHealth() == null)
return false;
if (other.getHealth() != null && other.getHealth().equals(this.getHealth()) == false)
return false;
if (other.getPlaybackUrl() == null ^ this.getPlaybackUrl() == null)
return false;
if (other.getPlaybackUrl() != null && other.getPlaybackUrl().equals(this.getPlaybackUrl()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getStreamId() == null ^ this.getStreamId() == null)
return false;
if (other.getStreamId() != null && other.getStreamId().equals(this.getStreamId()) == false)
return false;
if (other.getViewerCount() == null ^ this.getViewerCount() == null)
return false;
if (other.getViewerCount() != null && other.getViewerCount().equals(this.getViewerCount()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getChannelArn() == null) ? 0 : getChannelArn().hashCode());
hashCode = prime * hashCode + ((getHealth() == null) ? 0 : getHealth().hashCode());
hashCode = prime * hashCode + ((getPlaybackUrl() == null) ? 0 : getPlaybackUrl().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getStreamId() == null) ? 0 : getStreamId().hashCode());
hashCode = prime * hashCode + ((getViewerCount() == null) ? 0 : getViewerCount().hashCode());
return hashCode;
}
@Override
public Stream clone() {
try {
return (Stream) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.ivs.model.transform.StreamMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}