Archive (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.eventbridge.model.Archive

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Archive
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An Archive object that contains details about an archive.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Archive()

Constructors
Constructor and Description
`Archive()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Archive`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArchiveName()` The name of the archive.
`Date`	`getCreationTime()` The time stamp for the time that the archive was created.
`Long`	`getEventCount()` The number of events in the archive.
`String`	`getEventSourceArn()` The ARN of the event bus associated with the archive.
`Integer`	`getRetentionDays()` The number of days to retain events in the archive before they are deleted.
`Long`	`getSizeBytes()` The size of the archive, in bytes.
`String`	`getState()` The current state of the archive.
`String`	`getStateReason()` A description for the reason that the archive is in the current state.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArchiveName(String archiveName)` The name of the archive.
`void`	`setCreationTime(Date creationTime)` The time stamp for the time that the archive was created.
`void`	`setEventCount(Long eventCount)` The number of events in the archive.
`void`	`setEventSourceArn(String eventSourceArn)` The ARN of the event bus associated with the archive.
`void`	`setRetentionDays(Integer retentionDays)` The number of days to retain events in the archive before they are deleted.
`void`	`setSizeBytes(Long sizeBytes)` The size of the archive, in bytes.
`void`	`setState(String state)` The current state of the archive.
`void`	`setStateReason(String stateReason)` A description for the reason that the archive is in the current state.
`String`	`toString()` Returns a string representation of this object.
`Archive`	`withArchiveName(String archiveName)` The name of the archive.
`Archive`	`withCreationTime(Date creationTime)` The time stamp for the time that the archive was created.
`Archive`	`withEventCount(Long eventCount)` The number of events in the archive.
`Archive`	`withEventSourceArn(String eventSourceArn)` The ARN of the event bus associated with the archive.
`Archive`	`withRetentionDays(Integer retentionDays)` The number of days to retain events in the archive before they are deleted.
`Archive`	`withSizeBytes(Long sizeBytes)` The size of the archive, in bytes.
`Archive`	`withState(ArchiveState state)` The current state of the archive.
`Archive`	`withState(String state)` The current state of the archive.
`Archive`	`withStateReason(String stateReason)` A description for the reason that the archive is in the current state.

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

- Constructor Detail
  - Archive
```
public Archive()
```
- Method Detail
  - setArchiveName
```
public void setArchiveName(String archiveName)
```
    The name of the archive.
    
    Parameters:
    
    archiveName - The name of the archive.
  - getArchiveName
```
public String getArchiveName()
```
    The name of the archive.
    
    Returns:
    
    The name of the archive.
  - withArchiveName
```
public Archive withArchiveName(String archiveName)
```
    The name of the archive.
    
    Parameters:
    
    archiveName - The name of the archive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventSourceArn
```
public void setEventSourceArn(String eventSourceArn)
```
    The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.
    
    Parameters:
    
    eventSourceArn - The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.
  - getEventSourceArn
```
public String getEventSourceArn()
```
    The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.
    
    Returns:
    
    The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.
  - withEventSourceArn
```
public Archive withEventSourceArn(String eventSourceArn)
```
    The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.
    
    Parameters:
    
    eventSourceArn - The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The current state of the archive.
    
    Parameters:
    
    state - The current state of the archive.
    
    See Also:
    
    ArchiveState
  - getState
```
public String getState()
```
    The current state of the archive.
    
    Returns:
    
    The current state of the archive.
    
    See Also:
    
    ArchiveState
  - withState
```
public Archive withState(String state)
```
    The current state of the archive.
    
    Parameters:
    
    state - The current state of the archive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ArchiveState
  - withState
```
public Archive withState(ArchiveState state)
```
    The current state of the archive.
    
    Parameters:
    
    state - The current state of the archive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ArchiveState
  - setStateReason
```
public void setStateReason(String stateReason)
```
    A description for the reason that the archive is in the current state.
    
    Parameters:
    
    stateReason - A description for the reason that the archive is in the current state.
  - getStateReason
```
public String getStateReason()
```
    A description for the reason that the archive is in the current state.
    
    Returns:
    
    A description for the reason that the archive is in the current state.
  - withStateReason
```
public Archive withStateReason(String stateReason)
```
    A description for the reason that the archive is in the current state.
    
    Parameters:
    
    stateReason - A description for the reason that the archive is in the current state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetentionDays
```
public void setRetentionDays(Integer retentionDays)
```
    The number of days to retain events in the archive before they are deleted.
    
    Parameters:
    
    retentionDays - The number of days to retain events in the archive before they are deleted.
  - getRetentionDays
```
public Integer getRetentionDays()
```
    The number of days to retain events in the archive before they are deleted.
    
    Returns:
    
    The number of days to retain events in the archive before they are deleted.
  - withRetentionDays
```
public Archive withRetentionDays(Integer retentionDays)
```
    The number of days to retain events in the archive before they are deleted.
    
    Parameters:
    
    retentionDays - The number of days to retain events in the archive before they are deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSizeBytes
```
public void setSizeBytes(Long sizeBytes)
```
    The size of the archive, in bytes.
    
    Parameters:
    
    sizeBytes - The size of the archive, in bytes.
  - getSizeBytes
```
public Long getSizeBytes()
```
    The size of the archive, in bytes.
    
    Returns:
    
    The size of the archive, in bytes.
  - withSizeBytes
```
public Archive withSizeBytes(Long sizeBytes)
```
    The size of the archive, in bytes.
    
    Parameters:
    
    sizeBytes - The size of the archive, in bytes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventCount
```
public void setEventCount(Long eventCount)
```
    The number of events in the archive.
    
    Parameters:
    
    eventCount - The number of events in the archive.
  - getEventCount
```
public Long getEventCount()
```
    The number of events in the archive.
    
    Returns:
    
    The number of events in the archive.
  - withEventCount
```
public Archive withEventCount(Long eventCount)
```
    The number of events in the archive.
    
    Parameters:
    
    eventCount - The number of events in the archive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time stamp for the time that the archive was created.
    
    Parameters:
    
    creationTime - The time stamp for the time that the archive was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time stamp for the time that the archive was created.
    
    Returns:
    
    The time stamp for the time that the archive was created.
  - withCreationTime
```
public Archive withCreationTime(Date creationTime)
```
    The time stamp for the time that the archive was created.
    
    Parameters:
    
    creationTime - The time stamp for the time that the archive was created.
    
    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 Archive 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.780

Class Archive

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Archive

Method Detail

setArchiveName

getArchiveName

withArchiveName

setEventSourceArn

getEventSourceArn

withEventSourceArn

setState

getState

withState

withState

setStateReason

getStateReason

withStateReason

setRetentionDays

getRetentionDays

withRetentionDays

setSizeBytes

getSizeBytes

withSizeBytes

setEventCount

getEventCount

withEventCount

setCreationTime

getCreationTime

withCreationTime

toString

equals

hashCode

clone

marshall