software.amazon.awssdk.services.cloudwatchlogs.model

Class LogGroup

java.lang.Object

software.amazon.awssdk.services.cloudwatchlogs.model.LogGroup

All Implemented Interfaces:

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

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

Represents a log group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LogGroup.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the log group.
static LogGroup.Builder	builder()
Long	creationTime() The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
DataProtectionStatus	dataProtectionStatus() Displays whether this log group has a protection policy, or whether it had one in the past.
String	dataProtectionStatusAsString() Displays whether this log group has a protection policy, or whether it had one in the past.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInheritedProperties() For responses, this returns true if the service returned a value for the InheritedProperties property.
List<InheritedProperty>	inheritedProperties() Displays all the properties that this log group has inherited from account-level settings.
List<String>	inheritedPropertiesAsStrings() Displays all the properties that this log group has inherited from account-level settings.
String	kmsKeyId() The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
String	logGroupName() The name of the log group.
Integer	metricFilterCount() The number of metric filters.
Integer	retentionInDays() Returns the value of the RetentionInDays property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends LogGroup.Builder>	serializableBuilderClass()
Long	storedBytes() The number of bytes stored.
LogGroup.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

logGroupName

public final String logGroupName()

The name of the log group.

Returns:

The name of the log group.

creationTime

public final Long creationTime()

The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Returns:

The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

retentionInDays

public final Integer retentionInDays()

Returns the value of the RetentionInDays property for this object.

Returns:

The value of the RetentionInDays property for this object.

metricFilterCount

public final Integer metricFilterCount()

The number of metric filters.

Returns:

The number of metric filters.

arn

public final String arn()

The Amazon Resource Name (ARN) of the log group.

Returns:

The Amazon Resource Name (ARN) of the log group.

storedBytes

public final Long storedBytes()

The number of bytes stored.

Returns:

The number of bytes stored.

kmsKeyId

public final String kmsKeyId()

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.

Returns:

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.

dataProtectionStatus

public final DataProtectionStatus dataProtectionStatus()

Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.

If the service returns an enum value that is not available in the current SDK version, dataProtectionStatus will return DataProtectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataProtectionStatusAsString().

Returns:

Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.

See Also:

DataProtectionStatus

dataProtectionStatusAsString

public final String dataProtectionStatusAsString()

Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.

If the service returns an enum value that is not available in the current SDK version, dataProtectionStatus will return DataProtectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataProtectionStatusAsString().

Returns:

Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.

See Also:

DataProtectionStatus

inheritedProperties

public final List<InheritedProperty> inheritedProperties()

Displays all the properties that this log group has inherited from account-level settings.

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

Returns:

Displays all the properties that this log group has inherited from account-level settings.

hasInheritedProperties

public final boolean hasInheritedProperties()

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

inheritedPropertiesAsStrings

public final List<String> inheritedPropertiesAsStrings()

Displays all the properties that this log group has inherited from account-level settings.

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

Returns:

Displays all the properties that this log group has inherited from account-level settings.

toBuilder

public LogGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LogGroup.Builder,LogGroup>

builder

public static LogGroup.Builder builder()

serializableBuilderClass

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