Package software.amazon.awssdk.services.s3control.model

Class Scope

java.lang.Object

software.amazon.awssdk.services.s3control.model.Scope

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Scope.Builder,Scope>

@Generated("software.amazon.awssdk:codegen")
public final class Scope
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Scope.Builder,Scope>

You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

For more information, see Manage the scope of your access points for directory buckets.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Scope.Builder

Method Summary

Modifier and Type	Method	Description
static Scope.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPermissions()	For responses, this returns true if the service returned a value for the Permissions property.
boolean	hasPrefixes()	For responses, this returns true if the service returned a value for the Prefixes property.
List<ScopePermission>	permissions()	You can include one or more API operations as permissions.
List<String>	permissionsAsStrings()	You can include one or more API operations as permissions.
List<String>	prefixes()	You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Scope.Builder>	serializableBuilderClass()
Scope.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasPrefixes

public final boolean hasPrefixes()

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

prefixes

public final List<String> prefixes()

You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.

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

Returns:

You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.

permissions

public final List<ScopePermission> permissions()

You can include one or more API operations as permissions.

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

Returns:

You can include one or more API operations as permissions.

hasPermissions

public final boolean hasPermissions()

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

permissionsAsStrings

public final List<String> permissionsAsStrings()

You can include one or more API operations as permissions.

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

Returns:

You can include one or more API operations as permissions.

toBuilder

public Scope.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Scope.Builder,Scope>

builder

public static Scope.Builder builder()

serializableBuilderClass

public static Class<? extends Scope.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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