Class PopulateIdMappingTableRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cleanrooms.model.CleanRoomsRequest
software.amazon.awssdk.services.cleanrooms.model.PopulateIdMappingTableRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PopulateIdMappingTableRequest.Builder,PopulateIdMappingTableRequest>
@Generated("software.amazon.awssdk:codegen") public final class PopulateIdMappingTableRequest extends CleanRoomsRequest implements ToCopyableBuilder<PopulateIdMappingTableRequest.Builder,PopulateIdMappingTableRequest>

  • Method Details

    • idMappingTableIdentifier

      public final String idMappingTableIdentifier()

      The unique identifier of the ID mapping table that you want to populate.

      Returns:
      The unique identifier of the ID mapping table that you want to populate.

    • membershipIdentifier

      public final String membershipIdentifier()

      The unique identifier of the membership that contains the ID mapping table that you want to populate.

      Returns:
      The unique identifier of the membership that contains the ID mapping table that you want to populate.

    • jobType

      public final JobType jobType()

      The job type of the rule-based ID mapping job. Valid values include:

      INCREMENTAL: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in Entity Resolution with incrementalRunConfig specified.

      BATCH: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in Entity Resolution but incrementalRunConfig wasn't specified.

      DELETE_ONLY: Processes only deletion requests from BatchDeleteUniqueId, which is set in Entity Resolution.

      For more information about incrementalRunConfig and BatchDeleteUniqueId, see the Entity Resolution API Reference.

      If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

      Returns:
      The job type of the rule-based ID mapping job. Valid values include:

      INCREMENTAL: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in Entity Resolution with incrementalRunConfig specified.

      BATCH: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in Entity Resolution but incrementalRunConfig wasn't specified.

      DELETE_ONLY: Processes only deletion requests from BatchDeleteUniqueId, which is set in Entity Resolution.

      For more information about incrementalRunConfig and BatchDeleteUniqueId, see the Entity Resolution API Reference.

      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      The job type of the rule-based ID mapping job. Valid values include:

      INCREMENTAL: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in Entity Resolution with incrementalRunConfig specified.

      BATCH: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in Entity Resolution but incrementalRunConfig wasn't specified.

      DELETE_ONLY: Processes only deletion requests from BatchDeleteUniqueId, which is set in Entity Resolution.

      For more information about incrementalRunConfig and BatchDeleteUniqueId, see the Entity Resolution API Reference.

      If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

      Returns:
      The job type of the rule-based ID mapping job. Valid values include:

      INCREMENTAL: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in Entity Resolution with incrementalRunConfig specified.

      BATCH: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in Entity Resolution but incrementalRunConfig wasn't specified.

      DELETE_ONLY: Processes only deletion requests from BatchDeleteUniqueId, which is set in Entity Resolution.

      For more information about incrementalRunConfig and BatchDeleteUniqueId, see the Entity Resolution API Reference.

      See Also:

    • toBuilder

      public PopulateIdMappingTableRequest.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<PopulateIdMappingTableRequest.Builder,PopulateIdMappingTableRequest>
      Specified by:
      toBuilder in class CleanRoomsRequest
      Returns:
      a builder for type T

    • builder

      public static PopulateIdMappingTableRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PopulateIdMappingTableRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.