software.amazon.awssdk.services.pi.model.MetricQuery Maven / Gradle / Ivy
Show all versions of pi Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.pi.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A single query to be processed. You must provide the metric to query and append an aggregate function to the metric.
* For example, to find the average for the metric db.load you must use db.load.avg. Valid
* values for aggregate functions include .avg, .min, .max, and .sum
* . If no other parameters are specified, Performance Insights returns all data points for the specified metric.
* Optionally, you can request that the data points be aggregated by dimension group (GroupBy), and return
* only those data points that match your criteria (Filter).
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MetricQuery implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField METRIC_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Metric")
.getter(getter(MetricQuery::metric)).setter(setter(Builder::metric))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Metric").build()).build();
private static final SdkField GROUP_BY_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("GroupBy").getter(getter(MetricQuery::groupBy)).setter(setter(Builder::groupBy))
.constructor(DimensionGroup::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupBy").build()).build();
private static final SdkField> FILTER_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Filter")
.getter(getter(MetricQuery::filter))
.setter(setter(Builder::filter))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filter").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(METRIC_FIELD, GROUP_BY_FIELD,
FILTER_FIELD));
private static final long serialVersionUID = 1L;
private final String metric;
private final DimensionGroup groupBy;
private final Map filter;
private MetricQuery(BuilderImpl builder) {
this.metric = builder.metric;
this.groupBy = builder.groupBy;
this.filter = builder.filter;
}
/**
*
* The name of a Performance Insights metric to be measured.
*
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - A scaled representation of the number of active sessions for the database engine.
*
*
* -
*
* db.sampledload.avg - The raw number of active sessions for the database engine.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of active sessions
* is greater than the internal threshold, Performance Insights samples the active sessions, with
* db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and
* db.sampledload.avg less than db.load.avg. For most use cases, you can query
* db.load.avg only.
*
*
* @return The name of a Performance Insights metric to be measured.
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - A scaled representation of the number of active sessions for the database
* engine.
*
*
* -
*
* db.sampledload.avg - The raw number of active sessions for the database engine.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of active
* sessions is greater than the internal threshold, Performance Insights samples the active sessions, with
* db.load.avg showing the scaled values, db.sampledload.avg showing the raw
* values, and db.sampledload.avg less than db.load.avg. For most use cases, you
* can query db.load.avg only.
*/
public final String metric() {
return metric;
}
/**
*
* A specification for how to aggregate the data points from a query result. You must specify a valid dimension
* group. Performance Insights will return all of the dimensions within that group, unless you provide the names of
* specific dimensions within that group. You can also request that Performance Insights return a limited number of
* values for a dimension.
*
*
* @return A specification for how to aggregate the data points from a query result. You must specify a valid
* dimension group. Performance Insights will return all of the dimensions within that group, unless you
* provide the names of specific dimensions within that group. You can also request that Performance
* Insights return a limited number of values for a dimension.
*/
public final DimensionGroup groupBy() {
return groupBy;
}
/**
* For responses, this returns true if the service returned a value for the Filter property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasFilter() {
return filter != null && !(filter instanceof SdkAutoConstructMap);
}
/**
*
* One or more filters to apply in the request. Restrictions:
*
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
*
*
* 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 {@link #hasFilter} method.
*
*
* @return One or more filters to apply in the request. Restrictions:
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
*/
public final Map filter() {
return filter;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(metric());
hashCode = 31 * hashCode + Objects.hashCode(groupBy());
hashCode = 31 * hashCode + Objects.hashCode(hasFilter() ? filter() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof MetricQuery)) {
return false;
}
MetricQuery other = (MetricQuery) obj;
return Objects.equals(metric(), other.metric()) && Objects.equals(groupBy(), other.groupBy())
&& hasFilter() == other.hasFilter() && Objects.equals(filter(), other.filter());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("MetricQuery").add("Metric", metric()).add("GroupBy", groupBy())
.add("Filter", hasFilter() ? filter() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Metric":
return Optional.ofNullable(clazz.cast(metric()));
case "GroupBy":
return Optional.ofNullable(clazz.cast(groupBy()));
case "Filter":
return Optional.ofNullable(clazz.cast(filter()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MetricQuery) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of a Performance Insights metric to be measured.
*
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - A scaled representation of the number of active sessions for the database engine.
*
*
* -
*
* db.sampledload.avg - The raw number of active sessions for the database engine.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of active
* sessions is greater than the internal threshold, Performance Insights samples the active sessions, with
* db.load.avg showing the scaled values, db.sampledload.avg showing the raw values,
* and db.sampledload.avg less than db.load.avg. For most use cases, you can query
* db.load.avg only.
*
*
* @param metric
* The name of a Performance Insights metric to be measured.
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - A scaled representation of the number of active sessions for the database
* engine.
*
*
* -
*
* db.sampledload.avg - The raw number of active sessions for the database engine.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of
* active sessions is greater than the internal threshold, Performance Insights samples the active
* sessions, with db.load.avg showing the scaled values, db.sampledload.avg
* showing the raw values, and db.sampledload.avg less than db.load.avg. For
* most use cases, you can query db.load.avg only.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metric(String metric);
/**
*
* A specification for how to aggregate the data points from a query result. You must specify a valid dimension
* group. Performance Insights will return all of the dimensions within that group, unless you provide the names
* of specific dimensions within that group. You can also request that Performance Insights return a limited
* number of values for a dimension.
*
*
* @param groupBy
* A specification for how to aggregate the data points from a query result. You must specify a valid
* dimension group. Performance Insights will return all of the dimensions within that group, unless you
* provide the names of specific dimensions within that group. You can also request that Performance
* Insights return a limited number of values for a dimension.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupBy(DimensionGroup groupBy);
/**
*
* A specification for how to aggregate the data points from a query result. You must specify a valid dimension
* group. Performance Insights will return all of the dimensions within that group, unless you provide the names
* of specific dimensions within that group. You can also request that Performance Insights return a limited
* number of values for a dimension.
*
* This is a convenience method that creates an instance of the {@link DimensionGroup.Builder} avoiding the need
* to create one manually via {@link DimensionGroup#builder()}.
*
*
* When the {@link Consumer} completes, {@link DimensionGroup.Builder#build()} is called immediately and its
* result is passed to {@link #groupBy(DimensionGroup)}.
*
* @param groupBy
* a consumer that will call methods on {@link DimensionGroup.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #groupBy(DimensionGroup)
*/
default Builder groupBy(Consumer groupBy) {
return groupBy(DimensionGroup.builder().applyMutation(groupBy).build());
}
/**
*
* One or more filters to apply in the request. Restrictions:
*
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
*
*
* @param filter
* One or more filters to apply in the request. Restrictions:
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filter(Map filter);
}
static final class BuilderImpl implements Builder {
private String metric;
private DimensionGroup groupBy;
private Map filter = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(MetricQuery model) {
metric(model.metric);
groupBy(model.groupBy);
filter(model.filter);
}
public final String getMetric() {
return metric;
}
public final void setMetric(String metric) {
this.metric = metric;
}
@Override
public final Builder metric(String metric) {
this.metric = metric;
return this;
}
public final DimensionGroup.Builder getGroupBy() {
return groupBy != null ? groupBy.toBuilder() : null;
}
public final void setGroupBy(DimensionGroup.BuilderImpl groupBy) {
this.groupBy = groupBy != null ? groupBy.build() : null;
}
@Override
public final Builder groupBy(DimensionGroup groupBy) {
this.groupBy = groupBy;
return this;
}
public final Map getFilter() {
if (filter instanceof SdkAutoConstructMap) {
return null;
}
return filter;
}
public final void setFilter(Map filter) {
this.filter = MetricQueryFilterMapCopier.copy(filter);
}
@Override
public final Builder filter(Map filter) {
this.filter = MetricQueryFilterMapCopier.copy(filter);
return this;
}
@Override
public MetricQuery build() {
return new MetricQuery(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}