BatchSegmentJob (AWS Java SDK :: Services :: Personalize 2.20.30 API)

java.lang.Object
- software.amazon.awssdk.services.personalize.model.BatchSegmentJob

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<BatchSegmentJob.Builder,BatchSegmentJob>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchSegmentJob
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BatchSegmentJob.Builder,BatchSegmentJob>

Contains information on a batch segment job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BatchSegmentJob.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BatchSegmentJob.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`batchSegmentJobArn()` The Amazon Resource Name (ARN) of the batch segment job.
`static BatchSegmentJob.Builder`	`builder()`
`Instant`	`creationDateTime()` The time at which the batch segment job was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` If the batch segment job failed, the reason for the failure.
`String`	`filterArn()` The ARN of the filter used on the batch segment job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`BatchSegmentJobInput`	`jobInput()` The Amazon S3 path that leads to the input data used to generate the batch segment job.
`String`	`jobName()` The name of the batch segment job.
`BatchSegmentJobOutput`	`jobOutput()` The Amazon S3 bucket that contains the output data generated by the batch segment job.
`Instant`	`lastUpdatedDateTime()` The time at which the batch segment job last updated.
`Integer`	`numResults()` The number of predicted users generated by the batch segment job for each line of input data.
`String`	`roleArn()` The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BatchSegmentJob.Builder>`	`serializableBuilderClass()`
`String`	`solutionVersionArn()` The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
`String`	`status()` The status of the batch segment job.
`BatchSegmentJob.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - jobName
```
public final String jobName()
```
    The name of the batch segment job.
    
    Returns:
    
    The name of the batch segment job.
  - batchSegmentJobArn
```
public final String batchSegmentJobArn()
```
    The Amazon Resource Name (ARN) of the batch segment job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the batch segment job.
  - filterArn
```
public final String filterArn()
```
    The ARN of the filter used on the batch segment job.
    
    Returns:
    
    The ARN of the filter used on the batch segment job.
  - failureReason
```
public final String failureReason()
```
    If the batch segment job failed, the reason for the failure.
    
    Returns:
    
    If the batch segment job failed, the reason for the failure.
  - solutionVersionArn
```
public final String solutionVersionArn()
```
    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.
  - numResults
```
public final Integer numResults()
```
    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.
  - jobInput
```
public final BatchSegmentJobInput jobInput()
```
    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.
  - jobOutput
```
public final BatchSegmentJobOutput jobOutput()
```
    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.
  - roleArn
```
public final String roleArn()
```
    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.
  - status
```
public final String status()
```
    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
  - creationDateTime
```
public final Instant creationDateTime()
```
    The time at which the batch segment job was created.
    
    Returns:
    
    The time at which the batch segment job was created.
  - lastUpdatedDateTime
```
public final Instant lastUpdatedDateTime()
```
    The time at which the batch segment job last updated.
    
    Returns:
    
    The time at which the batch segment job last updated.
  - toBuilder
```
public BatchSegmentJob.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BatchSegmentJob.Builder,BatchSegmentJob>
  - builder
```
public static BatchSegmentJob.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BatchSegmentJob.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class BatchSegmentJob

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobName

batchSegmentJobArn

filterArn

failureReason

solutionVersionArn

numResults

jobInput

jobOutput

roleArn

status

creationDateTime

lastUpdatedDateTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields