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

416 lines
20 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/OneDriveUsers.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/kendra/model/DataSourceToIndexFieldMapping.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace kendra
{
namespace Model
{
/**
* <p>Provides configuration information for data sources that connect to
* OneDrive.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OneDriveConfiguration">AWS
* API Reference</a></p>
*/
class AWS_KENDRA_API OneDriveConfiguration
{
public:
OneDriveConfiguration();
OneDriveConfiguration(Aws::Utils::Json::JsonView jsonValue);
OneDriveConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>Tha Azure Active Directory domain of the organization. </p>
*/
inline const Aws::String& GetTenantDomain() const{ return m_tenantDomain; }
/**
* <p>Tha Azure Active Directory domain of the organization. </p>
*/
inline bool TenantDomainHasBeenSet() const { return m_tenantDomainHasBeenSet; }
/**
* <p>Tha Azure Active Directory domain of the organization. </p>
*/
inline void SetTenantDomain(const Aws::String& value) { m_tenantDomainHasBeenSet = true; m_tenantDomain = value; }
/**
* <p>Tha Azure Active Directory domain of the organization. </p>
*/
inline void SetTenantDomain(Aws::String&& value) { m_tenantDomainHasBeenSet = true; m_tenantDomain = std::move(value); }
/**
* <p>Tha Azure Active Directory domain of the organization. </p>
*/
inline void SetTenantDomain(const char* value) { m_tenantDomainHasBeenSet = true; m_tenantDomain.assign(value); }
/**
* <p>Tha Azure Active Directory domain of the organization. </p>
*/
inline OneDriveConfiguration& WithTenantDomain(const Aws::String& value) { SetTenantDomain(value); return *this;}
/**
* <p>Tha Azure Active Directory domain of the organization. </p>
*/
inline OneDriveConfiguration& WithTenantDomain(Aws::String&& value) { SetTenantDomain(std::move(value)); return *this;}
/**
* <p>Tha Azure Active Directory domain of the organization. </p>
*/
inline OneDriveConfiguration& WithTenantDomain(const char* value) { SetTenantDomain(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
* the user name and password to connect to OneDrive. The user namd should be the
* application ID for the OneDrive application, and the password is the application
* key for the OneDrive application.</p>
*/
inline const Aws::String& GetSecretArn() const{ return m_secretArn; }
/**
* <p>The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
* the user name and password to connect to OneDrive. The user namd should be the
* application ID for the OneDrive application, and the password is the application
* key for the OneDrive application.</p>
*/
inline bool SecretArnHasBeenSet() const { return m_secretArnHasBeenSet; }
/**
* <p>The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
* the user name and password to connect to OneDrive. The user namd should be the
* application ID for the OneDrive application, and the password is the application
* key for the OneDrive application.</p>
*/
inline void SetSecretArn(const Aws::String& value) { m_secretArnHasBeenSet = true; m_secretArn = value; }
/**
* <p>The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
* the user name and password to connect to OneDrive. The user namd should be the
* application ID for the OneDrive application, and the password is the application
* key for the OneDrive application.</p>
*/
inline void SetSecretArn(Aws::String&& value) { m_secretArnHasBeenSet = true; m_secretArn = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
* the user name and password to connect to OneDrive. The user namd should be the
* application ID for the OneDrive application, and the password is the application
* key for the OneDrive application.</p>
*/
inline void SetSecretArn(const char* value) { m_secretArnHasBeenSet = true; m_secretArn.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
* the user name and password to connect to OneDrive. The user namd should be the
* application ID for the OneDrive application, and the password is the application
* key for the OneDrive application.</p>
*/
inline OneDriveConfiguration& WithSecretArn(const Aws::String& value) { SetSecretArn(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
* the user name and password to connect to OneDrive. The user namd should be the
* application ID for the OneDrive application, and the password is the application
* key for the OneDrive application.</p>
*/
inline OneDriveConfiguration& WithSecretArn(Aws::String&& value) { SetSecretArn(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
* the user name and password to connect to OneDrive. The user namd should be the
* application ID for the OneDrive application, and the password is the application
* key for the OneDrive application.</p>
*/
inline OneDriveConfiguration& WithSecretArn(const char* value) { SetSecretArn(value); return *this;}
/**
* <p>A list of user accounts whose documents should be indexed.</p>
*/
inline const OneDriveUsers& GetOneDriveUsers() const{ return m_oneDriveUsers; }
/**
* <p>A list of user accounts whose documents should be indexed.</p>
*/
inline bool OneDriveUsersHasBeenSet() const { return m_oneDriveUsersHasBeenSet; }
/**
* <p>A list of user accounts whose documents should be indexed.</p>
*/
inline void SetOneDriveUsers(const OneDriveUsers& value) { m_oneDriveUsersHasBeenSet = true; m_oneDriveUsers = value; }
/**
* <p>A list of user accounts whose documents should be indexed.</p>
*/
inline void SetOneDriveUsers(OneDriveUsers&& value) { m_oneDriveUsersHasBeenSet = true; m_oneDriveUsers = std::move(value); }
/**
* <p>A list of user accounts whose documents should be indexed.</p>
*/
inline OneDriveConfiguration& WithOneDriveUsers(const OneDriveUsers& value) { SetOneDriveUsers(value); return *this;}
/**
* <p>A list of user accounts whose documents should be indexed.</p>
*/
inline OneDriveConfiguration& WithOneDriveUsers(OneDriveUsers&& value) { SetOneDriveUsers(std::move(value)); return *this;}
/**
* <p>A list of regular expression patterns. Documents that match the pattern are
* included in the index. Documents that don't match the pattern are excluded from
* the index. If a document matches both an inclusion pattern and an exclusion
* pattern, the document is not included in the index. </p> <p>The exclusion
* pattern is applied to the file name.</p>
*/
inline const Aws::Vector<Aws::String>& GetInclusionPatterns() const{ return m_inclusionPatterns; }
/**
* <p>A list of regular expression patterns. Documents that match the pattern are
* included in the index. Documents that don't match the pattern are excluded from
* the index. If a document matches both an inclusion pattern and an exclusion
* pattern, the document is not included in the index. </p> <p>The exclusion
* pattern is applied to the file name.</p>
*/
inline bool InclusionPatternsHasBeenSet() const { return m_inclusionPatternsHasBeenSet; }
/**
* <p>A list of regular expression patterns. Documents that match the pattern are
* included in the index. Documents that don't match the pattern are excluded from
* the index. If a document matches both an inclusion pattern and an exclusion
* pattern, the document is not included in the index. </p> <p>The exclusion
* pattern is applied to the file name.</p>
*/
inline void SetInclusionPatterns(const Aws::Vector<Aws::String>& value) { m_inclusionPatternsHasBeenSet = true; m_inclusionPatterns = value; }
/**
* <p>A list of regular expression patterns. Documents that match the pattern are
* included in the index. Documents that don't match the pattern are excluded from
* the index. If a document matches both an inclusion pattern and an exclusion
* pattern, the document is not included in the index. </p> <p>The exclusion
* pattern is applied to the file name.</p>
*/
inline void SetInclusionPatterns(Aws::Vector<Aws::String>&& value) { m_inclusionPatternsHasBeenSet = true; m_inclusionPatterns = std::move(value); }
/**
* <p>A list of regular expression patterns. Documents that match the pattern are
* included in the index. Documents that don't match the pattern are excluded from
* the index. If a document matches both an inclusion pattern and an exclusion
* pattern, the document is not included in the index. </p> <p>The exclusion
* pattern is applied to the file name.</p>
*/
inline OneDriveConfiguration& WithInclusionPatterns(const Aws::Vector<Aws::String>& value) { SetInclusionPatterns(value); return *this;}
/**
* <p>A list of regular expression patterns. Documents that match the pattern are
* included in the index. Documents that don't match the pattern are excluded from
* the index. If a document matches both an inclusion pattern and an exclusion
* pattern, the document is not included in the index. </p> <p>The exclusion
* pattern is applied to the file name.</p>
*/
inline OneDriveConfiguration& WithInclusionPatterns(Aws::Vector<Aws::String>&& value) { SetInclusionPatterns(std::move(value)); return *this;}
/**
* <p>A list of regular expression patterns. Documents that match the pattern are
* included in the index. Documents that don't match the pattern are excluded from
* the index. If a document matches both an inclusion pattern and an exclusion
* pattern, the document is not included in the index. </p> <p>The exclusion
* pattern is applied to the file name.</p>
*/
inline OneDriveConfiguration& AddInclusionPatterns(const Aws::String& value) { m_inclusionPatternsHasBeenSet = true; m_inclusionPatterns.push_back(value); return *this; }
/**
* <p>A list of regular expression patterns. Documents that match the pattern are
* included in the index. Documents that don't match the pattern are excluded from
* the index. If a document matches both an inclusion pattern and an exclusion
* pattern, the document is not included in the index. </p> <p>The exclusion
* pattern is applied to the file name.</p>
*/
inline OneDriveConfiguration& AddInclusionPatterns(Aws::String&& value) { m_inclusionPatternsHasBeenSet = true; m_inclusionPatterns.push_back(std::move(value)); return *this; }
/**
* <p>A list of regular expression patterns. Documents that match the pattern are
* included in the index. Documents that don't match the pattern are excluded from
* the index. If a document matches both an inclusion pattern and an exclusion
* pattern, the document is not included in the index. </p> <p>The exclusion
* pattern is applied to the file name.</p>
*/
inline OneDriveConfiguration& AddInclusionPatterns(const char* value) { m_inclusionPatternsHasBeenSet = true; m_inclusionPatterns.push_back(value); return *this; }
/**
* <p>List of regular expressions applied to documents. Items that match the
* exclusion pattern are not indexed. If you provide both an inclusion pattern and
* an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
* </p> <p>The exclusion pattern is applied to the file name.</p>
*/
inline const Aws::Vector<Aws::String>& GetExclusionPatterns() const{ return m_exclusionPatterns; }
/**
* <p>List of regular expressions applied to documents. Items that match the
* exclusion pattern are not indexed. If you provide both an inclusion pattern and
* an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
* </p> <p>The exclusion pattern is applied to the file name.</p>
*/
inline bool ExclusionPatternsHasBeenSet() const { return m_exclusionPatternsHasBeenSet; }
/**
* <p>List of regular expressions applied to documents. Items that match the
* exclusion pattern are not indexed. If you provide both an inclusion pattern and
* an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
* </p> <p>The exclusion pattern is applied to the file name.</p>
*/
inline void SetExclusionPatterns(const Aws::Vector<Aws::String>& value) { m_exclusionPatternsHasBeenSet = true; m_exclusionPatterns = value; }
/**
* <p>List of regular expressions applied to documents. Items that match the
* exclusion pattern are not indexed. If you provide both an inclusion pattern and
* an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
* </p> <p>The exclusion pattern is applied to the file name.</p>
*/
inline void SetExclusionPatterns(Aws::Vector<Aws::String>&& value) { m_exclusionPatternsHasBeenSet = true; m_exclusionPatterns = std::move(value); }
/**
* <p>List of regular expressions applied to documents. Items that match the
* exclusion pattern are not indexed. If you provide both an inclusion pattern and
* an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
* </p> <p>The exclusion pattern is applied to the file name.</p>
*/
inline OneDriveConfiguration& WithExclusionPatterns(const Aws::Vector<Aws::String>& value) { SetExclusionPatterns(value); return *this;}
/**
* <p>List of regular expressions applied to documents. Items that match the
* exclusion pattern are not indexed. If you provide both an inclusion pattern and
* an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
* </p> <p>The exclusion pattern is applied to the file name.</p>
*/
inline OneDriveConfiguration& WithExclusionPatterns(Aws::Vector<Aws::String>&& value) { SetExclusionPatterns(std::move(value)); return *this;}
/**
* <p>List of regular expressions applied to documents. Items that match the
* exclusion pattern are not indexed. If you provide both an inclusion pattern and
* an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
* </p> <p>The exclusion pattern is applied to the file name.</p>
*/
inline OneDriveConfiguration& AddExclusionPatterns(const Aws::String& value) { m_exclusionPatternsHasBeenSet = true; m_exclusionPatterns.push_back(value); return *this; }
/**
* <p>List of regular expressions applied to documents. Items that match the
* exclusion pattern are not indexed. If you provide both an inclusion pattern and
* an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
* </p> <p>The exclusion pattern is applied to the file name.</p>
*/
inline OneDriveConfiguration& AddExclusionPatterns(Aws::String&& value) { m_exclusionPatternsHasBeenSet = true; m_exclusionPatterns.push_back(std::move(value)); return *this; }
/**
* <p>List of regular expressions applied to documents. Items that match the
* exclusion pattern are not indexed. If you provide both an inclusion pattern and
* an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
* </p> <p>The exclusion pattern is applied to the file name.</p>
*/
inline OneDriveConfiguration& AddExclusionPatterns(const char* value) { m_exclusionPatternsHasBeenSet = true; m_exclusionPatterns.push_back(value); return *this; }
/**
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
* Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must
* first create the index fields before you map OneDrive fields.</p>
*/
inline const Aws::Vector<DataSourceToIndexFieldMapping>& GetFieldMappings() const{ return m_fieldMappings; }
/**
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
* Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must
* first create the index fields before you map OneDrive fields.</p>
*/
inline bool FieldMappingsHasBeenSet() const { return m_fieldMappingsHasBeenSet; }
/**
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
* Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must
* first create the index fields before you map OneDrive fields.</p>
*/
inline void SetFieldMappings(const Aws::Vector<DataSourceToIndexFieldMapping>& value) { m_fieldMappingsHasBeenSet = true; m_fieldMappings = value; }
/**
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
* Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must
* first create the index fields before you map OneDrive fields.</p>
*/
inline void SetFieldMappings(Aws::Vector<DataSourceToIndexFieldMapping>&& value) { m_fieldMappingsHasBeenSet = true; m_fieldMappings = std::move(value); }
/**
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
* Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must
* first create the index fields before you map OneDrive fields.</p>
*/
inline OneDriveConfiguration& WithFieldMappings(const Aws::Vector<DataSourceToIndexFieldMapping>& value) { SetFieldMappings(value); return *this;}
/**
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
* Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must
* first create the index fields before you map OneDrive fields.</p>
*/
inline OneDriveConfiguration& WithFieldMappings(Aws::Vector<DataSourceToIndexFieldMapping>&& value) { SetFieldMappings(std::move(value)); return *this;}
/**
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
* Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must
* first create the index fields before you map OneDrive fields.</p>
*/
inline OneDriveConfiguration& AddFieldMappings(const DataSourceToIndexFieldMapping& value) { m_fieldMappingsHasBeenSet = true; m_fieldMappings.push_back(value); return *this; }
/**
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
* Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must
* first create the index fields before you map OneDrive fields.</p>
*/
inline OneDriveConfiguration& AddFieldMappings(DataSourceToIndexFieldMapping&& value) { m_fieldMappingsHasBeenSet = true; m_fieldMappings.push_back(std::move(value)); return *this; }
private:
Aws::String m_tenantDomain;
bool m_tenantDomainHasBeenSet;
Aws::String m_secretArn;
bool m_secretArnHasBeenSet;
OneDriveUsers m_oneDriveUsers;
bool m_oneDriveUsersHasBeenSet;
Aws::Vector<Aws::String> m_inclusionPatterns;
bool m_inclusionPatternsHasBeenSet;
Aws::Vector<Aws::String> m_exclusionPatterns;
bool m_exclusionPatternsHasBeenSet;
Aws::Vector<DataSourceToIndexFieldMapping> m_fieldMappings;
bool m_fieldMappingsHasBeenSet;
};
} // namespace Model
} // namespace kendra
} // namespace Aws