java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.personalize.model.PersonalizeRequest
    - - software.amazon.awssdk.services.personalize.model.CreateBatchSegmentJobRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateBatchSegmentJobRequest.Builder,CreateBatchSegmentJobRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateBatchSegmentJobRequest
extends PersonalizeRequest
implements ToCopyableBuilder<CreateBatchSegmentJobRequest.Builder,CreateBatchSegmentJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateBatchSegmentJobRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateBatchSegmentJobRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`filterArn()`	The ARN of the filter to apply to the batch segment job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`BatchSegmentJobInput`	`jobInput()`	The Amazon S3 path for the input data used to generate the batch segment job.
`String`	`jobName()`	The name of the batch segment job to create.
`BatchSegmentJobOutput`	`jobOutput()`	The Amazon S3 path for the bucket where the job's output will be stored.
`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 role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateBatchSegmentJobRequest.Builder>`	`serializableBuilderClass()`
`String`	`solutionVersionArn()`	The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
`List<Tag>`	`tags()`	A list of tags to apply to the batch segment job.
`CreateBatchSegmentJobRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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 to create.
    
    Returns:
    
    The name of the batch segment job to create.
  - solutionVersionArn
```
public final String solutionVersionArn()
```
    The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
  - filterArn
```
public final String filterArn()
```
    The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.
    
    Returns:
    
    The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.
  - numResults
```
public final Integer numResults()
```
    The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
    
    Returns:
    
    The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
  - jobInput
```
public final BatchSegmentJobInput jobInput()
```
    The Amazon S3 path for the input data used to generate the batch segment job.
    
    Returns:
    
    The Amazon S3 path for the input data used to generate the batch segment job.
  - jobOutput
```
public final BatchSegmentJobOutput jobOutput()
```
    The Amazon S3 path for the bucket where the job's output will be stored.
    
    Returns:
    
    The Amazon S3 path for the bucket where the job's output will be stored.
  - roleArn
```
public final String roleArn()
```
    The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
    
    Returns:
    
    The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    A list of tags to apply to the batch segment job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    A list of tags to apply to the batch segment job.
  - toBuilder
```
public CreateBatchSegmentJobRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateBatchSegmentJobRequest.Builder,CreateBatchSegmentJobRequest>
    
    Specified by:
    
    toBuilder in class PersonalizeRequest
  - builder
```
public static CreateBatchSegmentJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateBatchSegmentJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateBatchSegmentJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

jobName

solutionVersionArn

filterArn

numResults

jobInput

jobOutput

roleArn

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields