OBJECT
Entity
Primary Entity type in the graph, implementing the individual EntityNode interface and with additional fields permitting traversals to other entities in the entity topology and to access other graph nodes with information related to the entity.
link GraphQL Schema definition
- type Entity implements Node, EntityNodeInterface, NodeVersion {
- # Unique identifier for an entity in a canonical form. Uniqueness applies at the
- # scope of the entire organization
- EntityId! :
- # Get hyperlinks for this entity. Optionally filter by namespace
- #
- # Arguments
- # namespace: [Not documented]
- String!]): [HyperLink!] ( : [
- # Opaque global ID
- ID! :
- # query timeseries stats for this entity.
- #
- # Arguments
- # input: [Not documented]
- StatsInput): [Stat!] ( :
- # Get user specific fields connected to a given entity, given the optional list of
- # userIds as input.
- # UserId other than the current user can only be provided by admin users.
- UserEntityFields!] : [
- # entity-specific action information
- EntityActions! :
- # Costing and pricing information related to the entity.
- #
- # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
- # and schema elements may change over future iterations.
- CostingEntityInfo! @deprecated( reason: "replaced with finOps" ) :
- # Costing and pricing information related to the entity.
- #
- # **NOTE:** This API/functionality is in Alpha, This functionality can be unstable
- # and schema elements may change over future iterations.
- FinOpsEntityInfo! :
- # The cloud account ID. This is a synonym for the `managementEndpointId` field of
- # the `managementEndpoint` of this entity, exposed for quick filtering for public
- # cloud accounts.
- String :
- # This optional property represents an unique ID of the source collector
- String :
- # Time this Entity was created. Note: Expressed in UTC ISO-8601 timestamp
- DateTime :
- # Paged parent entities, optionally filtering by fields, most filters support
- # leading '!' (not) and trailing '*' (starts with)
- #
- # 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
- # entitiesTraversalFilter: Optionally filter by related entities
- # being present / absent
- # entityId: Optionally filter by entityIds
- # entityType: Optionally filter by this field, support leading
- # '!' (not) and trailing '*' (starts with)
- # 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.
- #
- # The field format is `[[namespaces.
.](properties.|tags.)]` - # first: Return first N records in a paged response, as per
- # GraphQL Relay spec
- # provider: Optionally filter by this field, support leading '!'
- # (not) and trailing '*' (starts with)
- # relationshipType: Filter traversal by one of the given
- # relationship types, requires an exact match.
- # Traversal across 'in' relationships should be optimized by specifying a
- # relationshipType otherwise they will be slow.
- # service: Optionally filter by this field, support leading '!'
- # (not) and trailing '*' (starts with)
- # sort: Optional sort order for results in EntityConnection
- # traversalScope: Optionally specify whether the traversals
- # should be constrained to same partition (cloud account id), can be used for
- # optimizing some queries
- (
- String, :
- String, :
- EntityTraversalFilterInput, :
- EntityId!], : [
- String!], : [
- EntityTypeConst!], : [
- QueryFilter, :
- Int, :
- String!], : [
- String!], : [
- String!], : [
- QuerySort!], : [
- EntityTraversalScope :
- ): EntityConnection
- # Paged child entities, optionally filtering by fields, most filters support
- # leading '!' (not) and trailing '*' (starts with)
- #
- # 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
- # entitiesTraversalFilter: Optionally filter by related entities
- # being present / absent
- # entityId: Optionally filter by entityIds
- # entityType: Optionally filter by this field, support leading
- # '!' (not) and trailing '*' (starts with)
- # 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.
- #
- # The field format is `[[namespaces.
.](properties.|tags.)]` - # first: Return first N records in a paged response, as per
- # GraphQL Relay spec
- # provider: Optionally filter by this field, support leading '!'
- # (not) and trailing '*' (starts with)
- # relationshipType: Optionally filter traversal by one of the
- # given relationship types, requires an exact match
- # service: Optionally filter by this field, support leading '!'
- # (not) and trailing '*' (starts with)
- # sort: Optional sort order for results in EntityConnection
- # traversalScope: Optionally specify whether the traversals
- # should be constrained to same partition (cloud account id), can be used for
- # optimizing some queries
- (
- String, :
- String, :
- EntityTraversalFilterInput, :
- EntityId!], : [
- String!], : [
- EntityTypeConst!], : [
- QueryFilter, :
- Int, :
- String!], : [
- String!], : [
- String!], : [
- QuerySort!], : [
- EntityTraversalScope :
- ): EntityConnection
- # Single or multi-step entity graph traversal returning paged entities at the end
- # of the traversal
- #
- # 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
- # entitiesTraversal: Entities Traversal specifies the path to
- # traverse through the Entity graph, with optional filtering at each step
- # first: Return first N records in a paged response, as per
- # GraphQL Relay spec
- # recursion: optionally specify recursion information for this
- # traversal allowing the traversal to repeat
- # sort: Optional sort order for results in EntityConnection
- (
- String, :
- String, :
- EntityTraversalInput!]!, : [
- Int, :
- EntityTraversalRecursionInfo, :
- QuerySort!] : [
- ): EntityConnection
- # Calculate number of recorded changes to this entity in the given time window.
- # Individual changes for a specific entity can be fetched using
- # `EntityQuery.queryEntityChangeLog()`.
- #
- # Arguments
- # timeRange: [Not documented]
- EntityTimeRangeFilter!): Int ( :
- # Optional. EntityName of the entity
- String :
- # access the schema for this entity's entityType, if available
- EntitySchema :
- # EntityScopes provide information on the membership and visibility of the Entity.
- #
- # For example, if an Entity is in the scope of a VMW.Aria.BusinessApplication then
- # it is considered to be "visible"
- # as a part of that Business Application.
- #
- # If the Entity is in the scope of a VMW.CSP.Project, then the Entity will be
- # visible be visible
- # to users who's roles are scoped to that specific CSP project.
- #
- # An Entity may have multiple scopes, or none.
- EntityScopes :
- # EntityType of the entity. e.g. `ec2`, `security-group` etc. Required but not
- # enforced because of federation constraints.
- String :
- # entityType as an enum constant
- EntityTypeConst :
- # Last time this entity was updated. Note: Expressed in UTC ISO-8601 timestamp
- DateTime :
- # namespaces for this entity, filtered by namespace
- #
- # Arguments
- # namespace: [Not documented]
- String!]): [EntityNamespace!] ( : [
- # Versioning ID
- ID! :
- # Properties for this entity, optionally filtered by name
- #
- # Arguments
- # name: [Not documented]
- String!]): [EntityProperty!] ( : [
- # provider component of the entityType
- String :
- # For cloud resources, this property contains the entity region
- String :
- # Paged relationships to parents, optionally filtering by fields, most filters
- # support leading '!' (not) and trailing '*' (starts with)
- #
- # 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
- # entitiesTraversalFilter: Optionally filter by related entities
- # being present / absent
- # entityFilter: Additional filters on 'other' entity fields
- # entityType: Filter on the 'other' entity type
- # first: Return first N records in a paged response, as per
- # GraphQL Relay spec
- # relationshipType: Filter traversal by one of the given
- # relationship types, requires an exact match.
- # Traversal across 'in' relationships should be optimized by specifying a
- # relationshipType otherwise they will be slow.
- # sort: Optional sort order for results
- # traversalScope: Optionally specify whether the traversals
- # should be constrained to same partition (cloud account id), can be used for
- # optimizing some queries
- (
- String, :
- String, :
- EntityTraversalFilterInput, :
- QueryFilter, :
- String!], : [
- Int, :
- String!], : [
- QuerySort!], : [
- EntityTraversalScope :
- ): EntityRelationshipConnection
- # Paged relationships to children, optionally filtering by fields
- #
- # 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
- # entitiesTraversalFilter: Optionally filter by related entities
- # being present / absent
- # entityFilter: Additional filters on 'other' entity fields
- # entityType: Filter on the 'other' entity type
- # first: Return first N records in a paged response, as per
- # GraphQL Relay spec
- # relationshipType: Filter traversal by one of the given
- # relationship types, requires an exact match
- # sort: Optional sort order for results
- # traversalScope: Optionally specify whether the traversals
- # should be constrained to same partition (cloud account id), can be used for
- # optimizing some queries
- (
- String, :
- String, :
- EntityTraversalFilterInput, :
- QueryFilter, :
- String!], : [
- Int, :
- String!], : [
- QuerySort!], : [
- EntityTraversalScope :
- ): EntityRelationshipConnection
- # Single-step relationship traversal returning paged relationships based upon the
- # given filters
- #
- # 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
- # direction: Mandatory traversal direction
- # entitiesTraversalFilter: Optionally filter by related entities
- # being present / absent
- # entityFilter: Additional filters on 'other' entity fields
- # entityType: Filter on the 'other' entity type
- # first: Return first N records in a paged response, as per
- # GraphQL Relay spec
- # relationshipType: Optionally filter traversal by one of the
- # given relationship types, requires an exact match
- # sort: Optional sort order for results
- # traversalScope: Optionally specify whether the traversals
- # should be constrained to same partition (cloud account id), can be used for
- # optimizing some queries
- (
- String, :
- String, :
- EntityTraversalDirection!, :
- EntityTraversalFilterInput, :
- QueryFilter, :
- String!], : [
- Int, :
- String!], : [
- QuerySort!], : [
- EntityTraversalScope :
- ): EntityRelationshipConnection
- # service component of the entityType
- String :
- # Key/Value entityTags for this entity, optionally filtered by key
- #
- # Arguments
- # key: [Not documented]
- String!]): [Tag!] ( : [
- # type-specific traits
- EntityTraits! :
- # query insights
- #
- # Arguments
- # after: [Not documented]
- # filter: [Not documented]
- # first: [Not documented]
- # input: [Not documented]
- # sort: [Not documented]
- (
- String, :
- QueryFilter, :
- Int, :
- InsightFilter, :
- QuerySort!] : [
- ): InsightConnection
- # query observations
- #
- # Arguments
- # after: [Not documented]
- # filter: [Not documented]
- # first: [Not documented]
- # input: [Not documented]
- # sort: [Not documented]
- (
- String, :
- QueryFilter, :
- Int, :
- ObservationFilter, :
- QuerySort!] : [
- ): ObservationConnection
- # The managementEndpoint represents the endpoint through which this entity is
- # managed.
- # For public cloud resources this will be through the cloud account, for vCenter
- # or NSX resources it will represent the vCenter or NSX instance.
- # Management-plane resources such as those from vRealize or Ensemble products will
- # not have a managementEndpoint defined for them.
- ManagementEndpoint :
- # Security resources associated to arbitrary entities.
- #
- # **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.
- SecurityEntityInfo! :
- # guardrails types that will be contributed by guardrails service to an Entity
- GuardrailsTypes :
- # query logs for this entity
- #
- # Arguments
- # after: Return records after the given cursor, as per GraphQL
- # Relay spec
- # first: Return first N records in a paged response, as per
- # GraphQL Relay spec
- # input: [Not documented]
- String, : Int, : LogInput): LogConnection ( :
- # Finding entities associated to arbitrary entities.
- #
- # **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.
- FindingEntityInfo! :
- }
link Require by
- ActionRequestnull
- AriaNotificationTargetDescribes a notification target for Aria
- ArtifactAssessmentAn analysis done on an artifact is an assessment. An assessment is an operational data that captures user/project visibility information. Domain specific implementation may add to this as appropriate.
- ArtifactVulnerabilityEntityDetailsDetails of how a vulnerability affects an Entity
- AuthContextnull
- AuthRoleBindingnull
- AuthScopenull
- BuildRunA build run resource represents a single request to build an application
- BusinessAppMutationnull
- BusinessAppSourceTreenull
- CatalogA catalog resource represents a collection of software artifacts
- Dashboardnull
- DashboardDefaultnull
- EntityAggregationItemnull
- EntityConnectionnull
- EntityEdgenull
- EntityEdgeTraversalPathnull
- EntityGroupMutationnull
- EntityRelationshipA typed relationship between two Entity instances
- EntityScopesnull
- EventsNotificationRulenull
- FindingDescribes a Finding
- FindingNotificationRulenull
- FindingNotificationTargetDescribes a Notification Target
- FindingReportConfigurationReport Configuration.
- FindingSuppressionDescribe a finding suppression
- FindingSuppressionChangenull
- GuardrailsAccountStateProjectGuardrails account state project association
- GuardrailsDesiredStateIt is a combination of a guardrail template with required input parameters as well as the credentials metadata required to create infrastructure and enforce policies on the same. Guardrails DesiredState can be run on-demand, or on a pre-defined schedule, or in response to an event
- GuardrailsDesiredStateRunGuardrailsDesiredStateRun - It is a point-in-time instance of guardrails desired state run.
- GuardrailsDesiredStateRunResponseencapsulation of one or more runs resulting from a desired state being run
- GuardrailsEnforcedStateRepresents state that is enforced
- GuardrailsTemplateGuardrailsTemplate - It is a collection of guardrail states as code including landing zone, preventive guardrails, detective guardrails, all expressed as code.
- HubPolicyHub policy
- Insightnull
- InsightConnectionnull
- InsightImpactEntities impacted by an insight, and the type and size of impact. This must minimally include the originatingEntityId
- InsightNotificationRulenull
- InsightReclaimableResourceInfonull
- InsightReclamationInfoReclaimation information for a given cluster entity. Currently this information is provided for a vROPs ClusterComputeResource entity by fetching the information from vROPs. The schema however is generic.
- KubernetesKindAgentTargetRelationshipsRelationships to other nodes
- KubernetesKindAvailabilityTargetRelationshipsRelationships to other nodes
- KubernetesKindBuildConfigurationRelationshipsRelationships to other nodes
- KubernetesKindCertificateProviderRelationshipsRelationships to other nodes
- KubernetesKindClassClaimRelationshipsRelationships to other nodes
- KubernetesKindClusterGroupRelationshipsRelationships to other nodes
- KubernetesKindClusterRoleBindingRelationshipsRelationships to other nodes
- KubernetesKindClusterRoleRelationshipsRelationships to other nodes
- KubernetesKindClusterSyncResourceSetRelationshipsRelationships to other nodes
- KubernetesKindConfigMapRelationshipsRelationships to other nodes
- KubernetesKindContainerAppBuildPlanRelationshipsRelationships to other nodes
- KubernetesKindContainerAppRelationshipsRelationships to other nodes
- KubernetesKindCredentialRelationshipsRelationships to other nodes
- KubernetesKindDNSProviderRelationshipsRelationships to other nodes
- KubernetesKindDomainBindingRelationshipsRelationships to other nodes
- KubernetesKindDomainRelationshipsRelationships to other nodes
- KubernetesKindEgressPointRelationshipsRelationships to other nodes
- KubernetesKindEKSClusterRelationshipsRelationships to other nodes
- KubernetesKindEKSNodepoolRelationshipsRelationships to other nodes
- KubernetesKindEKSOptionRelationshipsRelationships to other nodes
- KubernetesKindEventRelationshipsRelationships to other nodes
- KubernetesKindEvictionRelationshipsRelationships to other nodes
- KubernetesKindHealthProbeRelationshipsRelationships to other nodes
- KubernetesKindHTTPRouteRelationshipsRelationships to other nodes
- KubernetesKindKubernetesClusterRelationshipsRelationships to other nodes
- KubernetesKindLimitRangeRelationshipsRelationships to other nodes
- KubernetesKindManagedNamespaceRelationshipsRelationships to other nodes
- KubernetesKindManagedNamespaceSetRelationshipsRelationships to other nodes
- KubernetesKindNamespaceRelationshipsRelationships to other nodes
- KubernetesKindNetworkNeighborSetRelationshipsRelationships to other nodes
- KubernetesKindPackageInstallRelationshipsRelationships to other nodes
- KubernetesKindPackageMetadataRelationshipsRelationships to other nodes
- KubernetesKindPackageRelationshipsRelationships to other nodes
- KubernetesKindPackageRepositoryRelationshipsRelationships to other nodes
- KubernetesKindPodSecurityPolicyRelationshipsRelationships to other nodes
- KubernetesKindPreProvisionedServiceRelationshipsRelationships to other nodes
- KubernetesKindProfileRelationshipsRelationships to other nodes
- KubernetesKindProjectRelationshipsRelationships to other nodes
- KubernetesKindRoleBindingRelationshipsRelationships to other nodes
- KubernetesKindRoleRelationshipsRelationships to other nodes
- KubernetesKindSecretExportRelationshipsRelationships to other nodes
- KubernetesKindSecretRelationshipsRelationships to other nodes
- KubernetesKindServiceAccountRelationshipsRelationships to other nodes
- KubernetesKindServiceBindingRelationshipsRelationships to other nodes
- KubernetesKindSpaceDisruptionBudgetRelationshipsRelationships to other nodes
- KubernetesKindSpaceOutputRelationshipsRelationships to other nodes
- KubernetesKindSpaceRelationshipsRelationships to other nodes
- KubernetesKindSpringCloudGatewayMappingRelationshipsRelationships to other nodes
- KubernetesKindSpringCloudGatewayRouteConfigRelationshipsRelationships to other nodes
- KubernetesKindSyncResourceSetRelationshipsRelationships to other nodes
- KubernetesKindTraitRelationshipsRelationships to other nodes
- KubernetesPackageCatalogA catalog represents a collection of installable package definitions.
- KubernetesResourceRelationshipsany relationship may be available from a generic kubernetes resource
- ManagementEndpointA management endpoint is an abstraction of the place to which to connect to monitor/manage a system. In the public cloud world this can be considered as an "account" (AWS), "subscription" (Azure), or "project" (GCP). In the on-prem vCenter / VMX world a management endpoint can refer to a vCenter or NSX-Manager instance and its URL. In order to support other management endpoints in the future, the management endpoint is considered a point through which a system, with its discovered entities, can be monitored and/or managed.
- ManagementEndpointCredentialCredential - holds credential information that can be used to access one or more cloud accounts.
- NetworkCommunicationEndpointnull
- NetworkCommunicationSummarynull
- NetworkEntityFlowCountByFlowTypeEntrydescribes an entity to destination flow count
- NetworkFlowSummaryEntry a single unit of flow summary entry with a target application entity
- NetworkHybridConnectivityUtilizationEntry a single unit of Hybrid connectivity utilization entry.
- NetworkOverviewnull
- NetworkServicenull
- NetworkStatsServicenull
- NotificationRulenull
- NotificationTargetDescribes a notification target
- ObservabilityAlertObservability Alert to trigger Alerts on metrics/logs
- ObservabilityAlertNotificationRulenull
- ObservabilityLogAlertObservability Log Alert to trigger Alerts on logs
- ObservabilityMetricAlertObservability Metric Alert to trigger Alerts on metrics
- ObservationA point-in-time observation about the state of something in the system which may interest our insight service
- ObservationConnectionnull
- RepositoryEndpointRepresents an endpoint that can be used access one or more repositories. Eg. gitlab.eng.vmware.com Example providers (gitlab, github). Concrete implementation would also add other details like credentials to this as applicable.
- SecurityFindingDescribes a security finding
- SecurityPolicyImpactedEntitiesnull
- SecurityPolicyImpactedEntityRelationshipnull
- SecuritySuppressionDescribe a security suppression
- SecuritySuppressionRequestnull
- SpringArtifactAssessmentAssessment is systematically evaluating and appraising a Spring or non-spring Artifacts/GIT Repository. This comprehensive analysis aims to derive valuable insights, findings, and recommendations, ultimately resulting in a detailed report that focuses on specific aspects of the Tanzu Hub product.
- SpringArtifactRepositoryEndpointRepresents an endpoint that can be used access one or more repositories. Eg. gitlab.eng.vmware.com As of now we are only supporting PRIVATE repositories, so there is no need to configure credentials in SAAS. PUBLIC will be supported in next phase
- SpringPolicySpring policy
- StatsList of time-series stats for the given entity.
- StatsRelatedEntitynull
- TacCatalogA catalog resource represents a set of curated applications available for installation through Tanzu Application Catalog (TAC) for a given organization. Most resources extends graphql built-in Node type because they represent a persisted object in the TAC domain storage.
- TanzuHubPolicyHub policy
- UserInterestScore Represent User's Interest Score in a entity
- UserPrefnull
- UserServiceRoleUser Service Role type
- _CatalogFederatednull
- _NotificationRulePrivatenull
- _NotificationTargetPrivatenull