C# Class EventStore.ClientAPI.StreamMetadataBuilder

Builder for StreamMetadata.
显示文件 Open project: EventStore/EventStore Class Usage Examples

Public Methods

Method Description
Build ( ) : StreamMetadata

Builds a StreamMetadata from a StreamMetadataBuilder.
SetCacheControl ( System.TimeSpan cacheControl ) : StreamMetadataBuilder

Sets the amount of time for which the stream head is cachable.
SetCustomProperty ( string key, bool value ) : StreamMetadataBuilder

Sets a custom metadata property.
SetCustomProperty ( string key, decimal value ) : StreamMetadataBuilder

Sets a custom metadata property.
SetCustomProperty ( string key, double value ) : StreamMetadataBuilder

Sets a custom metadata property.
SetCustomProperty ( string key, float value ) : StreamMetadataBuilder

Sets a custom metadata property.
SetCustomProperty ( string key, int value ) : StreamMetadataBuilder

Sets a custom metadata property.
SetCustomProperty ( string key, long value ) : StreamMetadataBuilder

Sets a custom metadata property.
SetCustomProperty ( string key, string value ) : StreamMetadataBuilder

Sets a custom metadata property.
SetCustomPropertyWithValueAsRawJsonString ( string key, string rawJson ) : StreamMetadataBuilder

Sets a custom metadata property to a string of raw JSON.
SetDeleteRole ( string role ) : StreamMetadataBuilder

Sets a single role name with delete permission for the stream.
SetDeleteRoles ( string roles ) : StreamMetadataBuilder

Sets role names with delete permission for the stream.
SetMaxAge ( System.TimeSpan maxAge ) : StreamMetadataBuilder

Sets the maximum age of events allowed in the stream.
SetMaxCount ( int maxCount ) : StreamMetadataBuilder

Sets the maximum number of events allowed in the stream.
SetMetadataReadRole ( string role ) : StreamMetadataBuilder

Sets a single role name with metadata read permission for the stream.
SetMetadataReadRoles ( string roles ) : StreamMetadataBuilder

Sets role names with metadata read permission for the stream.
SetMetadataWriteRole ( string role ) : StreamMetadataBuilder

Sets a single role name with metadata write permission for the stream.
SetMetadataWriteRoles ( string roles ) : StreamMetadataBuilder

Sets role names with metadata write permission for the stream.
SetReadRole ( string role ) : StreamMetadataBuilder

Sets a single role name with read permission for the stream.
SetReadRoles ( string roles ) : StreamMetadataBuilder

Sets role names with read permission for the stream.
SetTruncateBefore ( int truncateBefore ) : StreamMetadataBuilder

Sets the event number from which previous events can be scavenged.
SetWriteRole ( string role ) : StreamMetadataBuilder

Sets a single role name with write permission for the stream.
SetWriteRoles ( string roles ) : StreamMetadataBuilder

Sets role names with write permission for the stream.

Private Methods

Method Description
StreamMetadataBuilder ( int maxCount = null, System.TimeSpan maxAge = null, int truncateBefore = null, System.TimeSpan cacheControl = null, string aclRead = null, string aclWrite = null, string aclDelete = null, string aclMetaRead = null, string aclMetaWrite = null, JToken>.IDictionary customMetadata = null ) : System

Method Details

Build() public method

Builds a StreamMetadata from a StreamMetadataBuilder.
public Build ( ) : StreamMetadata
return StreamMetadata

SetCacheControl() public method

Sets the amount of time for which the stream head is cachable.
public SetCacheControl ( System.TimeSpan cacheControl ) : StreamMetadataBuilder
cacheControl System.TimeSpan The amount of time for which the stream head is cachable.
return StreamMetadataBuilder

SetCustomProperty() public method

Sets a custom metadata property.
public SetCustomProperty ( string key, bool value ) : StreamMetadataBuilder
key string The key.
value bool The value.
return StreamMetadataBuilder

SetCustomProperty() public method

Sets a custom metadata property.
public SetCustomProperty ( string key, decimal value ) : StreamMetadataBuilder
key string The key.
value decimal The value.
return StreamMetadataBuilder

SetCustomProperty() public method

Sets a custom metadata property.
public SetCustomProperty ( string key, double value ) : StreamMetadataBuilder
key string The key.
value double The value.
return StreamMetadataBuilder

SetCustomProperty() public method

Sets a custom metadata property.
public SetCustomProperty ( string key, float value ) : StreamMetadataBuilder
key string The key.
value float The value.
return StreamMetadataBuilder

SetCustomProperty() public method

Sets a custom metadata property.
public SetCustomProperty ( string key, int value ) : StreamMetadataBuilder
key string The key.
value int The value.
return StreamMetadataBuilder

SetCustomProperty() public method

Sets a custom metadata property.
public SetCustomProperty ( string key, long value ) : StreamMetadataBuilder
key string The key.
value long The value.
return StreamMetadataBuilder

SetCustomProperty() public method

Sets a custom metadata property.
public SetCustomProperty ( string key, string value ) : StreamMetadataBuilder
key string The key.
value string The value.
return StreamMetadataBuilder

SetCustomPropertyWithValueAsRawJsonString() public method

Sets a custom metadata property to a string of raw JSON.
public SetCustomPropertyWithValueAsRawJsonString ( string key, string rawJson ) : StreamMetadataBuilder
key string The key.
rawJson string The value.
return StreamMetadataBuilder

SetDeleteRole() public method

Sets a single role name with delete permission for the stream.
public SetDeleteRole ( string role ) : StreamMetadataBuilder
role string Role name.
return StreamMetadataBuilder

SetDeleteRoles() public method

Sets role names with delete permission for the stream.
public SetDeleteRoles ( string roles ) : StreamMetadataBuilder
roles string Role names.
return StreamMetadataBuilder

SetMaxAge() public method

Sets the maximum age of events allowed in the stream.
public SetMaxAge ( System.TimeSpan maxAge ) : StreamMetadataBuilder
maxAge System.TimeSpan The maximum age of events allowed in the stream.
return StreamMetadataBuilder

SetMaxCount() public method

Sets the maximum number of events allowed in the stream.
public SetMaxCount ( int maxCount ) : StreamMetadataBuilder
maxCount int The maximum number of events allowed in the stream.
return StreamMetadataBuilder

SetMetadataReadRole() public method

Sets a single role name with metadata read permission for the stream.
public SetMetadataReadRole ( string role ) : StreamMetadataBuilder
role string Role name.
return StreamMetadataBuilder

SetMetadataReadRoles() public method

Sets role names with metadata read permission for the stream.
public SetMetadataReadRoles ( string roles ) : StreamMetadataBuilder
roles string Role names.
return StreamMetadataBuilder

SetMetadataWriteRole() public method

Sets a single role name with metadata write permission for the stream.
public SetMetadataWriteRole ( string role ) : StreamMetadataBuilder
role string Role name.
return StreamMetadataBuilder

SetMetadataWriteRoles() public method

Sets role names with metadata write permission for the stream.
public SetMetadataWriteRoles ( string roles ) : StreamMetadataBuilder
roles string Role names.
return StreamMetadataBuilder

SetReadRole() public method

Sets a single role name with read permission for the stream.
public SetReadRole ( string role ) : StreamMetadataBuilder
role string Role name.
return StreamMetadataBuilder

SetReadRoles() public method

Sets role names with read permission for the stream.
public SetReadRoles ( string roles ) : StreamMetadataBuilder
roles string Role names.
return StreamMetadataBuilder

SetTruncateBefore() public method

Sets the event number from which previous events can be scavenged.
public SetTruncateBefore ( int truncateBefore ) : StreamMetadataBuilder
truncateBefore int The event number from which previous events can be scavenged.
return StreamMetadataBuilder

SetWriteRole() public method

Sets a single role name with write permission for the stream.
public SetWriteRole ( string role ) : StreamMetadataBuilder
role string Role name.
return StreamMetadataBuilder

SetWriteRoles() public method

Sets role names with write permission for the stream.
public SetWriteRoles ( string roles ) : StreamMetadataBuilder
roles string Role names.
return StreamMetadataBuilder