com.amazonaws.services.lookoutequipment.model.IngestionS3InputConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lookoutequipment Show documentation
/*
* Copyright 2018-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.lookoutequipment.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Specifies S3 configuration information for the input data for the data ingestion job.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IngestionS3InputConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the S3 bucket used for the input data for the data ingestion.
*
*/
private String bucket;
/**
*
* The prefix for the S3 location being used for the input data for the data ingestion.
*
*/
private String prefix;
/**
*
* The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created
* previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download
* files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first
* time.
*
*
* Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]*
* (Allowed delimiters : space, dot, underscore, hyphen)
*
*/
private String keyPattern;
/**
*
* The name of the S3 bucket used for the input data for the data ingestion.
*
*
* @param bucket
* The name of the S3 bucket used for the input data for the data ingestion.
*/
public void setBucket(String bucket) {
this.bucket = bucket;
}
/**
*
* The name of the S3 bucket used for the input data for the data ingestion.
*
*
* @return The name of the S3 bucket used for the input data for the data ingestion.
*/
public String getBucket() {
return this.bucket;
}
/**
*
* The name of the S3 bucket used for the input data for the data ingestion.
*
*
* @param bucket
* The name of the S3 bucket used for the input data for the data ingestion.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IngestionS3InputConfiguration withBucket(String bucket) {
setBucket(bucket);
return this;
}
/**
*
* The prefix for the S3 location being used for the input data for the data ingestion.
*
*
* @param prefix
* The prefix for the S3 location being used for the input data for the data ingestion.
*/
public void setPrefix(String prefix) {
this.prefix = prefix;
}
/**
*
* The prefix for the S3 location being used for the input data for the data ingestion.
*
*
* @return The prefix for the S3 location being used for the input data for the data ingestion.
*/
public String getPrefix() {
return this.prefix;
}
/**
*
* The prefix for the S3 location being used for the input data for the data ingestion.
*
*
* @param prefix
* The prefix for the S3 location being used for the input data for the data ingestion.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IngestionS3InputConfiguration withPrefix(String prefix) {
setPrefix(prefix);
return this;
}
/**
*
* The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created
* previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download
* files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first
* time.
*
*
* Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]*
* (Allowed delimiters : space, dot, underscore, hyphen)
*
*
* @param keyPattern
* The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created
* previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to
* download files from Amazon S3 according to the schema. This field is required when ingestion is being done
* for the first time.
*
* Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* |
* {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)
*/
public void setKeyPattern(String keyPattern) {
this.keyPattern = keyPattern;
}
/**
*
* The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created
* previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download
* files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first
* time.
*
*
* Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]*
* (Allowed delimiters : space, dot, underscore, hyphen)
*
*
* @return The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created
* previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to
* download files from Amazon S3 according to the schema. This field is required when ingestion is being
* done for the first time.
*
* Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* |
* {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)
*/
public String getKeyPattern() {
return this.keyPattern;
}
/**
*
* The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created
* previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download
* files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first
* time.
*
*
* Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]*
* (Allowed delimiters : space, dot, underscore, hyphen)
*
*
* @param keyPattern
* The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created
* previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to
* download files from Amazon S3 according to the schema. This field is required when ingestion is being done
* for the first time.
*
* Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* |
* {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IngestionS3InputConfiguration withKeyPattern(String keyPattern) {
setKeyPattern(keyPattern);
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 (getPrefix() != null)
sb.append("Prefix: ").append(getPrefix()).append(",");
if (getKeyPattern() != null)
sb.append("KeyPattern: ").append(getKeyPattern());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IngestionS3InputConfiguration == false)
return false;
IngestionS3InputConfiguration other = (IngestionS3InputConfiguration) obj;
if (other.getBucket() == null ^ this.getBucket() == null)
return false;
if (other.getBucket() != null && other.getBucket().equals(this.getBucket()) == false)
return false;
if (other.getPrefix() == null ^ this.getPrefix() == null)
return false;
if (other.getPrefix() != null && other.getPrefix().equals(this.getPrefix()) == false)
return false;
if (other.getKeyPattern() == null ^ this.getKeyPattern() == null)
return false;
if (other.getKeyPattern() != null && other.getKeyPattern().equals(this.getKeyPattern()) == 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 + ((getPrefix() == null) ? 0 : getPrefix().hashCode());
hashCode = prime * hashCode + ((getKeyPattern() == null) ? 0 : getKeyPattern().hashCode());
return hashCode;
}
@Override
public IngestionS3InputConfiguration clone() {
try {
return (IngestionS3InputConfiguration) 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.lookoutequipment.model.transform.IngestionS3InputConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}