Package software.amazon.awssdk.services.healthlake.model

Class CreateFhirDatastoreRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.healthlake.model.HealthLakeRequest

software.amazon.awssdk.services.healthlake.model.CreateFhirDatastoreRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFhirDatastoreRequest.Builder,CreateFhirDatastoreRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateFhirDatastoreRequest
extends HealthLakeRequest
implements ToCopyableBuilder<CreateFhirDatastoreRequest.Builder,CreateFhirDatastoreRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateFhirDatastoreRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateFhirDatastoreRequest.Builder	builder()
String	clientToken()	Optional user provided token used for ensuring idempotency.
String	datastoreName()	The user generated name for the data store.
FHIRVersion	datastoreTypeVersion()	The FHIR version of the data store.
String	datastoreTypeVersionAsString()	The FHIR version of the data store.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
IdentityProviderConfiguration	identityProviderConfiguration()	The configuration of the identity provider that you want to use for your data store.
PreloadDataConfig	preloadDataConfig()	Optional parameter to preload data upon creation of the data store.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFhirDatastoreRequest.Builder>	serializableBuilderClass()
SseConfiguration	sseConfiguration()	The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.
List<Tag>	tags()	Resource tags that are applied to a data store when it is created.
CreateFhirDatastoreRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

datastoreName

public final String datastoreName()

The user generated name for the data store.

Returns:

The user generated name for the data store.

datastoreTypeVersion

public final FHIRVersion datastoreTypeVersion()

The FHIR version of the data store. The only supported version is R4.

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

Returns:

The FHIR version of the data store. The only supported version is R4.

See Also:

FHIRVersion

datastoreTypeVersionAsString

public final String datastoreTypeVersionAsString()

The FHIR version of the data store. The only supported version is R4.

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

Returns:

The FHIR version of the data store. The only supported version is R4.

See Also:

FHIRVersion

sseConfiguration

public final SseConfiguration sseConfiguration()

The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.

Returns:

The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.

preloadDataConfig

public final PreloadDataConfig preloadDataConfig()

Optional parameter to preload data upon creation of the data store. Currently, the only supported preloaded data is synthetic data generated from Synthea.

Returns:

Optional parameter to preload data upon creation of the data store. Currently, the only supported preloaded data is synthetic data generated from Synthea.

clientToken

public final String clientToken()

Optional user provided token used for ensuring idempotency.

Returns:

Optional user provided token used for ensuring idempotency.

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 List<Tag> tags()

Resource tags that are applied to a data store when it is created.

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:

Resource tags that are applied to a data store when it is created.

identityProviderConfiguration

public final IdentityProviderConfiguration identityProviderConfiguration()

The configuration of the identity provider that you want to use for your data store.

Returns:

The configuration of the identity provider that you want to use for your data store.

toBuilder

public CreateFhirDatastoreRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFhirDatastoreRequest.Builder,CreateFhirDatastoreRequest>

Specified by:

toBuilder in class HealthLakeRequest

builder

public static CreateFhirDatastoreRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo