@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartAudienceGenerationJobRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
StartAudienceGenerationJobRequest() |
Modifier and Type | Method and Description |
---|---|
StartAudienceGenerationJobRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
StartAudienceGenerationJobRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
StartAudienceGenerationJobRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getCollaborationId()
The identifier of the collaboration that contains the audience generation job.
|
String |
getConfiguredAudienceModelArn()
The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
|
String |
getDescription()
The description of the audience generation job.
|
Boolean |
getIncludeSeedInOutput()
Whether the seed audience is included in the audience generation output.
|
String |
getName()
The name of the audience generation job.
|
AudienceGenerationJobDataSource |
getSeedAudience()
The seed audience that is used to generate the audience.
|
Map<String,String> |
getTags()
The optional metadata that you apply to the resource to help you categorize and organize them.
|
int |
hashCode() |
Boolean |
isIncludeSeedInOutput()
Whether the seed audience is included in the audience generation output.
|
void |
setCollaborationId(String collaborationId)
The identifier of the collaboration that contains the audience generation job.
|
void |
setConfiguredAudienceModelArn(String configuredAudienceModelArn)
The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
|
void |
setDescription(String description)
The description of the audience generation job.
|
void |
setIncludeSeedInOutput(Boolean includeSeedInOutput)
Whether the seed audience is included in the audience generation output.
|
void |
setName(String name)
The name of the audience generation job.
|
void |
setSeedAudience(AudienceGenerationJobDataSource seedAudience)
The seed audience that is used to generate the audience.
|
void |
setTags(Map<String,String> tags)
The optional metadata that you apply to the resource to help you categorize and organize them.
|
String |
toString()
Returns a string representation of this object.
|
StartAudienceGenerationJobRequest |
withCollaborationId(String collaborationId)
The identifier of the collaboration that contains the audience generation job.
|
StartAudienceGenerationJobRequest |
withConfiguredAudienceModelArn(String configuredAudienceModelArn)
The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
|
StartAudienceGenerationJobRequest |
withDescription(String description)
The description of the audience generation job.
|
StartAudienceGenerationJobRequest |
withIncludeSeedInOutput(Boolean includeSeedInOutput)
Whether the seed audience is included in the audience generation output.
|
StartAudienceGenerationJobRequest |
withName(String name)
The name of the audience generation job.
|
StartAudienceGenerationJobRequest |
withSeedAudience(AudienceGenerationJobDataSource seedAudience)
The seed audience that is used to generate the audience.
|
StartAudienceGenerationJobRequest |
withTags(Map<String,String> tags)
The optional metadata that you apply to the resource to help you categorize and organize them.
|
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 setName(String name)
The name of the audience generation job.
name
- The name of the audience generation job.public String getName()
The name of the audience generation job.
public StartAudienceGenerationJobRequest withName(String name)
The name of the audience generation job.
name
- The name of the audience generation job.public void setConfiguredAudienceModelArn(String configuredAudienceModelArn)
The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
configuredAudienceModelArn
- The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation
job.public String getConfiguredAudienceModelArn()
The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
public StartAudienceGenerationJobRequest withConfiguredAudienceModelArn(String configuredAudienceModelArn)
The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
configuredAudienceModelArn
- The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation
job.public void setSeedAudience(AudienceGenerationJobDataSource seedAudience)
The seed audience that is used to generate the audience.
seedAudience
- The seed audience that is used to generate the audience.public AudienceGenerationJobDataSource getSeedAudience()
The seed audience that is used to generate the audience.
public StartAudienceGenerationJobRequest withSeedAudience(AudienceGenerationJobDataSource seedAudience)
The seed audience that is used to generate the audience.
seedAudience
- The seed audience that is used to generate the audience.public void setIncludeSeedInOutput(Boolean includeSeedInOutput)
Whether the seed audience is included in the audience generation output.
includeSeedInOutput
- Whether the seed audience is included in the audience generation output.public Boolean getIncludeSeedInOutput()
Whether the seed audience is included in the audience generation output.
public StartAudienceGenerationJobRequest withIncludeSeedInOutput(Boolean includeSeedInOutput)
Whether the seed audience is included in the audience generation output.
includeSeedInOutput
- Whether the seed audience is included in the audience generation output.public Boolean isIncludeSeedInOutput()
Whether the seed audience is included in the audience generation output.
public void setCollaborationId(String collaborationId)
The identifier of the collaboration that contains the audience generation job.
collaborationId
- The identifier of the collaboration that contains the audience generation job.public String getCollaborationId()
The identifier of the collaboration that contains the audience generation job.
public StartAudienceGenerationJobRequest withCollaborationId(String collaborationId)
The identifier of the collaboration that contains the audience generation job.
collaborationId
- The identifier of the collaboration that contains the audience generation job.public void setDescription(String description)
The description of the audience generation job.
description
- The description of the audience generation job.public String getDescription()
The description of the audience generation job.
public StartAudienceGenerationJobRequest withDescription(String description)
The description of the audience generation job.
description
- The description of the audience generation job.public Map<String,String> getTags()
The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
public void setTags(Map<String,String> tags)
The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
tags
- The optional metadata that you apply to the resource to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
public StartAudienceGenerationJobRequest withTags(Map<String,String> tags)
The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
tags
- The optional metadata that you apply to the resource to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
public StartAudienceGenerationJobRequest addTagsEntry(String key, String value)
public StartAudienceGenerationJobRequest clearTagsEntries()
public String toString()
toString
in class Object
Object.toString()
public StartAudienceGenerationJobRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()