Package software.amazon.awssdk.services.lakeformation.model

Class LFTag

java.lang.Object

software.amazon.awssdk.services.lakeformation.model.LFTag

All Implemented Interfaces:

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

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

A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LFTag.Builder

Method Summary

Modifier and Type	Method	Description
static LFTag.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagValues()	For responses, this returns true if the service returned a value for the TagValues property.
List<SdkField<?>>	sdkFields()
static Class<? extends LFTag.Builder>	serializableBuilderClass()
String	tagKey()	The key-name for the LF-tag.
List<String>	tagValues()	A list of possible values an attribute can take.
LFTag.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

tagKey

public final String tagKey()

The key-name for the LF-tag.

Returns:

The key-name for the LF-tag.

hasTagValues

public final boolean hasTagValues()

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

tagValues

public final List<String> tagValues()

A list of possible values an attribute can take.

The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

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

Returns:

A list of possible values an attribute can take.

The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.

toBuilder

public LFTag.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LFTag.Builder,LFTag>

builder

public static LFTag.Builder builder()

serializableBuilderClass

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