LogGroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.logs.model.LogGroup

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LogGroup
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents a log group.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LogGroup()

Constructors
Constructor and Description
`LogGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogGroup`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the log group.
`Long`	`getCreationTime()` The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`String`	`getDataProtectionStatus()` Displays whether this log group has a protection policy, or whether it had one in the past.
`List<String>`	`getInheritedProperties()` Displays all the properties that this log group has inherited from account-level settings.
`String`	`getKmsKeyId()` The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
`String`	`getLogGroupArn()` The Amazon Resource Name (ARN) of the log group.
`String`	`getLogGroupClass()` This specifies the log group class for this log group.
`String`	`getLogGroupName()` The name of the log group.
`Integer`	`getMetricFilterCount()` The number of metric filters.
`Integer`	`getRetentionInDays()`
`Long`	`getStoredBytes()` The number of bytes stored.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the log group.
`void`	`setCreationTime(Long creationTime)` The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`void`	`setDataProtectionStatus(String dataProtectionStatus)` Displays whether this log group has a protection policy, or whether it had one in the past.
`void`	`setInheritedProperties(Collection<String> inheritedProperties)` Displays all the properties that this log group has inherited from account-level settings.
`void`	`setKmsKeyId(String kmsKeyId)` The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
`void`	`setLogGroupArn(String logGroupArn)` The Amazon Resource Name (ARN) of the log group.
`void`	`setLogGroupClass(String logGroupClass)` This specifies the log group class for this log group.
`void`	`setLogGroupName(String logGroupName)` The name of the log group.
`void`	`setMetricFilterCount(Integer metricFilterCount)` The number of metric filters.
`void`	`setRetentionInDays(Integer retentionInDays)`
`void`	`setStoredBytes(Long storedBytes)` The number of bytes stored.
`String`	`toString()` Returns a string representation of this object.
`LogGroup`	`withArn(String arn)` The Amazon Resource Name (ARN) of the log group.
`LogGroup`	`withCreationTime(Long creationTime)` The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`LogGroup`	`withDataProtectionStatus(DataProtectionStatus dataProtectionStatus)` Displays whether this log group has a protection policy, or whether it had one in the past.
`LogGroup`	`withDataProtectionStatus(String dataProtectionStatus)` Displays whether this log group has a protection policy, or whether it had one in the past.
`LogGroup`	`withInheritedProperties(Collection<String> inheritedProperties)` Displays all the properties that this log group has inherited from account-level settings.
`LogGroup`	`withInheritedProperties(InheritedProperty... inheritedProperties)` Displays all the properties that this log group has inherited from account-level settings.
`LogGroup`	`withInheritedProperties(String... inheritedProperties)` Displays all the properties that this log group has inherited from account-level settings.
`LogGroup`	`withKmsKeyId(String kmsKeyId)` The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
`LogGroup`	`withLogGroupArn(String logGroupArn)` The Amazon Resource Name (ARN) of the log group.
`LogGroup`	`withLogGroupClass(LogGroupClass logGroupClass)` This specifies the log group class for this log group.
`LogGroup`	`withLogGroupClass(String logGroupClass)` This specifies the log group class for this log group.
`LogGroup`	`withLogGroupName(String logGroupName)` The name of the log group.
`LogGroup`	`withMetricFilterCount(Integer metricFilterCount)` The number of metric filters.
`LogGroup`	`withRetentionInDays(Integer retentionInDays)`
`LogGroup`	`withStoredBytes(Long storedBytes)` The number of bytes stored.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LogGroup
```
public LogGroup()
```
- Method Detail
  - setLogGroupName
```
public void setLogGroupName(String logGroupName)
```
    The name of the log group.
    
    Parameters:
    
    logGroupName - The name of the log group.
  - getLogGroupName
```
public String getLogGroupName()
```
    The name of the log group.
    
    Returns:
    
    The name of the log group.
  - withLogGroupName
```
public LogGroup withLogGroupName(String logGroupName)
```
    The name of the log group.
    
    Parameters:
    
    logGroupName - The name of the log group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Long creationTime)
```
    The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
    
    Parameters:
    
    creationTime - The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
  - getCreationTime
```
public Long getCreationTime()
```
    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.
  - withCreationTime
```
public LogGroup withCreationTime(Long creationTime)
```
    The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
    
    Parameters:
    
    creationTime - The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetentionInDays
```
public void setRetentionInDays(Integer retentionInDays)
```
    Parameters:
    
    retentionInDays -
  - getRetentionInDays
```
public Integer getRetentionInDays()
```
    Returns:
  - withRetentionInDays
```
public LogGroup withRetentionInDays(Integer retentionInDays)
```
    Parameters:
    
    retentionInDays -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricFilterCount
```
public void setMetricFilterCount(Integer metricFilterCount)
```
    The number of metric filters.
    
    Parameters:
    
    metricFilterCount - The number of metric filters.
  - getMetricFilterCount
```
public Integer getMetricFilterCount()
```
    The number of metric filters.
    
    Returns:
    
    The number of metric filters.
  - withMetricFilterCount
```
public LogGroup withMetricFilterCount(Integer metricFilterCount)
```
    The number of metric filters.
    
    Parameters:
    
    metricFilterCount - The number of metric filters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(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 :*.
    
    Parameters:
    
    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 :*.
  - getArn
```
public String getArn()
```
    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 :*.
  - withArn
```
public LogGroup withArn(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 :*.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoredBytes
```
public void setStoredBytes(Long storedBytes)
```
    The number of bytes stored.
    
    Parameters:
    
    storedBytes - The number of bytes stored.
  - getStoredBytes
```
public Long getStoredBytes()
```
    The number of bytes stored.
    
    Returns:
    
    The number of bytes stored.
  - withStoredBytes
```
public LogGroup withStoredBytes(Long storedBytes)
```
    The number of bytes stored.
    
    Parameters:
    
    storedBytes - The number of bytes stored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
    
    Parameters:
    
    kmsKeyId - The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    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.
  - withKmsKeyId
```
public LogGroup withKmsKeyId(String kmsKeyId)
```
    The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
    
    Parameters:
    
    kmsKeyId - The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataProtectionStatus
```
public void setDataProtectionStatus(String dataProtectionStatus)
```
    Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
    
    Parameters:
    
    dataProtectionStatus - 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
  - getDataProtectionStatus
```
public String getDataProtectionStatus()
```
    Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
    
    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
  - withDataProtectionStatus
```
public LogGroup withDataProtectionStatus(String dataProtectionStatus)
```
    Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
    
    Parameters:
    
    dataProtectionStatus - Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataProtectionStatus
  - withDataProtectionStatus
```
public LogGroup withDataProtectionStatus(DataProtectionStatus dataProtectionStatus)
```
    Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
    
    Parameters:
    
    dataProtectionStatus - Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataProtectionStatus
  - getInheritedProperties
```
public List<String> getInheritedProperties()
```
    Displays all the properties that this log group has inherited from account-level settings.
    
    Returns:
    
    Displays all the properties that this log group has inherited from account-level settings.
    
    See Also:
    
    InheritedProperty
  - setInheritedProperties
```
public void setInheritedProperties(Collection<String> inheritedProperties)
```
    Displays all the properties that this log group has inherited from account-level settings.
    
    Parameters:
    
    inheritedProperties - Displays all the properties that this log group has inherited from account-level settings.
    
    See Also:
    
    InheritedProperty
  - withInheritedProperties
```
public LogGroup withInheritedProperties(String... inheritedProperties)
```
    Displays all the properties that this log group has inherited from account-level settings.
    
    NOTE: This method appends the values to the existing list (if any). Use setInheritedProperties(java.util.Collection) or withInheritedProperties(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    inheritedProperties - Displays all the properties that this log group has inherited from account-level settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InheritedProperty
  - withInheritedProperties
```
public LogGroup withInheritedProperties(Collection<String> inheritedProperties)
```
    Displays all the properties that this log group has inherited from account-level settings.
    
    Parameters:
    
    inheritedProperties - Displays all the properties that this log group has inherited from account-level settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InheritedProperty
  - withInheritedProperties
```
public LogGroup withInheritedProperties(InheritedProperty... inheritedProperties)
```
    Displays all the properties that this log group has inherited from account-level settings.
    
    Parameters:
    
    inheritedProperties - Displays all the properties that this log group has inherited from account-level settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InheritedProperty
  - setLogGroupClass
```
public void setLogGroupClass(String 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
    Parameters:
    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
    See Also:
    
    LogGroupClass
  - getLogGroupClass
```
public String getLogGroupClass()
```
    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
    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:
    
    LogGroupClass
  - withLogGroupClass
```
public LogGroup withLogGroupClass(String 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogGroupClass
  - withLogGroupClass
```
public LogGroup withLogGroupClass(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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogGroupClass
  - setLogGroupArn
```
public void setLogGroupArn(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 logGroupIdentifier input field in many CloudWatch Logs APIs.
    - In the resourceArn field in tagging APIs
    - In IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.
    Parameters:
    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 logGroupIdentifier input field in many CloudWatch Logs APIs.
    
    In the resourceArn field in tagging APIs
    
    In IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.
  - getLogGroupArn
```
public String getLogGroupArn()
```
    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 logGroupIdentifier input field in many CloudWatch Logs APIs.
    - In the resourceArn field 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 logGroupIdentifier input field in many CloudWatch Logs APIs.
    
    In the resourceArn field in tagging APIs
    
    In IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.
  - withLogGroupArn
```
public LogGroup withLogGroupArn(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 logGroupIdentifier input field in many CloudWatch Logs APIs.
    - In the resourceArn field in tagging APIs
    - In IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.
    Parameters:
    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 logGroupIdentifier input field in many CloudWatch Logs APIs.
    
    In the resourceArn field in tagging APIs
    
    In IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public LogGroup clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class LogGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LogGroup

Method Detail

setLogGroupName

getLogGroupName

withLogGroupName

setCreationTime

getCreationTime

withCreationTime

setRetentionInDays

getRetentionInDays

withRetentionInDays

setMetricFilterCount

getMetricFilterCount

withMetricFilterCount

setArn

getArn

withArn

setStoredBytes

getStoredBytes

withStoredBytes

setKmsKeyId

getKmsKeyId

withKmsKeyId

setDataProtectionStatus

getDataProtectionStatus

withDataProtectionStatus

withDataProtectionStatus

getInheritedProperties

setInheritedProperties

withInheritedProperties

withInheritedProperties

withInheritedProperties

setLogGroupClass

getLogGroupClass

withLogGroupClass

withLogGroupClass

setLogGroupArn

getLogGroupArn

withLogGroupArn

toString

equals

hashCode

clone

marshall