com.amazonaws.services.iotanalytics.model.CustomerManagedChannelS3Storage Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iotanalytics Show documentation
/*
* Copyright 2019-2024 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.iotanalytics.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Used to store channel data in an S3 bucket that you manage. If customer-managed storage is selected, the
* retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is
* created.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CustomerManagedChannelS3Storage implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the S3 bucket in which channel data is stored.
*
*/
private String bucket;
/**
*
* (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key
* that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end
* with a forward slash (/).
*
*/
private String keyPrefix;
/**
*
* The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
*
*/
private String roleArn;
/**
*
* The name of the S3 bucket in which channel data is stored.
*
*
* @param bucket
* The name of the S3 bucket in which channel data is stored.
*/
public void setBucket(String bucket) {
this.bucket = bucket;
}
/**
*
* The name of the S3 bucket in which channel data is stored.
*
*
* @return The name of the S3 bucket in which channel data is stored.
*/
public String getBucket() {
return this.bucket;
}
/**
*
* The name of the S3 bucket in which channel data is stored.
*
*
* @param bucket
* The name of the S3 bucket in which channel data is stored.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomerManagedChannelS3Storage withBucket(String bucket) {
setBucket(bucket);
return this;
}
/**
*
* (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key
* that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end
* with a forward slash (/).
*
*
* @param keyPrefix
* (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has
* a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix
* must end with a forward slash (/).
*/
public void setKeyPrefix(String keyPrefix) {
this.keyPrefix = keyPrefix;
}
/**
*
* (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key
* that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end
* with a forward slash (/).
*
*
* @return (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket
* has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The
* prefix must end with a forward slash (/).
*/
public String getKeyPrefix() {
return this.keyPrefix;
}
/**
*
* (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key
* that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end
* with a forward slash (/).
*
*
* @param keyPrefix
* (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has
* a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix
* must end with a forward slash (/).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomerManagedChannelS3Storage withKeyPrefix(String keyPrefix) {
setKeyPrefix(keyPrefix);
return this;
}
/**
*
* The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
*
*
* @param roleArn
* The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
*
*
* @return The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
*
*
* @param roleArn
* The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomerManagedChannelS3Storage withRoleArn(String roleArn) {
setRoleArn(roleArn);
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 (getBucket() != null)
sb.append("Bucket: ").append(getBucket()).append(",");
if (getKeyPrefix() != null)
sb.append("KeyPrefix: ").append(getKeyPrefix()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CustomerManagedChannelS3Storage == false)
return false;
CustomerManagedChannelS3Storage other = (CustomerManagedChannelS3Storage) obj;
if (other.getBucket() == null ^ this.getBucket() == null)
return false;
if (other.getBucket() != null && other.getBucket().equals(this.getBucket()) == false)
return false;
if (other.getKeyPrefix() == null ^ this.getKeyPrefix() == null)
return false;
if (other.getKeyPrefix() != null && other.getKeyPrefix().equals(this.getKeyPrefix()) == false)
return false;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBucket() == null) ? 0 : getBucket().hashCode());
hashCode = prime * hashCode + ((getKeyPrefix() == null) ? 0 : getKeyPrefix().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
return hashCode;
}
@Override
public CustomerManagedChannelS3Storage clone() {
try {
return (CustomerManagedChannelS3Storage) 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.iotanalytics.model.transform.CustomerManagedChannelS3StorageMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}