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-amplify/include/aws/amplify/model/UpdateBranchRequest.h

701 lines
25 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/amplify/Amplify_EXPORTS.h>
#include <aws/amplify/AmplifyRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/amplify/model/Stage.h>
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <utility>
namespace Aws
{
namespace Amplify
{
namespace Model
{
/**
* <p> The request structure for the update branch request. </p><p><h3>See
* Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranchRequest">AWS
* API Reference</a></p>
*/
class AWS_AMPLIFY_API UpdateBranchRequest : public AmplifyRequest
{
public:
UpdateBranchRequest();
// 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 "UpdateBranch"; }
Aws::String SerializePayload() const override;
/**
* <p> The unique ID for an Amplify app. </p>
*/
inline const Aws::String& GetAppId() const{ return m_appId; }
/**
* <p> The unique ID for an Amplify app. </p>
*/
inline bool AppIdHasBeenSet() const { return m_appIdHasBeenSet; }
/**
* <p> The unique ID for an Amplify app. </p>
*/
inline void SetAppId(const Aws::String& value) { m_appIdHasBeenSet = true; m_appId = value; }
/**
* <p> The unique ID for an Amplify app. </p>
*/
inline void SetAppId(Aws::String&& value) { m_appIdHasBeenSet = true; m_appId = std::move(value); }
/**
* <p> The unique ID for an Amplify app. </p>
*/
inline void SetAppId(const char* value) { m_appIdHasBeenSet = true; m_appId.assign(value); }
/**
* <p> The unique ID for an Amplify app. </p>
*/
inline UpdateBranchRequest& WithAppId(const Aws::String& value) { SetAppId(value); return *this;}
/**
* <p> The unique ID for an Amplify app. </p>
*/
inline UpdateBranchRequest& WithAppId(Aws::String&& value) { SetAppId(std::move(value)); return *this;}
/**
* <p> The unique ID for an Amplify app. </p>
*/
inline UpdateBranchRequest& WithAppId(const char* value) { SetAppId(value); return *this;}
/**
* <p> The name for the branch. </p>
*/
inline const Aws::String& GetBranchName() const{ return m_branchName; }
/**
* <p> The name for the branch. </p>
*/
inline bool BranchNameHasBeenSet() const { return m_branchNameHasBeenSet; }
/**
* <p> The name for the branch. </p>
*/
inline void SetBranchName(const Aws::String& value) { m_branchNameHasBeenSet = true; m_branchName = value; }
/**
* <p> The name for the branch. </p>
*/
inline void SetBranchName(Aws::String&& value) { m_branchNameHasBeenSet = true; m_branchName = std::move(value); }
/**
* <p> The name for the branch. </p>
*/
inline void SetBranchName(const char* value) { m_branchNameHasBeenSet = true; m_branchName.assign(value); }
/**
* <p> The name for the branch. </p>
*/
inline UpdateBranchRequest& WithBranchName(const Aws::String& value) { SetBranchName(value); return *this;}
/**
* <p> The name for the branch. </p>
*/
inline UpdateBranchRequest& WithBranchName(Aws::String&& value) { SetBranchName(std::move(value)); return *this;}
/**
* <p> The name for the branch. </p>
*/
inline UpdateBranchRequest& WithBranchName(const char* value) { SetBranchName(value); return *this;}
/**
* <p> The description for the branch. </p>
*/
inline const Aws::String& GetDescription() const{ return m_description; }
/**
* <p> The description for the branch. </p>
*/
inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
/**
* <p> The description for the branch. </p>
*/
inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
/**
* <p> The description for the branch. </p>
*/
inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
/**
* <p> The description for the branch. </p>
*/
inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
/**
* <p> The description for the branch. </p>
*/
inline UpdateBranchRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
/**
* <p> The description for the branch. </p>
*/
inline UpdateBranchRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
/**
* <p> The description for the branch. </p>
*/
inline UpdateBranchRequest& WithDescription(const char* value) { SetDescription(value); return *this;}
/**
* <p> The framework for the branch. </p>
*/
inline const Aws::String& GetFramework() const{ return m_framework; }
/**
* <p> The framework for the branch. </p>
*/
inline bool FrameworkHasBeenSet() const { return m_frameworkHasBeenSet; }
/**
* <p> The framework for the branch. </p>
*/
inline void SetFramework(const Aws::String& value) { m_frameworkHasBeenSet = true; m_framework = value; }
/**
* <p> The framework for the branch. </p>
*/
inline void SetFramework(Aws::String&& value) { m_frameworkHasBeenSet = true; m_framework = std::move(value); }
/**
* <p> The framework for the branch. </p>
*/
inline void SetFramework(const char* value) { m_frameworkHasBeenSet = true; m_framework.assign(value); }
/**
* <p> The framework for the branch. </p>
*/
inline UpdateBranchRequest& WithFramework(const Aws::String& value) { SetFramework(value); return *this;}
/**
* <p> The framework for the branch. </p>
*/
inline UpdateBranchRequest& WithFramework(Aws::String&& value) { SetFramework(std::move(value)); return *this;}
/**
* <p> The framework for the branch. </p>
*/
inline UpdateBranchRequest& WithFramework(const char* value) { SetFramework(value); return *this;}
/**
* <p> Describes the current stage for the branch. </p>
*/
inline const Stage& GetStage() const{ return m_stage; }
/**
* <p> Describes the current stage for the branch. </p>
*/
inline bool StageHasBeenSet() const { return m_stageHasBeenSet; }
/**
* <p> Describes the current stage for the branch. </p>
*/
inline void SetStage(const Stage& value) { m_stageHasBeenSet = true; m_stage = value; }
/**
* <p> Describes the current stage for the branch. </p>
*/
inline void SetStage(Stage&& value) { m_stageHasBeenSet = true; m_stage = std::move(value); }
/**
* <p> Describes the current stage for the branch. </p>
*/
inline UpdateBranchRequest& WithStage(const Stage& value) { SetStage(value); return *this;}
/**
* <p> Describes the current stage for the branch. </p>
*/
inline UpdateBranchRequest& WithStage(Stage&& value) { SetStage(std::move(value)); return *this;}
/**
* <p> Enables notifications for the branch. </p>
*/
inline bool GetEnableNotification() const{ return m_enableNotification; }
/**
* <p> Enables notifications for the branch. </p>
*/
inline bool EnableNotificationHasBeenSet() const { return m_enableNotificationHasBeenSet; }
/**
* <p> Enables notifications for the branch. </p>
*/
inline void SetEnableNotification(bool value) { m_enableNotificationHasBeenSet = true; m_enableNotification = value; }
/**
* <p> Enables notifications for the branch. </p>
*/
inline UpdateBranchRequest& WithEnableNotification(bool value) { SetEnableNotification(value); return *this;}
/**
* <p> Enables auto building for the branch. </p>
*/
inline bool GetEnableAutoBuild() const{ return m_enableAutoBuild; }
/**
* <p> Enables auto building for the branch. </p>
*/
inline bool EnableAutoBuildHasBeenSet() const { return m_enableAutoBuildHasBeenSet; }
/**
* <p> Enables auto building for the branch. </p>
*/
inline void SetEnableAutoBuild(bool value) { m_enableAutoBuildHasBeenSet = true; m_enableAutoBuild = value; }
/**
* <p> Enables auto building for the branch. </p>
*/
inline UpdateBranchRequest& WithEnableAutoBuild(bool value) { SetEnableAutoBuild(value); return *this;}
/**
* <p> The environment variables for the branch. </p>
*/
inline const Aws::Map<Aws::String, Aws::String>& GetEnvironmentVariables() const{ return m_environmentVariables; }
/**
* <p> The environment variables for the branch. </p>
*/
inline bool EnvironmentVariablesHasBeenSet() const { return m_environmentVariablesHasBeenSet; }
/**
* <p> The environment variables for the branch. </p>
*/
inline void SetEnvironmentVariables(const Aws::Map<Aws::String, Aws::String>& value) { m_environmentVariablesHasBeenSet = true; m_environmentVariables = value; }
/**
* <p> The environment variables for the branch. </p>
*/
inline void SetEnvironmentVariables(Aws::Map<Aws::String, Aws::String>&& value) { m_environmentVariablesHasBeenSet = true; m_environmentVariables = std::move(value); }
/**
* <p> The environment variables for the branch. </p>
*/
inline UpdateBranchRequest& WithEnvironmentVariables(const Aws::Map<Aws::String, Aws::String>& value) { SetEnvironmentVariables(value); return *this;}
/**
* <p> The environment variables for the branch. </p>
*/
inline UpdateBranchRequest& WithEnvironmentVariables(Aws::Map<Aws::String, Aws::String>&& value) { SetEnvironmentVariables(std::move(value)); return *this;}
/**
* <p> The environment variables for the branch. </p>
*/
inline UpdateBranchRequest& AddEnvironmentVariables(const Aws::String& key, const Aws::String& value) { m_environmentVariablesHasBeenSet = true; m_environmentVariables.emplace(key, value); return *this; }
/**
* <p> The environment variables for the branch. </p>
*/
inline UpdateBranchRequest& AddEnvironmentVariables(Aws::String&& key, const Aws::String& value) { m_environmentVariablesHasBeenSet = true; m_environmentVariables.emplace(std::move(key), value); return *this; }
/**
* <p> The environment variables for the branch. </p>
*/
inline UpdateBranchRequest& AddEnvironmentVariables(const Aws::String& key, Aws::String&& value) { m_environmentVariablesHasBeenSet = true; m_environmentVariables.emplace(key, std::move(value)); return *this; }
/**
* <p> The environment variables for the branch. </p>
*/
inline UpdateBranchRequest& AddEnvironmentVariables(Aws::String&& key, Aws::String&& value) { m_environmentVariablesHasBeenSet = true; m_environmentVariables.emplace(std::move(key), std::move(value)); return *this; }
/**
* <p> The environment variables for the branch. </p>
*/
inline UpdateBranchRequest& AddEnvironmentVariables(const char* key, Aws::String&& value) { m_environmentVariablesHasBeenSet = true; m_environmentVariables.emplace(key, std::move(value)); return *this; }
/**
* <p> The environment variables for the branch. </p>
*/
inline UpdateBranchRequest& AddEnvironmentVariables(Aws::String&& key, const char* value) { m_environmentVariablesHasBeenSet = true; m_environmentVariables.emplace(std::move(key), value); return *this; }
/**
* <p> The environment variables for the branch. </p>
*/
inline UpdateBranchRequest& AddEnvironmentVariables(const char* key, const char* value) { m_environmentVariablesHasBeenSet = true; m_environmentVariables.emplace(key, value); return *this; }
/**
* <p> The basic authorization credentials for the branch. </p>
*/
inline const Aws::String& GetBasicAuthCredentials() const{ return m_basicAuthCredentials; }
/**
* <p> The basic authorization credentials for the branch. </p>
*/
inline bool BasicAuthCredentialsHasBeenSet() const { return m_basicAuthCredentialsHasBeenSet; }
/**
* <p> The basic authorization credentials for the branch. </p>
*/
inline void SetBasicAuthCredentials(const Aws::String& value) { m_basicAuthCredentialsHasBeenSet = true; m_basicAuthCredentials = value; }
/**
* <p> The basic authorization credentials for the branch. </p>
*/
inline void SetBasicAuthCredentials(Aws::String&& value) { m_basicAuthCredentialsHasBeenSet = true; m_basicAuthCredentials = std::move(value); }
/**
* <p> The basic authorization credentials for the branch. </p>
*/
inline void SetBasicAuthCredentials(const char* value) { m_basicAuthCredentialsHasBeenSet = true; m_basicAuthCredentials.assign(value); }
/**
* <p> The basic authorization credentials for the branch. </p>
*/
inline UpdateBranchRequest& WithBasicAuthCredentials(const Aws::String& value) { SetBasicAuthCredentials(value); return *this;}
/**
* <p> The basic authorization credentials for the branch. </p>
*/
inline UpdateBranchRequest& WithBasicAuthCredentials(Aws::String&& value) { SetBasicAuthCredentials(std::move(value)); return *this;}
/**
* <p> The basic authorization credentials for the branch. </p>
*/
inline UpdateBranchRequest& WithBasicAuthCredentials(const char* value) { SetBasicAuthCredentials(value); return *this;}
/**
* <p> Enables basic authorization for the branch. </p>
*/
inline bool GetEnableBasicAuth() const{ return m_enableBasicAuth; }
/**
* <p> Enables basic authorization for the branch. </p>
*/
inline bool EnableBasicAuthHasBeenSet() const { return m_enableBasicAuthHasBeenSet; }
/**
* <p> Enables basic authorization for the branch. </p>
*/
inline void SetEnableBasicAuth(bool value) { m_enableBasicAuthHasBeenSet = true; m_enableBasicAuth = value; }
/**
* <p> Enables basic authorization for the branch. </p>
*/
inline UpdateBranchRequest& WithEnableBasicAuth(bool value) { SetEnableBasicAuth(value); return *this;}
/**
* <p> The build specification (build spec) for the branch. </p>
*/
inline const Aws::String& GetBuildSpec() const{ return m_buildSpec; }
/**
* <p> The build specification (build spec) for the branch. </p>
*/
inline bool BuildSpecHasBeenSet() const { return m_buildSpecHasBeenSet; }
/**
* <p> The build specification (build spec) for the branch. </p>
*/
inline void SetBuildSpec(const Aws::String& value) { m_buildSpecHasBeenSet = true; m_buildSpec = value; }
/**
* <p> The build specification (build spec) for the branch. </p>
*/
inline void SetBuildSpec(Aws::String&& value) { m_buildSpecHasBeenSet = true; m_buildSpec = std::move(value); }
/**
* <p> The build specification (build spec) for the branch. </p>
*/
inline void SetBuildSpec(const char* value) { m_buildSpecHasBeenSet = true; m_buildSpec.assign(value); }
/**
* <p> The build specification (build spec) for the branch. </p>
*/
inline UpdateBranchRequest& WithBuildSpec(const Aws::String& value) { SetBuildSpec(value); return *this;}
/**
* <p> The build specification (build spec) for the branch. </p>
*/
inline UpdateBranchRequest& WithBuildSpec(Aws::String&& value) { SetBuildSpec(std::move(value)); return *this;}
/**
* <p> The build specification (build spec) for the branch. </p>
*/
inline UpdateBranchRequest& WithBuildSpec(const char* value) { SetBuildSpec(value); return *this;}
/**
* <p> The content Time to Live (TTL) for the website in seconds. </p>
*/
inline const Aws::String& GetTtl() const{ return m_ttl; }
/**
* <p> The content Time to Live (TTL) for the website in seconds. </p>
*/
inline bool TtlHasBeenSet() const { return m_ttlHasBeenSet; }
/**
* <p> The content Time to Live (TTL) for the website in seconds. </p>
*/
inline void SetTtl(const Aws::String& value) { m_ttlHasBeenSet = true; m_ttl = value; }
/**
* <p> The content Time to Live (TTL) for the website in seconds. </p>
*/
inline void SetTtl(Aws::String&& value) { m_ttlHasBeenSet = true; m_ttl = std::move(value); }
/**
* <p> The content Time to Live (TTL) for the website in seconds. </p>
*/
inline void SetTtl(const char* value) { m_ttlHasBeenSet = true; m_ttl.assign(value); }
/**
* <p> The content Time to Live (TTL) for the website in seconds. </p>
*/
inline UpdateBranchRequest& WithTtl(const Aws::String& value) { SetTtl(value); return *this;}
/**
* <p> The content Time to Live (TTL) for the website in seconds. </p>
*/
inline UpdateBranchRequest& WithTtl(Aws::String&& value) { SetTtl(std::move(value)); return *this;}
/**
* <p> The content Time to Live (TTL) for the website in seconds. </p>
*/
inline UpdateBranchRequest& WithTtl(const char* value) { SetTtl(value); return *this;}
/**
* <p> The display name for a branch. This is used as the default domain prefix.
* </p>
*/
inline const Aws::String& GetDisplayName() const{ return m_displayName; }
/**
* <p> The display name for a branch. This is used as the default domain prefix.
* </p>
*/
inline bool DisplayNameHasBeenSet() const { return m_displayNameHasBeenSet; }
/**
* <p> The display name for a branch. This is used as the default domain prefix.
* </p>
*/
inline void SetDisplayName(const Aws::String& value) { m_displayNameHasBeenSet = true; m_displayName = value; }
/**
* <p> The display name for a branch. This is used as the default domain prefix.
* </p>
*/
inline void SetDisplayName(Aws::String&& value) { m_displayNameHasBeenSet = true; m_displayName = std::move(value); }
/**
* <p> The display name for a branch. This is used as the default domain prefix.
* </p>
*/
inline void SetDisplayName(const char* value) { m_displayNameHasBeenSet = true; m_displayName.assign(value); }
/**
* <p> The display name for a branch. This is used as the default domain prefix.
* </p>
*/
inline UpdateBranchRequest& WithDisplayName(const Aws::String& value) { SetDisplayName(value); return *this;}
/**
* <p> The display name for a branch. This is used as the default domain prefix.
* </p>
*/
inline UpdateBranchRequest& WithDisplayName(Aws::String&& value) { SetDisplayName(std::move(value)); return *this;}
/**
* <p> The display name for a branch. This is used as the default domain prefix.
* </p>
*/
inline UpdateBranchRequest& WithDisplayName(const char* value) { SetDisplayName(value); return *this;}
/**
* <p> Enables pull request preview for this branch. </p>
*/
inline bool GetEnablePullRequestPreview() const{ return m_enablePullRequestPreview; }
/**
* <p> Enables pull request preview for this branch. </p>
*/
inline bool EnablePullRequestPreviewHasBeenSet() const { return m_enablePullRequestPreviewHasBeenSet; }
/**
* <p> Enables pull request preview for this branch. </p>
*/
inline void SetEnablePullRequestPreview(bool value) { m_enablePullRequestPreviewHasBeenSet = true; m_enablePullRequestPreview = value; }
/**
* <p> Enables pull request preview for this branch. </p>
*/
inline UpdateBranchRequest& WithEnablePullRequestPreview(bool value) { SetEnablePullRequestPreview(value); return *this;}
/**
* <p> The Amplify environment name for the pull request. </p>
*/
inline const Aws::String& GetPullRequestEnvironmentName() const{ return m_pullRequestEnvironmentName; }
/**
* <p> The Amplify environment name for the pull request. </p>
*/
inline bool PullRequestEnvironmentNameHasBeenSet() const { return m_pullRequestEnvironmentNameHasBeenSet; }
/**
* <p> The Amplify environment name for the pull request. </p>
*/
inline void SetPullRequestEnvironmentName(const Aws::String& value) { m_pullRequestEnvironmentNameHasBeenSet = true; m_pullRequestEnvironmentName = value; }
/**
* <p> The Amplify environment name for the pull request. </p>
*/
inline void SetPullRequestEnvironmentName(Aws::String&& value) { m_pullRequestEnvironmentNameHasBeenSet = true; m_pullRequestEnvironmentName = std::move(value); }
/**
* <p> The Amplify environment name for the pull request. </p>
*/
inline void SetPullRequestEnvironmentName(const char* value) { m_pullRequestEnvironmentNameHasBeenSet = true; m_pullRequestEnvironmentName.assign(value); }
/**
* <p> The Amplify environment name for the pull request. </p>
*/
inline UpdateBranchRequest& WithPullRequestEnvironmentName(const Aws::String& value) { SetPullRequestEnvironmentName(value); return *this;}
/**
* <p> The Amplify environment name for the pull request. </p>
*/
inline UpdateBranchRequest& WithPullRequestEnvironmentName(Aws::String&& value) { SetPullRequestEnvironmentName(std::move(value)); return *this;}
/**
* <p> The Amplify environment name for the pull request. </p>
*/
inline UpdateBranchRequest& WithPullRequestEnvironmentName(const char* value) { SetPullRequestEnvironmentName(value); return *this;}
/**
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an
* Amplify app. </p>
*/
inline const Aws::String& GetBackendEnvironmentArn() const{ return m_backendEnvironmentArn; }
/**
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an
* Amplify app. </p>
*/
inline bool BackendEnvironmentArnHasBeenSet() const { return m_backendEnvironmentArnHasBeenSet; }
/**
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an
* Amplify app. </p>
*/
inline void SetBackendEnvironmentArn(const Aws::String& value) { m_backendEnvironmentArnHasBeenSet = true; m_backendEnvironmentArn = value; }
/**
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an
* Amplify app. </p>
*/
inline void SetBackendEnvironmentArn(Aws::String&& value) { m_backendEnvironmentArnHasBeenSet = true; m_backendEnvironmentArn = std::move(value); }
/**
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an
* Amplify app. </p>
*/
inline void SetBackendEnvironmentArn(const char* value) { m_backendEnvironmentArnHasBeenSet = true; m_backendEnvironmentArn.assign(value); }
/**
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an
* Amplify app. </p>
*/
inline UpdateBranchRequest& WithBackendEnvironmentArn(const Aws::String& value) { SetBackendEnvironmentArn(value); return *this;}
/**
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an
* Amplify app. </p>
*/
inline UpdateBranchRequest& WithBackendEnvironmentArn(Aws::String&& value) { SetBackendEnvironmentArn(std::move(value)); return *this;}
/**
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an
* Amplify app. </p>
*/
inline UpdateBranchRequest& WithBackendEnvironmentArn(const char* value) { SetBackendEnvironmentArn(value); return *this;}
private:
Aws::String m_appId;
bool m_appIdHasBeenSet;
Aws::String m_branchName;
bool m_branchNameHasBeenSet;
Aws::String m_description;
bool m_descriptionHasBeenSet;
Aws::String m_framework;
bool m_frameworkHasBeenSet;
Stage m_stage;
bool m_stageHasBeenSet;
bool m_enableNotification;
bool m_enableNotificationHasBeenSet;
bool m_enableAutoBuild;
bool m_enableAutoBuildHasBeenSet;
Aws::Map<Aws::String, Aws::String> m_environmentVariables;
bool m_environmentVariablesHasBeenSet;
Aws::String m_basicAuthCredentials;
bool m_basicAuthCredentialsHasBeenSet;
bool m_enableBasicAuth;
bool m_enableBasicAuthHasBeenSet;
Aws::String m_buildSpec;
bool m_buildSpecHasBeenSet;
Aws::String m_ttl;
bool m_ttlHasBeenSet;
Aws::String m_displayName;
bool m_displayNameHasBeenSet;
bool m_enablePullRequestPreview;
bool m_enablePullRequestPreviewHasBeenSet;
Aws::String m_pullRequestEnvironmentName;
bool m_pullRequestEnvironmentNameHasBeenSet;
Aws::String m_backendEnvironmentArn;
bool m_backendEnvironmentArnHasBeenSet;
};
} // namespace Model
} // namespace Amplify
} // namespace Aws