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

* Creates a stream for delivering one or more large files in chunks over MQTT. * A stream transports data bytes in chunks or blocks packaged as MQTT messages * from a source like S3. You can have one or more files associated with a * stream. *

*

* Requires permission to access the CreateStream action. *

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

* The stream ID. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_-]+
*/ private String streamId; /** *

* A description of the stream. *

*

* Constraints:
* Length: - 2028
* Pattern: [^\p{C}]+
*/ private String description; /** *

* The files to stream. *

*/ private java.util.List files; /** *

* An IAM role that allows the IoT service principal to access your S3 * files. *

*

* Constraints:
* Length: 20 - 2048
*/ private String roleArn; /** *

* Metadata which can be used to manage streams. *

*/ private java.util.List tags; /** *

* The stream ID. *

*

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

* The stream ID. *

*/ public String getStreamId() { return streamId; } /** *

* The stream ID. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_-]+
* * @param streamId

* The stream ID. *

*/ public void setStreamId(String streamId) { this.streamId = streamId; } /** *

* The stream ID. *

*

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

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_-]+
* * @param streamId

* The stream ID. *

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

* A description of the stream. *

*

* Constraints:
* Length: - 2028
* Pattern: [^\p{C}]+
* * @return

* A description of the stream. *

*/ public String getDescription() { return description; } /** *

* A description of the stream. *

*

* Constraints:
* Length: - 2028
* Pattern: [^\p{C}]+
* * @param description

* A description of the stream. *

*/ public void setDescription(String description) { this.description = description; } /** *

* A description of the stream. *

*

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

* Constraints:
* Length: - 2028
* Pattern: [^\p{C}]+
* * @param description

* A description of the stream. *

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

* The files to stream. *

* * @return

* The files to stream. *

*/ public java.util.List getFiles() { return files; } /** *

* The files to stream. *

* * @param files

* The files to stream. *

*/ public void setFiles(java.util.Collection files) { if (files == null) { this.files = null; return; } this.files = new java.util.ArrayList(files); } /** *

* The files to stream. *

*

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

* The files to stream. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateStreamRequest withFiles(StreamFile... files) { if (getFiles() == null) { this.files = new java.util.ArrayList(files.length); } for (StreamFile value : files) { this.files.add(value); } return this; } /** *

* The files to stream. *

*

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

* The files to stream. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateStreamRequest withFiles(java.util.Collection files) { setFiles(files); return this; } /** *

* An IAM role that allows the IoT service principal to access your S3 * files. *

*

* Constraints:
* Length: 20 - 2048
* * @return

* An IAM role that allows the IoT service principal to access your * S3 files. *

*/ public String getRoleArn() { return roleArn; } /** *

* An IAM role that allows the IoT service principal to access your S3 * files. *

*

* Constraints:
* Length: 20 - 2048
* * @param roleArn

* An IAM role that allows the IoT service principal to access * your S3 files. *

*/ public void setRoleArn(String roleArn) { this.roleArn = roleArn; } /** *

* An IAM role that allows the IoT service principal to access your S3 * files. *

*

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

* Constraints:
* Length: 20 - 2048
* * @param roleArn

* An IAM role that allows the IoT service principal to access * your S3 files. *

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

* Metadata which can be used to manage streams. *

* * @return

* Metadata which can be used to manage streams. *

*/ public java.util.List getTags() { return tags; } /** *

* Metadata which can be used to manage streams. *

* * @param tags

* Metadata which can be used to manage streams. *

*/ public void setTags(java.util.Collection tags) { if (tags == null) { this.tags = null; return; } this.tags = new java.util.ArrayList(tags); } /** *

* Metadata which can be used to manage streams. *

*

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

* Metadata which can be used to manage streams. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateStreamRequest withTags(Tag... tags) { if (getTags() == null) { this.tags = new java.util.ArrayList(tags.length); } for (Tag value : tags) { this.tags.add(value); } return this; } /** *

* Metadata which can be used to manage streams. *

*

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

* Metadata which can be used to manage streams. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateStreamRequest withTags(java.util.Collection tags) { setTags(tags); 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 (getStreamId() != null) sb.append("streamId: " + getStreamId() + ","); if (getDescription() != null) sb.append("description: " + getDescription() + ","); if (getFiles() != null) sb.append("files: " + getFiles() + ","); if (getRoleArn() != null) sb.append("roleArn: " + getRoleArn() + ","); if (getTags() != null) sb.append("tags: " + getTags()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getStreamId() == null) ? 0 : getStreamId().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getFiles() == null) ? 0 : getFiles().hashCode()); hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateStreamRequest == false) return false; CreateStreamRequest other = (CreateStreamRequest) obj; if (other.getStreamId() == null ^ this.getStreamId() == null) return false; if (other.getStreamId() != null && other.getStreamId().equals(this.getStreamId()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getFiles() == null ^ this.getFiles() == null) return false; if (other.getFiles() != null && other.getFiles().equals(this.getFiles()) == false) return false; if (other.getRoleArn() == null ^ this.getRoleArn() == null) return false; if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; return true; } }