docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Interface IMetadataQuery

    Inherited Members
    IAsyncEnumerable<MetadataInstance>.GetAsyncEnumerator(CancellationToken)
    Namespace: Unity.Cloud.DataStreaming.Metadata
    Assembly: Unity.Cloud.DataStreaming.Runtime.dll
    Syntax
    public interface IMetadataQuery : IAsyncEnumerable<MetadataInstance>

    Methods

    Select(IEnumerable<string>)

    Adds the desired output fields to the query.

    Declaration
    IMetadataQuery Select(IEnumerable<string> paths)
    Parameters
    Type Name Description
    IEnumerable<string> paths

    Adds those fields to the query.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    Select(IEnumerable<string>, OptionalData)

    Adds the desired output fields to the query.

    Declaration
    IMetadataQuery Select(IEnumerable<string> paths, OptionalData optionalData)
    Parameters
    Type Name Description
    IEnumerable<string> paths

    Adds those fields to the query.

    OptionalData optionalData

    Restrict optional data to include only the specified fields. Everything is included by default.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    Select(params string[])

    Adds the desired output fields to the query.

    Declaration
    IMetadataQuery Select(params string[] paths)
    Parameters
    Type Name Description
    string[] paths

    Adds those fields to the query.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    Select(MetadataPathCollection)

    Adds the desired output fields to the query.

    Declaration
    IMetadataQuery Select(MetadataPathCollection paths)
    Parameters
    Type Name Description
    MetadataPathCollection paths

    Adds those fields to the query.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    Select(MetadataPathCollection, OptionalData)

    Adds the desired output fields to the query.

    Declaration
    IMetadataQuery Select(MetadataPathCollection paths, OptionalData optionalData)
    Parameters
    Type Name Description
    MetadataPathCollection paths

    Adds those fields to the query.

    OptionalData optionalData

    Restrict optional data to include only the specified fields. Everything is included by default.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    WhereFieldEquals(string, string)

    Adds metadata conditions to the query where the given key. value must equals the given value.

    Declaration
    IMetadataQuery WhereFieldEquals(string key, string value)
    Parameters
    Type Name Description
    string key

    The field path in the metadata to validate its value equals the given value.

    string value

    The value that the field needs to be equals to.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    WhereFieldExists(string)

    Adds metadata conditions to the query where the given key has a value.

    Declaration
    IMetadataQuery WhereFieldExists(string key)
    Parameters
    Type Name Description
    string key

    Search for MetadataInstance which has this key.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    WhereFieldNotEquals(string, string)

    Adds metadata conditions to the query where the given key. value must NOT equals the given value.

    Declaration
    IMetadataQuery WhereFieldNotEquals(string key, string value)
    Parameters
    Type Name Description
    string key

    The path in the metadata to validate its value equals the given value.

    string value

    The value that the field needs to be equals to.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    WhereFieldNotExists(string)

    Adds metadata conditions to the query where the given key has no value assigned.

    Declaration
    IMetadataQuery WhereFieldNotExists(string key)
    Parameters
    Type Name Description
    string key

    Search for MetadataInstance which doesn't have this key.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    WhereHasAncestor(InstanceId)

    Restricts the query to only return instances that have a specific ancestor.

    Declaration
    IMetadataQuery WhereHasAncestor(InstanceId ancestor)
    Parameters
    Type Name Description
    InstanceId ancestor

    This ancestor must be part of the MetadataInstanceancestors.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery.

    WhereHasAncestor(InstanceId, int)

    Restricts the query to only return instances that have a specific ancestor.

    Declaration
    IMetadataQuery WhereHasAncestor(InstanceId ancestor, int maxDepth)
    Parameters
    Type Name Description
    InstanceId ancestor

    This ancestor must be part of the MetadataInstance ancestors.

    int maxDepth

    Stop the recurring search beyond this level of depth.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery.

    WhereInstanceEquals(IEnumerable<InstanceId>)

    Adds the owner IDs to the lookup query.

    Declaration
    IMetadataQuery WhereInstanceEquals(IEnumerable<InstanceId> instanceIds)
    Parameters
    Type Name Description
    IEnumerable<InstanceId> instanceIds

    The owners' ids

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    WhereInstanceEquals(IEnumerable<InstanceId>, QueryOptions)

    Adds the owner IDs to the lookup query.

    Declaration
    IMetadataQuery WhereInstanceEquals(IEnumerable<InstanceId> instanceIds, QueryOptions options)
    Parameters
    Type Name Description
    IEnumerable<InstanceId> instanceIds

    The owners' ids

    QueryOptions options

    Alter the behavior of the MetadataQuery with these options.

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    WhereInstanceEquals(params InstanceId[])

    Adds the owner IDs to the lookup query.

    Declaration
    IMetadataQuery WhereInstanceEquals(params InstanceId[] instanceIds)
    Parameters
    Type Name Description
    InstanceId[] instanceIds

    The owners' ids

    Returns
    Type Description
    IMetadataQuery

    The called MetadataQuery

    Extension Methods

    AsyncEnumerableExtensions.GetFirstOrDefaultAsync<T>(IAsyncEnumerable<T>, CancellationToken)
    AsyncEnumerableExtensions.GetFirstOrDefaultAsync<T>(IAsyncEnumerable<T>, CancellationToken)
    AsyncEnumerableExtensions.ToDictionaryAsync<TSource, TKey, TElement>(IAsyncEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>, CancellationToken)
    AsyncEnumerableExtensions.ToDictionaryAsync<TSource, TKey, TElement>(IAsyncEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>, CancellationToken)
    AsyncEnumerableExtensions.ToListAsync<T>(IAsyncEnumerable<T>, CancellationToken)
    AsyncEnumerableExtensions.ToListAsync<T>(IAsyncEnumerable<T>, CancellationToken)
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)