com.amazonaws.services.iot.model.CreateProvisioningTemplateRequest Maven / Gradle / Ivy
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.iot.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateProvisioningTemplateRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the fleet provisioning template.
*
*/
private String templateName;
/**
*
* The description of the fleet provisioning template.
*
*/
private String description;
/**
*
* The JSON formatted contents of the fleet provisioning template.
*
*/
private String templateBody;
/**
*
* True to enable the fleet provisioning template, otherwise false.
*
*/
private Boolean enabled;
/**
*
* The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to
* provision a device.
*
*/
private String provisioningRoleArn;
/**
*
* Creates a pre-provisioning hook template.
*
*/
private ProvisioningHook preProvisioningHook;
/**
*
* Metadata which can be used to manage the fleet 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..."
*
*
*/
private java.util.List tags;
/**
*
* The name of the fleet provisioning template.
*
*
* @param templateName
* The name of the fleet provisioning template.
*/
public void setTemplateName(String templateName) {
this.templateName = templateName;
}
/**
*
* The name of the fleet provisioning template.
*
*
* @return The name of the fleet provisioning template.
*/
public String getTemplateName() {
return this.templateName;
}
/**
*
* The name of the fleet provisioning template.
*
*
* @param templateName
* The name of the fleet provisioning template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProvisioningTemplateRequest withTemplateName(String templateName) {
setTemplateName(templateName);
return this;
}
/**
*
* The description of the fleet provisioning template.
*
*
* @param description
* The description of the fleet provisioning template.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the fleet provisioning template.
*
*
* @return The description of the fleet provisioning template.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the fleet provisioning template.
*
*
* @param description
* The description of the fleet provisioning template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProvisioningTemplateRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The JSON formatted contents of the fleet provisioning template.
*
*
* @param templateBody
* The JSON formatted contents of the fleet provisioning template.
*/
public void setTemplateBody(String templateBody) {
this.templateBody = templateBody;
}
/**
*
* The JSON formatted contents of the fleet provisioning template.
*
*
* @return The JSON formatted contents of the fleet provisioning template.
*/
public String getTemplateBody() {
return this.templateBody;
}
/**
*
* The JSON formatted contents of the fleet provisioning template.
*
*
* @param templateBody
* The JSON formatted contents of the fleet provisioning template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProvisioningTemplateRequest withTemplateBody(String templateBody) {
setTemplateBody(templateBody);
return this;
}
/**
*
* True to enable the fleet provisioning template, otherwise false.
*
*
* @param enabled
* True to enable the fleet provisioning template, otherwise false.
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
*
* True to enable the fleet provisioning template, otherwise false.
*
*
* @return True to enable the fleet provisioning template, otherwise false.
*/
public Boolean getEnabled() {
return this.enabled;
}
/**
*
* True to enable the fleet provisioning template, otherwise false.
*
*
* @param enabled
* True to enable the fleet provisioning template, otherwise false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProvisioningTemplateRequest withEnabled(Boolean enabled) {
setEnabled(enabled);
return this;
}
/**
*
* True to enable the fleet provisioning template, otherwise false.
*
*
* @return True to enable the fleet provisioning template, otherwise false.
*/
public Boolean isEnabled() {
return this.enabled;
}
/**
*
* The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to
* provision a device.
*
*
* @param provisioningRoleArn
* The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission
* to provision a device.
*/
public void setProvisioningRoleArn(String provisioningRoleArn) {
this.provisioningRoleArn = provisioningRoleArn;
}
/**
*
* The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to
* provision a device.
*
*
* @return The role ARN for the role associated with the fleet provisioning template. This IoT role grants
* permission to provision a device.
*/
public String getProvisioningRoleArn() {
return this.provisioningRoleArn;
}
/**
*
* The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to
* provision a device.
*
*
* @param provisioningRoleArn
* The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission
* to provision a device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProvisioningTemplateRequest withProvisioningRoleArn(String provisioningRoleArn) {
setProvisioningRoleArn(provisioningRoleArn);
return this;
}
/**
*
* Creates a pre-provisioning hook template.
*
*
* @param preProvisioningHook
* Creates a pre-provisioning hook template.
*/
public void setPreProvisioningHook(ProvisioningHook preProvisioningHook) {
this.preProvisioningHook = preProvisioningHook;
}
/**
*
* Creates a pre-provisioning hook template.
*
*
* @return Creates a pre-provisioning hook template.
*/
public ProvisioningHook getPreProvisioningHook() {
return this.preProvisioningHook;
}
/**
*
* Creates a pre-provisioning hook template.
*
*
* @param preProvisioningHook
* Creates a pre-provisioning hook template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProvisioningTemplateRequest withPreProvisioningHook(ProvisioningHook preProvisioningHook) {
setPreProvisioningHook(preProvisioningHook);
return this;
}
/**
*
* Metadata which can be used to manage the fleet 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..."
*
*
*
* @return Metadata which can be used to manage the fleet 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..."
*
*/
public java.util.List getTags() {
return tags;
}
/**
*
* Metadata which can be used to manage the fleet 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..."
*
*
*
* @param tags
* Metadata which can be used to manage the fleet 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..."
*
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* Metadata which can be used to manage the fleet 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
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Metadata which can be used to manage the fleet 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..."
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProvisioningTemplateRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Metadata which can be used to manage the fleet 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..."
*
*
*
* @param tags
* Metadata which can be used to manage the fleet 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..."
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProvisioningTemplateRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTemplateName() != null)
sb.append("TemplateName: ").append(getTemplateName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getTemplateBody() != null)
sb.append("TemplateBody: ").append(getTemplateBody()).append(",");
if (getEnabled() != null)
sb.append("Enabled: ").append(getEnabled()).append(",");
if (getProvisioningRoleArn() != null)
sb.append("ProvisioningRoleArn: ").append(getProvisioningRoleArn()).append(",");
if (getPreProvisioningHook() != null)
sb.append("PreProvisioningHook: ").append(getPreProvisioningHook()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateProvisioningTemplateRequest == false)
return false;
CreateProvisioningTemplateRequest other = (CreateProvisioningTemplateRequest) obj;
if (other.getTemplateName() == null ^ this.getTemplateName() == null)
return false;
if (other.getTemplateName() != null && other.getTemplateName().equals(this.getTemplateName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getTemplateBody() == null ^ this.getTemplateBody() == null)
return false;
if (other.getTemplateBody() != null && other.getTemplateBody().equals(this.getTemplateBody()) == false)
return false;
if (other.getEnabled() == null ^ this.getEnabled() == null)
return false;
if (other.getEnabled() != null && other.getEnabled().equals(this.getEnabled()) == false)
return false;
if (other.getProvisioningRoleArn() == null ^ this.getProvisioningRoleArn() == null)
return false;
if (other.getProvisioningRoleArn() != null && other.getProvisioningRoleArn().equals(this.getProvisioningRoleArn()) == false)
return false;
if (other.getPreProvisioningHook() == null ^ this.getPreProvisioningHook() == null)
return false;
if (other.getPreProvisioningHook() != null && other.getPreProvisioningHook().equals(this.getPreProvisioningHook()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTemplateName() == null) ? 0 : getTemplateName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getTemplateBody() == null) ? 0 : getTemplateBody().hashCode());
hashCode = prime * hashCode + ((getEnabled() == null) ? 0 : getEnabled().hashCode());
hashCode = prime * hashCode + ((getProvisioningRoleArn() == null) ? 0 : getProvisioningRoleArn().hashCode());
hashCode = prime * hashCode + ((getPreProvisioningHook() == null) ? 0 : getPreProvisioningHook().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateProvisioningTemplateRequest clone() {
return (CreateProvisioningTemplateRequest) super.clone();
}
}