Package software.amazon.awssdk.services.iotsitewise.model

Class CreateAccessPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest

software.amazon.awssdk.services.iotsitewise.model.CreateAccessPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAccessPolicyRequest.Builder,CreateAccessPolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAccessPolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
Identity	accessPolicyIdentity()	The identity for this access policy.
Permission	accessPolicyPermission()	The permission level for this access policy.
String	accessPolicyPermissionAsString()	The permission level for this access policy.
Resource	accessPolicyResource()	The IoT SiteWise Monitor resource for this access policy.
static CreateAccessPolicyRequest.Builder	builder()
String	clientToken()	A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAccessPolicyRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	A list of key-value pairs that contain metadata for the access policy.
CreateAccessPolicyRequest.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

accessPolicyIdentity

public final Identity accessPolicyIdentity()

The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.

Returns:

The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.

accessPolicyResource

public final Resource accessPolicyResource()

The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

Returns:

The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

accessPolicyPermission

public final Permission accessPolicyPermission()

The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

If the service returns an enum value that is not available in the current SDK version, accessPolicyPermission will return Permission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessPolicyPermissionAsString().

Returns:

The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

See Also:

Permission

accessPolicyPermissionAsString

public final String accessPolicyPermissionAsString()

The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

If the service returns an enum value that is not available in the current SDK version, accessPolicyPermission will return Permission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessPolicyPermissionAsString().

Returns:

The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

See Also:

Permission

clientToken

public final String clientToken()

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Returns:

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

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 Map<String,String> tags()

A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

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:

A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

toBuilder

public CreateAccessPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAccessPolicyRequest.Builder,CreateAccessPolicyRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static CreateAccessPolicyRequest.Builder builder()

serializableBuilderClass

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