Class StartIdMappingJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartIdMappingJobRequest.Builder,
StartIdMappingJobRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OutputSourceConfig property.final JobType
jobType()
The job type for the ID mapping job.final String
The job type for the ID mapping job.final List
<IdMappingJobOutputSource> A list ofOutputSource
objects.static Class
<? extends StartIdMappingJobRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The name of the ID mapping job to be retrieved.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
workflowName
The name of the ID mapping job to be retrieved.
- Returns:
- The name of the ID mapping job to be retrieved.
-
hasOutputSourceConfig
public final boolean hasOutputSourceConfig()For responses, this returns true if the service returned a value for the OutputSourceConfig property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
outputSourceConfig
A list of
OutputSource
objects.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOutputSourceConfig()
method.- Returns:
- A list of
OutputSource
objects.
-
jobType
The job type for the ID mapping job.
If the
jobType
value is set toINCREMENTAL
, only new or changed data is processed since the last job run. This is the default value if theCreateIdMappingWorkflow
API is configured with anincrementalRunConfig
.If the
jobType
value is set toBATCH
, all data is processed from the input source, regardless of previous job runs. This is the default value if theCreateIdMappingWorkflow
API isn't configured with anincrementalRunConfig
.If the
jobType
value is set toDELETE_ONLY
, only deletion requests fromBatchDeleteUniqueIds
are processed.If the service returns an enum value that is not available in the current SDK version,
jobType
will returnJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- The job type for the ID mapping job.
If the
jobType
value is set toINCREMENTAL
, only new or changed data is processed since the last job run. This is the default value if theCreateIdMappingWorkflow
API is configured with anincrementalRunConfig
.If the
jobType
value is set toBATCH
, all data is processed from the input source, regardless of previous job runs. This is the default value if theCreateIdMappingWorkflow
API isn't configured with anincrementalRunConfig
.If the
jobType
value is set toDELETE_ONLY
, only deletion requests fromBatchDeleteUniqueIds
are processed. - See Also:
-
jobTypeAsString
The job type for the ID mapping job.
If the
jobType
value is set toINCREMENTAL
, only new or changed data is processed since the last job run. This is the default value if theCreateIdMappingWorkflow
API is configured with anincrementalRunConfig
.If the
jobType
value is set toBATCH
, all data is processed from the input source, regardless of previous job runs. This is the default value if theCreateIdMappingWorkflow
API isn't configured with anincrementalRunConfig
.If the
jobType
value is set toDELETE_ONLY
, only deletion requests fromBatchDeleteUniqueIds
are processed.If the service returns an enum value that is not available in the current SDK version,
jobType
will returnJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- The job type for the ID mapping job.
If the
jobType
value is set toINCREMENTAL
, only new or changed data is processed since the last job run. This is the default value if theCreateIdMappingWorkflow
API is configured with anincrementalRunConfig
.If the
jobType
value is set toBATCH
, all data is processed from the input source, regardless of previous job runs. This is the default value if theCreateIdMappingWorkflow
API isn't configured with anincrementalRunConfig
.If the
jobType
value is set toDELETE_ONLY
, only deletion requests fromBatchDeleteUniqueIds
are processed. - See Also:
-
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 interfaceToCopyableBuilder<StartIdMappingJobRequest.Builder,
StartIdMappingJobRequest> - Specified by:
toBuilder
in classEntityResolutionRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-