Class GetEventDataStoreResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.cloudtrail.model.CloudTrailResponse
-
- software.amazon.awssdk.services.cloudtrail.model.GetEventDataStoreResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetEventDataStoreResponse.Builder,GetEventDataStoreResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetEventDataStoreResponse extends CloudTrailResponse implements ToCopyableBuilder<GetEventDataStoreResponse.Builder,GetEventDataStoreResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetEventDataStoreResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AdvancedEventSelector>advancedEventSelectors()The advanced event selectors used to select events for the data store.BillingModebillingMode()The billing mode for the event data store.StringbillingModeAsString()The billing mode for the event data store.static GetEventDataStoreResponse.Builderbuilder()InstantcreatedTimestamp()The timestamp of the event data store's creation.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventDataStoreArn()The event data store Amazon Resource Number (ARN).StringfederationRoleArn()If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.FederationStatusfederationStatus()Indicates the Lake query federation status.StringfederationStatusAsString()Indicates the Lake query federation status.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAdvancedEventSelectors()For responses, this returns true if the service returned a value for the AdvancedEventSelectors property.inthashCode()booleanhasPartitionKeys()For responses, this returns true if the service returned a value for the PartitionKeys property.StringkmsKeyId()Specifies the KMS key ID that encrypts the events delivered by CloudTrail.BooleanmultiRegionEnabled()Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.Stringname()The name of the event data store.BooleanorganizationEnabled()Indicates whether an event data store is collecting logged events for an organization in Organizations.List<PartitionKey>partitionKeys()The partition keys for the event data store.IntegerretentionPeriod()The retention period of the event data store, in days.List<SdkField<?>>sdkFields()static Class<? extends GetEventDataStoreResponse.Builder>serializableBuilderClass()EventDataStoreStatusstatus()The status of an event data store.StringstatusAsString()The status of an event data store.BooleanterminationProtectionEnabled()Indicates that termination protection is enabled.GetEventDataStoreResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedTimestamp()Shows the time that an event data store was updated, if applicable.-
Methods inherited from class software.amazon.awssdk.services.cloudtrail.model.CloudTrailResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
eventDataStoreArn
public final String eventDataStoreArn()
The event data store Amazon Resource Number (ARN).
- Returns:
- The event data store Amazon Resource Number (ARN).
-
name
public final String name()
The name of the event data store.
- Returns:
- The name of the event data store.
-
status
public final EventDataStoreStatus status()
The status of an event data store.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnEventDataStoreStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of an event data store.
- See Also:
EventDataStoreStatus
-
statusAsString
public final String statusAsString()
The status of an event data store.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnEventDataStoreStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of an event data store.
- See Also:
EventDataStoreStatus
-
hasAdvancedEventSelectors
public final boolean hasAdvancedEventSelectors()
For responses, this returns true if the service returned a value for the AdvancedEventSelectors 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.
-
advancedEventSelectors
public final List<AdvancedEventSelector> advancedEventSelectors()
The advanced event selectors used to select events for the data store.
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
hasAdvancedEventSelectors()method.- Returns:
- The advanced event selectors used to select events for the data store.
-
multiRegionEnabled
public final Boolean multiRegionEnabled()
Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.
- Returns:
- Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.
-
organizationEnabled
public final Boolean organizationEnabled()
Indicates whether an event data store is collecting logged events for an organization in Organizations.
- Returns:
- Indicates whether an event data store is collecting logged events for an organization in Organizations.
-
retentionPeriod
public final Integer retentionPeriod()
The retention period of the event data store, in days.
- Returns:
- The retention period of the event data store, in days.
-
terminationProtectionEnabled
public final Boolean terminationProtectionEnabled()
Indicates that termination protection is enabled.
- Returns:
- Indicates that termination protection is enabled.
-
createdTimestamp
public final Instant createdTimestamp()
The timestamp of the event data store's creation.
- Returns:
- The timestamp of the event data store's creation.
-
updatedTimestamp
public final Instant updatedTimestamp()
Shows the time that an event data store was updated, if applicable.
UpdatedTimestampis always either the same or newer than the time shown inCreatedTimestamp.- Returns:
- Shows the time that an event data store was updated, if applicable.
UpdatedTimestampis always either the same or newer than the time shown inCreatedTimestamp.
-
kmsKeyId
public final String kmsKeyId()
Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012- Returns:
- Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified
ARN to a KMS key in the following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
-
billingMode
public final BillingMode billingMode()
The billing mode for the event data store.
If the service returns an enum value that is not available in the current SDK version,
billingModewill returnBillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frombillingModeAsString().- Returns:
- The billing mode for the event data store.
- See Also:
BillingMode
-
billingModeAsString
public final String billingModeAsString()
The billing mode for the event data store.
If the service returns an enum value that is not available in the current SDK version,
billingModewill returnBillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frombillingModeAsString().- Returns:
- The billing mode for the event data store.
- See Also:
BillingMode
-
federationStatus
public final FederationStatus federationStatus()
Indicates the Lake query federation status. The status is
ENABLEDif Lake query federation is enabled, orDISABLEDif Lake query federation is disabled. You cannot delete an event data store if theFederationStatusisENABLED.If the service returns an enum value that is not available in the current SDK version,
federationStatuswill returnFederationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfederationStatusAsString().- Returns:
- Indicates the Lake query
federation status. The status is
ENABLEDif Lake query federation is enabled, orDISABLEDif Lake query federation is disabled. You cannot delete an event data store if theFederationStatusisENABLED. - See Also:
FederationStatus
-
federationStatusAsString
public final String federationStatusAsString()
Indicates the Lake query federation status. The status is
ENABLEDif Lake query federation is enabled, orDISABLEDif Lake query federation is disabled. You cannot delete an event data store if theFederationStatusisENABLED.If the service returns an enum value that is not available in the current SDK version,
federationStatuswill returnFederationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfederationStatusAsString().- Returns:
- Indicates the Lake query
federation status. The status is
ENABLEDif Lake query federation is enabled, orDISABLEDif Lake query federation is disabled. You cannot delete an event data store if theFederationStatusisENABLED. - See Also:
FederationStatus
-
federationRoleArn
public final String federationRoleArn()
If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.
- Returns:
- If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.
-
hasPartitionKeys
public final boolean hasPartitionKeys()
For responses, this returns true if the service returned a value for the PartitionKeys 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.
-
partitionKeys
public final List<PartitionKey> partitionKeys()
The partition keys for the event data store. To improve query performance and efficiency, CloudTrail Lake organizes event data into partitions based on values derived from partition keys.
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
hasPartitionKeys()method.- Returns:
- The partition keys for the event data store. To improve query performance and efficiency, CloudTrail Lake organizes event data into partitions based on values derived from partition keys.
-
toBuilder
public GetEventDataStoreResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetEventDataStoreResponse.Builder,GetEventDataStoreResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetEventDataStoreResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetEventDataStoreResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-