Class CreateProvisioningTemplateRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateProvisioningTemplateRequest.Builder,CreateProvisioningTemplateRequest>

@Generated("software.amazon.awssdk:codegen") public final class CreateProvisioningTemplateRequest extends IotRequest implements ToCopyableBuilder<CreateProvisioningTemplateRequest.Builder,CreateProvisioningTemplateRequest>
  • Method Details

    • templateName

      public final String templateName()

      The name of the provisioning template.

      Returns:
      The name of the provisioning template.
    • description

      public final String description()

      The description of the provisioning template.

      Returns:
      The description of the provisioning template.
    • templateBody

      public final String templateBody()

      The JSON formatted contents of the provisioning template.

      Returns:
      The JSON formatted contents of the provisioning template.
    • enabled

      public final Boolean enabled()

      True to enable the provisioning template, otherwise false.

      Returns:
      True to enable the provisioning template, otherwise false.
    • provisioningRoleArn

      public final String provisioningRoleArn()

      The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.

      Returns:
      The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.
    • preProvisioningHook

      public final ProvisioningHook preProvisioningHook()

      Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.

      Returns:
      Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.
    • 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 List<Tag> tags()

      Metadata which can be used to manage the provisioning template.

      For URI Request parameters use format: ...key1=value1&key2=value2...

      For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

      For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

      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 which can be used to manage the provisioning template.

      For URI Request parameters use format: ...key1=value1&key2=value2...

      For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

      For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

    • type

      public final TemplateType type()

      The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

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

      Returns:
      The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.
      See Also:
    • typeAsString

      public final String typeAsString()

      The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

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

      Returns:
      The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.
      See Also:
    • 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<CreateProvisioningTemplateRequest.Builder,CreateProvisioningTemplateRequest>
      Specified by:
      toBuilder in class IotRequest
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

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