Interface UpdateImageSetMetadataRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateImageSetMetadataRequest.Builder,UpdateImageSetMetadataRequest>, MedicalImagingRequest.Builder, SdkBuilder<UpdateImageSetMetadataRequest.Builder,UpdateImageSetMetadataRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateImageSetMetadataRequest

@Mutable
@NotThreadSafe
public static interface UpdateImageSetMetadataRequest.Builder
extends MedicalImagingRequest.Builder, SdkPojo, CopyableBuilder<UpdateImageSetMetadataRequest.Builder,UpdateImageSetMetadataRequest>

Method Summary

Modifier and Type	Method	Description
UpdateImageSetMetadataRequest.Builder	datastoreId(String datastoreId)	The data store identifier.
UpdateImageSetMetadataRequest.Builder	force(Boolean force)	Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:
UpdateImageSetMetadataRequest.Builder	imageSetId(String imageSetId)	The image set identifier.
UpdateImageSetMetadataRequest.Builder	includeStudyImageSets(Boolean includeStudyImageSets)	Flag to apply the metadata updates to all image sets in the same Study as the requested image set ID.
UpdateImageSetMetadataRequest.Builder	latestVersionId(String latestVersionId)	The latest image set version identifier.
UpdateImageSetMetadataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateImageSetMetadataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default UpdateImageSetMetadataRequest.Builder	updateImageSetMetadataUpdates(Consumer<MetadataUpdates.Builder> updateImageSetMetadataUpdates)	Update image set metadata updates.
UpdateImageSetMetadataRequest.Builder	updateImageSetMetadataUpdates(MetadataUpdates updateImageSetMetadataUpdates)	Update image set metadata updates.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.medicalimaging.model.MedicalImagingRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

datastoreId

UpdateImageSetMetadataRequest.Builder datastoreId(String datastoreId)

The data store identifier.

Parameters:

datastoreId - The data store identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageSetId

UpdateImageSetMetadataRequest.Builder imageSetId(String imageSetId)

The image set identifier.

Parameters:

imageSetId - The image set identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

latestVersionId

UpdateImageSetMetadataRequest.Builder latestVersionId(String latestVersionId)

The latest image set version identifier.

Parameters:

latestVersionId - The latest image set version identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

force

UpdateImageSetMetadataRequest.Builder force(Boolean force)

Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:

• Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID, and Tag.StudyID

• Adding, removing, or updating private tags for an individual SOP Instance

Parameters:

force - Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:

• Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID , and Tag.StudyID

• Adding, removing, or updating private tags for an individual SOP Instance

Returns:

Returns a reference to this object so that method calls can be chained together.

includeStudyImageSets

UpdateImageSetMetadataRequest.Builder includeStudyImageSets(Boolean includeStudyImageSets)

Flag to apply the metadata updates to all image sets in the same Study as the requested image set ID.

Parameters:

includeStudyImageSets - Flag to apply the metadata updates to all image sets in the same Study as the requested image set ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

updateImageSetMetadataUpdates

UpdateImageSetMetadataRequest.Builder updateImageSetMetadataUpdates(MetadataUpdates updateImageSetMetadataUpdates)

Update image set metadata updates.

Parameters:

updateImageSetMetadataUpdates - Update image set metadata updates.

Returns:

Returns a reference to this object so that method calls can be chained together.

updateImageSetMetadataUpdates

default UpdateImageSetMetadataRequest.Builder updateImageSetMetadataUpdates(Consumer<MetadataUpdates.Builder> updateImageSetMetadataUpdates)

Update image set metadata updates.

This is a convenience method that creates an instance of the MetadataUpdates.Builder avoiding the need to create one manually via MetadataUpdates.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to updateImageSetMetadataUpdates(MetadataUpdates).

Parameters:

updateImageSetMetadataUpdates - a consumer that will call methods on MetadataUpdates.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• updateImageSetMetadataUpdates(MetadataUpdates)

overrideConfiguration

UpdateImageSetMetadataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateImageSetMetadataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.