Package software.amazon.awssdk.services.cloudwatchlogs.model

Class LogFieldType

java.lang.Object

software.amazon.awssdk.services.cloudwatchlogs.model.LogFieldType

All Implemented Interfaces:

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

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

Defines the data type structure for a log field, including the type, element information, and nested fields for complex types.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LogFieldType.Builder

Method Summary

Modifier and Type	Method	Description
static LogFieldType.Builder	builder()
LogFieldType	element()	For array or collection types, specifies the element type information.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<LogFieldsListItem>	fields()	For complex types, contains the nested field definitions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFields()	For responses, this returns true if the service returned a value for the Fields property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends LogFieldType.Builder>	serializableBuilderClass()
LogFieldType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The data type of the log field.

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

type

public final String type()

The data type of the log field.

Returns:

The data type of the log field.

element

public final LogFieldType element()

For array or collection types, specifies the element type information.

Returns:

For array or collection types, specifies the element type information.

hasFields

public final boolean hasFields()

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

fields

public final List<LogFieldsListItem> fields()

For complex types, contains the nested field definitions.

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

Returns:

For complex types, contains the nested field definitions.

toBuilder

public LogFieldType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LogFieldType.Builder,LogFieldType>

builder

public static LogFieldType.Builder builder()

serializableBuilderClass

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