This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-glacier/include/aws/glacier/model/DeleteArchiveRequest.h

208 lines
8.1 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/glacier/Glacier_EXPORTS.h>
#include <aws/glacier/GlacierRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Glacier
{
namespace Model
{
/**
* <p>Provides options for deleting an archive from an Amazon S3 Glacier
* vault.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/glacier-2012-06-01/DeleteArchiveInput">AWS
* API Reference</a></p>
*/
class AWS_GLACIER_API DeleteArchiveRequest : public GlacierRequest
{
public:
DeleteArchiveRequest();
// Service request name is the Operation name which will send this request out,
// each operation should has unique request name, so that we can get operation's name from this request.
// Note: this is not true for response, multiple operations may have the same response name,
// so we can not get operation's name from response.
inline virtual const char* GetServiceRequestName() const override { return "DeleteArchive"; }
Aws::String SerializePayload() const override;
/**
* <p>The <code>AccountId</code> 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
* '<code>-</code>' (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.</p>
*/
inline const Aws::String& GetAccountId() const{ return m_accountId; }
/**
* <p>The <code>AccountId</code> 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
* '<code>-</code>' (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.</p>
*/
inline bool AccountIdHasBeenSet() const { return m_accountIdHasBeenSet; }
/**
* <p>The <code>AccountId</code> 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
* '<code>-</code>' (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.</p>
*/
inline void SetAccountId(const Aws::String& value) { m_accountIdHasBeenSet = true; m_accountId = value; }
/**
* <p>The <code>AccountId</code> 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
* '<code>-</code>' (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.</p>
*/
inline void SetAccountId(Aws::String&& value) { m_accountIdHasBeenSet = true; m_accountId = std::move(value); }
/**
* <p>The <code>AccountId</code> 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
* '<code>-</code>' (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.</p>
*/
inline void SetAccountId(const char* value) { m_accountIdHasBeenSet = true; m_accountId.assign(value); }
/**
* <p>The <code>AccountId</code> 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
* '<code>-</code>' (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.</p>
*/
inline DeleteArchiveRequest& WithAccountId(const Aws::String& value) { SetAccountId(value); return *this;}
/**
* <p>The <code>AccountId</code> 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
* '<code>-</code>' (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.</p>
*/
inline DeleteArchiveRequest& WithAccountId(Aws::String&& value) { SetAccountId(std::move(value)); return *this;}
/**
* <p>The <code>AccountId</code> 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
* '<code>-</code>' (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.</p>
*/
inline DeleteArchiveRequest& WithAccountId(const char* value) { SetAccountId(value); return *this;}
/**
* <p>The name of the vault.</p>
*/
inline const Aws::String& GetVaultName() const{ return m_vaultName; }
/**
* <p>The name of the vault.</p>
*/
inline bool VaultNameHasBeenSet() const { return m_vaultNameHasBeenSet; }
/**
* <p>The name of the vault.</p>
*/
inline void SetVaultName(const Aws::String& value) { m_vaultNameHasBeenSet = true; m_vaultName = value; }
/**
* <p>The name of the vault.</p>
*/
inline void SetVaultName(Aws::String&& value) { m_vaultNameHasBeenSet = true; m_vaultName = std::move(value); }
/**
* <p>The name of the vault.</p>
*/
inline void SetVaultName(const char* value) { m_vaultNameHasBeenSet = true; m_vaultName.assign(value); }
/**
* <p>The name of the vault.</p>
*/
inline DeleteArchiveRequest& WithVaultName(const Aws::String& value) { SetVaultName(value); return *this;}
/**
* <p>The name of the vault.</p>
*/
inline DeleteArchiveRequest& WithVaultName(Aws::String&& value) { SetVaultName(std::move(value)); return *this;}
/**
* <p>The name of the vault.</p>
*/
inline DeleteArchiveRequest& WithVaultName(const char* value) { SetVaultName(value); return *this;}
/**
* <p>The ID of the archive to delete.</p>
*/
inline const Aws::String& GetArchiveId() const{ return m_archiveId; }
/**
* <p>The ID of the archive to delete.</p>
*/
inline bool ArchiveIdHasBeenSet() const { return m_archiveIdHasBeenSet; }
/**
* <p>The ID of the archive to delete.</p>
*/
inline void SetArchiveId(const Aws::String& value) { m_archiveIdHasBeenSet = true; m_archiveId = value; }
/**
* <p>The ID of the archive to delete.</p>
*/
inline void SetArchiveId(Aws::String&& value) { m_archiveIdHasBeenSet = true; m_archiveId = std::move(value); }
/**
* <p>The ID of the archive to delete.</p>
*/
inline void SetArchiveId(const char* value) { m_archiveIdHasBeenSet = true; m_archiveId.assign(value); }
/**
* <p>The ID of the archive to delete.</p>
*/
inline DeleteArchiveRequest& WithArchiveId(const Aws::String& value) { SetArchiveId(value); return *this;}
/**
* <p>The ID of the archive to delete.</p>
*/
inline DeleteArchiveRequest& WithArchiveId(Aws::String&& value) { SetArchiveId(std::move(value)); return *this;}
/**
* <p>The ID of the archive to delete.</p>
*/
inline DeleteArchiveRequest& WithArchiveId(const char* value) { SetArchiveId(value); return *this;}
private:
Aws::String m_accountId;
bool m_accountIdHasBeenSet;
Aws::String m_vaultName;
bool m_vaultNameHasBeenSet;
Aws::String m_archiveId;
bool m_archiveIdHasBeenSet;
};
} // namespace Model
} // namespace Glacier
} // namespace Aws