ImportJobRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.ImportJobRequest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ImportJobRequest
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ImportJobRequest()

Constructors
Constructor and Description
`ImportJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImportJobRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getDefineSegment()` Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
`String`	`getExternalId()` (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.
`String`	`getFormat()` The format of the files that contain the endpoint definitions to import.
`Boolean`	`getRegisterEndpoints()` Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
`String`	`getS3Url()` The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import.
`String`	`getSegmentId()` The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
`String`	`getSegmentName()` A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
`int`	`hashCode()`
`Boolean`	`isDefineSegment()` Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
`Boolean`	`isRegisterEndpoints()` Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefineSegment(Boolean defineSegment)` Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
`void`	`setExternalId(String externalId)` (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.
`void`	`setFormat(Format format)` The format of the files that contain the endpoint definitions to import.
`void`	`setFormat(String format)` The format of the files that contain the endpoint definitions to import.
`void`	`setRegisterEndpoints(Boolean registerEndpoints)` Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
`void`	`setS3Url(String s3Url)` The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import.
`void`	`setSegmentId(String segmentId)` The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
`void`	`setSegmentName(String segmentName)` A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
`String`	`toString()` Returns a string representation of this object.
`ImportJobRequest`	`withDefineSegment(Boolean defineSegment)` Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
`ImportJobRequest`	`withExternalId(String externalId)` (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.
`ImportJobRequest`	`withFormat(Format format)` The format of the files that contain the endpoint definitions to import.
`ImportJobRequest`	`withFormat(String format)` The format of the files that contain the endpoint definitions to import.
`ImportJobRequest`	`withRegisterEndpoints(Boolean registerEndpoints)` Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
`ImportJobRequest`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
`ImportJobRequest`	`withS3Url(String s3Url)` The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import.
`ImportJobRequest`	`withSegmentId(String segmentId)` The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
`ImportJobRequest`	`withSegmentName(String segmentName)` A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

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

- Constructor Detail
  - ImportJobRequest
```
public ImportJobRequest()
```
- Method Detail
  - setDefineSegment
```
public void setDefineSegment(Boolean defineSegment)
```
    Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
    
    Parameters:
    
    defineSegment - Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
  - getDefineSegment
```
public Boolean getDefineSegment()
```
    Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
    
    Returns:
    
    Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
  - withDefineSegment
```
public ImportJobRequest withDefineSegment(Boolean defineSegment)
```
    Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
    
    Parameters:
    
    defineSegment - Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDefineSegment
```
public Boolean isDefineSegment()
```
    Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
    
    Returns:
    
    Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
  - setExternalId
```
public void setExternalId(String externalId)
```
    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
    
    Parameters:
    
    externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
  - getExternalId
```
public String getExternalId()
```
    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
    
    Returns:
    
    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
  - withExternalId
```
public ImportJobRequest withExternalId(String externalId)
```
    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
    
    Parameters:
    
    externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFormat
```
public void setFormat(String format)
```
    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
    
    Parameters:
    
    format - The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
    
    See Also:
    
    Format
  - getFormat
```
public String getFormat()
```
    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
    
    Returns:
    
    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
    
    See Also:
    
    Format
  - withFormat
```
public ImportJobRequest withFormat(String format)
```
    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
    
    Parameters:
    
    format - The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Format
  - setFormat
```
public void setFormat(Format format)
```
    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
    
    Parameters:
    
    format - The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
    
    See Also:
    
    Format
  - withFormat
```
public ImportJobRequest withFormat(Format format)
```
    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
    
    Parameters:
    
    format - The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Format
  - setRegisterEndpoints
```
public void setRegisterEndpoints(Boolean registerEndpoints)
```
    Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
    
    Parameters:
    
    registerEndpoints - Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
  - getRegisterEndpoints
```
public Boolean getRegisterEndpoints()
```
    Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
    
    Returns:
    
    Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
  - withRegisterEndpoints
```
public ImportJobRequest withRegisterEndpoints(Boolean registerEndpoints)
```
    Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
    
    Parameters:
    
    registerEndpoints - Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRegisterEndpoints
```
public Boolean isRegisterEndpoints()
```
    Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
    
    Returns:
    
    Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
  - withRoleArn
```
public ImportJobRequest withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Url
```
public void setS3Url(String s3Url)
```
    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
    
    The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
    
    Parameters:
    
    s3Url - The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
    
    The URL should be in the following format: s3://bucket-name/folder- name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
  - getS3Url
```
public String getS3Url()
```
    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
    
    The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
    
    Returns:
    
    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
    
    The URL should be in the following format: s3://bucket-name/folder -name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
  - withS3Url
```
public ImportJobRequest withS3Url(String s3Url)
```
    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
    
    The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
    
    Parameters:
    
    s3Url - The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
    
    The URL should be in the following format: s3://bucket-name/folder- name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentId
```
public void setSegmentId(String segmentId)
```
    The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
    
    Parameters:
    
    segmentId - The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
  - getSegmentId
```
public String getSegmentId()
```
    The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
    
    Returns:
    
    The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
  - withSegmentId
```
public ImportJobRequest withSegmentId(String segmentId)
```
    The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
    
    Parameters:
    
    segmentId - The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentName
```
public void setSegmentName(String segmentName)
```
    A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
    
    Parameters:
    
    segmentName - A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
  - getSegmentName
```
public String getSegmentName()
```
    A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
    
    Returns:
    
    A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
  - withSegmentName
```
public ImportJobRequest withSegmentName(String segmentName)
```
    A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
    
    Parameters:
    
    segmentName - A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
    
    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 ImportJobRequest 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.

AWS SDK for Java 1.x API Reference - 1.12.772

Class ImportJobRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImportJobRequest

Method Detail

setDefineSegment

getDefineSegment

withDefineSegment

isDefineSegment

setExternalId

getExternalId

withExternalId

setFormat

getFormat

withFormat

setFormat

withFormat

setRegisterEndpoints

getRegisterEndpoints

withRegisterEndpoints

isRegisterEndpoints

setRoleArn

getRoleArn

withRoleArn

setS3Url

getS3Url

withS3Url

setSegmentId

getSegmentId

withSegmentId

setSegmentName

getSegmentName

withSegmentName

toString

equals

hashCode

clone

marshall