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

Represents the input of a ListDeployments * operation.

See Also:

AWS * API Reference

*/ class ListDeploymentsRequest : public CodeDeployRequest { public: AWS_CODEDEPLOY_API ListDeploymentsRequest(); // 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 "ListDeployments"; } AWS_CODEDEPLOY_API Aws::String SerializePayload() const override; AWS_CODEDEPLOY_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of an CodeDeploy application associated with the IAM user or Amazon * Web Services account.

If applicationName is * specified, then deploymentGroupName must be specified. If it is not * specified, then deploymentGroupName must not be specified.

* */ inline const Aws::String& GetApplicationName() const{ return m_applicationName; } /** *

The name of an CodeDeploy application associated with the IAM user or Amazon * Web Services account.

If applicationName is * specified, then deploymentGroupName must be specified. If it is not * specified, then deploymentGroupName must not be specified.

* */ inline bool ApplicationNameHasBeenSet() const { return m_applicationNameHasBeenSet; } /** *

The name of an CodeDeploy application associated with the IAM user or Amazon * Web Services account.

If applicationName is * specified, then deploymentGroupName must be specified. If it is not * specified, then deploymentGroupName must not be specified.

* */ inline void SetApplicationName(const Aws::String& value) { m_applicationNameHasBeenSet = true; m_applicationName = value; } /** *

The name of an CodeDeploy application associated with the IAM user or Amazon * Web Services account.

If applicationName is * specified, then deploymentGroupName must be specified. If it is not * specified, then deploymentGroupName must not be specified.

* */ inline void SetApplicationName(Aws::String&& value) { m_applicationNameHasBeenSet = true; m_applicationName = std::move(value); } /** *

The name of an CodeDeploy application associated with the IAM user or Amazon * Web Services account.

If applicationName is * specified, then deploymentGroupName must be specified. If it is not * specified, then deploymentGroupName must not be specified.

* */ inline void SetApplicationName(const char* value) { m_applicationNameHasBeenSet = true; m_applicationName.assign(value); } /** *

The name of an CodeDeploy application associated with the IAM user or Amazon * Web Services account.

If applicationName is * specified, then deploymentGroupName must be specified. If it is not * specified, then deploymentGroupName must not be specified.

* */ inline ListDeploymentsRequest& WithApplicationName(const Aws::String& value) { SetApplicationName(value); return *this;} /** *

The name of an CodeDeploy application associated with the IAM user or Amazon * Web Services account.

If applicationName is * specified, then deploymentGroupName must be specified. If it is not * specified, then deploymentGroupName must not be specified.

* */ inline ListDeploymentsRequest& WithApplicationName(Aws::String&& value) { SetApplicationName(std::move(value)); return *this;} /** *

The name of an CodeDeploy application associated with the IAM user or Amazon * Web Services account.

If applicationName is * specified, then deploymentGroupName must be specified. If it is not * specified, then deploymentGroupName must not be specified.

* */ inline ListDeploymentsRequest& WithApplicationName(const char* value) { SetApplicationName(value); return *this;} /** *

The name of a deployment group for the specified application.

*

If deploymentGroupName is specified, then * applicationName must be specified. If it is not specified, then * applicationName must not be specified.

*/ inline const Aws::String& GetDeploymentGroupName() const{ return m_deploymentGroupName; } /** *

The name of a deployment group for the specified application.

*

If deploymentGroupName is specified, then * applicationName must be specified. If it is not specified, then * applicationName must not be specified.

*/ inline bool DeploymentGroupNameHasBeenSet() const { return m_deploymentGroupNameHasBeenSet; } /** *

The name of a deployment group for the specified application.

*

If deploymentGroupName is specified, then * applicationName must be specified. If it is not specified, then * applicationName must not be specified.

*/ inline void SetDeploymentGroupName(const Aws::String& value) { m_deploymentGroupNameHasBeenSet = true; m_deploymentGroupName = value; } /** *

The name of a deployment group for the specified application.

*

If deploymentGroupName is specified, then * applicationName must be specified. If it is not specified, then * applicationName must not be specified.

*/ inline void SetDeploymentGroupName(Aws::String&& value) { m_deploymentGroupNameHasBeenSet = true; m_deploymentGroupName = std::move(value); } /** *

The name of a deployment group for the specified application.

*

If deploymentGroupName is specified, then * applicationName must be specified. If it is not specified, then * applicationName must not be specified.

*/ inline void SetDeploymentGroupName(const char* value) { m_deploymentGroupNameHasBeenSet = true; m_deploymentGroupName.assign(value); } /** *

The name of a deployment group for the specified application.

*

If deploymentGroupName is specified, then * applicationName must be specified. If it is not specified, then * applicationName must not be specified.

*/ inline ListDeploymentsRequest& WithDeploymentGroupName(const Aws::String& value) { SetDeploymentGroupName(value); return *this;} /** *

The name of a deployment group for the specified application.

*

If deploymentGroupName is specified, then * applicationName must be specified. If it is not specified, then * applicationName must not be specified.

*/ inline ListDeploymentsRequest& WithDeploymentGroupName(Aws::String&& value) { SetDeploymentGroupName(std::move(value)); return *this;} /** *

The name of a deployment group for the specified application.

*

If deploymentGroupName is specified, then * applicationName must be specified. If it is not specified, then * applicationName must not be specified.

*/ inline ListDeploymentsRequest& WithDeploymentGroupName(const char* value) { SetDeploymentGroupName(value); return *this;} /** *

The unique ID of an external resource for returning deployments linked to the * external resource.

*/ inline const Aws::String& GetExternalId() const{ return m_externalId; } /** *

The unique ID of an external resource for returning deployments linked to the * external resource.

*/ inline bool ExternalIdHasBeenSet() const { return m_externalIdHasBeenSet; } /** *

The unique ID of an external resource for returning deployments linked to the * external resource.

*/ inline void SetExternalId(const Aws::String& value) { m_externalIdHasBeenSet = true; m_externalId = value; } /** *

The unique ID of an external resource for returning deployments linked to the * external resource.

*/ inline void SetExternalId(Aws::String&& value) { m_externalIdHasBeenSet = true; m_externalId = std::move(value); } /** *

The unique ID of an external resource for returning deployments linked to the * external resource.

*/ inline void SetExternalId(const char* value) { m_externalIdHasBeenSet = true; m_externalId.assign(value); } /** *

The unique ID of an external resource for returning deployments linked to the * external resource.

*/ inline ListDeploymentsRequest& WithExternalId(const Aws::String& value) { SetExternalId(value); return *this;} /** *

The unique ID of an external resource for returning deployments linked to the * external resource.

*/ inline ListDeploymentsRequest& WithExternalId(Aws::String&& value) { SetExternalId(std::move(value)); return *this;} /** *

The unique ID of an external resource for returning deployments linked to the * external resource.

*/ inline ListDeploymentsRequest& WithExternalId(const char* value) { SetExternalId(value); return *this;} /** *

A subset of deployments to list by status:

  • * Created: Include created deployments in the resulting list.

    *
  • Queued: Include queued deployments in the resulting * list.

  • In Progress: Include in-progress * deployments in the resulting list.

  • Succeeded: * Include successful deployments in the resulting list.

  • * Failed: Include failed deployments in the resulting list.

  • *
  • Stopped: Include stopped deployments in the resulting * list.

*/ inline const Aws::Vector& GetIncludeOnlyStatuses() const{ return m_includeOnlyStatuses; } /** *

A subset of deployments to list by status:

  • * Created: Include created deployments in the resulting list.

    *
  • Queued: Include queued deployments in the resulting * list.

  • In Progress: Include in-progress * deployments in the resulting list.

  • Succeeded: * Include successful deployments in the resulting list.

  • * Failed: Include failed deployments in the resulting list.

  • *
  • Stopped: Include stopped deployments in the resulting * list.

*/ inline bool IncludeOnlyStatusesHasBeenSet() const { return m_includeOnlyStatusesHasBeenSet; } /** *

A subset of deployments to list by status:

  • * Created: Include created deployments in the resulting list.

    *
  • Queued: Include queued deployments in the resulting * list.

  • In Progress: Include in-progress * deployments in the resulting list.

  • Succeeded: * Include successful deployments in the resulting list.

  • * Failed: Include failed deployments in the resulting list.

  • *
  • Stopped: Include stopped deployments in the resulting * list.

*/ inline void SetIncludeOnlyStatuses(const Aws::Vector& value) { m_includeOnlyStatusesHasBeenSet = true; m_includeOnlyStatuses = value; } /** *

A subset of deployments to list by status:

  • * Created: Include created deployments in the resulting list.

    *
  • Queued: Include queued deployments in the resulting * list.

  • In Progress: Include in-progress * deployments in the resulting list.

  • Succeeded: * Include successful deployments in the resulting list.

  • * Failed: Include failed deployments in the resulting list.

  • *
  • Stopped: Include stopped deployments in the resulting * list.

*/ inline void SetIncludeOnlyStatuses(Aws::Vector&& value) { m_includeOnlyStatusesHasBeenSet = true; m_includeOnlyStatuses = std::move(value); } /** *

A subset of deployments to list by status:

  • * Created: Include created deployments in the resulting list.

    *
  • Queued: Include queued deployments in the resulting * list.

  • In Progress: Include in-progress * deployments in the resulting list.

  • Succeeded: * Include successful deployments in the resulting list.

  • * Failed: Include failed deployments in the resulting list.

  • *
  • Stopped: Include stopped deployments in the resulting * list.

*/ inline ListDeploymentsRequest& WithIncludeOnlyStatuses(const Aws::Vector& value) { SetIncludeOnlyStatuses(value); return *this;} /** *

A subset of deployments to list by status:

  • * Created: Include created deployments in the resulting list.

    *
  • Queued: Include queued deployments in the resulting * list.

  • In Progress: Include in-progress * deployments in the resulting list.

  • Succeeded: * Include successful deployments in the resulting list.

  • * Failed: Include failed deployments in the resulting list.

  • *
  • Stopped: Include stopped deployments in the resulting * list.

*/ inline ListDeploymentsRequest& WithIncludeOnlyStatuses(Aws::Vector&& value) { SetIncludeOnlyStatuses(std::move(value)); return *this;} /** *

A subset of deployments to list by status:

  • * Created: Include created deployments in the resulting list.

    *
  • Queued: Include queued deployments in the resulting * list.

  • In Progress: Include in-progress * deployments in the resulting list.

  • Succeeded: * Include successful deployments in the resulting list.

  • * Failed: Include failed deployments in the resulting list.

  • *
  • Stopped: Include stopped deployments in the resulting * list.

*/ inline ListDeploymentsRequest& AddIncludeOnlyStatuses(const DeploymentStatus& value) { m_includeOnlyStatusesHasBeenSet = true; m_includeOnlyStatuses.push_back(value); return *this; } /** *

A subset of deployments to list by status:

  • * Created: Include created deployments in the resulting list.

    *
  • Queued: Include queued deployments in the resulting * list.

  • In Progress: Include in-progress * deployments in the resulting list.

  • Succeeded: * Include successful deployments in the resulting list.

  • * Failed: Include failed deployments in the resulting list.

  • *
  • Stopped: Include stopped deployments in the resulting * list.

*/ inline ListDeploymentsRequest& AddIncludeOnlyStatuses(DeploymentStatus&& value) { m_includeOnlyStatusesHasBeenSet = true; m_includeOnlyStatuses.push_back(std::move(value)); return *this; } /** *

A time range (start and end) for returning a subset of the list of * deployments.

*/ inline const TimeRange& GetCreateTimeRange() const{ return m_createTimeRange; } /** *

A time range (start and end) for returning a subset of the list of * deployments.

*/ inline bool CreateTimeRangeHasBeenSet() const { return m_createTimeRangeHasBeenSet; } /** *

A time range (start and end) for returning a subset of the list of * deployments.

*/ inline void SetCreateTimeRange(const TimeRange& value) { m_createTimeRangeHasBeenSet = true; m_createTimeRange = value; } /** *

A time range (start and end) for returning a subset of the list of * deployments.

*/ inline void SetCreateTimeRange(TimeRange&& value) { m_createTimeRangeHasBeenSet = true; m_createTimeRange = std::move(value); } /** *

A time range (start and end) for returning a subset of the list of * deployments.

*/ inline ListDeploymentsRequest& WithCreateTimeRange(const TimeRange& value) { SetCreateTimeRange(value); return *this;} /** *

A time range (start and end) for returning a subset of the list of * deployments.

*/ inline ListDeploymentsRequest& WithCreateTimeRange(TimeRange&& value) { SetCreateTimeRange(std::move(value)); return *this;} /** *

An identifier returned from the previous list deployments call. It can be * used to return the next set of deployments in the list.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

An identifier returned from the previous list deployments call. It can be * used to return the next set of deployments in the list.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

An identifier returned from the previous list deployments call. It can be * used to return the next set of deployments in the list.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

An identifier returned from the previous list deployments call. It can be * used to return the next set of deployments in the list.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

An identifier returned from the previous list deployments call. It can be * used to return the next set of deployments in the list.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

An identifier returned from the previous list deployments call. It can be * used to return the next set of deployments in the list.

*/ inline ListDeploymentsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

An identifier returned from the previous list deployments call. It can be * used to return the next set of deployments in the list.

*/ inline ListDeploymentsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

An identifier returned from the previous list deployments call. It can be * used to return the next set of deployments in the list.

*/ inline ListDeploymentsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::String m_applicationName; bool m_applicationNameHasBeenSet = false; Aws::String m_deploymentGroupName; bool m_deploymentGroupNameHasBeenSet = false; Aws::String m_externalId; bool m_externalIdHasBeenSet = false; Aws::Vector m_includeOnlyStatuses; bool m_includeOnlyStatusesHasBeenSet = false; TimeRange m_createTimeRange; bool m_createTimeRangeHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace CodeDeploy } // namespace Aws