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

Class CreatePolicyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>

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

The input for the CreatePolicy operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePolicyRequest.Builder	builder()
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.
String	policyDocument()	The JSON document that describes the policy.
String	policyName()	The policy name.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePolicyRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Metadata which can be used to manage the policy.
CreatePolicyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

policyName

public final String policyName()

The policy name.

Returns:

The policy name.

policyDocument

public final String policyDocument()

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Returns:

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

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

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

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

toBuilder

public CreatePolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>

Specified by:

toBuilder in class IotRequest

builder

public static CreatePolicyRequest.Builder builder()

serializableBuilderClass

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