ImportJobRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.pinpoint.model.ImportJobRequest

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

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

Import job request.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ImportJobRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImportJobRequest.Builder`	`builder()`
`Boolean`	`defineSegment()` Sets whether the endpoints create a segment when they are imported.
`boolean`	`equals(Object obj)`
`String`	`externalId()` (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy.
`Format`	`format()` The format of the files that contain the endpoint definitions.
`String`	`formatAsString()` The format of the files that contain the endpoint definitions.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`registerEndpoints()` Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
`String`	`roleArn()` The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
`String`	`s3Url()` The URL of the S3 bucket that contains the segment information to import.
`List<SdkField<?>>`	`sdkFields()`
`String`	`segmentId()` The ID of the segment to update if the import job is meant to update an existing segment.
`String`	`segmentName()` A custom name for the segment created by the import job.
`static Class<? extends ImportJobRequest.Builder>`	`serializableBuilderClass()`
`ImportJobRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

- Method Detail
  - defineSegment
```
public Boolean defineSegment()
```
    Sets whether the endpoints create a segment when they are imported.
    
    Returns:
    
    Sets whether the endpoints create a segment when they are imported.
  - externalId
```
public String externalId()
```
    (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
    
    Returns:
    
    (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
  - format
```
public Format format()
```
    The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    If the service returns an enum value that is not available in the current SDK version, format will return Format.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().
    
    Returns:
    
    The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    
    See Also:
    
    Format
  - formatAsString
```
public String formatAsString()
```
    The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    If the service returns an enum value that is not available in the current SDK version, format will return Format.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().
    
    Returns:
    
    The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    
    See Also:
    
    Format
  - registerEndpoints
```
public Boolean registerEndpoints()
```
    Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
    
    Returns:
    
    Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
  - roleArn
```
public String roleArn()
```
    The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
  - s3Url
```
public String s3Url()
```
    The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
    
    Returns:
    
    The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
  - segmentId
```
public String segmentId()
```
    The ID of the segment to update if the import job is meant to update an existing segment.
    
    Returns:
    
    The ID of the segment to update if the import job is meant to update an existing segment.
  - segmentName
```
public String segmentName()
```
    A custom name for the segment created by the import job. Use if DefineSegment is true.
    
    Returns:
    
    A custom name for the segment created by the import job. Use if DefineSegment is true.
  - toBuilder
```
public ImportJobRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ImportJobRequest.Builder,ImportJobRequest>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ImportJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ImportJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ImportJobRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

defineSegment

externalId

format

formatAsString

registerEndpoints

roleArn

s3Url

segmentId

segmentName

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields