OBJECT
EntityQuery

GraphQL Schema definition

type EntityQuery {
#   Query the Entity model schema
entitySchema: EntitySchemaQuery! 
#   Perform Tanzu Hub queries
# 
#   **NOTE:** This API/functionality is in Alpha, This functionality can be unstable 
#   and schema elements may change over future iterations.
hubQuery: HubQuery! 
#   Query a filtered set of entities for aggregated counts of values of specified 
#   fields.
# 
#   This can be used, for example, to fetch counts of AWS services and their types
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   aggregations: Specify aggregation buckets
#   entityQueryFilter: Specify query filter
#   searchInfo: Specify a search filter
queryAggregations(
aggregations: [EntityAggregationInput!]!,
entityQueryFilter: EntityQueryFilter,
searchInfo: EntitySearchInfo
): EntityAggregations! 
#   Query paged list of Entities, optionally filtering by fields and traversals. 
#   Supports bidirectional paging.
# 
#   Query performance may be affected when querying across cloud account partitions.
# 
#   Each customer has multiple graph partitions. There is one partition for the 
#   management plane entities,
#   one for the VMware managed resources, and one partition per public cloud 
#   account. When navigating
#   relationships between partitions, then one must specify a suitable 
#   TraversalScope in the traversal.
#   Cross-partition traversals in a graph query have a performance impact on the 
#   query but are required
#   when data is in different partitions.
# 
#   By default the partition ID(s) are calculated from:
#   - the provided partitionId parameter if set
#   - determined from the entityIds parameter if set, via the provider instance ID 
#   field
#   - determined from the entityTypes if set, in particular if filtering on 
#   management tier entities
# 
# Arguments
#   after: Return records after the given cursor, as per GraphQL 
#   Relay spec
#   before: Return records before the given cursor, as per GraphQL 
#   Relay spec
#   cloudAccountId: this is a synonym for the managementEndpointId 
#   field of an Entity's management endpoint typically used for public cloud 
#   accounts
#   entitiesTraversal: Optionally start at the entity/ies that 
#   match the other filters provided as input parameter, but immediately traverse to 
#   some other entities and return those
#   entitiesTraversalFilter: Optionally filter by conditions on 
#   related entities 
#   entitiesTraversalRecursion: If entitiesTraversal is specified, 
#   optionally specify recursion information allowing the traversal to repeat
#   entityId: Optionally filter by entityIds
#   entityName: Optionally filter by this field
#   entityType: Optionally filter by this field
#   entityTypeConst: Optionally filter by entityTypes corresponding 
#   to the values from the enum (this can be used for its autocomplete 
#   functionality)
#   filter: Optional additional field filters. This can only be 
#   used to filter on fields local to this entity
#   and cannot be used to query across traversals to relationships/other entities or 
#   to insights, stats etc.
# 
#   The field format is `[[namespaces..](properties.|tags.)]`
#   first: Return first N records in a paged response, as per 
#   GraphQL Relay spec
#   managementEndpointId: Optionally specify a managementEndpointId 
#   to identify graph query's origin partition if request is for a public cloud 
#   account
#   partitionId: Optionally specify a graph partition name for the 
#   graph query's origin if request is for a predefined partition
#   pointInTime: Query the state of entities at a given point in 
#   time.
# 
#   The `pointInTime` parameter is *not* automatically propagated across traversals 
#   to other entities or navigations to other types
#   unless otherwise stated. To do a full `pointInTime` query involving other nodes 
#   than entities may require specifying the `pointInTime` parameter
#   in multiple places (e.g. when navigating from entities to insights or stats). A 
#   query variable may be helpful for this use-case.
# 
#   **NOTE:** This API/functionality is in Alpha, This functionality can be unstable 
#   and schema elements may change over future iterations.
#   provider: Optionally filter by this field
#   region: Optionally filter by this field
#   searchInfo: Optional search info - allows global search and/or 
#   search by specific fields
#   service: Optionally filter by this field
#   sort: Sort order for results in EntityConnection
#   tags: Optionally filter by tags. OR is used among values for 
#   the same key, AND across different keys
queryEntities(
after: String,
before: String,
cloudAccountId: String,
entitiesTraversal: [EntityTraversalInput!],
entitiesTraversalFilter: EntityTraversalFilterInput,
entitiesTraversalRecursion: EntityTraversalRecursionInfo,
entityId: [EntityId!],
entityName: [String!],
entityType: [String!],
entityTypeConst: [EntityTypeConst!],
filter: QueryFilter,
first: Int,
managementEndpointId: String,
partitionId: EntityGraphPartitionNames,
pointInTime: DateTime,
provider: [String!],
region: [String!],
searchInfo: EntitySearchInfo,
service: [String!],
sort: [QuerySort!],
tags: [TagFilterInput!]
): EntityConnection 
#   Query an entity's changelog
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   after: Return records after the given cursor, as per GraphQL 
#   Relay spec
#   before: Return records before the given cursor, as per GraphQL 
#   Relay spec
#   entityId: [Not documented]
#   first: Return first N records in a paged response, as per 
#   GraphQL Relay spec
#   mostRecentFirst: [Not documented]
#   timeRange: Filter responses to changes within a given time 
#   range
queryEntityChangeLog(
after: String,
before: String,
entityId: EntityId!,
first: Int,
mostRecentFirst: Boolean,
timeRange: EntityTimeRangeFilter
): EntityChangeLogConnection! 
#   Query a filtered set of relationships for aggregated counts of values of 
#   specified fields.
# 
#   This can be used, for example, to fetch counts of destination entityTypes for a 
#   given source entityId
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
# 
# Arguments
#   aggregations: Specify aggregation buckets
#   relationshipQueryFilter: Specify query filter
queryRelationshipAggregations(
aggregations: [EntityAggregationInput!]!,
relationshipQueryFilter: EntityRelationshipQueryFilter
): EntityAggregations! 
#   Search API supporting free-text search, filtering sorting and paging.
# 
# Arguments
#   after: Return records after the given cursor, as per GraphQL 
#   Relay spec
#   before: Return records before the given cursor, as per GraphQL 
#   Relay spec
#   first: Return first N records in a paged response, as per 
#   GraphQL Relay spec
#   input: Search parameters
searchEntities(
after: String,
before: String,
first: Int,
input: EntitySearchInput!
): EntityConnection @deprecated( reason: "queryEntities provides search functionality and much more"  )
#   Make a SSQL Entity query
# 
#   **NOTE:** This API/functionality is in Beta, this functionality is a candidate 
#   for a stable API but we reserve the right to fix issues including modifying the 
#   schema if required.
ssqlQuery: EntitySSQLQuery! 
}
EntityQuery

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
