GetRecordOptions (Semantic Kernel API 1.4.0 API)

java.lang.Object
- com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions

public class GetRecordOptions
extends Object

Options for getting a record.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GetRecordOptions.Builder
A builder for GetRecordOptions.

Constructor Summary

Constructors
Constructor	Description
`GetRecordOptions(boolean includeVectors)`	Creates a new instance of the GetRecordOptions class.
`GetRecordOptions(boolean includeVectors, boolean wildcardKeyMatching)`	Creates a new instance of the GetRecordOptions class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetRecordOptions.Builder`	`builder()`	Creates a new builder.
`boolean`	`isIncludeVectors()`	Gets whether to include vectors.
`boolean`	`isWildcardKeyMatching()`	Gets whether to use wildcard key matching.

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

- Constructor Detail
  - GetRecordOptions
```
public GetRecordOptions(boolean includeVectors)
```
    Creates a new instance of the GetRecordOptions class.
    
    Parameters:
    
    includeVectors - A value indicating whether to include vectors in a response.
  - GetRecordOptions
```
public GetRecordOptions(boolean includeVectors,
                        boolean wildcardKeyMatching)
```
    Creates a new instance of the GetRecordOptions class.
    
    Parameters:
    
    includeVectors - A value indicating whether to include vectors in a response.
    
    wildcardKeyMatching - A value indicating whether to use wildcard key matching.
- Method Detail
  - isWildcardKeyMatching
```
public boolean isWildcardKeyMatching()
```
    Gets whether to use wildcard key matching.
    
    Returns:
    
    true if wildcard key matching is used; otherwise, false.
  - builder
```
public static GetRecordOptions.Builder builder()
```
    Creates a new builder.
    
    Returns:
    
    the builder
  - isIncludeVectors
```
public boolean isIncludeVectors()
```
    Gets whether to include vectors.
    
    Returns:
    
    whether to include vectors