Class: Aws::CloudWatchOmni::Types::GetContextGraphInput

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchOmni::Types::GetContextGraphInput

Defined in:

gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb

Overview

The request for retrieving a slice of the context graph.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #depth ⇒ Integer

  How many hops to traverse out from the nodes matched by nodeFilters.

• #edge_filters ⇒ Types::EdgeFilters

  Criteria restricting which edges are returned.

• #end_time ⇒ Time

  End of the time range (UTC), inclusive.

• #include_metadata ⇒ Boolean

  Whether to return the metadata block, semantics included, on each node and edge.

• #max_edges_per_node ⇒ Integer

  The maximum number of edges to return per node, bounding the fan-out of a densely connected node.

• #max_results ⇒ Integer

  The maximum number of nodes to return in a single page.

• #next_token ⇒ String

  Pagination token from a previous response, to retrieve the next page.

• #node_filters ⇒ Types::NodeFilters

  Criteria restricting which nodes are returned.

• #start_time ⇒ Time

  Start of the time range (UTC), inclusive.

Instance Attribute Details

#depth ⇒ Integer

How many hops to traverse out from the nodes matched by nodeFilters. 0 returns only the matched nodes themselves.

Returns:

• (Integer)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2101

class GetContextGraphInput < Struct.new(
  :node_filters,
  :edge_filters,
  :start_time,
  :end_time,
  :depth,
  :max_results,
  :max_edges_per_node,
  :include_metadata,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#edge_filters ⇒ Types::EdgeFilters

Criteria restricting which edges are returned.

Returns:

• (Types::EdgeFilters)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2101

class GetContextGraphInput < Struct.new(
  :node_filters,
  :edge_filters,
  :start_time,
  :end_time,
  :depth,
  :max_results,
  :max_edges_per_node,
  :include_metadata,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

End of the time range (UTC), inclusive.

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2101

class GetContextGraphInput < Struct.new(
  :node_filters,
  :edge_filters,
  :start_time,
  :end_time,
  :depth,
  :max_results,
  :max_edges_per_node,
  :include_metadata,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#include_metadata ⇒ Boolean

Whether to return the metadata block, semantics included, on each node and edge. Off by default because it costs an extra lookup per returned node.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2101

class GetContextGraphInput < Struct.new(
  :node_filters,
  :edge_filters,
  :start_time,
  :end_time,
  :depth,
  :max_results,
  :max_edges_per_node,
  :include_metadata,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_edges_per_node ⇒ Integer

The maximum number of edges to return per node, bounding the fan-out of a densely connected node.

Returns:

• (Integer)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2101

class GetContextGraphInput < Struct.new(
  :node_filters,
  :edge_filters,
  :start_time,
  :end_time,
  :depth,
  :max_results,
  :max_edges_per_node,
  :include_metadata,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of nodes to return in a single page.

Returns:

• (Integer)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2101

class GetContextGraphInput < Struct.new(
  :node_filters,
  :edge_filters,
  :start_time,
  :end_time,
  :depth,
  :max_results,
  :max_edges_per_node,
  :include_metadata,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Pagination token from a previous response, to retrieve the next page.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2101

class GetContextGraphInput < Struct.new(
  :node_filters,
  :edge_filters,
  :start_time,
  :end_time,
  :depth,
  :max_results,
  :max_edges_per_node,
  :include_metadata,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#node_filters ⇒ Types::NodeFilters

Criteria restricting which nodes are returned.

Returns:

• (Types::NodeFilters)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2101

class GetContextGraphInput < Struct.new(
  :node_filters,
  :edge_filters,
  :start_time,
  :end_time,
  :depth,
  :max_results,
  :max_edges_per_node,
  :include_metadata,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

Start of the time range (UTC), inclusive.

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 2101

class GetContextGraphInput < Struct.new(
  :node_filters,
  :edge_filters,
  :start_time,
  :end_time,
  :depth,
  :max_results,
  :max_edges_per_node,
  :include_metadata,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end