# DataStoreIncrementOptions

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not replicated
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/DataStoreIncrementOptions/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/DataStoreIncrementOptions

Specifies additional parameters for a [`GlobalDataStore:IncrementAsync()`](https://rapi.sleaze.dev/classes/GlobalDataStore.md) call.

## Methods

### GetMetadata

```luau
DataStoreIncrementOptions:GetMetadata(): { [string]: any }
```

- Tags: Capabilities: DataStore

Gets the custom metadata set with this [`DataStoreIncrementOptions`](https://rapi.sleaze.dev/classes/DataStoreIncrementOptions.md) instance.

Returns: Metadata associated with this [`DataStoreIncrementOptions`](https://rapi.sleaze.dev/classes/DataStoreIncrementOptions.md) instance.

### SetMetadata

```luau
DataStoreIncrementOptions:SetMetadata(attributes: { [string]: any })
```

- Tags: Capabilities: DataStore

Sets custom metadata to be associated with the key.

Parameters:

- `attributes`: Metadata values to set for the key.

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`