com.amazonaws.services.iot.model

Class CreateProvisioningTemplateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateProvisioningTemplateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateProvisioningTemplateRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateProvisioningTemplateRequest()

Method Summary

Modifier and Type	Method and Description
CreateProvisioningTemplateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() The description of the provisioning template.
Boolean	getEnabled() True to enable the provisioning template, otherwise false.
ProvisioningHook	getPreProvisioningHook() Creates a pre-provisioning hook template.
String	getProvisioningRoleArn() The role ARN for the role associated with the provisioning template.
List<Tag>	getTags() Metadata which can be used to manage the provisioning template.
String	getTemplateBody() The JSON formatted contents of the provisioning template.
String	getTemplateName() The name of the provisioning template.
String	getType() The type you define in a provisioning template.
int	hashCode()
Boolean	isEnabled() True to enable the provisioning template, otherwise false.
void	setDescription(String description) The description of the provisioning template.
void	setEnabled(Boolean enabled) True to enable the provisioning template, otherwise false.
void	setPreProvisioningHook(ProvisioningHook preProvisioningHook) Creates a pre-provisioning hook template.
void	setProvisioningRoleArn(String provisioningRoleArn) The role ARN for the role associated with the provisioning template.
void	setTags(Collection<Tag> tags) Metadata which can be used to manage the provisioning template.
void	setTemplateBody(String templateBody) The JSON formatted contents of the provisioning template.
void	setTemplateName(String templateName) The name of the provisioning template.
void	setType(String type) The type you define in a provisioning template.
String	toString() Returns a string representation of this object.
CreateProvisioningTemplateRequest	withDescription(String description) The description of the provisioning template.
CreateProvisioningTemplateRequest	withEnabled(Boolean enabled) True to enable the provisioning template, otherwise false.
CreateProvisioningTemplateRequest	withPreProvisioningHook(ProvisioningHook preProvisioningHook) Creates a pre-provisioning hook template.
CreateProvisioningTemplateRequest	withProvisioningRoleArn(String provisioningRoleArn) The role ARN for the role associated with the provisioning template.
CreateProvisioningTemplateRequest	withTags(Collection<Tag> tags) Metadata which can be used to manage the provisioning template.
CreateProvisioningTemplateRequest	withTags(Tag... tags) Metadata which can be used to manage the provisioning template.
CreateProvisioningTemplateRequest	withTemplateBody(String templateBody) The JSON formatted contents of the provisioning template.
CreateProvisioningTemplateRequest	withTemplateName(String templateName) The name of the provisioning template.
CreateProvisioningTemplateRequest	withType(String type) The type you define in a provisioning template.
CreateProvisioningTemplateRequest	withType(TemplateType type) The type you define in a provisioning template.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateProvisioningTemplateRequest

public CreateProvisioningTemplateRequest()

Method Detail

setTemplateName

public void setTemplateName(String templateName)

The name of the provisioning template.

Parameters:

templateName - The name of the provisioning template.

getTemplateName

public String getTemplateName()

The name of the provisioning template.

Returns:

The name of the provisioning template.

withTemplateName

public CreateProvisioningTemplateRequest withTemplateName(String templateName)

The name of the provisioning template.

Parameters:

templateName - The name of the provisioning template.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description of the provisioning template.

Parameters:

description - The description of the provisioning template.

getDescription

public String getDescription()

The description of the provisioning template.

Returns:

The description of the provisioning template.

withDescription

public CreateProvisioningTemplateRequest withDescription(String description)

The description of the provisioning template.

Parameters:

description - The description of the provisioning template.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTemplateBody

public void setTemplateBody(String templateBody)

The JSON formatted contents of the provisioning template.

Parameters:

templateBody - The JSON formatted contents of the provisioning template.

getTemplateBody

public String getTemplateBody()

The JSON formatted contents of the provisioning template.

Returns:

The JSON formatted contents of the provisioning template.

withTemplateBody

public CreateProvisioningTemplateRequest withTemplateBody(String templateBody)

The JSON formatted contents of the provisioning template.

Parameters:

templateBody - The JSON formatted contents of the provisioning template.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnabled

public void setEnabled(Boolean enabled)

True to enable the provisioning template, otherwise false.

Parameters:

enabled - True to enable the provisioning template, otherwise false.

getEnabled

public Boolean getEnabled()

True to enable the provisioning template, otherwise false.

Returns:

True to enable the provisioning template, otherwise false.

withEnabled

public CreateProvisioningTemplateRequest withEnabled(Boolean enabled)

True to enable the provisioning template, otherwise false.

Parameters:

enabled - True to enable the provisioning template, otherwise false.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnabled

public Boolean isEnabled()

True to enable the provisioning template, otherwise false.

Returns:

True to enable the provisioning template, otherwise false.

setProvisioningRoleArn

public void setProvisioningRoleArn(String provisioningRoleArn)

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

Parameters:

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

getProvisioningRoleArn

public String getProvisioningRoleArn()

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.

withProvisioningRoleArn

public CreateProvisioningTemplateRequest withProvisioningRoleArn(String provisioningRoleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setPreProvisioningHook

public void setPreProvisioningHook(ProvisioningHook preProvisioningHook)

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

Parameters:

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

getPreProvisioningHook

public ProvisioningHook getPreProvisioningHook()

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.

withPreProvisioningHook

public CreateProvisioningTemplateRequest withPreProvisioningHook(ProvisioningHook preProvisioningHook)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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

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

setTags

public void setTags(Collection<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..."

Parameters:

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

withTags

public CreateProvisioningTemplateRequest withTags(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..."

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateProvisioningTemplateRequest withTags(Collection<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..."

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String 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.

Parameters:

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.

See Also:

TemplateType

getType

public String getType()

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.

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

withType

public CreateProvisioningTemplateRequest withType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TemplateType

withType

public CreateProvisioningTemplateRequest withType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TemplateType

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateProvisioningTemplateRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()