BatchSegmentJob (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.personalize.model.BatchSegmentJob

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchSegmentJob
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains information on a batch segment job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BatchSegmentJob()

Constructors
Constructor and Description
`BatchSegmentJob()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchSegmentJob`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBatchSegmentJobArn()` The Amazon Resource Name (ARN) of the batch segment job.
`Date`	`getCreationDateTime()` The time at which the batch segment job was created.
`String`	`getFailureReason()` If the batch segment job failed, the reason for the failure.
`String`	`getFilterArn()` The ARN of the filter used on the batch segment job.
`BatchSegmentJobInput`	`getJobInput()` The Amazon S3 path that leads to the input data used to generate the batch segment job.
`String`	`getJobName()` The name of the batch segment job.
`BatchSegmentJobOutput`	`getJobOutput()` The Amazon S3 bucket that contains the output data generated by the batch segment job.
`Date`	`getLastUpdatedDateTime()` The time at which the batch segment job last updated.
`Integer`	`getNumResults()` The number of predicted users generated by the batch segment job for each line of input data.
`String`	`getRoleArn()` The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
`String`	`getSolutionVersionArn()` The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
`String`	`getStatus()` The status of the batch segment job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBatchSegmentJobArn(String batchSegmentJobArn)` The Amazon Resource Name (ARN) of the batch segment job.
`void`	`setCreationDateTime(Date creationDateTime)` The time at which the batch segment job was created.
`void`	`setFailureReason(String failureReason)` If the batch segment job failed, the reason for the failure.
`void`	`setFilterArn(String filterArn)` The ARN of the filter used on the batch segment job.
`void`	`setJobInput(BatchSegmentJobInput jobInput)` The Amazon S3 path that leads to the input data used to generate the batch segment job.
`void`	`setJobName(String jobName)` The name of the batch segment job.
`void`	`setJobOutput(BatchSegmentJobOutput jobOutput)` The Amazon S3 bucket that contains the output data generated by the batch segment job.
`void`	`setLastUpdatedDateTime(Date lastUpdatedDateTime)` The time at which the batch segment job last updated.
`void`	`setNumResults(Integer numResults)` The number of predicted users generated by the batch segment job for each line of input data.
`void`	`setRoleArn(String roleArn)` The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
`void`	`setSolutionVersionArn(String solutionVersionArn)` The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
`void`	`setStatus(String status)` The status of the batch segment job.
`String`	`toString()` Returns a string representation of this object.
`BatchSegmentJob`	`withBatchSegmentJobArn(String batchSegmentJobArn)` The Amazon Resource Name (ARN) of the batch segment job.
`BatchSegmentJob`	`withCreationDateTime(Date creationDateTime)` The time at which the batch segment job was created.
`BatchSegmentJob`	`withFailureReason(String failureReason)` If the batch segment job failed, the reason for the failure.
`BatchSegmentJob`	`withFilterArn(String filterArn)` The ARN of the filter used on the batch segment job.
`BatchSegmentJob`	`withJobInput(BatchSegmentJobInput jobInput)` The Amazon S3 path that leads to the input data used to generate the batch segment job.
`BatchSegmentJob`	`withJobName(String jobName)` The name of the batch segment job.
`BatchSegmentJob`	`withJobOutput(BatchSegmentJobOutput jobOutput)` The Amazon S3 bucket that contains the output data generated by the batch segment job.
`BatchSegmentJob`	`withLastUpdatedDateTime(Date lastUpdatedDateTime)` The time at which the batch segment job last updated.
`BatchSegmentJob`	`withNumResults(Integer numResults)` The number of predicted users generated by the batch segment job for each line of input data.
`BatchSegmentJob`	`withRoleArn(String roleArn)` The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
`BatchSegmentJob`	`withSolutionVersionArn(String solutionVersionArn)` The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
`BatchSegmentJob`	`withStatus(String status)` The status of the batch segment job.

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

- Constructor Detail
  - BatchSegmentJob
```
public BatchSegmentJob()
```
- Method Detail
  - setJobName
```
public void setJobName(String jobName)
```
    The name of the batch segment job.
    
    Parameters:
    
    jobName - The name of the batch segment job.
  - getJobName
```
public String getJobName()
```
    The name of the batch segment job.
    
    Returns:
    
    The name of the batch segment job.
  - withJobName
```
public BatchSegmentJob withJobName(String jobName)
```
    The name of the batch segment job.
    
    Parameters:
    
    jobName - The name of the batch segment job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBatchSegmentJobArn
```
public void setBatchSegmentJobArn(String batchSegmentJobArn)
```
    The Amazon Resource Name (ARN) of the batch segment job.
    
    Parameters:
    
    batchSegmentJobArn - The Amazon Resource Name (ARN) of the batch segment job.
  - getBatchSegmentJobArn
```
public String getBatchSegmentJobArn()
```
    The Amazon Resource Name (ARN) of the batch segment job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the batch segment job.
  - withBatchSegmentJobArn
```
public BatchSegmentJob withBatchSegmentJobArn(String batchSegmentJobArn)
```
    The Amazon Resource Name (ARN) of the batch segment job.
    
    Parameters:
    
    batchSegmentJobArn - The Amazon Resource Name (ARN) of the batch segment job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFilterArn
```
public void setFilterArn(String filterArn)
```
    The ARN of the filter used on the batch segment job.
    
    Parameters:
    
    filterArn - The ARN of the filter used on the batch segment job.
  - getFilterArn
```
public String getFilterArn()
```
    The ARN of the filter used on the batch segment job.
    
    Returns:
    
    The ARN of the filter used on the batch segment job.
  - withFilterArn
```
public BatchSegmentJob withFilterArn(String filterArn)
```
    The ARN of the filter used on the batch segment job.
    
    Parameters:
    
    filterArn - The ARN of the filter used on the batch segment job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If the batch segment job failed, the reason for the failure.
    
    Parameters:
    
    failureReason - If the batch segment job failed, the reason for the failure.
  - getFailureReason
```
public String getFailureReason()
```
    If the batch segment job failed, the reason for the failure.
    
    Returns:
    
    If the batch segment job failed, the reason for the failure.
  - withFailureReason
```
public BatchSegmentJob withFailureReason(String failureReason)
```
    If the batch segment job failed, the reason for the failure.
    
    Parameters:
    
    failureReason - If the batch segment job failed, the reason for the failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSolutionVersionArn
```
public void setSolutionVersionArn(String solutionVersionArn)
```
    The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
    
    Parameters:
    
    solutionVersionArn - The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
  - getSolutionVersionArn
```
public String getSolutionVersionArn()
```
    The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
  - withSolutionVersionArn
```
public BatchSegmentJob withSolutionVersionArn(String solutionVersionArn)
```
    The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
    
    Parameters:
    
    solutionVersionArn - The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumResults
```
public void setNumResults(Integer numResults)
```
    The number of predicted users generated by the batch segment job for each line of input data.
    
    Parameters:
    
    numResults - The number of predicted users generated by the batch segment job for each line of input data.
  - getNumResults
```
public Integer getNumResults()
```
    The number of predicted users generated by the batch segment job for each line of input data.
    
    Returns:
    
    The number of predicted users generated by the batch segment job for each line of input data.
  - withNumResults
```
public BatchSegmentJob withNumResults(Integer numResults)
```
    The number of predicted users generated by the batch segment job for each line of input data.
    
    Parameters:
    
    numResults - The number of predicted users generated by the batch segment job for each line of input data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobInput
```
public void setJobInput(BatchSegmentJobInput jobInput)
```
    The Amazon S3 path that leads to the input data used to generate the batch segment job.
    
    Parameters:
    
    jobInput - The Amazon S3 path that leads to the input data used to generate the batch segment job.
  - getJobInput
```
public BatchSegmentJobInput getJobInput()
```
    The Amazon S3 path that leads to the input data used to generate the batch segment job.
    
    Returns:
    
    The Amazon S3 path that leads to the input data used to generate the batch segment job.
  - withJobInput
```
public BatchSegmentJob withJobInput(BatchSegmentJobInput jobInput)
```
    The Amazon S3 path that leads to the input data used to generate the batch segment job.
    
    Parameters:
    
    jobInput - The Amazon S3 path that leads to the input data used to generate the batch segment job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobOutput
```
public void setJobOutput(BatchSegmentJobOutput jobOutput)
```
    The Amazon S3 bucket that contains the output data generated by the batch segment job.
    
    Parameters:
    
    jobOutput - The Amazon S3 bucket that contains the output data generated by the batch segment job.
  - getJobOutput
```
public BatchSegmentJobOutput getJobOutput()
```
    The Amazon S3 bucket that contains the output data generated by the batch segment job.
    
    Returns:
    
    The Amazon S3 bucket that contains the output data generated by the batch segment job.
  - withJobOutput
```
public BatchSegmentJob withJobOutput(BatchSegmentJobOutput jobOutput)
```
    The Amazon S3 bucket that contains the output data generated by the batch segment job.
    
    Parameters:
    
    jobOutput - The Amazon S3 bucket that contains the output data generated by the batch segment job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
    
    Parameters:
    
    roleArn - The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
  - getRoleArn
```
public String getRoleArn()
```
    The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
    
    Returns:
    
    The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
  - withRoleArn
```
public BatchSegmentJob withRoleArn(String roleArn)
```
    The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
    
    Parameters:
    
    roleArn - The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment 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 batch segment job. The status is one of the following values:
    - PENDING
    - IN PROGRESS
    - ACTIVE
    - CREATE FAILED
    Parameters:
    status - The status of the batch segment job. The status is one of the following values:
    
    PENDING
    
    IN PROGRESS
    
    ACTIVE
    
    CREATE FAILED
  - getStatus
```
public String getStatus()
```
    The status of the batch segment job. The status is one of the following values:
    - PENDING
    - IN PROGRESS
    - ACTIVE
    - CREATE FAILED
    Returns:
    The status of the batch segment job. The status is one of the following values:
    
    PENDING
    
    IN PROGRESS
    
    ACTIVE
    
    CREATE FAILED
  - withStatus
```
public BatchSegmentJob withStatus(String status)
```
    The status of the batch segment job. The status is one of the following values:
    - PENDING
    - IN PROGRESS
    - ACTIVE
    - CREATE FAILED
    Parameters:
    status - The status of the batch segment job. The status is one of the following values:
    
    PENDING
    
    IN PROGRESS
    
    ACTIVE
    
    CREATE FAILED
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDateTime
```
public void setCreationDateTime(Date creationDateTime)
```
    The time at which the batch segment job was created.
    
    Parameters:
    
    creationDateTime - The time at which the batch segment job was created.
  - getCreationDateTime
```
public Date getCreationDateTime()
```
    The time at which the batch segment job was created.
    
    Returns:
    
    The time at which the batch segment job was created.
  - withCreationDateTime
```
public BatchSegmentJob withCreationDateTime(Date creationDateTime)
```
    The time at which the batch segment job was created.
    
    Parameters:
    
    creationDateTime - The time at which the batch segment job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDateTime
```
public void setLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The time at which the batch segment job last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The time at which the batch segment job last updated.
  - getLastUpdatedDateTime
```
public Date getLastUpdatedDateTime()
```
    The time at which the batch segment job last updated.
    
    Returns:
    
    The time at which the batch segment job last updated.
  - withLastUpdatedDateTime
```
public BatchSegmentJob withLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The time at which the batch segment job last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The time at which the batch segment job last updated.
    
    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 BatchSegmentJob clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class BatchSegmentJob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchSegmentJob

Method Detail

setJobName

getJobName

withJobName

setBatchSegmentJobArn

getBatchSegmentJobArn

withBatchSegmentJobArn

setFilterArn

getFilterArn

withFilterArn

setFailureReason

getFailureReason

withFailureReason

setSolutionVersionArn

getSolutionVersionArn

withSolutionVersionArn

setNumResults

getNumResults

withNumResults

setJobInput

getJobInput

withJobInput

setJobOutput

getJobOutput

withJobOutput

setRoleArn

getRoleArn

withRoleArn

setStatus

getStatus

withStatus

setCreationDateTime

getCreationDateTime

withCreationDateTime

setLastUpdatedDateTime

getLastUpdatedDateTime

withLastUpdatedDateTime

toString

equals

hashCode

clone

marshall