com.amazonaws.services.qconnect.model.AppIntegrationsConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-qconnect 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.qconnect.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Configuration information for Amazon AppIntegrations to automatically ingest content.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AppIntegrationsConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
*
*
* -
*
* For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least Id, ArticleNumber, VersionNumber,
* Title, PublishStatus, and IsDeleted as source fields.
*
*
* -
*
* For
* ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least number, short_description, sys_mod_count,
* workflow_state, and active as source fields.
*
*
* -
*
* For Zendesk,
* your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least id, title, updated_at, and draft
* as source fields.
*
*
* -
*
* For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file
* extensions that are among docx, pdf, html, htm, and
* txt.
*
*
* -
*
* For Amazon S3, the ObjectConfiguration and FileConfiguration of your
* AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the
* following format: s3://your_s3_bucket_name.
*
*
*
* The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
* app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and
* s3:GetBucketLocation against the bucket.
*
*
*
*/
private String appIntegrationArn;
/**
*
* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
* ObjectConfiguration is included in the provided DataIntegration.
*
*
* -
*
* For Salesforce, you must include at least Id, ArticleNumber,
* VersionNumber, Title, PublishStatus, and IsDeleted.
*
*
* -
*
* For
* ServiceNow, you must include at least number, short_description,
* sys_mod_count, workflow_state, and active.
*
*
* -
*
* For Zendesk, you
* must include at least id, title, updated_at, and draft.
*
*
*
*
* Make sure to include additional fields. These fields are indexed and used to source recommendations.
*
*/
private java.util.List objectFields;
/**
*
* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
*
*
* -
*
* For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least Id, ArticleNumber, VersionNumber,
* Title, PublishStatus, and IsDeleted as source fields.
*
*
* -
*
* For
* ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least number, short_description, sys_mod_count,
* workflow_state, and active as source fields.
*
*
* -
*
* For Zendesk,
* your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least id, title, updated_at, and draft
* as source fields.
*
*
* -
*
* For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file
* extensions that are among docx, pdf, html, htm, and
* txt.
*
*
* -
*
* For Amazon S3, the ObjectConfiguration and FileConfiguration of your
* AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the
* following format: s3://your_s3_bucket_name.
*
*
*
* The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
* app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and
* s3:GetBucketLocation against the bucket.
*
*
*
*
* @param appIntegrationArn
* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
*
* -
*
* For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is
* not provided, including at least Id, ArticleNumber, VersionNumber,
* Title, PublishStatus, and IsDeleted as source fields.
*
*
* -
*
* For
* ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is
* not provided, including at least number, short_description,
* sys_mod_count, workflow_state, and active as source fields.
*
*
* -
*
* For
* Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if
* objectFields is not provided, including at least id, title,
* updated_at, and draft as source fields.
*
*
* -
*
* For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file
* extensions that are among docx, pdf, html, htm, and
* txt.
*
*
* -
*
* For Amazon S3, the ObjectConfiguration and FileConfiguration of
* your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must
* use the following format: s3://your_s3_bucket_name.
*
*
*
* The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
* app-integrations.amazonaws.com to perform s3:ListBucket,
* s3:GetObject, and s3:GetBucketLocation against the bucket.
*
*
*/
public void setAppIntegrationArn(String appIntegrationArn) {
this.appIntegrationArn = appIntegrationArn;
}
/**
*
* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
*
*
* -
*
* For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least Id, ArticleNumber, VersionNumber,
* Title, PublishStatus, and IsDeleted as source fields.
*
*
* -
*
* For
* ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least number, short_description, sys_mod_count,
* workflow_state, and active as source fields.
*
*
* -
*
* For Zendesk,
* your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least id, title, updated_at, and draft
* as source fields.
*
*
* -
*
* For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file
* extensions that are among docx, pdf, html, htm, and
* txt.
*
*
* -
*
* For Amazon S3, the ObjectConfiguration and FileConfiguration of your
* AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the
* following format: s3://your_s3_bucket_name.
*
*
*
* The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
* app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and
* s3:GetBucketLocation against the bucket.
*
*
*
*
* @return The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
*
* -
*
* For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields
* is not provided, including at least Id, ArticleNumber,
* VersionNumber, Title, PublishStatus, and IsDeleted as
* source fields.
*
*
* -
*
* For
* ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is
* not provided, including at least number, short_description,
* sys_mod_count, workflow_state, and active as source fields.
*
*
* -
*
* For
* Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if
* objectFields is not provided, including at least id, title,
* updated_at, and draft as source fields.
*
*
* -
*
* For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file
* extensions that are among docx, pdf, html, htm, and
* txt.
*
*
* -
*
* For Amazon S3, the ObjectConfiguration and FileConfiguration of
* your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration
* must use the following format: s3://your_s3_bucket_name.
*
*
*
* The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
* app-integrations.amazonaws.com to perform s3:ListBucket,
* s3:GetObject, and s3:GetBucketLocation against the bucket.
*
*
*/
public String getAppIntegrationArn() {
return this.appIntegrationArn;
}
/**
*
* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
*
*
* -
*
* For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least Id, ArticleNumber, VersionNumber,
* Title, PublishStatus, and IsDeleted as source fields.
*
*
* -
*
* For
* ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least number, short_description, sys_mod_count,
* workflow_state, and active as source fields.
*
*
* -
*
* For Zendesk,
* your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not
* provided, including at least id, title, updated_at, and draft
* as source fields.
*
*
* -
*
* For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file
* extensions that are among docx, pdf, html, htm, and
* txt.
*
*
* -
*
* For Amazon S3, the ObjectConfiguration and FileConfiguration of your
* AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the
* following format: s3://your_s3_bucket_name.
*
*
*
* The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
* app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and
* s3:GetBucketLocation against the bucket.
*
*
*
*
* @param appIntegrationArn
* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
*
* -
*
* For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is
* not provided, including at least Id, ArticleNumber, VersionNumber,
* Title, PublishStatus, and IsDeleted as source fields.
*
*
* -
*
* For
* ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is
* not provided, including at least number, short_description,
* sys_mod_count, workflow_state, and active as source fields.
*
*
* -
*
* For
* Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if
* objectFields is not provided, including at least id, title,
* updated_at, and draft as source fields.
*
*
* -
*
* For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file
* extensions that are among docx, pdf, html, htm, and
* txt.
*
*
* -
*
* For Amazon S3, the ObjectConfiguration and FileConfiguration of
* your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must
* use the following format: s3://your_s3_bucket_name.
*
*
*
* The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
* app-integrations.amazonaws.com to perform s3:ListBucket,
* s3:GetObject, and s3:GetBucketLocation against the bucket.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppIntegrationsConfiguration withAppIntegrationArn(String appIntegrationArn) {
setAppIntegrationArn(appIntegrationArn);
return this;
}
/**
*
* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
* ObjectConfiguration is included in the provided DataIntegration.
*
*
* -
*
* For Salesforce, you must include at least Id, ArticleNumber,
* VersionNumber, Title, PublishStatus, and IsDeleted.
*
*
* -
*
* For
* ServiceNow, you must include at least number, short_description,
* sys_mod_count, workflow_state, and active.
*
*
* -
*
* For Zendesk, you
* must include at least id, title, updated_at, and draft.
*
*
*
*
* Make sure to include additional fields. These fields are indexed and used to source recommendations.
*
*
* @return The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
* ObjectConfiguration is included in the provided DataIntegration.
*
* -
*
* For Salesforce, you must include at least Id, ArticleNumber,
* VersionNumber, Title, PublishStatus, and IsDeleted.
*
*
* -
*
* For
* ServiceNow, you must include at least number, short_description,
* sys_mod_count, workflow_state, and active.
*
*
* -
*
* For
* Zendesk, you must include at least id, title, updated_at, and
* draft.
*
*
*
*
* Make sure to include additional fields. These fields are indexed and used to source recommendations.
*/
public java.util.List getObjectFields() {
return objectFields;
}
/**
*
* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
* ObjectConfiguration is included in the provided DataIntegration.
*
*
* -
*
* For Salesforce, you must include at least Id, ArticleNumber,
* VersionNumber, Title, PublishStatus, and IsDeleted.
*
*
* -
*
* For
* ServiceNow, you must include at least number, short_description,
* sys_mod_count, workflow_state, and active.
*
*
* -
*
* For Zendesk, you
* must include at least id, title, updated_at, and draft.
*
*
*
*
* Make sure to include additional fields. These fields are indexed and used to source recommendations.
*
*
* @param objectFields
* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
* ObjectConfiguration is included in the provided DataIntegration.
*
* -
*
* For Salesforce, you must include at least Id, ArticleNumber,
* VersionNumber, Title, PublishStatus, and IsDeleted.
*
*
* -
*
* For
* ServiceNow, you must include at least number, short_description,
* sys_mod_count, workflow_state, and active.
*
*
* -
*
* For
* Zendesk, you must include at least id, title, updated_at, and
* draft.
*
*
*
*
* Make sure to include additional fields. These fields are indexed and used to source recommendations.
*/
public void setObjectFields(java.util.Collection objectFields) {
if (objectFields == null) {
this.objectFields = null;
return;
}
this.objectFields = new java.util.ArrayList(objectFields);
}
/**
*
* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
* ObjectConfiguration is included in the provided DataIntegration.
*
*
* -
*
* For Salesforce, you must include at least Id, ArticleNumber,
* VersionNumber, Title, PublishStatus, and IsDeleted.
*
*
* -
*
* For
* ServiceNow, you must include at least number, short_description,
* sys_mod_count, workflow_state, and active.
*
*
* -
*
* For Zendesk, you
* must include at least id, title, updated_at, and draft.
*
*
*
*
* Make sure to include additional fields. These fields are indexed and used to source recommendations.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setObjectFields(java.util.Collection)} or {@link #withObjectFields(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param objectFields
* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
* ObjectConfiguration is included in the provided DataIntegration.
*
* -
*
* For Salesforce, you must include at least Id, ArticleNumber,
* VersionNumber, Title, PublishStatus, and IsDeleted.
*
*
* -
*
* For
* ServiceNow, you must include at least number, short_description,
* sys_mod_count, workflow_state, and active.
*
*
* -
*
* For
* Zendesk, you must include at least id, title, updated_at, and
* draft.
*
*
*
*
* Make sure to include additional fields. These fields are indexed and used to source recommendations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppIntegrationsConfiguration withObjectFields(String... objectFields) {
if (this.objectFields == null) {
setObjectFields(new java.util.ArrayList(objectFields.length));
}
for (String ele : objectFields) {
this.objectFields.add(ele);
}
return this;
}
/**
*
* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
* ObjectConfiguration is included in the provided DataIntegration.
*
*
* -
*
* For Salesforce, you must include at least Id, ArticleNumber,
* VersionNumber, Title, PublishStatus, and IsDeleted.
*
*
* -
*
* For
* ServiceNow, you must include at least number, short_description,
* sys_mod_count, workflow_state, and active.
*
*
* -
*
* For Zendesk, you
* must include at least id, title, updated_at, and draft.
*
*
*
*
* Make sure to include additional fields. These fields are indexed and used to source recommendations.
*
*
* @param objectFields
* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
* ObjectConfiguration is included in the provided DataIntegration.
*
* -
*
* For Salesforce, you must include at least Id, ArticleNumber,
* VersionNumber, Title, PublishStatus, and IsDeleted.
*
*
* -
*
* For
* ServiceNow, you must include at least number, short_description,
* sys_mod_count, workflow_state, and active.
*
*
* -
*
* For
* Zendesk, you must include at least id, title, updated_at, and
* draft.
*
*
*
*
* Make sure to include additional fields. These fields are indexed and used to source recommendations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppIntegrationsConfiguration withObjectFields(java.util.Collection objectFields) {
setObjectFields(objectFields);
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 (getAppIntegrationArn() != null)
sb.append("AppIntegrationArn: ").append(getAppIntegrationArn()).append(",");
if (getObjectFields() != null)
sb.append("ObjectFields: ").append(getObjectFields());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AppIntegrationsConfiguration == false)
return false;
AppIntegrationsConfiguration other = (AppIntegrationsConfiguration) obj;
if (other.getAppIntegrationArn() == null ^ this.getAppIntegrationArn() == null)
return false;
if (other.getAppIntegrationArn() != null && other.getAppIntegrationArn().equals(this.getAppIntegrationArn()) == false)
return false;
if (other.getObjectFields() == null ^ this.getObjectFields() == null)
return false;
if (other.getObjectFields() != null && other.getObjectFields().equals(this.getObjectFields()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAppIntegrationArn() == null) ? 0 : getAppIntegrationArn().hashCode());
hashCode = prime * hashCode + ((getObjectFields() == null) ? 0 : getObjectFields().hashCode());
return hashCode;
}
@Override
public AppIntegrationsConfiguration clone() {
try {
return (AppIntegrationsConfiguration) 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.qconnect.model.transform.AppIntegrationsConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}