/* * 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.qldb.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ExportJournalToS3Request extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the ledger. *
*/ private String name; /** ** The inclusive start date and time for the range of journal contents to export. *
*
* The InclusiveStartTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The InclusiveStartTime
must be before ExclusiveEndTime
.
*
* If you provide an InclusiveStartTime
that is before the ledger's CreationDateTime
,
* Amazon QLDB defaults it to the ledger's CreationDateTime
.
*
* The exclusive end date and time for the range of journal contents to export. *
*
* The ExclusiveEndTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The ExclusiveEndTime
must be less than or equal to the current UTC date and time.
*
* The configuration settings of the Amazon S3 bucket destination for your export request. *
*/ private S3ExportConfiguration s3ExportConfiguration; /** ** The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the * following: *
** Write objects into your Amazon S3 bucket. *
** (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your * exported data. *
*
* To pass a role to QLDB when requesting a journal export, you must have permissions to perform the
* iam:PassRole
action on the IAM role resource. This is required for all journal export requests.
*
* The output format of your exported journal data. A journal export job can write the data objects in either the * text or binary representation of Amazon * Ion format, or in JSON Lines text format. *
*
* Default: ION_TEXT
*
* In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a * newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena * and Glue because these services can parse newline-delimited JSON automatically. *
*/ private String outputFormat; /** ** The name of the ledger. *
* * @param name * The name of the ledger. */ public void setName(String name) { this.name = name; } /** ** The name of the ledger. *
* * @return The name of the ledger. */ public String getName() { return this.name; } /** ** The name of the ledger. *
* * @param name * The name of the ledger. * @return Returns a reference to this object so that method calls can be chained together. */ public ExportJournalToS3Request withName(String name) { setName(name); return this; } /** ** The inclusive start date and time for the range of journal contents to export. *
*
* The InclusiveStartTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The InclusiveStartTime
must be before ExclusiveEndTime
.
*
* If you provide an InclusiveStartTime
that is before the ledger's CreationDateTime
,
* Amazon QLDB defaults it to the ledger's CreationDateTime
.
*
* The InclusiveStartTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The InclusiveStartTime
must be before ExclusiveEndTime
.
*
* If you provide an InclusiveStartTime
that is before the ledger's
* CreationDateTime
, Amazon QLDB defaults it to the ledger's CreationDateTime
.
*/
public void setInclusiveStartTime(java.util.Date inclusiveStartTime) {
this.inclusiveStartTime = inclusiveStartTime;
}
/**
*
* The inclusive start date and time for the range of journal contents to export. *
*
* The InclusiveStartTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The InclusiveStartTime
must be before ExclusiveEndTime
.
*
* If you provide an InclusiveStartTime
that is before the ledger's CreationDateTime
,
* Amazon QLDB defaults it to the ledger's CreationDateTime
.
*
* The InclusiveStartTime
must be in ISO 8601
date and time format and in
* Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The InclusiveStartTime
must be before ExclusiveEndTime
.
*
* If you provide an InclusiveStartTime
that is before the ledger's
* CreationDateTime
, Amazon QLDB defaults it to the ledger's CreationDateTime
.
*/
public java.util.Date getInclusiveStartTime() {
return this.inclusiveStartTime;
}
/**
*
* The inclusive start date and time for the range of journal contents to export. *
*
* The InclusiveStartTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The InclusiveStartTime
must be before ExclusiveEndTime
.
*
* If you provide an InclusiveStartTime
that is before the ledger's CreationDateTime
,
* Amazon QLDB defaults it to the ledger's CreationDateTime
.
*
* The InclusiveStartTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The InclusiveStartTime
must be before ExclusiveEndTime
.
*
* If you provide an InclusiveStartTime
that is before the ledger's
* CreationDateTime
, Amazon QLDB defaults it to the ledger's CreationDateTime
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportJournalToS3Request withInclusiveStartTime(java.util.Date inclusiveStartTime) {
setInclusiveStartTime(inclusiveStartTime);
return this;
}
/**
*
* The exclusive end date and time for the range of journal contents to export. *
*
* The ExclusiveEndTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The ExclusiveEndTime
must be less than or equal to the current UTC date and time.
*
* The ExclusiveEndTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The ExclusiveEndTime
must be less than or equal to the current UTC date and time.
*/
public void setExclusiveEndTime(java.util.Date exclusiveEndTime) {
this.exclusiveEndTime = exclusiveEndTime;
}
/**
*
* The exclusive end date and time for the range of journal contents to export. *
*
* The ExclusiveEndTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The ExclusiveEndTime
must be less than or equal to the current UTC date and time.
*
* The ExclusiveEndTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The ExclusiveEndTime
must be less than or equal to the current UTC date and time.
*/
public java.util.Date getExclusiveEndTime() {
return this.exclusiveEndTime;
}
/**
*
* The exclusive end date and time for the range of journal contents to export. *
*
* The ExclusiveEndTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The ExclusiveEndTime
must be less than or equal to the current UTC date and time.
*
* The ExclusiveEndTime
must be in ISO 8601
date and time format and in Universal
* Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
*
* The ExclusiveEndTime
must be less than or equal to the current UTC date and time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportJournalToS3Request withExclusiveEndTime(java.util.Date exclusiveEndTime) {
setExclusiveEndTime(exclusiveEndTime);
return this;
}
/**
*
* The configuration settings of the Amazon S3 bucket destination for your export request. *
* * @param s3ExportConfiguration * The configuration settings of the Amazon S3 bucket destination for your export request. */ public void setS3ExportConfiguration(S3ExportConfiguration s3ExportConfiguration) { this.s3ExportConfiguration = s3ExportConfiguration; } /** ** The configuration settings of the Amazon S3 bucket destination for your export request. *
* * @return The configuration settings of the Amazon S3 bucket destination for your export request. */ public S3ExportConfiguration getS3ExportConfiguration() { return this.s3ExportConfiguration; } /** ** The configuration settings of the Amazon S3 bucket destination for your export request. *
* * @param s3ExportConfiguration * The configuration settings of the Amazon S3 bucket destination for your export request. * @return Returns a reference to this object so that method calls can be chained together. */ public ExportJournalToS3Request withS3ExportConfiguration(S3ExportConfiguration s3ExportConfiguration) { setS3ExportConfiguration(s3ExportConfiguration); return this; } /** ** The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the * following: *
** Write objects into your Amazon S3 bucket. *
** (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your * exported data. *
*
* To pass a role to QLDB when requesting a journal export, you must have permissions to perform the
* iam:PassRole
action on the IAM role resource. This is required for all journal export requests.
*
* Write objects into your Amazon S3 bucket. *
** (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of * your exported data. *
*
* To pass a role to QLDB when requesting a journal export, you must have permissions to perform the
* iam:PassRole
action on the IAM role resource. This is required for all journal export
* requests.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the * following: *
** Write objects into your Amazon S3 bucket. *
** (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your * exported data. *
*
* To pass a role to QLDB when requesting a journal export, you must have permissions to perform the
* iam:PassRole
action on the IAM role resource. This is required for all journal export requests.
*
* Write objects into your Amazon S3 bucket. *
** (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of * your exported data. *
*
* To pass a role to QLDB when requesting a journal export, you must have permissions to perform the
* iam:PassRole
action on the IAM role resource. This is required for all journal export
* requests.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the * following: *
** Write objects into your Amazon S3 bucket. *
** (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your * exported data. *
*
* To pass a role to QLDB when requesting a journal export, you must have permissions to perform the
* iam:PassRole
action on the IAM role resource. This is required for all journal export requests.
*
* Write objects into your Amazon S3 bucket. *
** (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of * your exported data. *
*
* To pass a role to QLDB when requesting a journal export, you must have permissions to perform the
* iam:PassRole
action on the IAM role resource. This is required for all journal export
* requests.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportJournalToS3Request withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* The output format of your exported journal data. A journal export job can write the data objects in either the * text or binary representation of Amazon * Ion format, or in JSON Lines text format. *
*
* Default: ION_TEXT
*
* In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a * newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena * and Glue because these services can parse newline-delimited JSON automatically. *
* * @param outputFormat * The output format of your exported journal data. A journal export job can write the data objects in either * the text or binary representation of Amazon Ion format, or in JSON Lines text format. *
* Default: ION_TEXT
*
* In JSON Lines format, each journal block in an exported data object is a valid JSON object that is * delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools * such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically. * @see OutputFormat */ public void setOutputFormat(String outputFormat) { this.outputFormat = outputFormat; } /** *
* The output format of your exported journal data. A journal export job can write the data objects in either the * text or binary representation of Amazon * Ion format, or in JSON Lines text format. *
*
* Default: ION_TEXT
*
* In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a * newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena * and Glue because these services can parse newline-delimited JSON automatically. *
* * @return The output format of your exported journal data. A journal export job can write the data objects in * either the text or binary representation of Amazon Ion format, or in JSON Lines text format. *
* Default: ION_TEXT
*
* In JSON Lines format, each journal block in an exported data object is a valid JSON object that is * delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools * such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically. * @see OutputFormat */ public String getOutputFormat() { return this.outputFormat; } /** *
* The output format of your exported journal data. A journal export job can write the data objects in either the * text or binary representation of Amazon * Ion format, or in JSON Lines text format. *
*
* Default: ION_TEXT
*
* In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a * newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena * and Glue because these services can parse newline-delimited JSON automatically. *
* * @param outputFormat * The output format of your exported journal data. A journal export job can write the data objects in either * the text or binary representation of Amazon Ion format, or in JSON Lines text format. *
* Default: ION_TEXT
*
* In JSON Lines format, each journal block in an exported data object is a valid JSON object that is * delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools * such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically. * @return Returns a reference to this object so that method calls can be chained together. * @see OutputFormat */ public ExportJournalToS3Request withOutputFormat(String outputFormat) { setOutputFormat(outputFormat); return this; } /** *
* The output format of your exported journal data. A journal export job can write the data objects in either the * text or binary representation of Amazon * Ion format, or in JSON Lines text format. *
*
* Default: ION_TEXT
*
* In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a * newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena * and Glue because these services can parse newline-delimited JSON automatically. *
* * @param outputFormat * The output format of your exported journal data. A journal export job can write the data objects in either * the text or binary representation of Amazon Ion format, or in JSON Lines text format. *
* Default: ION_TEXT
*
* In JSON Lines format, each journal block in an exported data object is a valid JSON object that is * delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools * such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically. * @return Returns a reference to this object so that method calls can be chained together. * @see OutputFormat */ public ExportJournalToS3Request withOutputFormat(OutputFormat outputFormat) { this.outputFormat = outputFormat.toString(); 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 (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getInclusiveStartTime() != null) sb.append("InclusiveStartTime: ").append(getInclusiveStartTime()).append(","); if (getExclusiveEndTime() != null) sb.append("ExclusiveEndTime: ").append(getExclusiveEndTime()).append(","); if (getS3ExportConfiguration() != null) sb.append("S3ExportConfiguration: ").append(getS3ExportConfiguration()).append(","); if (getRoleArn() != null) sb.append("RoleArn: ").append(getRoleArn()).append(","); if (getOutputFormat() != null) sb.append("OutputFormat: ").append(getOutputFormat()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ExportJournalToS3Request == false) return false; ExportJournalToS3Request other = (ExportJournalToS3Request) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getInclusiveStartTime() == null ^ this.getInclusiveStartTime() == null) return false; if (other.getInclusiveStartTime() != null && other.getInclusiveStartTime().equals(this.getInclusiveStartTime()) == false) return false; if (other.getExclusiveEndTime() == null ^ this.getExclusiveEndTime() == null) return false; if (other.getExclusiveEndTime() != null && other.getExclusiveEndTime().equals(this.getExclusiveEndTime()) == false) return false; if (other.getS3ExportConfiguration() == null ^ this.getS3ExportConfiguration() == null) return false; if (other.getS3ExportConfiguration() != null && other.getS3ExportConfiguration().equals(this.getS3ExportConfiguration()) == 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.getOutputFormat() == null ^ this.getOutputFormat() == null) return false; if (other.getOutputFormat() != null && other.getOutputFormat().equals(this.getOutputFormat()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getInclusiveStartTime() == null) ? 0 : getInclusiveStartTime().hashCode()); hashCode = prime * hashCode + ((getExclusiveEndTime() == null) ? 0 : getExclusiveEndTime().hashCode()); hashCode = prime * hashCode + ((getS3ExportConfiguration() == null) ? 0 : getS3ExportConfiguration().hashCode()); hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getOutputFormat() == null) ? 0 : getOutputFormat().hashCode()); return hashCode; } @Override public ExportJournalToS3Request clone() { return (ExportJournalToS3Request) super.clone(); } }