Class CreateManagedThingRequest

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

  • Method Details

    • role

      public final Role role()

      The type of device used. This will be the hub controller, cloud device, or AWS IoT device.

      If the service returns an enum value that is not available in the current SDK version, role will return Role.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

      Returns:
      The type of device used. This will be the hub controller, cloud device, or AWS IoT device.
      See Also:

    • roleAsString

      public final String roleAsString()

      The type of device used. This will be the hub controller, cloud device, or AWS IoT device.

      If the service returns an enum value that is not available in the current SDK version, role will return Role.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

      Returns:
      The type of device used. This will be the hub controller, cloud device, or AWS IoT device.
      See Also:

    • owner

      public final String owner()

      Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

      Returns:
      Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

    • credentialLockerId

      public final String credentialLockerId()

      The identifier of the credential for the managed thing.

      Returns:
      The identifier of the credential for the managed thing.

    • authenticationMaterial

      public final String authenticationMaterial()

      The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.

      Returns:
      The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.

    • authenticationMaterialType

      public final AuthMaterialType authenticationMaterialType()

      The type of authentication material used for device connectivity setup requests.

      If the service returns an enum value that is not available in the current SDK version, authenticationMaterialType will return AuthMaterialType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationMaterialTypeAsString().

      Returns:
      The type of authentication material used for device connectivity setup requests.
      See Also:

    • authenticationMaterialTypeAsString

      public final String authenticationMaterialTypeAsString()

      The type of authentication material used for device connectivity setup requests.

      If the service returns an enum value that is not available in the current SDK version, authenticationMaterialType will return AuthMaterialType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationMaterialTypeAsString().

      Returns:
      The type of authentication material used for device connectivity setup requests.
      See Also:

    • serialNumber

      public final String serialNumber()

      The serial number of the device.

      Returns:
      The serial number of the device.

    • brand

      public final String brand()

      The brand of the device.

      Returns:
      The brand of the device.

    • model

      public final String model()

      The model of the device.

      Returns:
      The model of the device.

    • name

      public final String name()

      The name of the managed thing representing the physical device.

      Returns:
      The name of the managed thing representing the physical device.

    • capabilityReport

      public final CapabilityReport capabilityReport()

      A report of the capabilities for the managed thing.

      Returns:
      A report of the capabilities for the managed thing.

    • hasCapabilitySchemas

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

    • capabilitySchemas

      public final List<CapabilitySchemaItem> capabilitySchemas()

      The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.

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

      Returns:
      The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.

    • capabilities

      public final String capabilities()

      The capabilities of the device such as light bulb.

      Returns:
      The capabilities of the device such as light bulb.

    • clientToken

      public final String clientToken()

      An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

      Returns:
      An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    • classification

      public final String classification()

      The classification of the managed thing such as light bulb or thermostat.

      Returns:
      The classification of the managed thing such as light bulb or thermostat.

    • 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()

      A set of key/value pairs that are used to manage the managed thing.

      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:
      A set of key/value pairs that are used to manage the managed thing.

    • hasMetaData

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

    • metaData

      public final Map<String,String> metaData()

      The metadata for the managed thing.

      The managedThing metadata parameter is used for associating attributes with a managedThing that can be used for grouping over-the-air (OTA) tasks. Name value pairs in metadata can be used in the OtaTargetQueryString parameter for the CreateOtaTask API operation.

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

      Returns:
      The metadata for the managed thing.

      The managedThing metadata parameter is used for associating attributes with a managedThing that can be used for grouping over-the-air (OTA) tasks. Name value pairs in metadata can be used in the OtaTargetQueryString parameter for the CreateOtaTask API operation.

    • toBuilder

      public CreateManagedThingRequest.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<CreateManagedThingRequest.Builder,CreateManagedThingRequest>
      Specified by:
      toBuilder in class IotManagedIntegrationsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateManagedThingRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateManagedThingRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.