Package software.amazon.awssdk.services.pinpoint.model

Class ImportJobRequest

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.ImportJobRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ImportJobRequest.Builder,ImportJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class ImportJobRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ImportJobRequest.Builder,ImportJobRequest>

Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

See Also:

  • Method Details

    • defineSegment

      public final Boolean defineSegment()

      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.

    • externalId

      public final 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.

      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.

    • format

      public final 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.

      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 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:

    • formatAsString

      public final String formatAsString()

      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.

      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 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:

    • registerEndpoints

      public final Boolean registerEndpoints()

      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.

    • roleArn

      public final 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.

      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.

    • s3Url

      public final 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.

      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.

    • segmentId

      public final 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.

      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.

    • segmentName

      public final String segmentName()

      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.

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.