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

Class DescribeProvisioningTemplateResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iot.model.IotResponse

software.amazon.awssdk.services.iot.model.DescribeProvisioningTemplateResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeProvisioningTemplateResponse.Builder,DescribeProvisioningTemplateResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeProvisioningTemplateResponse
extends IotResponse
implements ToCopyableBuilder<DescribeProvisioningTemplateResponse.Builder,DescribeProvisioningTemplateResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeProvisioningTemplateResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeProvisioningTemplateResponse.Builder	builder()
Instant	creationDate()	The date when the provisioning template was created.
Integer	defaultVersionId()	The default fleet template version ID.
String	description()	The description of the provisioning template.
Boolean	enabled()	True if the provisioning template is enabled, otherwise false.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedDate()	The date when the provisioning template was last modified.
ProvisioningHook	preProvisioningHook()	Gets information about a pre-provisioned hook.
String	provisioningRoleArn()	The ARN of the role associated with the provisioning template.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeProvisioningTemplateResponse.Builder>	serializableBuilderClass()
String	templateArn()	The ARN of the provisioning template.
String	templateBody()	The JSON formatted contents of the provisioning template.
String	templateName()	The name of the provisioning template.
DescribeProvisioningTemplateResponse.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.services.iot.model.IotResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

templateArn

public final String templateArn()

The ARN of the provisioning template.

Returns:

The ARN of the provisioning template.

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.

creationDate

public final Instant creationDate()

The date when the provisioning template was created.

Returns:

The date when the provisioning template was created.

lastModifiedDate

public final Instant lastModifiedDate()

The date when the provisioning template was last modified.

Returns:

The date when the provisioning template was last modified.

defaultVersionId

public final Integer defaultVersionId()

The default fleet template version ID.

Returns:

The default fleet template version ID.

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 if the provisioning template is enabled, otherwise false.

Returns:

True if the provisioning template is enabled, otherwise false.

provisioningRoleArn

public final String provisioningRoleArn()

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

Returns:

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

preProvisioningHook

public final ProvisioningHook preProvisioningHook()

Gets information about a pre-provisioned hook.

Returns:

Gets information about a pre-provisioned hook.

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 DescribeProvisioningTemplateResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeProvisioningTemplateResponse.Builder,DescribeProvisioningTemplateResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeProvisioningTemplateResponse.Builder builder()

serializableBuilderClass

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