Interface UploadEntityDefinitionsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UploadEntityDefinitionsRequest.Builder,UploadEntityDefinitionsRequest>, IoTThingsGraphRequest.Builder, SdkBuilder<UploadEntityDefinitionsRequest.Builder,UploadEntityDefinitionsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UploadEntityDefinitionsRequest

@Mutable
@NotThreadSafe
public static interface UploadEntityDefinitionsRequest.Builder
extends IoTThingsGraphRequest.Builder, SdkPojo, CopyableBuilder<UploadEntityDefinitionsRequest.Builder,UploadEntityDefinitionsRequest>

Method Summary

Modifier and Type	Method	Description
UploadEntityDefinitionsRequest.Builder	deprecateExistingEntities(Boolean deprecateExistingEntities)	A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument.
default UploadEntityDefinitionsRequest.Builder	document(Consumer<DefinitionDocument.Builder> document)	The DefinitionDocument that defines the updated entities.
UploadEntityDefinitionsRequest.Builder	document(DefinitionDocument document)	The DefinitionDocument that defines the updated entities.
UploadEntityDefinitionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UploadEntityDefinitionsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UploadEntityDefinitionsRequest.Builder	syncWithPublicNamespace(Boolean syncWithPublicNamespace)	A Boolean that specifies whether to synchronize with the latest version of the public namespace.

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.iotthingsgraph.model.IoTThingsGraphRequest.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

document

UploadEntityDefinitionsRequest.Builder document(DefinitionDocument document)

The DefinitionDocument that defines the updated entities.

Parameters:

document - The DefinitionDocument that defines the updated entities.

Returns:

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

document

default UploadEntityDefinitionsRequest.Builder document(Consumer<DefinitionDocument.Builder> document)

The DefinitionDocument that defines the updated entities.

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

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

Parameters:

document - a consumer that will call methods on DefinitionDocument.Builder

Returns:

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

See Also:

• document(DefinitionDocument)

syncWithPublicNamespace

UploadEntityDefinitionsRequest.Builder syncWithPublicNamespace(Boolean syncWithPublicNamespace)

A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.

Parameters:

syncWithPublicNamespace - A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.

Returns:

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

deprecateExistingEntities

UploadEntityDefinitionsRequest.Builder deprecateExistingEntities(Boolean deprecateExistingEntities)

A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument. If set to true, the upload will create a new namespace version.

Parameters:

deprecateExistingEntities - A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument. If set to true, the upload will create a new namespace version.

Returns:

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

overrideConfiguration

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

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