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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceLogGroup.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the log group.static LogGroup.Builderbuilder()LongcreationTime()The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.DataProtectionStatusdataProtectionStatus()Displays whether this log group has a protection policy, or whether it had one in the past.StringdataProtectionStatusAsString()Displays whether this log group has a protection policy, or whether it had one in the past.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasInheritedProperties()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.StringkmsKeyId()The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.StringlogGroupArn()The Amazon Resource Name (ARN) of the log group.LogGroupClasslogGroupClass()This specifies the log group class for this log group.StringlogGroupClassAsString()This specifies the log group class for this log group.StringlogGroupName()The name of the log group.IntegermetricFilterCount()The number of metric filters.IntegerretentionInDays()Returns the value of the RetentionInDays property for this object.List<SdkField<?>>sdkFields()static Class<? extends LogGroup.Builder>serializableBuilderClass()LongstoredBytes()The number of bytes stored.LogGroup.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
-
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,
dataProtectionStatuswill returnDataProtectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataProtectionStatusAsString().- 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,
dataProtectionStatuswill returnDataProtectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataProtectionStatusAsString().- 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 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.
-
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
Standardlog class supports all CloudWatch Logs features. -
The
Infrequent Accesslog 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,
logGroupClasswill returnLogGroupClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlogGroupClassAsString().- Returns:
- This specifies the log group class for this log group. There are two classes:
-
The
Standardlog class supports all CloudWatch Logs features. -
The
Infrequent Accesslog 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:
LogGroupClass
-
-
logGroupClassAsString
public final String logGroupClassAsString()
This specifies the log group class for this log group. There are two classes:
-
The
Standardlog class supports all CloudWatch Logs features. -
The
Infrequent Accesslog 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,
logGroupClasswill returnLogGroupClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlogGroupClassAsString().- Returns:
- This specifies the log group class for this log group. There are two classes:
-
The
Standardlog class supports all CloudWatch Logs features. -
The
Infrequent Accesslog 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:
LogGroupClass
-
-
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:
-
In the
logGroupIdentifierinput field in many CloudWatch Logs APIs. -
In the
resourceArnfield in tagging APIs -
In IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.
- 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:
-
In the
logGroupIdentifierinput field in many CloudWatch Logs APIs. -
In the
resourceArnfield in tagging APIs -
In IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.
-
-
-
toBuilder
public LogGroup.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<LogGroup.Builder,LogGroup>
-
builder
public static LogGroup.Builder builder()
-
serializableBuilderClass
public static Class<? extends LogGroup.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.
-
-