@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateVocabularyFilterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
UpdateVocabularyFilterRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateVocabularyFilterRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getDataAccessRoleArn()
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains
your input files (in this case, your custom vocabulary filter).
|
String |
getVocabularyFilterFileUri()
The Amazon S3 location of the text file that contains your custom vocabulary filter terms.
|
String |
getVocabularyFilterName()
The name of the custom vocabulary filter you want to update.
|
List<String> |
getWords()
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request.
|
int |
hashCode() |
void |
setDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains
your input files (in this case, your custom vocabulary filter).
|
void |
setVocabularyFilterFileUri(String vocabularyFilterFileUri)
The Amazon S3 location of the text file that contains your custom vocabulary filter terms.
|
void |
setVocabularyFilterName(String vocabularyFilterName)
The name of the custom vocabulary filter you want to update.
|
void |
setWords(Collection<String> words)
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request.
|
String |
toString()
Returns a string representation of this object.
|
UpdateVocabularyFilterRequest |
withDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains
your input files (in this case, your custom vocabulary filter).
|
UpdateVocabularyFilterRequest |
withVocabularyFilterFileUri(String vocabularyFilterFileUri)
The Amazon S3 location of the text file that contains your custom vocabulary filter terms.
|
UpdateVocabularyFilterRequest |
withVocabularyFilterName(String vocabularyFilterName)
The name of the custom vocabulary filter you want to update.
|
UpdateVocabularyFilterRequest |
withWords(Collection<String> words)
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request.
|
UpdateVocabularyFilterRequest |
withWords(String... words)
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setVocabularyFilterName(String vocabularyFilterName)
The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.
vocabularyFilterName
- The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case
sensitive.public String getVocabularyFilterName()
The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.
public UpdateVocabularyFilterRequest withVocabularyFilterName(String vocabularyFilterName)
The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.
vocabularyFilterName
- The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case
sensitive.public List<String> getWords()
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for updating your vocabulary filter is to save your
entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the
VocabularyFilterFileUri
parameter.
Note that if you include Words
in your request, you cannot use VocabularyFilterFileUri
;
you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
VocabularyFilterFileUri
parameter.
Note that if you include Words
in your request, you cannot use
VocabularyFilterFileUri
; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
public void setWords(Collection<String> words)
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for updating your vocabulary filter is to save your
entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the
VocabularyFilterFileUri
parameter.
Note that if you include Words
in your request, you cannot use VocabularyFilterFileUri
;
you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
words
- Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for updating your vocabulary filter is to
save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your
file using the VocabularyFilterFileUri
parameter.
Note that if you include Words
in your request, you cannot use
VocabularyFilterFileUri
; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
public UpdateVocabularyFilterRequest withWords(String... words)
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for updating your vocabulary filter is to save your
entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the
VocabularyFilterFileUri
parameter.
Note that if you include Words
in your request, you cannot use VocabularyFilterFileUri
;
you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
NOTE: This method appends the values to the existing list (if any). Use
setWords(java.util.Collection)
or withWords(java.util.Collection)
if you want to override the
existing values.
words
- Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for updating your vocabulary filter is to
save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your
file using the VocabularyFilterFileUri
parameter.
Note that if you include Words
in your request, you cannot use
VocabularyFilterFileUri
; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
public UpdateVocabularyFilterRequest withWords(Collection<String> words)
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for updating your vocabulary filter is to save your
entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the
VocabularyFilterFileUri
parameter.
Note that if you include Words
in your request, you cannot use VocabularyFilterFileUri
;
you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
words
- Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for updating your vocabulary filter is to
save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your
file using the VocabularyFilterFileUri
parameter.
Note that if you include Words
in your request, you cannot use
VocabularyFilterFileUri
; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
public void setVocabularyFilterFileUri(String vocabularyFilterFileUri)
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri
in your request, you cannot use Words
;
you must choose one or the other.
vocabularyFilterFileUri
- The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be
located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri
in your request, you cannot use
Words
; you must choose one or the other.
public String getVocabularyFilterFileUri()
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri
in your request, you cannot use Words
;
you must choose one or the other.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri
in your request, you cannot use
Words
; you must choose one or the other.
public UpdateVocabularyFilterRequest withVocabularyFilterFileUri(String vocabularyFilterFileUri)
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri
in your request, you cannot use Words
;
you must choose one or the other.
vocabularyFilterFileUri
- The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be
located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri
in your request, you cannot use
Words
; you must choose one or the other.
public void setDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path
. For example:
arn:aws:iam::111122223333:role/Admin
.
For more information, see IAM ARNs.
dataAccessRoleArn
- The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that
contains your input files (in this case, your custom vocabulary filter). If the role that you specify
doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request
fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path
. For
example: arn:aws:iam::111122223333:role/Admin
.
For more information, see IAM ARNs.
public String getDataAccessRoleArn()
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path
. For example:
arn:aws:iam::111122223333:role/Admin
.
For more information, see IAM ARNs.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path
. For
example: arn:aws:iam::111122223333:role/Admin
.
For more information, see IAM ARNs.
public UpdateVocabularyFilterRequest withDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path
. For example:
arn:aws:iam::111122223333:role/Admin
.
For more information, see IAM ARNs.
dataAccessRoleArn
- The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that
contains your input files (in this case, your custom vocabulary filter). If the role that you specify
doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request
fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path
. For
example: arn:aws:iam::111122223333:role/Admin
.
For more information, see IAM ARNs.
public String toString()
toString
in class Object
Object.toString()
public UpdateVocabularyFilterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()