Skip to content

Javadoc incorrect for DocumentTableSchema #3929

Closed
@tkhill-AWS

Description

@tkhill-AWS

Describe the issue

The following appears in the introductory description of the Javadoc:

DocumentTableSchema specifying primaryKey, sortKey and a customAttributeConverter can be created as below

 DocumentTableSchema documentTableSchema = DocumentTableSchema.builder()
 .primaryKey("sampleHashKey", AttributeValueType.S)
 .sortKey("sampleSortKey", AttributeValueType.S)
 .attributeConverterProviders(customAttributeConverter, AttributeConverterProvider.defaultProvider())
 .build();

However, if you look at the DocumentTableSchema.Builder documentation, the method names are different:

  • addIndexPartitionKey() (not primaryKey())
  • addIndexSortKeyy() (not sortKey())

The description should be fixed to use the actual method names.

Links

DocumentTableSchema

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationThis is a problem with documentation.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions