Class DataLakeSource
- java.lang.Object
-
- software.amazon.awssdk.services.securitylake.model.DataLakeSource
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DataLakeSource.Builder,DataLakeSource>
@Generated("software.amazon.awssdk:codegen") public final class DataLakeSource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataLakeSource.Builder,DataLakeSource>
Amazon Security Lake collects logs and events from supported Amazon Web Services services and custom sources. For the list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDataLakeSource.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringaccount()The ID of the Security Lake account for which logs are collected.static DataLakeSource.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<String>eventClasses()The Open Cybersecurity Schema Framework (OCSF) event classes describes the type of data that the custom source will send to Security Lake.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEventClasses()For responses, this returns true if the service returned a value for the EventClasses property.inthashCode()booleanhasSourceStatuses()For responses, this returns true if the service returned a value for the SourceStatuses property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DataLakeSource.Builder>serializableBuilderClass()StringsourceName()The supported Amazon Web Services services from which logs and events are collected.List<DataLakeSourceStatus>sourceStatuses()The log status for the Security Lake account.DataLakeSource.BuildertoBuilder()StringtoString()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
-
account
public final String account()
The ID of the Security Lake account for which logs are collected.
- Returns:
- The ID of the Security Lake account for which logs are collected.
-
hasEventClasses
public final boolean hasEventClasses()
For responses, this returns true if the service returned a value for the EventClasses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
eventClasses
public final List<String> eventClasses()
The Open Cybersecurity Schema Framework (OCSF) event classes describes the type of data that the custom source will send to Security Lake. For the list of supported event classes, see Supported OCSF Event classes in the Amazon Security Lake User Guide.
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
hasEventClasses()method.- Returns:
- The Open Cybersecurity Schema Framework (OCSF) event classes describes the type of data that the custom source will send to Security Lake. For the list of supported event classes, see Supported OCSF Event classes in the Amazon Security Lake User Guide.
-
sourceName
public final String sourceName()
The supported Amazon Web Services services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services.
- Returns:
- The supported Amazon Web Services services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services.
-
hasSourceStatuses
public final boolean hasSourceStatuses()
For responses, this returns true if the service returned a value for the SourceStatuses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
sourceStatuses
public final List<DataLakeSourceStatus> sourceStatuses()
The log status for the Security Lake account.
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
hasSourceStatuses()method.- Returns:
- The log status for the Security Lake account.
-
toBuilder
public DataLakeSource.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DataLakeSource.Builder,DataLakeSource>
-
builder
public static DataLakeSource.Builder builder()
-
serializableBuilderClass
public static Class<? extends DataLakeSource.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-