software.amazon.awssdk.services.iot.model.CreateProvisioningTemplateRequest Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.iot.model;
import java.beans.Transient;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateProvisioningTemplateRequest extends IotRequest implements
ToCopyableBuilder {
private static final SdkField TEMPLATE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("templateName").getter(getter(CreateProvisioningTemplateRequest::templateName))
.setter(setter(Builder::templateName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("templateName").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreateProvisioningTemplateRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField TEMPLATE_BODY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("templateBody").getter(getter(CreateProvisioningTemplateRequest::templateBody))
.setter(setter(Builder::templateBody))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("templateBody").build()).build();
private static final SdkField ENABLED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("enabled").getter(getter(CreateProvisioningTemplateRequest::enabled)).setter(setter(Builder::enabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("enabled").build()).build();
private static final SdkField PROVISIONING_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("provisioningRoleArn").getter(getter(CreateProvisioningTemplateRequest::provisioningRoleArn))
.setter(setter(Builder::provisioningRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("provisioningRoleArn").build())
.build();
private static final SdkField PRE_PROVISIONING_HOOK_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("preProvisioningHook")
.getter(getter(CreateProvisioningTemplateRequest::preProvisioningHook)).setter(setter(Builder::preProvisioningHook))
.constructor(ProvisioningHook::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("preProvisioningHook").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateProvisioningTemplateRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TEMPLATE_NAME_FIELD,
DESCRIPTION_FIELD, TEMPLATE_BODY_FIELD, ENABLED_FIELD, PROVISIONING_ROLE_ARN_FIELD, PRE_PROVISIONING_HOOK_FIELD,
TAGS_FIELD));
private final String templateName;
private final String description;
private final String templateBody;
private final Boolean enabled;
private final String provisioningRoleArn;
private final ProvisioningHook preProvisioningHook;
private final List tags;
private CreateProvisioningTemplateRequest(BuilderImpl builder) {
super(builder);
this.templateName = builder.templateName;
this.description = builder.description;
this.templateBody = builder.templateBody;
this.enabled = builder.enabled;
this.provisioningRoleArn = builder.provisioningRoleArn;
this.preProvisioningHook = builder.preProvisioningHook;
this.tags = builder.tags;
}
/**
*
* The name of the fleet provisioning template.
*
*
* @return The name of the fleet provisioning template.
*/
public final String templateName() {
return templateName;
}
/**
*
* The description of the fleet provisioning template.
*
*
* @return The description of the fleet provisioning template.
*/
public final String description() {
return description;
}
/**
*
* The JSON formatted contents of the fleet provisioning template.
*
*
* @return The JSON formatted contents of the fleet provisioning template.
*/
public final String templateBody() {
return templateBody;
}
/**
*
* True to enable the fleet provisioning template, otherwise false.
*
*
* @return True to enable the fleet provisioning template, otherwise false.
*/
public final Boolean enabled() {
return enabled;
}
/**
*
* 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 final String provisioningRoleArn() {
return provisioningRoleArn;
}
/**
*
* Creates a pre-provisioning hook template.
*
*
* @return Creates a pre-provisioning hook template.
*/
public final ProvisioningHook preProvisioningHook() {
return preProvisioningHook;
}
/**
* 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 {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* 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..."
*
*
*
* 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 {@link #hasTags} method.
*
*
* @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 final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(templateName());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(templateBody());
hashCode = 31 * hashCode + Objects.hashCode(enabled());
hashCode = 31 * hashCode + Objects.hashCode(provisioningRoleArn());
hashCode = 31 * hashCode + Objects.hashCode(preProvisioningHook());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateProvisioningTemplateRequest)) {
return false;
}
CreateProvisioningTemplateRequest other = (CreateProvisioningTemplateRequest) obj;
return Objects.equals(templateName(), other.templateName()) && Objects.equals(description(), other.description())
&& Objects.equals(templateBody(), other.templateBody()) && Objects.equals(enabled(), other.enabled())
&& Objects.equals(provisioningRoleArn(), other.provisioningRoleArn())
&& Objects.equals(preProvisioningHook(), other.preProvisioningHook()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateProvisioningTemplateRequest").add("TemplateName", templateName())
.add("Description", description()).add("TemplateBody", templateBody()).add("Enabled", enabled())
.add("ProvisioningRoleArn", provisioningRoleArn()).add("PreProvisioningHook", preProvisioningHook())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "templateName":
return Optional.ofNullable(clazz.cast(templateName()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "templateBody":
return Optional.ofNullable(clazz.cast(templateBody()));
case "enabled":
return Optional.ofNullable(clazz.cast(enabled()));
case "provisioningRoleArn":
return Optional.ofNullable(clazz.cast(provisioningRoleArn()));
case "preProvisioningHook":
return Optional.ofNullable(clazz.cast(preProvisioningHook()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateProvisioningTemplateRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder templateName(String templateName);
/**
*
* 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.
*/
Builder description(String description);
/**
*
* 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.
*/
Builder templateBody(String templateBody);
/**
*
* 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.
*/
Builder enabled(Boolean 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder provisioningRoleArn(String provisioningRoleArn);
/**
*
* 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.
*/
Builder preProvisioningHook(ProvisioningHook preProvisioningHook);
/**
*
* Creates a pre-provisioning hook template.
*
* This is a convenience that creates an instance of the {@link ProvisioningHook.Builder} avoiding the need to
* create one manually via {@link ProvisioningHook#builder()}.
*
* When the {@link Consumer} completes, {@link ProvisioningHook.Builder#build()} is called immediately and its
* result is passed to {@link #preProvisioningHook(ProvisioningHook)}.
*
* @param preProvisioningHook
* a consumer that will call methods on {@link ProvisioningHook.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #preProvisioningHook(ProvisioningHook)
*/
default Builder preProvisioningHook(Consumer preProvisioningHook) {
return preProvisioningHook(ProvisioningHook.builder().applyMutation(preProvisioningHook).build());
}
/**
*
* 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.
*/
Builder tags(Collection 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..."
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... 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..."
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IotRequest.BuilderImpl implements Builder {
private String templateName;
private String description;
private String templateBody;
private Boolean enabled;
private String provisioningRoleArn;
private ProvisioningHook preProvisioningHook;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateProvisioningTemplateRequest model) {
super(model);
templateName(model.templateName);
description(model.description);
templateBody(model.templateBody);
enabled(model.enabled);
provisioningRoleArn(model.provisioningRoleArn);
preProvisioningHook(model.preProvisioningHook);
tags(model.tags);
}
public final String getTemplateName() {
return templateName;
}
public final void setTemplateName(String templateName) {
this.templateName = templateName;
}
@Override
@Transient
public final Builder templateName(String templateName) {
this.templateName = templateName;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
@Transient
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getTemplateBody() {
return templateBody;
}
public final void setTemplateBody(String templateBody) {
this.templateBody = templateBody;
}
@Override
@Transient
public final Builder templateBody(String templateBody) {
this.templateBody = templateBody;
return this;
}
public final Boolean getEnabled() {
return enabled;
}
public final void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
@Override
@Transient
public final Builder enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
public final String getProvisioningRoleArn() {
return provisioningRoleArn;
}
public final void setProvisioningRoleArn(String provisioningRoleArn) {
this.provisioningRoleArn = provisioningRoleArn;
}
@Override
@Transient
public final Builder provisioningRoleArn(String provisioningRoleArn) {
this.provisioningRoleArn = provisioningRoleArn;
return this;
}
public final ProvisioningHook.Builder getPreProvisioningHook() {
return preProvisioningHook != null ? preProvisioningHook.toBuilder() : null;
}
public final void setPreProvisioningHook(ProvisioningHook.BuilderImpl preProvisioningHook) {
this.preProvisioningHook = preProvisioningHook != null ? preProvisioningHook.build() : null;
}
@Override
@Transient
public final Builder preProvisioningHook(ProvisioningHook preProvisioningHook) {
this.preProvisioningHook = preProvisioningHook;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
@Transient
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateProvisioningTemplateRequest build() {
return new CreateProvisioningTemplateRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy