Package software.amazon.awssdk.services.iot.model

Class CreateProvisioningTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateProvisioningTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateProvisioningTemplateRequest.Builder	builder()
String	description()	The description of the provisioning template.
Boolean	enabled()	True to enable the provisioning template, otherwise false.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
ProvisioningHook	preProvisioningHook()	Creates a pre-provisioning hook template.
String	provisioningRoleArn()	The role ARN for the role associated with the provisioning template.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateProvisioningTemplateRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Metadata which can be used to manage the provisioning template.
String	templateBody()	The JSON formatted contents of the provisioning template.
String	templateName()	The name of the provisioning template.
CreateProvisioningTemplateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TemplateType	type()	The type you define in a provisioning template.
String	typeAsString()	The type you define in a provisioning template.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

TemplateType

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:

TemplateType

toBuilder

public CreateProvisioningTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateProvisioningTemplateRequest.Builder,CreateProvisioningTemplateRequest>

Specified by:

toBuilder in class IotRequest

builder

public static CreateProvisioningTemplateRequest.Builder 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)

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 SdkRequest

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