From 29586e38490200fe79e8e857a54aaebb1f7afcd8 Mon Sep 17 00:00:00 2001 From: sebastianburckhardt Date: Fri, 6 Oct 2023 15:35:25 -0700 Subject: [PATCH] rename includeStateless to includeTransient --- src/Client/Core/Entities/EntityQuery.cs | 12 +++++++----- src/Client/Grpc/GrpcDurableEntityClient.cs | 4 ++-- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/src/Client/Core/Entities/EntityQuery.cs b/src/Client/Core/Entities/EntityQuery.cs index f8dd6557..5b15a281 100644 --- a/src/Client/Core/Entities/EntityQuery.cs +++ b/src/Client/Core/Entities/EntityQuery.cs @@ -61,13 +61,15 @@ public string? InstanceIdStartsWith public bool IncludeState { get; init; } = true; /// - /// Gets a value indicating whether to include metadata about entities that have no user-defined state. Defaults to false. + /// Gets a value indicating whether to include metadata about transient entities. Defaults to false. /// - /// Stateless entities occur when the storage provider is tracking metadata about an entity for synchronization purposes - /// even though the entity does not "logically" exist, in the sense that it has no application-defined state. - /// Stateless entities are usually transient. For example, they may be in the process of being created or deleted, or they may have been locked by a critical section. + /// Transient entities are entities that do not have an application-defined state, but for which the storage provider is + /// tracking metadata for synchronization purposes. + /// For example, a transient entity may be observed when the entity is in the process of being created or deleted, or + /// when the entity has been locked by a critical section. By default, transient entities are not included in queries since they are + /// considered to "not exist" from the perspective of the user application. /// - public bool IncludeStateless { get; init; } + public bool IncludeTransient { get; init; } /// /// Gets the size of each page to return. If null, the page size is determined by the backend. diff --git a/src/Client/Grpc/GrpcDurableEntityClient.cs b/src/Client/Grpc/GrpcDurableEntityClient.cs index c1b826f6..b5e3371d 100644 --- a/src/Client/Grpc/GrpcDurableEntityClient.cs +++ b/src/Client/Grpc/GrpcDurableEntityClient.cs @@ -166,7 +166,7 @@ AsyncPageable GetAllEntitiesCoreAsync( where TMetadata : class { bool includeState = filter?.IncludeState ?? true; - bool includeStateless = filter?.IncludeStateless ?? false; + bool includeTransient = filter?.IncludeTransient ?? false; string startsWith = filter?.InstanceIdStartsWith ?? string.Empty; DateTimeOffset? lastModifiedFrom = filter?.LastModifiedFrom; DateTimeOffset? lastModifiedTo = filter?.LastModifiedTo; @@ -186,7 +186,7 @@ AsyncPageable GetAllEntitiesCoreAsync( LastModifiedFrom = lastModifiedFrom?.ToTimestamp(), LastModifiedTo = lastModifiedTo?.ToTimestamp(), IncludeState = includeState, - IncludeStateless = includeStateless, + IncludeTransient = includeTransient, PageSize = pageSize, ContinuationToken = continuation ?? filter?.ContinuationToken, },