Class StartQueryWorkloadInsightsTopContributorsDataRequest

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

  • Method Details

    • scopeId

      public final String scopeId()

      The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

      Returns:
      The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

    • startTime

      public final Instant startTime()

      The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

      Returns:
      The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

    • endTime

      public final Instant endTime()

      The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

      Returns:
      The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

    • metricName

      public final WorkloadInsightsMetric metricName()

      The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

      If the service returns an enum value that is not available in the current SDK version, metricName will return WorkloadInsightsMetric.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

      Returns:
      The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.
      See Also:

    • metricNameAsString

      public final String metricNameAsString()

      The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

      If the service returns an enum value that is not available in the current SDK version, metricName will return WorkloadInsightsMetric.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

      Returns:
      The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.
      See Also:

    • destinationCategory

      public final DestinationCategory destinationCategory()

      The destination category for a top contributors. Destination categories can be one of the following:

      • INTRA_AZ: Top contributor network flows within a single Availability Zone

      • INTER_AZ: Top contributor network flows between Availability Zones

      • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

      • INTER_VPC: Top contributor network flows between VPCs

      • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

      • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

      If the service returns an enum value that is not available in the current SDK version, destinationCategory will return DestinationCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationCategoryAsString().

      Returns:
      The destination category for a top contributors. Destination categories can be one of the following:

      • INTRA_AZ: Top contributor network flows within a single Availability Zone

      • INTER_AZ: Top contributor network flows between Availability Zones

      • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

      • INTER_VPC: Top contributor network flows between VPCs

      • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

      • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

      See Also:

    • destinationCategoryAsString

      public final String destinationCategoryAsString()

      The destination category for a top contributors. Destination categories can be one of the following:

      • INTRA_AZ: Top contributor network flows within a single Availability Zone

      • INTER_AZ: Top contributor network flows between Availability Zones

      • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

      • INTER_VPC: Top contributor network flows between VPCs

      • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

      • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

      If the service returns an enum value that is not available in the current SDK version, destinationCategory will return DestinationCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationCategoryAsString().

      Returns:
      The destination category for a top contributors. Destination categories can be one of the following:

      • INTRA_AZ: Top contributor network flows within a single Availability Zone

      • INTER_AZ: Top contributor network flows between Availability Zones

      • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

      • INTER_VPC: Top contributor network flows between VPCs

      • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

      • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

      See Also:

    • toBuilder

      public StartQueryWorkloadInsightsTopContributorsDataRequest.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<StartQueryWorkloadInsightsTopContributorsDataRequest.Builder,StartQueryWorkloadInsightsTopContributorsDataRequest>
      Specified by:
      toBuilder in class NetworkFlowMonitorRequest
      Returns:
      a builder for type T

    • builder

      public static StartQueryWorkloadInsightsTopContributorsDataRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartQueryWorkloadInsightsTopContributorsDataRequest.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.