com.amazonaws.services.logs.model

Class PutRetentionPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.PutRetentionPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutRetentionPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutRetentionPolicy operation.

Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.

See Also:

AWSLogs.putRetentionPolicy(PutRetentionPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutRetentionPolicyRequest() Default constructor for a new PutRetentionPolicyRequest object.
PutRetentionPolicyRequest(String logGroupName, Integer retentionInDays) Constructs a new PutRetentionPolicyRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
PutRetentionPolicyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getLogGroupName() The name of the log group to associate the retention policy with.
Integer	getRetentionInDays() Specifies the number of days you want to retain log events in the specified log group.
int	hashCode()
void	setLogGroupName(String logGroupName) The name of the log group to associate the retention policy with.
void	setRetentionInDays(Integer retentionInDays) Specifies the number of days you want to retain log events in the specified log group.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutRetentionPolicyRequest	withLogGroupName(String logGroupName) The name of the log group to associate the retention policy with.
PutRetentionPolicyRequest	withRetentionInDays(Integer retentionInDays) Specifies the number of days you want to retain log events in the specified log group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutRetentionPolicyRequest

public PutRetentionPolicyRequest()

Default constructor for a new PutRetentionPolicyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

PutRetentionPolicyRequest

public PutRetentionPolicyRequest(String logGroupName,
                         Integer retentionInDays)

Constructs a new PutRetentionPolicyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

logGroupName - The name of the log group to associate the retention policy with.

retentionInDays - Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653.

Method Detail

getLogGroupName

public String getLogGroupName()

The name of the log group to associate the retention policy with.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Returns:

The name of the log group to associate the retention policy with.

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the log group to associate the retention policy with.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupName - The name of the log group to associate the retention policy with.

withLogGroupName

public PutRetentionPolicyRequest withLogGroupName(String logGroupName)

The name of the log group to associate the retention policy with.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupName - The name of the log group to associate the retention policy with.

Returns:

A reference to this updated object so that method calls can be chained together.

getRetentionInDays

public Integer getRetentionInDays()

Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653.

Returns:

Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653.

setRetentionInDays

public void setRetentionInDays(Integer retentionInDays)

Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653.

Parameters:

retentionInDays - Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653.

withRetentionInDays

public PutRetentionPolicyRequest withRetentionInDays(Integer retentionInDays)

Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653.

Returns a reference to this object so that method calls can be chained together.

Parameters:

retentionInDays - Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public PutRetentionPolicyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()