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

Class ListAccessPoliciesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAccessPoliciesRequest.Builder,ListAccessPoliciesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListAccessPoliciesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListAccessPoliciesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResource()	For responses, this returns true if the service returned a value for the Resource property.
Integer	maxResults()	An optional parameter that specifies the maximum number of results to return.
String	nextToken()	If your initial ListAccessPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListAccessPolicies operations, which returns results in the next page.
List<String>	resource()	Resource filters (can be collections or indexes) that policies can apply to.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListAccessPoliciesRequest.Builder>	serializableBuilderClass()
ListAccessPoliciesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AccessPolicyType	type()	The type of access policy.
String	typeAsString()	The type of access 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

maxResults

public final Integer maxResults()

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

Returns:

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

nextToken

public final String nextToken()

If your initial ListAccessPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListAccessPolicies operations, which returns results in the next page.

Returns:

If your initial ListAccessPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListAccessPolicies operations, which returns results in the next page.

hasResource

public final boolean hasResource()

For responses, this returns true if the service returned a value for the Resource 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.

resource

public final List<String> resource()

Resource filters (can be collections or indexes) that policies can apply to.

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 hasResource() method.

Returns:

Resource filters (can be collections or indexes) that policies can apply to.

type

public final AccessPolicyType type()

The type of access 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 access policy.

See Also:

AccessPolicyType

typeAsString

public final String typeAsString()

The type of access 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 access policy.

See Also:

AccessPolicyType

toBuilder

public ListAccessPoliciesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAccessPoliciesRequest.Builder,ListAccessPoliciesRequest>

Specified by:

toBuilder in class OpenSearchServerlessRequest

builder

public static ListAccessPoliciesRequest.Builder builder()

serializableBuilderClass

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