Interface CreateEntityRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateEntityRequest.Builder,CreateEntityRequest>, IoTTwinMakerRequest.Builder, SdkBuilder<CreateEntityRequest.Builder,CreateEntityRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateEntityRequest
@Mutable @NotThreadSafe public static interface CreateEntityRequest.Builder extends IoTTwinMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateEntityRequest.Builder,CreateEntityRequest>

  • Method Details

    • workspaceId

      CreateEntityRequest.Builder workspaceId(String workspaceId)

      The ID of the workspace that contains the entity.

      Parameters:
      workspaceId - The ID of the workspace that contains the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entityId

      CreateEntityRequest.Builder entityId(String entityId)

      The ID of the entity.

      Parameters:
      entityId - The ID of the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entityName

      CreateEntityRequest.Builder entityName(String entityName)

      The name of the entity.

      Parameters:
      entityName - The name of the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateEntityRequest.Builder description(String description)

      The description of the entity.

      Parameters:
      description - The description of the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • components

      CreateEntityRequest.Builder components(Map<String,ComponentRequest> components)

      An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

      Parameters:
      components - An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • compositeComponents

      CreateEntityRequest.Builder compositeComponents(Map<String,CompositeComponentRequest> compositeComponents)

      This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.

      Parameters:
      compositeComponents - This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parentEntityId

      CreateEntityRequest.Builder parentEntityId(String parentEntityId)

      The ID of the entity's parent entity.

      Parameters:
      parentEntityId - The ID of the entity's parent entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateEntityRequest.Builder tags(Map<String,String> tags)

      Metadata that you can use to manage the entity.

      Parameters:
      tags - Metadata that you can use to manage the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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