Enum StorageLogbookParameterName
- java.lang.Object
-
- java.lang.Enum<StorageLogbookParameterName>
-
- fr.gouv.vitam.storage.engine.server.storagelog.parameters.StorageLogbookParameterName
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<StorageLogbookParameterName>
public enum StorageLogbookParameterName extends java.lang.Enum<StorageLogbookParameterName>
Enum with all possible logbook storage parameters
Use to set parameter value and to check emptiness or nullity
-
-
Enum Constant Summary
Enum Constants Enum Constant Description agentIdentifierRequesterRequester of the storage orderagentIdentifiersList of the offers identifiers on which the object has been writtenapplicationIdApplication-IdarchivesIdArchive Units ID with contains the objectcontextIdContext Id of the requestcontractIdAccess Contract Id of the requestdataCategoryData categorydigestDigest of the written object.digestAlgorithmdigest Algorithm used for this object Could be for instance: "SHA-256", "SHA-512", ...eventDateTimeSet by the storage engine : date time of the eventeventTypeEvent type: should use one global Enum ActionType
Could be for instance: "Unzip", "CheckSeda", ...objectGroupIdentifierObject Group Identifier.
Identifier of the object group corresponding to the object written in the storage offer.objectIdentifierObject Identifier.
Identifier of the object to be written in the storage offer.objectSizeObject SizeoutcomeStatus between: "OK", "KO", "PENDING"
One must use the StorageLogbookOutcome enum.qualifierObject qualifier in the objectGroupsizeSize in bytes of the object written on the storage offertenantIdTenant IDversionObject version in the objectGroupxRequestIdX-Request-Id
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static StorageLogbookParameterNamevalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static StorageLogbookParameterName[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
eventDateTime
public static final StorageLogbookParameterName eventDateTime
Set by the storage engine : date time of the event
-
xRequestId
public static final StorageLogbookParameterName xRequestId
X-Request-Id
-
applicationId
public static final StorageLogbookParameterName applicationId
Application-Id
-
tenantId
public static final StorageLogbookParameterName tenantId
Tenant ID
-
eventType
public static final StorageLogbookParameterName eventType
Event type: should use one global Enum ActionType
Could be for instance: "Unzip", "CheckSeda", ...
-
objectIdentifier
public static final StorageLogbookParameterName objectIdentifier
Object Identifier.
Identifier of the object to be written in the storage offer.
For instance: Object GUID
-
dataCategory
public static final StorageLogbookParameterName dataCategory
Data category
-
objectGroupIdentifier
public static final StorageLogbookParameterName objectGroupIdentifier
Object Group Identifier.
Identifier of the object group corresponding to the object written in the storage offer.
For instance: Object Group GUID
-
digest
public static final StorageLogbookParameterName digest
Digest of the written object.
-
digestAlgorithm
public static final StorageLogbookParameterName digestAlgorithm
digest Algorithm used for this object Could be for instance: "SHA-256", "SHA-512", ...
-
size
public static final StorageLogbookParameterName size
Size in bytes of the object written on the storage offer
-
agentIdentifiers
public static final StorageLogbookParameterName agentIdentifiers
List of the offers identifiers on which the object has been written
-
agentIdentifierRequester
public static final StorageLogbookParameterName agentIdentifierRequester
Requester of the storage order
-
outcome
public static final StorageLogbookParameterName outcome
Status between: "OK", "KO", "PENDING"
One must use the StorageLogbookOutcome enum.
-
qualifier
public static final StorageLogbookParameterName qualifier
Object qualifier in the objectGroup
-
version
public static final StorageLogbookParameterName version
Object version in the objectGroup
-
contextId
public static final StorageLogbookParameterName contextId
Context Id of the request
-
contractId
public static final StorageLogbookParameterName contractId
Access Contract Id of the request
-
archivesId
public static final StorageLogbookParameterName archivesId
Archive Units ID with contains the object
-
objectSize
public static final StorageLogbookParameterName objectSize
Object Size
-
-
Method Detail
-
values
public static StorageLogbookParameterName[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (StorageLogbookParameterName c : StorageLogbookParameterName.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static StorageLogbookParameterName valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException- if this enum type has no constant with the specified namejava.lang.NullPointerException- if the argument is null
-
-