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-kendra/include/aws/kendra/model/Principal.h

160 lines
4.2 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/kendra/Kendra_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/kendra/model/PrincipalType.h>
#include <aws/kendra/model/ReadAccessType.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace kendra
{
namespace Model
{
/**
* <p>Provides user and group information for document access
* filtering.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Principal">AWS
* API Reference</a></p>
*/
class AWS_KENDRA_API Principal
{
public:
Principal();
Principal(Aws::Utils::Json::JsonView jsonValue);
Principal& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The name of the user or group.</p>
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* <p>The name of the user or group.</p>
*/
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
/**
* <p>The name of the user or group.</p>
*/
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
/**
* <p>The name of the user or group.</p>
*/
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
/**
* <p>The name of the user or group.</p>
*/
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
/**
* <p>The name of the user or group.</p>
*/
inline Principal& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* <p>The name of the user or group.</p>
*/
inline Principal& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* <p>The name of the user or group.</p>
*/
inline Principal& WithName(const char* value) { SetName(value); return *this;}
/**
* <p>The type of principal.</p>
*/
inline const PrincipalType& GetType() const{ return m_type; }
/**
* <p>The type of principal.</p>
*/
inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }
/**
* <p>The type of principal.</p>
*/
inline void SetType(const PrincipalType& value) { m_typeHasBeenSet = true; m_type = value; }
/**
* <p>The type of principal.</p>
*/
inline void SetType(PrincipalType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); }
/**
* <p>The type of principal.</p>
*/
inline Principal& WithType(const PrincipalType& value) { SetType(value); return *this;}
/**
* <p>The type of principal.</p>
*/
inline Principal& WithType(PrincipalType&& value) { SetType(std::move(value)); return *this;}
/**
* <p>Whether to allow or deny access to the principal.</p>
*/
inline const ReadAccessType& GetAccess() const{ return m_access; }
/**
* <p>Whether to allow or deny access to the principal.</p>
*/
inline bool AccessHasBeenSet() const { return m_accessHasBeenSet; }
/**
* <p>Whether to allow or deny access to the principal.</p>
*/
inline void SetAccess(const ReadAccessType& value) { m_accessHasBeenSet = true; m_access = value; }
/**
* <p>Whether to allow or deny access to the principal.</p>
*/
inline void SetAccess(ReadAccessType&& value) { m_accessHasBeenSet = true; m_access = std::move(value); }
/**
* <p>Whether to allow or deny access to the principal.</p>
*/
inline Principal& WithAccess(const ReadAccessType& value) { SetAccess(value); return *this;}
/**
* <p>Whether to allow or deny access to the principal.</p>
*/
inline Principal& WithAccess(ReadAccessType&& value) { SetAccess(std::move(value)); return *this;}
private:
Aws::String m_name;
bool m_nameHasBeenSet;
PrincipalType m_type;
bool m_typeHasBeenSet;
ReadAccessType m_access;
bool m_accessHasBeenSet;
};
} // namespace Model
} // namespace kendra
} // namespace Aws