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

Class GetComponentTypeResponse

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

  • Method Details

    • workspaceId

      public final String workspaceId()

      The ID of the workspace that contains the component type.

      Returns:
      The ID of the workspace that contains the component type.

    • isSingleton

      public final Boolean isSingleton()

      A Boolean value that specifies whether an entity can have more than one component of this type.

      Returns:
      A Boolean value that specifies whether an entity can have more than one component of this type.

    • componentTypeId

      public final String componentTypeId()

      The ID of the component type.

      Returns:
      The ID of the component type.

    • description

      public final String description()

      The description of the component type.

      Returns:
      The description of the component type.

    • hasPropertyDefinitions

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

    • propertyDefinitions

      public final Map<String,PropertyDefinitionResponse> propertyDefinitions()

      An object that maps strings to the property definitions in the component type. 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 hasPropertyDefinitions() method.

      Returns:
      An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

    • hasExtendsFrom

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

    • extendsFrom

      public final List<String> extendsFrom()

      The name of the parent component type that this component type extends.

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

      Returns:
      The name of the parent component type that this component type extends.

    • hasFunctions

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

    • functions

      public final Map<String,FunctionResponse> functions()

      An object that maps strings to the functions in the component type. 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 hasFunctions() method.

      Returns:
      An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

    • creationDateTime

      public final Instant creationDateTime()

      The date and time when the component type was created.

      Returns:
      The date and time when the component type was created.

    • updateDateTime

      public final Instant updateDateTime()

      The date and time when the component was last updated.

      Returns:
      The date and time when the component was last updated.

    • arn

      public final String arn()

      The ARN of the component type.

      Returns:
      The ARN of the component type.

    • isAbstract

      public final Boolean isAbstract()

      A Boolean value that specifies whether the component type is abstract.

      Returns:
      A Boolean value that specifies whether the component type is abstract.

    • isSchemaInitialized

      public final Boolean isSchemaInitialized()

      A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

      Returns:
      A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

    • status

      public final Status status()

      The current status of the component type.

      Returns:
      The current status of the component type.

    • hasPropertyGroups

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

    • propertyGroups

      public final Map<String,PropertyGroupResponse> propertyGroups()

      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

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

      Returns:
      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

    • syncSource

      public final String syncSource()

      The syncSource of the SyncJob, if this entity was created by a SyncJob.

      Returns:
      The syncSource of the SyncJob, if this entity was created by a SyncJob.

    • componentTypeName

      public final String componentTypeName()

      The component type name.

      Returns:
      The component type name.

    • hasCompositeComponentTypes

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

    • compositeComponentTypes

      public final Map<String,CompositeComponentTypeResponse> compositeComponentTypes()

      This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.

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

      Returns:
      This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.

    • toBuilder

      public GetComponentTypeResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetComponentTypeResponse.Builder,GetComponentTypeResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static GetComponentTypeResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetComponentTypeResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo