com.amazonaws.services.kendra.model.ConfluencePageConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kendra.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Configuration of the page settings for the Confluence data source.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ConfluencePageConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields,
* use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The
* Confluence data source field names must exist in your Confluence custom metadata.
*
*
* If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
*
*/
private java.util.List pageFieldMappings;
/**
*
* Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields,
* use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The
* Confluence data source field names must exist in your Confluence custom metadata.
*
*
* If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
*
*
* @return Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Confluence fields. For more information,
* see Mapping data source
* fields. The Confluence data source field names must exist in your Confluence custom metadata.
*
* If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
*/
public java.util.List getPageFieldMappings() {
return pageFieldMappings;
}
/**
*
* Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields,
* use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The
* Confluence data source field names must exist in your Confluence custom metadata.
*
*
* If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
*
*
* @param pageFieldMappings
* Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Confluence fields. For more information,
* see Mapping data source
* fields. The Confluence data source field names must exist in your Confluence custom metadata.
*
* If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
*/
public void setPageFieldMappings(java.util.Collection pageFieldMappings) {
if (pageFieldMappings == null) {
this.pageFieldMappings = null;
return;
}
this.pageFieldMappings = new java.util.ArrayList(pageFieldMappings);
}
/**
*
* Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields,
* use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The
* Confluence data source field names must exist in your Confluence custom metadata.
*
*
* If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPageFieldMappings(java.util.Collection)} or {@link #withPageFieldMappings(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param pageFieldMappings
* Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Confluence fields. For more information,
* see Mapping data source
* fields. The Confluence data source field names must exist in your Confluence custom metadata.
*
* If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfluencePageConfiguration withPageFieldMappings(ConfluencePageToIndexFieldMapping... pageFieldMappings) {
if (this.pageFieldMappings == null) {
setPageFieldMappings(new java.util.ArrayList(pageFieldMappings.length));
}
for (ConfluencePageToIndexFieldMapping ele : pageFieldMappings) {
this.pageFieldMappings.add(ele);
}
return this;
}
/**
*
* Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields,
* use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The
* Confluence data source field names must exist in your Confluence custom metadata.
*
*
* If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
*
*
* @param pageFieldMappings
* Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Confluence fields. For more information,
* see Mapping data source
* fields. The Confluence data source field names must exist in your Confluence custom metadata.
*
* If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfluencePageConfiguration withPageFieldMappings(java.util.Collection pageFieldMappings) {
setPageFieldMappings(pageFieldMappings);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPageFieldMappings() != null)
sb.append("PageFieldMappings: ").append(getPageFieldMappings());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ConfluencePageConfiguration == false)
return false;
ConfluencePageConfiguration other = (ConfluencePageConfiguration) obj;
if (other.getPageFieldMappings() == null ^ this.getPageFieldMappings() == null)
return false;
if (other.getPageFieldMappings() != null && other.getPageFieldMappings().equals(this.getPageFieldMappings()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPageFieldMappings() == null) ? 0 : getPageFieldMappings().hashCode());
return hashCode;
}
@Override
public ConfluencePageConfiguration clone() {
try {
return (ConfluencePageConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kendra.model.transform.ConfluencePageConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}