/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the glacier-2012-06-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.Glacier.Model
{
///
/// Container for the parameters to the CompleteMultipartUpload operation.
/// You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive
/// parts have been uploaded and that Glacier can now assemble the archive from the uploaded
/// parts. After assembling and saving the archive to the vault, Glacier returns the URI
/// path of the newly created archive resource. Using the URI path, you can then access
/// the archive. After you upload an archive, you should save the archive ID returned
/// to retrieve the archive at a later point. You can also get the vault inventory to
/// obtain a list of archive IDs in a vault. For more information, see InitiateJob.
///
///
///
/// In the request, you must include the computed SHA256 tree hash of the entire archive
/// you have uploaded. For information about computing a SHA256 tree hash, see Computing
/// Checksums. On the server side, Glacier also constructs the SHA256 tree hash of
/// the assembled archive. If the values match, Glacier saves the archive to the vault;
/// otherwise, it returns an error, and the operation fails. The ListParts operation
/// returns a list of parts uploaded for a specific multipart upload. It includes checksum
/// information for each uploaded part that can be used to debug a bad checksum issue.
///
///
///
/// Additionally, Glacier also checks for any missing content ranges when assembling the
/// archive, if missing content ranges are found, Glacier returns an error and the operation
/// fails.
///
///
///
/// Complete Multipart Upload is an idempotent operation. After your first successful
/// complete multipart upload, if you call the operation again within a short period,
/// the operation will succeed and return the same archive ID. This is useful in the event
/// you experience a network issue that causes an aborted connection or receive a 500
/// server error, in which case you can repeat your Complete Multipart Upload request
/// and get the same archive ID without creating duplicate archives. Note, however, that
/// after the multipart upload completes, you cannot call the List Parts operation and
/// the multipart upload will not appear in List Multipart Uploads response, even if idempotent
/// complete is possible.
///
///
///
/// An AWS account has full permission to perform all operations (actions). However, AWS
/// Identity and Access Management (IAM) users don't have any permissions by default.
/// You must grant them explicit permission to perform specific actions. For more information,
/// see Access
/// Control Using AWS Identity and Access Management (IAM).
///
///
///
/// For conceptual information and underlying REST API, see Uploading
/// Large Archives in Parts (Multipart Upload) and Complete
/// Multipart Upload in the Amazon Glacier Developer Guide.
///
///
public partial class CompleteMultipartUploadRequest : AmazonGlacierRequest
{
private string _accountId;
private string _archiveSize;
private string _checksum;
private string _uploadId;
private string _vaultName;
///
/// Empty constructor used to set properties independently even when a simple constructor is available
///
public CompleteMultipartUploadRequest() { }
///
/// Instantiates CompleteMultipartUploadRequest with the parameterized properties
///
/// The name of the vault.
/// The upload ID of the multipart upload.
/// The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.
/// The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon S3 Glacier (Glacier), Glacier returns an error and the request fails.
public CompleteMultipartUploadRequest(string vaultName, string uploadId, string archiveSize, string checksum)
{
_vaultName = vaultName;
_uploadId = uploadId;
_archiveSize = archiveSize;
_checksum = checksum;
}
///
/// Instantiates CompleteMultipartUploadRequest with the parameterized properties
///
/// The AccountId
value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-
' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
/// The name of the vault.
/// The upload ID of the multipart upload.
/// The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.
/// The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon S3 Glacier (Glacier), Glacier returns an error and the request fails.
public CompleteMultipartUploadRequest(string accountId, string vaultName, string uploadId, string archiveSize, string checksum)
{
_accountId = accountId;
_vaultName = vaultName;
_uploadId = uploadId;
_archiveSize = archiveSize;
_checksum = checksum;
}
///
/// Gets and sets the property AccountId.
///
/// The AccountId
value is the AWS account ID of the account that owns the
/// vault. You can either specify an AWS account ID or optionally a single '-
'
/// (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with
/// the credentials used to sign the request. If you use an account ID, do not include
/// any hyphens ('-') in the ID.
///
///
[AWSProperty(Required=true)]
public string AccountId
{
get { return this._accountId; }
set { this._accountId = value; }
}
// Check to see if AccountId property is set
internal bool IsSetAccountId()
{
return this._accountId != null;
}
///
/// Gets and sets the property ArchiveSize.
///
/// The total size, in bytes, of the entire archive. This value should be the sum of all
/// the sizes of the individual parts that you uploaded.
///
///
public string ArchiveSize
{
get { return this._archiveSize; }
set { this._archiveSize = value; }
}
// Check to see if ArchiveSize property is set
internal bool IsSetArchiveSize()
{
return this._archiveSize != null;
}
///
/// Gets and sets the property Checksum.
///
/// The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash
/// of the individual parts. If the value you specify in the request does not match the
/// SHA256 tree hash of the final assembled archive as computed by Amazon S3 Glacier (Glacier),
/// Glacier returns an error and the request fails.
///
///
public string Checksum
{
get { return this._checksum; }
set { this._checksum = value; }
}
// Check to see if Checksum property is set
internal bool IsSetChecksum()
{
return this._checksum != null;
}
///
/// Gets and sets the property UploadId.
///
/// The upload ID of the multipart upload.
///
///
[AWSProperty(Required=true)]
public string UploadId
{
get { return this._uploadId; }
set { this._uploadId = value; }
}
// Check to see if UploadId property is set
internal bool IsSetUploadId()
{
return this._uploadId != null;
}
///
/// Gets and sets the property VaultName.
///
/// The name of the vault.
///
///
[AWSProperty(Required=true)]
public string VaultName
{
get { return this._vaultName; }
set { this._vaultName = value; }
}
// Check to see if VaultName property is set
internal bool IsSetVaultName()
{
return this._vaultName != null;
}
}
}