GetAudienceGenerationJobResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.cleanroomsml.model.GetAudienceGenerationJobResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetAudienceGenerationJobResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetAudienceGenerationJobResult()

Constructors
Constructor and Description
`GetAudienceGenerationJobResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetAudienceGenerationJobResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`GetAudienceGenerationJobResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`GetAudienceGenerationJobResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAudienceGenerationJobArn()` The Amazon Resource Name (ARN) of the audience generation job.
`String`	`getCollaborationId()` The identifier of the collaboration that this audience generation job is associated with.
`String`	`getConfiguredAudienceModelArn()` The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
`Date`	`getCreateTime()` The time at which the audience generation job was created.
`String`	`getDescription()` The description of the audience generation job.
`Boolean`	`getIncludeSeedInOutput()` Configure whether the seed users are included in the output audience.
`AudienceQualityMetrics`	`getMetrics()` The relevance scores for different audience sizes and the recall score of the generated audience.
`String`	`getName()` The name of the audience generation job.
`String`	`getProtectedQueryIdentifier()` The unique identifier of the protected query for this audience generation job.
`AudienceGenerationJobDataSource`	`getSeedAudience()` The seed audience that was used for this audience generation job.
`String`	`getStartedBy()` The AWS account that started this audience generation job.
`String`	`getStatus()` The status of the audience generation job.
`StatusDetails`	`getStatusDetails()` Details about the status of the audience generation job.
`Map<String,String>`	`getTags()` The tags that are associated to this audience generation job.
`Date`	`getUpdateTime()` The most recent time at which the audience generation job was updated.
`int`	`hashCode()`
`Boolean`	`isIncludeSeedInOutput()` Configure whether the seed users are included in the output audience.
`void`	`setAudienceGenerationJobArn(String audienceGenerationJobArn)` The Amazon Resource Name (ARN) of the audience generation job.
`void`	`setCollaborationId(String collaborationId)` The identifier of the collaboration that this audience generation job is associated with.
`void`	`setConfiguredAudienceModelArn(String configuredAudienceModelArn)` The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
`void`	`setCreateTime(Date createTime)` The time at which the audience generation job was created.
`void`	`setDescription(String description)` The description of the audience generation job.
`void`	`setIncludeSeedInOutput(Boolean includeSeedInOutput)` Configure whether the seed users are included in the output audience.
`void`	`setMetrics(AudienceQualityMetrics metrics)` The relevance scores for different audience sizes and the recall score of the generated audience.
`void`	`setName(String name)` The name of the audience generation job.
`void`	`setProtectedQueryIdentifier(String protectedQueryIdentifier)` The unique identifier of the protected query for this audience generation job.
`void`	`setSeedAudience(AudienceGenerationJobDataSource seedAudience)` The seed audience that was used for this audience generation job.
`void`	`setStartedBy(String startedBy)` The AWS account that started this audience generation job.
`void`	`setStatus(String status)` The status of the audience generation job.
`void`	`setStatusDetails(StatusDetails statusDetails)` Details about the status of the audience generation job.
`void`	`setTags(Map<String,String> tags)` The tags that are associated to this audience generation job.
`void`	`setUpdateTime(Date updateTime)` The most recent time at which the audience generation job was updated.
`String`	`toString()` Returns a string representation of this object.
`GetAudienceGenerationJobResult`	`withAudienceGenerationJobArn(String audienceGenerationJobArn)` The Amazon Resource Name (ARN) of the audience generation job.
`GetAudienceGenerationJobResult`	`withCollaborationId(String collaborationId)` The identifier of the collaboration that this audience generation job is associated with.
`GetAudienceGenerationJobResult`	`withConfiguredAudienceModelArn(String configuredAudienceModelArn)` The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
`GetAudienceGenerationJobResult`	`withCreateTime(Date createTime)` The time at which the audience generation job was created.
`GetAudienceGenerationJobResult`	`withDescription(String description)` The description of the audience generation job.
`GetAudienceGenerationJobResult`	`withIncludeSeedInOutput(Boolean includeSeedInOutput)` Configure whether the seed users are included in the output audience.
`GetAudienceGenerationJobResult`	`withMetrics(AudienceQualityMetrics metrics)` The relevance scores for different audience sizes and the recall score of the generated audience.
`GetAudienceGenerationJobResult`	`withName(String name)` The name of the audience generation job.
`GetAudienceGenerationJobResult`	`withProtectedQueryIdentifier(String protectedQueryIdentifier)` The unique identifier of the protected query for this audience generation job.
`GetAudienceGenerationJobResult`	`withSeedAudience(AudienceGenerationJobDataSource seedAudience)` The seed audience that was used for this audience generation job.
`GetAudienceGenerationJobResult`	`withStartedBy(String startedBy)` The AWS account that started this audience generation job.
`GetAudienceGenerationJobResult`	`withStatus(AudienceGenerationJobStatus status)` The status of the audience generation job.
`GetAudienceGenerationJobResult`	`withStatus(String status)` The status of the audience generation job.
`GetAudienceGenerationJobResult`	`withStatusDetails(StatusDetails statusDetails)` Details about the status of the audience generation job.
`GetAudienceGenerationJobResult`	`withTags(Map<String,String> tags)` The tags that are associated to this audience generation job.
`GetAudienceGenerationJobResult`	`withUpdateTime(Date updateTime)` The most recent time at which the audience generation job was updated.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetAudienceGenerationJobResult
```
public GetAudienceGenerationJobResult()
```
- Method Detail
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
    The time at which the audience generation job was created.
    
    Parameters:
    
    createTime - The time at which the audience generation job was created.
  - getCreateTime
```
public Date getCreateTime()
```
    The time at which the audience generation job was created.
    
    Returns:
    
    The time at which the audience generation job was created.
  - withCreateTime
```
public GetAudienceGenerationJobResult withCreateTime(Date createTime)
```
    The time at which the audience generation job was created.
    
    Parameters:
    
    createTime - The time at which the audience generation job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdateTime
```
public void setUpdateTime(Date updateTime)
```
    The most recent time at which the audience generation job was updated.
    
    Parameters:
    
    updateTime - The most recent time at which the audience generation job was updated.
  - getUpdateTime
```
public Date getUpdateTime()
```
    The most recent time at which the audience generation job was updated.
    
    Returns:
    
    The most recent time at which the audience generation job was updated.
  - withUpdateTime
```
public GetAudienceGenerationJobResult withUpdateTime(Date updateTime)
```
    The most recent time at which the audience generation job was updated.
    
    Parameters:
    
    updateTime - The most recent time at which the audience generation job was updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAudienceGenerationJobArn
```
public void setAudienceGenerationJobArn(String audienceGenerationJobArn)
```
    The Amazon Resource Name (ARN) of the audience generation job.
    
    Parameters:
    
    audienceGenerationJobArn - The Amazon Resource Name (ARN) of the audience generation job.
  - getAudienceGenerationJobArn
```
public String getAudienceGenerationJobArn()
```
    The Amazon Resource Name (ARN) of the audience generation job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the audience generation job.
  - withAudienceGenerationJobArn
```
public GetAudienceGenerationJobResult withAudienceGenerationJobArn(String audienceGenerationJobArn)
```
    The Amazon Resource Name (ARN) of the audience generation job.
    
    Parameters:
    
    audienceGenerationJobArn - The Amazon Resource Name (ARN) of the audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the audience generation job.
    
    Parameters:
    
    name - The name of the audience generation job.
  - getName
```
public String getName()
```
    The name of the audience generation job.
    
    Returns:
    
    The name of the audience generation job.
  - withName
```
public GetAudienceGenerationJobResult withName(String name)
```
    The name of the audience generation job.
    
    Parameters:
    
    name - The name of the audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the audience generation job.
    
    Parameters:
    
    description - The description of the audience generation job.
  - getDescription
```
public String getDescription()
```
    The description of the audience generation job.
    
    Returns:
    
    The description of the audience generation job.
  - withDescription
```
public GetAudienceGenerationJobResult withDescription(String description)
```
    The description of the audience generation job.
    
    Parameters:
    
    description - The description of the audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the audience generation job.
    
    Parameters:
    
    status - The status of the audience generation job.
    
    See Also:
    
    AudienceGenerationJobStatus
  - getStatus
```
public String getStatus()
```
    The status of the audience generation job.
    
    Returns:
    
    The status of the audience generation job.
    
    See Also:
    
    AudienceGenerationJobStatus
  - withStatus
```
public GetAudienceGenerationJobResult withStatus(String status)
```
    The status of the audience generation job.
    
    Parameters:
    
    status - The status of the audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AudienceGenerationJobStatus
  - withStatus
```
public GetAudienceGenerationJobResult withStatus(AudienceGenerationJobStatus status)
```
    The status of the audience generation job.
    
    Parameters:
    
    status - The status of the audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AudienceGenerationJobStatus
  - setStatusDetails
```
public void setStatusDetails(StatusDetails statusDetails)
```
    Details about the status of the audience generation job.
    
    Parameters:
    
    statusDetails - Details about the status of the audience generation job.
  - getStatusDetails
```
public StatusDetails getStatusDetails()
```
    Details about the status of the audience generation job.
    
    Returns:
    
    Details about the status of the audience generation job.
  - withStatusDetails
```
public GetAudienceGenerationJobResult withStatusDetails(StatusDetails statusDetails)
```
    Details about the status of the audience generation job.
    
    Parameters:
    
    statusDetails - Details about the status of the audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfiguredAudienceModelArn
```
public void setConfiguredAudienceModelArn(String configuredAudienceModelArn)
```
    The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
    
    Parameters:
    
    configuredAudienceModelArn - The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
  - getConfiguredAudienceModelArn
```
public String getConfiguredAudienceModelArn()
```
    The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
  - withConfiguredAudienceModelArn
```
public GetAudienceGenerationJobResult withConfiguredAudienceModelArn(String configuredAudienceModelArn)
```
    The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
    
    Parameters:
    
    configuredAudienceModelArn - The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSeedAudience
```
public void setSeedAudience(AudienceGenerationJobDataSource seedAudience)
```
    The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
    
    Parameters:
    
    seedAudience - The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
  - getSeedAudience
```
public AudienceGenerationJobDataSource getSeedAudience()
```
    The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
    
    Returns:
    
    The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
  - withSeedAudience
```
public GetAudienceGenerationJobResult withSeedAudience(AudienceGenerationJobDataSource seedAudience)
```
    The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
    
    Parameters:
    
    seedAudience - The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIncludeSeedInOutput
```
public void setIncludeSeedInOutput(Boolean includeSeedInOutput)
```
    Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
    
    Parameters:
    
    includeSeedInOutput - Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
  - getIncludeSeedInOutput
```
public Boolean getIncludeSeedInOutput()
```
    Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
    
    Returns:
    
    Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
  - withIncludeSeedInOutput
```
public GetAudienceGenerationJobResult withIncludeSeedInOutput(Boolean includeSeedInOutput)
```
    Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
    
    Parameters:
    
    includeSeedInOutput - Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeSeedInOutput
```
public Boolean isIncludeSeedInOutput()
```
    Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
    
    Returns:
    
    Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
  - setCollaborationId
```
public void setCollaborationId(String collaborationId)
```
    The identifier of the collaboration that this audience generation job is associated with.
    
    Parameters:
    
    collaborationId - The identifier of the collaboration that this audience generation job is associated with.
  - getCollaborationId
```
public String getCollaborationId()
```
    The identifier of the collaboration that this audience generation job is associated with.
    
    Returns:
    
    The identifier of the collaboration that this audience generation job is associated with.
  - withCollaborationId
```
public GetAudienceGenerationJobResult withCollaborationId(String collaborationId)
```
    The identifier of the collaboration that this audience generation job is associated with.
    
    Parameters:
    
    collaborationId - The identifier of the collaboration that this audience generation job is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetrics
```
public void setMetrics(AudienceQualityMetrics metrics)
```
    The relevance scores for different audience sizes and the recall score of the generated audience.
    
    Parameters:
    
    metrics - The relevance scores for different audience sizes and the recall score of the generated audience.
  - getMetrics
```
public AudienceQualityMetrics getMetrics()
```
    The relevance scores for different audience sizes and the recall score of the generated audience.
    
    Returns:
    
    The relevance scores for different audience sizes and the recall score of the generated audience.
  - withMetrics
```
public GetAudienceGenerationJobResult withMetrics(AudienceQualityMetrics metrics)
```
    The relevance scores for different audience sizes and the recall score of the generated audience.
    
    Parameters:
    
    metrics - The relevance scores for different audience sizes and the recall score of the generated audience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartedBy
```
public void setStartedBy(String startedBy)
```
    The AWS account that started this audience generation job.
    
    Parameters:
    
    startedBy - The AWS account that started this audience generation job.
  - getStartedBy
```
public String getStartedBy()
```
    The AWS account that started this audience generation job.
    
    Returns:
    
    The AWS account that started this audience generation job.
  - withStartedBy
```
public GetAudienceGenerationJobResult withStartedBy(String startedBy)
```
    The AWS account that started this audience generation job.
    
    Parameters:
    
    startedBy - The AWS account that started this audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags that are associated to this audience generation job.
    
    Returns:
    
    The tags that are associated to this audience generation job.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags that are associated to this audience generation job.
    
    Parameters:
    
    tags - The tags that are associated to this audience generation job.
  - withTags
```
public GetAudienceGenerationJobResult withTags(Map<String,String> tags)
```
    The tags that are associated to this audience generation job.
    
    Parameters:
    
    tags - The tags that are associated to this audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public GetAudienceGenerationJobResult addTagsEntry(String key,
                                                   String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public GetAudienceGenerationJobResult clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtectedQueryIdentifier
```
public void setProtectedQueryIdentifier(String protectedQueryIdentifier)
```
    The unique identifier of the protected query for this audience generation job.
    
    Parameters:
    
    protectedQueryIdentifier - The unique identifier of the protected query for this audience generation job.
  - getProtectedQueryIdentifier
```
public String getProtectedQueryIdentifier()
```
    The unique identifier of the protected query for this audience generation job.
    
    Returns:
    
    The unique identifier of the protected query for this audience generation job.
  - withProtectedQueryIdentifier
```
public GetAudienceGenerationJobResult withProtectedQueryIdentifier(String protectedQueryIdentifier)
```
    The unique identifier of the protected query for this audience generation job.
    
    Parameters:
    
    protectedQueryIdentifier - The unique identifier of the protected query for this audience generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetAudienceGenerationJobResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.773

Class GetAudienceGenerationJobResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetAudienceGenerationJobResult

Method Detail

setCreateTime

getCreateTime

withCreateTime

setUpdateTime

getUpdateTime

withUpdateTime

setAudienceGenerationJobArn

getAudienceGenerationJobArn

withAudienceGenerationJobArn

setName

getName

withName

setDescription

getDescription

withDescription

setStatus

getStatus

withStatus

withStatus

setStatusDetails

getStatusDetails

withStatusDetails

setConfiguredAudienceModelArn

getConfiguredAudienceModelArn

withConfiguredAudienceModelArn

setSeedAudience

getSeedAudience

withSeedAudience

setIncludeSeedInOutput

getIncludeSeedInOutput

withIncludeSeedInOutput

isIncludeSeedInOutput

setCollaborationId

getCollaborationId

withCollaborationId

setMetrics

getMetrics

withMetrics

setStartedBy

getStartedBy

withStartedBy

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setProtectedQueryIdentifier

getProtectedQueryIdentifier

withProtectedQueryIdentifier

toString

equals

hashCode

clone