ImportJobResource (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ImportJobResource()

Constructors
Constructor and Description
`ImportJobResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImportJobResource`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getDefineSegment()` Sets whether the endpoints create a segment when they are imported.
`String`	`getExternalId()` A unique, custom ID assigned to the IAM role that restricts who can assume the role.
`String`	`getFormat()` The format of the files that contain the endpoint definitions.
`Boolean`	`getRegisterEndpoints()` Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
`String`	`getRoleArn()` 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`	`getS3Url()` A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import.
`String`	`getSegmentId()` The ID of the segment to update if the import job is meant to update an existing segment.
`String`	`getSegmentName()` A custom name for the segment created by the import job.
`int`	`hashCode()`
`Boolean`	`isDefineSegment()` Sets whether the endpoints create a segment when they are imported.
`Boolean`	`isRegisterEndpoints()` Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefineSegment(Boolean defineSegment)` Sets whether the endpoints create a segment when they are imported.
`void`	`setExternalId(String externalId)` A unique, custom ID assigned to the IAM role that restricts who can assume the role.
`void`	`setFormat(Format format)` The format of the files that contain the endpoint definitions.
`void`	`setFormat(String format)` The format of the files that contain the endpoint definitions.
`void`	`setRegisterEndpoints(Boolean registerEndpoints)` Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
`void`	`setRoleArn(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.
`void`	`setS3Url(String s3Url)` A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import.
`void`	`setSegmentId(String segmentId)` The ID of the segment to update if the import job is meant to update an existing segment.
`void`	`setSegmentName(String segmentName)` A custom name for the segment created by the import job.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ImportJobResource`	`withDefineSegment(Boolean defineSegment)` Sets whether the endpoints create a segment when they are imported.
`ImportJobResource`	`withExternalId(String externalId)` A unique, custom ID assigned to the IAM role that restricts who can assume the role.
`ImportJobResource`	`withFormat(Format format)` The format of the files that contain the endpoint definitions.
`ImportJobResource`	`withFormat(String format)` The format of the files that contain the endpoint definitions.
`ImportJobResource`	`withRegisterEndpoints(Boolean registerEndpoints)` Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
`ImportJobResource`	`withRoleArn(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.
`ImportJobResource`	`withS3Url(String s3Url)` A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import.
`ImportJobResource`	`withSegmentId(String segmentId)` The ID of the segment to update if the import job is meant to update an existing segment.
`ImportJobResource`	`withSegmentName(String segmentName)` A custom name for the segment created by the import job.

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

- Constructor Detail
  - ImportJobResource
```
public ImportJobResource()
```
- Method Detail
  - setDefineSegment
```
public void setDefineSegment(Boolean defineSegment)
```
    Sets whether the endpoints create a segment when they are imported.
    
    Parameters:
    
    defineSegment - Sets whether the endpoints create a segment when they are imported.
  - getDefineSegment
```
public Boolean getDefineSegment()
```
    Sets whether the endpoints create a segment when they are imported.
    
    Returns:
    
    Sets whether the endpoints create a segment when they are imported.
  - withDefineSegment
```
public ImportJobResource withDefineSegment(Boolean defineSegment)
```
    Sets whether the endpoints create a segment when they are imported.
    
    Parameters:
    
    defineSegment - Sets whether the endpoints create a segment when they are imported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDefineSegment
```
public Boolean isDefineSegment()
```
    Sets whether the endpoints create a segment when they are imported.
    
    Returns:
    
    Sets whether the endpoints create a segment when they are imported.
  - setExternalId
```
public void setExternalId(String externalId)
```
    A unique, custom ID assigned to the IAM role that restricts who can assume the role.
    
    Parameters:
    
    externalId - A unique, custom ID assigned to the IAM role that restricts who can assume the role.
  - getExternalId
```
public String getExternalId()
```
    A unique, custom ID assigned to the IAM role that restricts who can assume the role.
    
    Returns:
    
    A unique, custom ID assigned to the IAM role that restricts who can assume the role.
  - withExternalId
```
public ImportJobResource withExternalId(String externalId)
```
    A unique, custom ID assigned to the IAM role that restricts who can assume the role.
    
    Parameters:
    
    externalId - A unique, custom ID assigned to the IAM role that restricts who can assume the role.
    
    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. Valid values: CSV, JSON
    
    Parameters:
    
    format - The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    
    See Also:
    
    Format
  - getFormat
```
public String getFormat()
```
    The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    
    Returns:
    
    The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    
    See Also:
    
    Format
  - withFormat
```
public ImportJobResource withFormat(String format)
```
    The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    
    Parameters:
    
    format - The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    
    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. Valid values: CSV, JSON
    
    Parameters:
    
    format - The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    
    See Also:
    
    Format
  - withFormat
```
public ImportJobResource withFormat(Format format)
```
    The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    
    Parameters:
    
    format - The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Format
  - setRegisterEndpoints
```
public void setRegisterEndpoints(Boolean registerEndpoints)
```
    Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
    
    Parameters:
    
    registerEndpoints - Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
  - getRegisterEndpoints
```
public Boolean getRegisterEndpoints()
```
    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.
  - withRegisterEndpoints
```
public ImportJobResource withRegisterEndpoints(Boolean registerEndpoints)
```
    Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
    
    Parameters:
    
    registerEndpoints - Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRegisterEndpoints
```
public Boolean isRegisterEndpoints()
```
    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.
  - setRoleArn
```
public void setRoleArn(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.
    
    Parameters:
    
    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.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public ImportJobResource withRoleArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Url
```
public void setS3Url(String s3Url)
```
    A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3://bucket-name/folder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.
    
    Parameters:
    
    s3Url - A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3://bucket-name/folder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.
  - getS3Url
```
public String getS3Url()
```
    A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3://bucket-name/folder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.
    
    Returns:
    
    A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3://bucket-name/folder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.
  - withS3Url
```
public ImportJobResource withS3Url(String s3Url)
```
    A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3://bucket-name/folder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.
    
    Parameters:
    
    s3Url - A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3://bucket-name/folder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentId
```
public void setSegmentId(String segmentId)
```
    The ID of the segment to update if the import job is meant to update an existing segment.
    
    Parameters:
    
    segmentId - The ID of the segment to update if the import job is meant to update an existing segment.
  - getSegmentId
```
public String getSegmentId()
```
    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.
  - withSegmentId
```
public ImportJobResource withSegmentId(String segmentId)
```
    The ID of the segment to update if the import job is meant to update an existing segment.
    
    Parameters:
    
    segmentId - The ID of the segment to update 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 created by the import job. Use if DefineSegment is true.
    
    Parameters:
    
    segmentName - A custom name for the segment created by the import job. Use if DefineSegment is true.
  - getSegmentName
```
public String getSegmentName()
```
    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.
  - withSegmentName
```
public ImportJobResource withSegmentName(String segmentName)
```
    A custom name for the segment created by the import job. Use if DefineSegment is true.
    
    Parameters:
    
    segmentName - A custom name for the segment created by the import job. Use if DefineSegment 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; useful for testing and debugging.
    
    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 ImportJobResource 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 ImportJobResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImportJobResource

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