Package 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("software.amazon.awssdk:codegen") public final class LogGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LogGroup.Builder,LogGroup>

Represents a log group.

See Also:

  • Method Details

    • 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. This version of the ARN includes a trailing :* after the log group name.

      Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for TagResource, UntagResource, and ListTagsForResource. The permissions for those three actions require the ARN version that doesn't include a trailing :*.

      Returns:
      The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a trailing :* after the log group name.

      Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for TagResource, UntagResource, and ListTagsForResource. The permissions for those three actions require the ARN version that doesn't include a trailing :*.

    • 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:

    • 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:

    • 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.

    • logGroupClass

      public final LogGroupClass logGroupClass()

      This specifies the log group class for this log group. There are two classes:

      • The Standard log class supports all CloudWatch Logs features.

      • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

      For details about the features supported by each class, see Log classes

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

      Returns:
      This specifies the log group class for this log group. There are two classes:

      • The Standard log class supports all CloudWatch Logs features.

      • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

      For details about the features supported by each class, see Log classes

      See Also:

    • logGroupClassAsString

      public final String logGroupClassAsString()

      This specifies the log group class for this log group. There are two classes:

      • The Standard log class supports all CloudWatch Logs features.

      • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

      For details about the features supported by each class, see Log classes

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

      Returns:
      This specifies the log group class for this log group. There are two classes:

      • The Standard log class supports all CloudWatch Logs features.

      • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

      For details about the features supported by each class, see Log classes

      See Also:

    • logGroupArn

      public final String logGroupArn()

      The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing :* after the log group name.

      Use this version to refer to the ARN in the following situations:

      Returns:
      The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing :* after the log group name.

      Use this version to refer to the ARN in the following situations:

    • toBuilder

      public LogGroup.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LogGroup.Builder,LogGroup>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.