/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace Glacier { namespace Model { /** *

Provides options for retrieving a job list for an Amazon S3 Glacier * vault.

See Also:

AWS * API Reference

*/ class ListJobsRequest : public GlacierRequest { public: AWS_GLACIER_API ListJobsRequest(); // 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 "ListJobs"; } AWS_GLACIER_API Aws::String SerializePayload() const override; AWS_GLACIER_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

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.

*/ inline const Aws::String& GetAccountId() const{ return m_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.

*/ inline bool AccountIdHasBeenSet() const { return m_accountIdHasBeenSet; } /** *

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.

*/ inline void SetAccountId(const Aws::String& value) { m_accountIdHasBeenSet = true; m_accountId = value; } /** *

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.

*/ inline void SetAccountId(Aws::String&& value) { m_accountIdHasBeenSet = true; m_accountId = std::move(value); } /** *

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.

*/ inline void SetAccountId(const char* value) { m_accountIdHasBeenSet = true; m_accountId.assign(value); } /** *

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.

*/ inline ListJobsRequest& WithAccountId(const Aws::String& value) { SetAccountId(value); return *this;} /** *

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.

*/ inline ListJobsRequest& WithAccountId(Aws::String&& value) { SetAccountId(std::move(value)); return *this;} /** *

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.

*/ inline ListJobsRequest& WithAccountId(const char* value) { SetAccountId(value); return *this;} /** *

The name of the vault.

*/ inline const Aws::String& GetVaultName() const{ return m_vaultName; } /** *

The name of the vault.

*/ inline bool VaultNameHasBeenSet() const { return m_vaultNameHasBeenSet; } /** *

The name of the vault.

*/ inline void SetVaultName(const Aws::String& value) { m_vaultNameHasBeenSet = true; m_vaultName = value; } /** *

The name of the vault.

*/ inline void SetVaultName(Aws::String&& value) { m_vaultNameHasBeenSet = true; m_vaultName = std::move(value); } /** *

The name of the vault.

*/ inline void SetVaultName(const char* value) { m_vaultNameHasBeenSet = true; m_vaultName.assign(value); } /** *

The name of the vault.

*/ inline ListJobsRequest& WithVaultName(const Aws::String& value) { SetVaultName(value); return *this;} /** *

The name of the vault.

*/ inline ListJobsRequest& WithVaultName(Aws::String&& value) { SetVaultName(std::move(value)); return *this;} /** *

The name of the vault.

*/ inline ListJobsRequest& WithVaultName(const char* value) { SetVaultName(value); return *this;} /** *

The maximum number of jobs to be returned. The default limit is 50. The * number of jobs returned might be fewer than the specified limit, but the number * of returned jobs never exceeds the limit.

*/ inline const Aws::String& GetLimit() const{ return m_limit; } /** *

The maximum number of jobs to be returned. The default limit is 50. The * number of jobs returned might be fewer than the specified limit, but the number * of returned jobs never exceeds the limit.

*/ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** *

The maximum number of jobs to be returned. The default limit is 50. The * number of jobs returned might be fewer than the specified limit, but the number * of returned jobs never exceeds the limit.

*/ inline void SetLimit(const Aws::String& value) { m_limitHasBeenSet = true; m_limit = value; } /** *

The maximum number of jobs to be returned. The default limit is 50. The * number of jobs returned might be fewer than the specified limit, but the number * of returned jobs never exceeds the limit.

*/ inline void SetLimit(Aws::String&& value) { m_limitHasBeenSet = true; m_limit = std::move(value); } /** *

The maximum number of jobs to be returned. The default limit is 50. The * number of jobs returned might be fewer than the specified limit, but the number * of returned jobs never exceeds the limit.

*/ inline void SetLimit(const char* value) { m_limitHasBeenSet = true; m_limit.assign(value); } /** *

The maximum number of jobs to be returned. The default limit is 50. The * number of jobs returned might be fewer than the specified limit, but the number * of returned jobs never exceeds the limit.

*/ inline ListJobsRequest& WithLimit(const Aws::String& value) { SetLimit(value); return *this;} /** *

The maximum number of jobs to be returned. The default limit is 50. The * number of jobs returned might be fewer than the specified limit, but the number * of returned jobs never exceeds the limit.

*/ inline ListJobsRequest& WithLimit(Aws::String&& value) { SetLimit(std::move(value)); return *this;} /** *

The maximum number of jobs to be returned. The default limit is 50. The * number of jobs returned might be fewer than the specified limit, but the number * of returned jobs never exceeds the limit.

*/ inline ListJobsRequest& WithLimit(const char* value) { SetLimit(value); return *this;} /** *

An opaque string used for pagination. This value specifies the job at which * the listing of jobs should begin. Get the marker value from a previous List Jobs * response. You only need to include the marker if you are continuing the * pagination of results started in a previous List Jobs request.

*/ inline const Aws::String& GetMarker() const{ return m_marker; } /** *

An opaque string used for pagination. This value specifies the job at which * the listing of jobs should begin. Get the marker value from a previous List Jobs * response. You only need to include the marker if you are continuing the * pagination of results started in a previous List Jobs request.

*/ inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; } /** *

An opaque string used for pagination. This value specifies the job at which * the listing of jobs should begin. Get the marker value from a previous List Jobs * response. You only need to include the marker if you are continuing the * pagination of results started in a previous List Jobs request.

*/ inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; } /** *

An opaque string used for pagination. This value specifies the job at which * the listing of jobs should begin. Get the marker value from a previous List Jobs * response. You only need to include the marker if you are continuing the * pagination of results started in a previous List Jobs request.

*/ inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); } /** *

An opaque string used for pagination. This value specifies the job at which * the listing of jobs should begin. Get the marker value from a previous List Jobs * response. You only need to include the marker if you are continuing the * pagination of results started in a previous List Jobs request.

*/ inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); } /** *

An opaque string used for pagination. This value specifies the job at which * the listing of jobs should begin. Get the marker value from a previous List Jobs * response. You only need to include the marker if you are continuing the * pagination of results started in a previous List Jobs request.

*/ inline ListJobsRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;} /** *

An opaque string used for pagination. This value specifies the job at which * the listing of jobs should begin. Get the marker value from a previous List Jobs * response. You only need to include the marker if you are continuing the * pagination of results started in a previous List Jobs request.

*/ inline ListJobsRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;} /** *

An opaque string used for pagination. This value specifies the job at which * the listing of jobs should begin. Get the marker value from a previous List Jobs * response. You only need to include the marker if you are continuing the * pagination of results started in a previous List Jobs request.

*/ inline ListJobsRequest& WithMarker(const char* value) { SetMarker(value); return *this;} /** *

The type of job status to return. You can specify the following values: * InProgress, Succeeded, or Failed.

*/ inline const Aws::String& GetStatuscode() const{ return m_statuscode; } /** *

The type of job status to return. You can specify the following values: * InProgress, Succeeded, or Failed.

*/ inline bool StatuscodeHasBeenSet() const { return m_statuscodeHasBeenSet; } /** *

The type of job status to return. You can specify the following values: * InProgress, Succeeded, or Failed.

*/ inline void SetStatuscode(const Aws::String& value) { m_statuscodeHasBeenSet = true; m_statuscode = value; } /** *

The type of job status to return. You can specify the following values: * InProgress, Succeeded, or Failed.

*/ inline void SetStatuscode(Aws::String&& value) { m_statuscodeHasBeenSet = true; m_statuscode = std::move(value); } /** *

The type of job status to return. You can specify the following values: * InProgress, Succeeded, or Failed.

*/ inline void SetStatuscode(const char* value) { m_statuscodeHasBeenSet = true; m_statuscode.assign(value); } /** *

The type of job status to return. You can specify the following values: * InProgress, Succeeded, or Failed.

*/ inline ListJobsRequest& WithStatuscode(const Aws::String& value) { SetStatuscode(value); return *this;} /** *

The type of job status to return. You can specify the following values: * InProgress, Succeeded, or Failed.

*/ inline ListJobsRequest& WithStatuscode(Aws::String&& value) { SetStatuscode(std::move(value)); return *this;} /** *

The type of job status to return. You can specify the following values: * InProgress, Succeeded, or Failed.

*/ inline ListJobsRequest& WithStatuscode(const char* value) { SetStatuscode(value); return *this;} /** *

The state of the jobs to return. You can specify true or * false.

*/ inline const Aws::String& GetCompleted() const{ return m_completed; } /** *

The state of the jobs to return. You can specify true or * false.

*/ inline bool CompletedHasBeenSet() const { return m_completedHasBeenSet; } /** *

The state of the jobs to return. You can specify true or * false.

*/ inline void SetCompleted(const Aws::String& value) { m_completedHasBeenSet = true; m_completed = value; } /** *

The state of the jobs to return. You can specify true or * false.

*/ inline void SetCompleted(Aws::String&& value) { m_completedHasBeenSet = true; m_completed = std::move(value); } /** *

The state of the jobs to return. You can specify true or * false.

*/ inline void SetCompleted(const char* value) { m_completedHasBeenSet = true; m_completed.assign(value); } /** *

The state of the jobs to return. You can specify true or * false.

*/ inline ListJobsRequest& WithCompleted(const Aws::String& value) { SetCompleted(value); return *this;} /** *

The state of the jobs to return. You can specify true or * false.

*/ inline ListJobsRequest& WithCompleted(Aws::String&& value) { SetCompleted(std::move(value)); return *this;} /** *

The state of the jobs to return. You can specify true or * false.

*/ inline ListJobsRequest& WithCompleted(const char* value) { SetCompleted(value); return *this;} private: Aws::String m_accountId; bool m_accountIdHasBeenSet = false; Aws::String m_vaultName; bool m_vaultNameHasBeenSet = false; Aws::String m_limit; bool m_limitHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; Aws::String m_statuscode; bool m_statuscodeHasBeenSet = false; Aws::String m_completed; bool m_completedHasBeenSet = false; }; } // namespace Model } // namespace Glacier } // namespace Aws