AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::ConfluencePageToIndexFieldMapping Class Reference

#include <ConfluencePageToIndexFieldMapping.h>

Public Member Functions

 ConfluencePageToIndexFieldMapping ()
 
 ConfluencePageToIndexFieldMapping (Aws::Utils::Json::JsonView jsonValue)
 
ConfluencePageToIndexFieldMappingoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ConfluencePageFieldNameGetDataSourceFieldName () const
 
bool DataSourceFieldNameHasBeenSet () const
 
void SetDataSourceFieldName (const ConfluencePageFieldName &value)
 
void SetDataSourceFieldName (ConfluencePageFieldName &&value)
 
ConfluencePageToIndexFieldMappingWithDataSourceFieldName (const ConfluencePageFieldName &value)
 
ConfluencePageToIndexFieldMappingWithDataSourceFieldName (ConfluencePageFieldName &&value)
 
const Aws::StringGetDateFieldFormat () const
 
bool DateFieldFormatHasBeenSet () const
 
void SetDateFieldFormat (const Aws::String &value)
 
void SetDateFieldFormat (Aws::String &&value)
 
void SetDateFieldFormat (const char *value)
 
ConfluencePageToIndexFieldMappingWithDateFieldFormat (const Aws::String &value)
 
ConfluencePageToIndexFieldMappingWithDateFieldFormat (Aws::String &&value)
 
ConfluencePageToIndexFieldMappingWithDateFieldFormat (const char *value)
 
const Aws::StringGetIndexFieldName () const
 
bool IndexFieldNameHasBeenSet () const
 
void SetIndexFieldName (const Aws::String &value)
 
void SetIndexFieldName (Aws::String &&value)
 
void SetIndexFieldName (const char *value)
 
ConfluencePageToIndexFieldMappingWithIndexFieldName (const Aws::String &value)
 
ConfluencePageToIndexFieldMappingWithIndexFieldName (Aws::String &&value)
 
ConfluencePageToIndexFieldMappingWithIndexFieldName (const char *value)
 

Detailed Description

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex operation.

See Also:

AWS API Reference

Definition at line 34 of file ConfluencePageToIndexFieldMapping.h.

Constructor & Destructor Documentation

◆ ConfluencePageToIndexFieldMapping() [1/2]

Aws::kendra::Model::ConfluencePageToIndexFieldMapping::ConfluencePageToIndexFieldMapping ( )

◆ ConfluencePageToIndexFieldMapping() [2/2]

Aws::kendra::Model::ConfluencePageToIndexFieldMapping::ConfluencePageToIndexFieldMapping ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DataSourceFieldNameHasBeenSet()

bool Aws::kendra::Model::ConfluencePageToIndexFieldMapping::DataSourceFieldNameHasBeenSet ( ) const
inline

The name of the field in the data source.

Definition at line 51 of file ConfluencePageToIndexFieldMapping.h.

◆ DateFieldFormatHasBeenSet()

bool Aws::kendra::Model::ConfluencePageToIndexFieldMapping::DateFieldFormatHasBeenSet ( ) const
inline

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Definition at line 86 of file ConfluencePageToIndexFieldMapping.h.

◆ GetDataSourceFieldName()

const ConfluencePageFieldName& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::GetDataSourceFieldName ( ) const
inline

The name of the field in the data source.

Definition at line 46 of file ConfluencePageToIndexFieldMapping.h.

◆ GetDateFieldFormat()

const Aws::String& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::GetDateFieldFormat ( ) const
inline

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Definition at line 79 of file ConfluencePageToIndexFieldMapping.h.

◆ GetIndexFieldName()

const Aws::String& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::GetIndexFieldName ( ) const
inline

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Definition at line 135 of file ConfluencePageToIndexFieldMapping.h.

◆ IndexFieldNameHasBeenSet()

bool Aws::kendra::Model::ConfluencePageToIndexFieldMapping::IndexFieldNameHasBeenSet ( ) const
inline

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Definition at line 141 of file ConfluencePageToIndexFieldMapping.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::ConfluencePageToIndexFieldMapping::Jsonize ( ) const

◆ operator=()

ConfluencePageToIndexFieldMapping& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetDataSourceFieldName() [1/2]

void Aws::kendra::Model::ConfluencePageToIndexFieldMapping::SetDataSourceFieldName ( ConfluencePageFieldName &&  value)
inline

The name of the field in the data source.

Definition at line 61 of file ConfluencePageToIndexFieldMapping.h.

◆ SetDataSourceFieldName() [2/2]

void Aws::kendra::Model::ConfluencePageToIndexFieldMapping::SetDataSourceFieldName ( const ConfluencePageFieldName value)
inline

The name of the field in the data source.

Definition at line 56 of file ConfluencePageToIndexFieldMapping.h.

◆ SetDateFieldFormat() [1/3]

void Aws::kendra::Model::ConfluencePageToIndexFieldMapping::SetDateFieldFormat ( Aws::String &&  value)
inline

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Definition at line 100 of file ConfluencePageToIndexFieldMapping.h.

◆ SetDateFieldFormat() [2/3]

void Aws::kendra::Model::ConfluencePageToIndexFieldMapping::SetDateFieldFormat ( const Aws::String value)
inline

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Definition at line 93 of file ConfluencePageToIndexFieldMapping.h.

◆ SetDateFieldFormat() [3/3]

void Aws::kendra::Model::ConfluencePageToIndexFieldMapping::SetDateFieldFormat ( const char *  value)
inline

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Definition at line 107 of file ConfluencePageToIndexFieldMapping.h.

◆ SetIndexFieldName() [1/3]

void Aws::kendra::Model::ConfluencePageToIndexFieldMapping::SetIndexFieldName ( Aws::String &&  value)
inline

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Definition at line 153 of file ConfluencePageToIndexFieldMapping.h.

◆ SetIndexFieldName() [2/3]

void Aws::kendra::Model::ConfluencePageToIndexFieldMapping::SetIndexFieldName ( const Aws::String value)
inline

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Definition at line 147 of file ConfluencePageToIndexFieldMapping.h.

◆ SetIndexFieldName() [3/3]

void Aws::kendra::Model::ConfluencePageToIndexFieldMapping::SetIndexFieldName ( const char *  value)
inline

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Definition at line 159 of file ConfluencePageToIndexFieldMapping.h.

◆ WithDataSourceFieldName() [1/2]

ConfluencePageToIndexFieldMapping& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::WithDataSourceFieldName ( ConfluencePageFieldName &&  value)
inline

The name of the field in the data source.

Definition at line 71 of file ConfluencePageToIndexFieldMapping.h.

◆ WithDataSourceFieldName() [2/2]

ConfluencePageToIndexFieldMapping& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::WithDataSourceFieldName ( const ConfluencePageFieldName value)
inline

The name of the field in the data source.

Definition at line 66 of file ConfluencePageToIndexFieldMapping.h.

◆ WithDateFieldFormat() [1/3]

ConfluencePageToIndexFieldMapping& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::WithDateFieldFormat ( Aws::String &&  value)
inline

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Definition at line 121 of file ConfluencePageToIndexFieldMapping.h.

◆ WithDateFieldFormat() [2/3]

ConfluencePageToIndexFieldMapping& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::WithDateFieldFormat ( const Aws::String value)
inline

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Definition at line 114 of file ConfluencePageToIndexFieldMapping.h.

◆ WithDateFieldFormat() [3/3]

ConfluencePageToIndexFieldMapping& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::WithDateFieldFormat ( const char *  value)
inline

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Definition at line 128 of file ConfluencePageToIndexFieldMapping.h.

◆ WithIndexFieldName() [1/3]

ConfluencePageToIndexFieldMapping& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::WithIndexFieldName ( Aws::String &&  value)
inline

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Definition at line 171 of file ConfluencePageToIndexFieldMapping.h.

◆ WithIndexFieldName() [2/3]

ConfluencePageToIndexFieldMapping& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::WithIndexFieldName ( const Aws::String value)
inline

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Definition at line 165 of file ConfluencePageToIndexFieldMapping.h.

◆ WithIndexFieldName() [3/3]

ConfluencePageToIndexFieldMapping& Aws::kendra::Model::ConfluencePageToIndexFieldMapping::WithIndexFieldName ( const char *  value)
inline

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Definition at line 177 of file ConfluencePageToIndexFieldMapping.h.


The documentation for this class was generated from the following file: