/* * Copyright 2010-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.kinesisvideoarchivedmedia.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Downloads an MP4 file (clip) containing the archived, on-demand media from * the specified video stream over the specified time range. *

*

* Both the StreamName and the StreamARN parameters are optional, but you must * specify either the StreamName or the StreamARN when invoking this API * operation. *

*

* As a prerequisite to using GetCLip API, you must obtain an endpoint using * GetDataEndpoint, specifying GET_CLIP for * the APIName parameter. *

*

* An Amazon Kinesis video stream has the following requirements for providing * data through MP4: *

* *

* You can monitor the amount of outgoing data by monitoring the * GetClip.OutgoingBytes Amazon CloudWatch metric. For information * about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis * Video Streams Pricing and AWS * Pricing. Charges for outgoing AWS data apply. *

*/ public class GetClipRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The name of the stream for which to retrieve the media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
*/ private String streamName; /** *

* The Amazon Resource Name (ARN) of the stream for which to retrieve the * media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
*/ private String streamARN; /** *

* The time range of the requested clip and the source of the timestamps. *

*/ private ClipFragmentSelector clipFragmentSelector; /** *

* The name of the stream for which to retrieve the media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @return

* The name of the stream for which to retrieve the media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*/ public String getStreamName() { return streamName; } /** *

* The name of the stream for which to retrieve the media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @param streamName

* The name of the stream for which to retrieve the media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*/ public void setStreamName(String streamName) { this.streamName = streamName; } /** *

* The name of the stream for which to retrieve the media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @param streamName

* The name of the stream for which to retrieve the media clip. *

*

* You must specify either the StreamName or the StreamARN. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetClipRequest withStreamName(String streamName) { this.streamName = streamName; return this; } /** *

* The Amazon Resource Name (ARN) of the stream for which to retrieve the * media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @return

* The Amazon Resource Name (ARN) of the stream for which to * retrieve the media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*/ public String getStreamARN() { return streamARN; } /** *

* The Amazon Resource Name (ARN) of the stream for which to retrieve the * media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @param streamARN

* The Amazon Resource Name (ARN) of the stream for which to * retrieve the media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*/ public void setStreamARN(String streamARN) { this.streamARN = streamARN; } /** *

* The Amazon Resource Name (ARN) of the stream for which to retrieve the * media clip. *

*

* You must specify either the StreamName or the StreamARN. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @param streamARN

* The Amazon Resource Name (ARN) of the stream for which to * retrieve the media clip. *

*

* You must specify either the StreamName or the StreamARN. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetClipRequest withStreamARN(String streamARN) { this.streamARN = streamARN; return this; } /** *

* The time range of the requested clip and the source of the timestamps. *

* * @return

* The time range of the requested clip and the source of the * timestamps. *

*/ public ClipFragmentSelector getClipFragmentSelector() { return clipFragmentSelector; } /** *

* The time range of the requested clip and the source of the timestamps. *

* * @param clipFragmentSelector

* The time range of the requested clip and the source of the * timestamps. *

*/ public void setClipFragmentSelector(ClipFragmentSelector clipFragmentSelector) { this.clipFragmentSelector = clipFragmentSelector; } /** *

* The time range of the requested clip and the source of the timestamps. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param clipFragmentSelector

* The time range of the requested clip and the source of the * timestamps. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetClipRequest withClipFragmentSelector(ClipFragmentSelector clipFragmentSelector) { this.clipFragmentSelector = clipFragmentSelector; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getStreamName() != null) sb.append("StreamName: " + getStreamName() + ","); if (getStreamARN() != null) sb.append("StreamARN: " + getStreamARN() + ","); if (getClipFragmentSelector() != null) sb.append("ClipFragmentSelector: " + getClipFragmentSelector()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getStreamName() == null) ? 0 : getStreamName().hashCode()); hashCode = prime * hashCode + ((getStreamARN() == null) ? 0 : getStreamARN().hashCode()); hashCode = prime * hashCode + ((getClipFragmentSelector() == null) ? 0 : getClipFragmentSelector().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetClipRequest == false) return false; GetClipRequest other = (GetClipRequest) obj; if (other.getStreamName() == null ^ this.getStreamName() == null) return false; if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == false) return false; if (other.getStreamARN() == null ^ this.getStreamARN() == null) return false; if (other.getStreamARN() != null && other.getStreamARN().equals(this.getStreamARN()) == false) return false; if (other.getClipFragmentSelector() == null ^ this.getClipFragmentSelector() == null) return false; if (other.getClipFragmentSelector() != null && other.getClipFragmentSelector().equals(this.getClipFragmentSelector()) == false) return false; return true; } }