Package software.amazon.awssdk.services.iottwinmaker.model

Class CreateEntityRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iottwinmaker.model.IoTTwinMakerRequest
software.amazon.awssdk.services.iottwinmaker.model.CreateEntityRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateEntityRequest.Builder,CreateEntityRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEntityRequest extends IoTTwinMakerRequest implements ToCopyableBuilder<CreateEntityRequest.Builder,CreateEntityRequest>

  • Method Details

    • workspaceId

      public final String workspaceId()

      The ID of the workspace that contains the entity.

      Returns:
      The ID of the workspace that contains the entity.

    • entityId

      public final String entityId()

      The ID of the entity.

      Returns:
      The ID of the entity.

    • entityName

      public final String entityName()

      The name of the entity.

      Returns:
      The name of the entity.

    • description

      public final String description()

      The description of the entity.

      Returns:
      The description of the entity.

    • hasComponents

      public final boolean hasComponents()
      For responses, this returns true if the service returned a value for the Components 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.

    • components

      public final 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.

      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 hasComponents() method.

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

    • hasCompositeComponents

      public final boolean hasCompositeComponents()
      For responses, this returns true if the service returned a value for the CompositeComponents 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.

    • compositeComponents

      public final 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.

      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 hasCompositeComponents() method.

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

    • parentEntityId

      public final String parentEntityId()

      The ID of the entity's parent entity.

      Returns:
      The ID of the entity's parent entity.

    • 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 Map<String,String> tags()

      Metadata that you can use to manage the entity.

      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:
      Metadata that you can use to manage the entity.

    • toBuilder

      public CreateEntityRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateEntityRequest.Builder,CreateEntityRequest>
      Specified by:
      toBuilder in class IoTTwinMakerRequest
      Returns:
      a builder for type T

    • builder

      public static CreateEntityRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateEntityRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.