Package software.amazon.awssdk.services.entityresolution.model

Class CreateIdNamespaceRequest

    • Method Detail

      • description

        public final String description()

        The description of the ID namespace.

        Returns:
        The description of the ID namespace.

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

      • idNamespaceName

        public final String idNamespaceName()

        The name of the ID namespace.

        Returns:
        The name 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.

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

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

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

      • 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