Class GetContextGraphRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudwatchomni.model.CloudWatchOmniRequest
software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetContextGraphRequest.Builder,GetContextGraphRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetContextGraphRequest extends CloudWatchOmniRequest implements ToCopyableBuilder<GetContextGraphRequest.Builder,GetContextGraphRequest>

The request for retrieving a slice of the context graph.

  • Method Details

    • nodeFilters

      public final NodeFilters nodeFilters()

      Criteria restricting which nodes are returned.

      Returns:
      Criteria restricting which nodes are returned.

    • edgeFilters

      public final EdgeFilters edgeFilters()

      Criteria restricting which edges are returned.

      Returns:
      Criteria restricting which edges are returned.

    • startTime

      public final Instant startTime()

      Start of the time range (UTC), inclusive.

      Returns:
      Start of the time range (UTC), inclusive.

    • endTime

      public final Instant endTime()

      End of the time range (UTC), inclusive.

      Returns:
      End of the time range (UTC), inclusive.

    • depth

      public final Integer depth()

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

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

    • maxResults

      public final Integer maxResults()

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

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

    • maxEdgesPerNode

      public final Integer maxEdgesPerNode()

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

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

    • includeMetadata

      public final 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.

      Returns:
      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.

    • nextToken

      public final String nextToken()

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

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

    • toBuilder

      public GetContextGraphRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetContextGraphRequest.Builder,GetContextGraphRequest>
      Specified by:
      toBuilder in class CloudWatchOmniRequest
      Returns:
      a builder for type T

    • builder

      public static GetContextGraphRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetContextGraphRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.