Package software.amazon.awssdk.services.networkflowmonitor.model

Class StartQueryWorkloadInsightsTopContributorsRequest

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.StartQueryWorkloadInsightsTopContributorsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartQueryWorkloadInsightsTopContributorsRequest.Builder,StartQueryWorkloadInsightsTopContributorsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartQueryWorkloadInsightsTopContributorsRequest
extends NetworkFlowMonitorRequest
implements ToCopyableBuilder<StartQueryWorkloadInsightsTopContributorsRequest.Builder,StartQueryWorkloadInsightsTopContributorsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartQueryWorkloadInsightsTopContributorsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartQueryWorkloadInsightsTopContributorsRequest.Builder	builder()
DestinationCategory	destinationCategory()	The destination category for a top contributors row.
String	destinationCategoryAsString()	The destination category for a top contributors row.
Instant	endTime()	The timestamp that is the date and time end of the period that you want to retrieve results for with your query.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The maximum number of top contributors to return.
WorkloadInsightsMetric	metricName()	The metric that you want to query top contributors for.
String	metricNameAsString()	The metric that you want to query top contributors for.
String	scopeId()	The identifier for the scope that includes the resources you want to get data results for.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartQueryWorkloadInsightsTopContributorsRequest.Builder>	serializableBuilderClass()
Instant	startTime()	The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.
StartQueryWorkloadInsightsTopContributorsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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. A scope ID is returned from a CreateScope API call.

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. A scope ID is returned from a CreateScope API call.

startTime

public final Instant startTime()

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

Returns:

The timestamp that is the date and time 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:

WorkloadInsightsMetric

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:

WorkloadInsightsMetric

destinationCategory

public final DestinationCategory destinationCategory()

The destination category for a top contributors row. 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_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 row. 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_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:

DestinationCategory

destinationCategoryAsString

public final String destinationCategoryAsString()

The destination category for a top contributors row. 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_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 row. 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_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:

DestinationCategory

limit

public final Integer limit()

The maximum number of top contributors to return.

Returns:

The maximum number of top contributors to return.

toBuilder

public StartQueryWorkloadInsightsTopContributorsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartQueryWorkloadInsightsTopContributorsRequest.Builder,StartQueryWorkloadInsightsTopContributorsRequest>

Specified by:

toBuilder in class NetworkFlowMonitorRequest

builder

public static StartQueryWorkloadInsightsTopContributorsRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo