Interface GetContextGraphRequest.Builder

  • Method Details

    • nodeFilters

      GetContextGraphRequest.Builder nodeFilters(NodeFilters nodeFilters)

      Criteria restricting which nodes are returned.

      Parameters:
      nodeFilters - Criteria restricting which nodes are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • nodeFilters

      default GetContextGraphRequest.Builder nodeFilters(Consumer<NodeFilters.Builder> nodeFilters)

      Criteria restricting which nodes are returned.

      This is a convenience method that creates an instance of the NodeFilters.Builder avoiding the need to create one manually via NodeFilters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nodeFilters(NodeFilters).

      Parameters:
      nodeFilters - a consumer that will call methods on NodeFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • edgeFilters

      GetContextGraphRequest.Builder edgeFilters(EdgeFilters edgeFilters)

      Criteria restricting which edges are returned.

      Parameters:
      edgeFilters - Criteria restricting which edges are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • edgeFilters

      default GetContextGraphRequest.Builder edgeFilters(Consumer<EdgeFilters.Builder> edgeFilters)

      Criteria restricting which edges are returned.

      This is a convenience method that creates an instance of the EdgeFilters.Builder avoiding the need to create one manually via EdgeFilters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to edgeFilters(EdgeFilters).

      Parameters:
      edgeFilters - a consumer that will call methods on EdgeFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • startTime

      Start of the time range (UTC), inclusive.

      Parameters:
      startTime - Start of the time range (UTC), inclusive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endTime

      End of the time range (UTC), inclusive.

      Parameters:
      endTime - End of the time range (UTC), inclusive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • depth

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

      Parameters:
      depth - How many hops to traverse out from the nodes matched by nodeFilters. 0 returns only the matched nodes themselves.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maxResults

      GetContextGraphRequest.Builder maxResults(Integer maxResults)

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

      Parameters:
      maxResults - The maximum number of nodes to return in a single page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maxEdgesPerNode

      GetContextGraphRequest.Builder maxEdgesPerNode(Integer maxEdgesPerNode)

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

      Parameters:
      maxEdgesPerNode - The maximum number of edges to return per node, bounding the fan-out of a densely connected node.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • includeMetadata

      GetContextGraphRequest.Builder includeMetadata(Boolean includeMetadata)

      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.

      Parameters:
      includeMetadata - 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:
      Returns a reference to this object so that method calls can be chained together.
    • nextToken

      GetContextGraphRequest.Builder nextToken(String nextToken)

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

      Parameters:
      nextToken - Pagination token from a previous response, to retrieve the next page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      GetContextGraphRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.