Package software.amazon.awssdk.services.ec2.model

Class GetCapacityManagerMetricDataRequest

    • Method Detail

      • metricNames

        public final List<Metric> metricNames()

        The names of the metrics to retrieve. Maximum of 10 metrics per request.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricNames() method.

        Returns:
        The names of the metrics to retrieve. Maximum of 10 metrics per request.

      • hasMetricNames

        public final boolean hasMetricNames()
        For responses, this returns true if the service returned a value for the MetricNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • metricNamesAsStrings

        public final List<String> metricNamesAsStrings()

        The names of the metrics to retrieve. Maximum of 10 metrics per request.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricNames() method.

        Returns:
        The names of the metrics to retrieve. Maximum of 10 metrics per request.

      • startTime

        public final Instant startTime()

        The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period.

        Returns:
        The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period.

      • endTime

        public final Instant endTime()

        The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point.

        Returns:
        The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point.

      • period

        public final Integer period()

        The granularity, in seconds, of the returned data points.

        Returns:
        The granularity, in seconds, of the returned data points.

      • groupBy

        public final List<GroupBy> groupBy()

        The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupBy() method.

        Returns:
        The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

      • hasGroupBy

        public final boolean hasGroupBy()
        For responses, this returns true if the service returned a value for the GroupBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • groupByAsStrings

        public final List<String> groupByAsStrings()

        The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupBy() method.

        Returns:
        The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

      • hasFilterBy

        public final boolean hasFilterBy()
        For responses, this returns true if the service returned a value for the FilterBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • filterBy

        public final List<CapacityManagerCondition> filterBy()

        Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilterBy() method.

        Returns:
        Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.

      • maxResults

        public final Integer maxResults()

        The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets.

        Returns:
        The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets.

      • nextToken

        public final String nextToken()

        The token for the next page of results. Use this value in a subsequent call to retrieve additional data points.

        Returns:
        The token for the next page of results. Use this value in a subsequent call to retrieve additional data points.

      • dryRun

        public final Boolean dryRun()

        Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

        Returns:
        Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      • 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