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(value="software.amazon.awssdk:codegen")
public final class CreateAccessPolicyRequest
extends IoTSiteWiseRequest
implements ToCopyableBuilder<CreateAccessPolicyRequest.Builder,CreateAccessPolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAccessPolicyRequest.Builder

Method Summary

Modifier and Type	Method and 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 AWS 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() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 AWS SSO user, an AWS SSO group, or an IAM user.

Returns:

The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.

accessPolicyResource

public final Resource accessPolicyResource()

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

Returns:

The AWS 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()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your AWS IoT SiteWise resources in the AWS 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