Class CreateIdNamespaceRequest

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

  • Method Details

    • idNamespaceName

      public final String idNamespaceName()

      The name of the ID namespace.

      Returns:
      The name of the ID namespace.

    • description

      public final String description()

      The description of the ID namespace.

      Returns:
      The description of the ID namespace.

    • hasInputSourceConfig

      public final boolean hasInputSourceConfig()
      For responses, this returns true if the service returned a value for the InputSourceConfig property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • inputSourceConfig

      public final List<IdNamespaceInputSource> inputSourceConfig()

      A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

      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 hasInputSourceConfig() method.

      Returns:
      A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

    • hasIdMappingWorkflowProperties

      public final boolean hasIdMappingWorkflowProperties()
      For responses, this returns true if the service returned a value for the IdMappingWorkflowProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • idMappingWorkflowProperties

      public final List<IdNamespaceIdMappingWorkflowProperties> idMappingWorkflowProperties()

      Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target.

      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 hasIdMappingWorkflowProperties() method.

      Returns:
      Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target.

    • type

      public final IdNamespaceType type()

      The type of ID namespace. There are two types: SOURCE and TARGET.

      The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

      The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

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

      Returns:
      The type of ID namespace. There are two types: SOURCE and TARGET.

      The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

      The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of ID namespace. There are two types: SOURCE and TARGET.

      The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

      The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

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

      Returns:
      The type of ID namespace. There are two types: SOURCE and TARGET.

      The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

      The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

      See Also:

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for this resource.

      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 hasTags() method.

      Returns:
      The tags used to organize, track, or control access for this resource.

    • toBuilder

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

    • builder

      public static CreateIdNamespaceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateIdNamespaceRequest.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.