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/DescribeJobRequest.h

208 lines
7.9 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 retrieving a job description.</p><p><h3>See Also:</h3>
* <a
* href="http://docs.aws.amazon.com/goto/WebAPI/glacier-2012-06-01/DescribeJobInput">AWS
* API Reference</a></p>
*/
class AWS_GLACIER_API DescribeJobRequest : public GlacierRequest
{
public:
DescribeJobRequest();
// 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 "DescribeJob"; }
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 DescribeJobRequest& 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 DescribeJobRequest& 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 DescribeJobRequest& 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 DescribeJobRequest& WithVaultName(const Aws::String& value) { SetVaultName(value); return *this;}
/**
* <p>The name of the vault.</p>
*/
inline DescribeJobRequest& WithVaultName(Aws::String&& value) { SetVaultName(std::move(value)); return *this;}
/**
* <p>The name of the vault.</p>
*/
inline DescribeJobRequest& WithVaultName(const char* value) { SetVaultName(value); return *this;}
/**
* <p>The ID of the job to describe.</p>
*/
inline const Aws::String& GetJobId() const{ return m_jobId; }
/**
* <p>The ID of the job to describe.</p>
*/
inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; }
/**
* <p>The ID of the job to describe.</p>
*/
inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; }
/**
* <p>The ID of the job to describe.</p>
*/
inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); }
/**
* <p>The ID of the job to describe.</p>
*/
inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); }
/**
* <p>The ID of the job to describe.</p>
*/
inline DescribeJobRequest& WithJobId(const Aws::String& value) { SetJobId(value); return *this;}
/**
* <p>The ID of the job to describe.</p>
*/
inline DescribeJobRequest& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;}
/**
* <p>The ID of the job to describe.</p>
*/
inline DescribeJobRequest& WithJobId(const char* value) { SetJobId(value); return *this;}
private:
Aws::String m_accountId;
bool m_accountIdHasBeenSet;
Aws::String m_vaultName;
bool m_vaultNameHasBeenSet;
Aws::String m_jobId;
bool m_jobIdHasBeenSet;
};
} // namespace Model
} // namespace Glacier
} // namespace Aws