Package software.amazon.awssdk.services.opensearchserverless.model

Class CreateAccessPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opensearchserverless.model.OpenSearchServerlessRequest

software.amazon.awssdk.services.opensearchserverless.model.CreateAccessPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAccessPolicyRequest.Builder,CreateAccessPolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAccessPolicyRequest
extends OpenSearchServerlessRequest
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
static CreateAccessPolicyRequest.Builder	builder()
String	clientToken()	Unique, case-sensitive identifier to ensure idempotency of the request.
String	description()	A description of the policy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the policy.
String	policy()	The JSON policy document to use as the content for the policy.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAccessPolicyRequest.Builder>	serializableBuilderClass()
CreateAccessPolicyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AccessPolicyType	type()	The type of policy.
String	typeAsString()	The type of policy.

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

clientToken

public final String clientToken()

Unique, case-sensitive identifier to ensure idempotency of the request.

Returns:

Unique, case-sensitive identifier to ensure idempotency of the request.

description

public final String description()

A description of the policy. Typically used to store information about the permissions defined in the policy.

Returns:

A description of the policy. Typically used to store information about the permissions defined in the policy.

name

public final String name()

The name of the policy.

Returns:

The name of the policy.

policy

public final String policy()

The JSON policy document to use as the content for the policy.

Returns:

The JSON policy document to use as the content for the policy.

type

public final AccessPolicyType type()

The type of policy.

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

Returns:

The type of policy.

See Also:

AccessPolicyType

typeAsString

public final String typeAsString()

The type of policy.

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

Returns:

The type of policy.

See Also:

AccessPolicyType

toBuilder

public CreateAccessPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAccessPolicyRequest.Builder,CreateAccessPolicyRequest>

Specified by:

toBuilder in class OpenSearchServerlessRequest

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo