Class StartDeviceDiscoveryRequest

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.StartDeviceDiscoveryRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartDeviceDiscoveryRequest.Builder,StartDeviceDiscoveryRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartDeviceDiscoveryRequest extends IotManagedIntegrationsRequest implements ToCopyableBuilder<StartDeviceDiscoveryRequest.Builder,StartDeviceDiscoveryRequest>

  • Method Details

    • discoveryType

      public final DiscoveryType discoveryType()

      The discovery type supporting the type of device to be discovered in the device discovery task request.

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

      Returns:
      The discovery type supporting the type of device to be discovered in the device discovery task request.
      See Also:

    • discoveryTypeAsString

      public final String discoveryTypeAsString()

      The discovery type supporting the type of device to be discovered in the device discovery task request.

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

      Returns:
      The discovery type supporting the type of device to be discovered in the device discovery task request.
      See Also:

    • hasCustomProtocolDetail

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

    • customProtocolDetail

      public final Map<String,String> customProtocolDetail()

      Additional protocol-specific details required for device discovery, which vary based on the discovery type.

      For a DiscoveryType of CUSTOM, the string-to-string map must have a key value of Name set to a non-empty-string.

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

      Returns:
      Additional protocol-specific details required for device discovery, which vary based on the discovery type.

      For a DiscoveryType of CUSTOM, the string-to-string map must have a key value of Name set to a non-empty-string.

    • controllerIdentifier

      public final String controllerIdentifier()

      The id of the end-user's IoT hub.

      Returns:
      The id of the end-user's IoT hub.

    • connectorAssociationIdentifier

      @Deprecated public final String connectorAssociationIdentifier()
      Deprecated.
      ConnectorAssociationIdentifier is deprecated

      The id of the connector association.

      Returns:
      The id of the connector association.

    • accountAssociationId

      public final String accountAssociationId()

      The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.

      Returns:
      The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.

    • authenticationMaterial

      public final String authenticationMaterial()

      The authentication material required to start the local device discovery job request.

      Returns:
      The authentication material required to start the local device discovery job request.

    • authenticationMaterialType

      public final DiscoveryAuthMaterialType authenticationMaterialType()

      The type of authentication material used for device discovery jobs.

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

      Returns:
      The type of authentication material used for device discovery jobs.
      See Also:

    • authenticationMaterialTypeAsString

      public final String authenticationMaterialTypeAsString()

      The type of authentication material used for device discovery jobs.

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

      Returns:
      The type of authentication material used for device discovery jobs.
      See Also:

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

    • hasTags

      @Deprecated public final boolean hasTags()
      Deprecated.
      Tags have been deprecated from this api
      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

      @Deprecated public final Map<String,String> tags()
      Deprecated.
      Tags have been deprecated from this api

      A set of key/value pairs that are used to manage the device discovery request.

      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 device discovery request.

    • toBuilder

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

    • builder

      public static StartDeviceDiscoveryRequest.Builder builder()

    • serializableBuilderClass

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