public static interface ListMetricsRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<ListMetricsRequest.Builder,ListMetricsRequest>
Modifier and Type | Method and Description |
---|---|
ListMetricsRequest.Builder |
dimensions(Collection<DimensionFilter> dimensions)
The dimensions to filter against.
|
ListMetricsRequest.Builder |
dimensions(Consumer<DimensionFilter.Builder>... dimensions)
The dimensions to filter against.
|
ListMetricsRequest.Builder |
dimensions(DimensionFilter... dimensions)
The dimensions to filter against.
|
ListMetricsRequest.Builder |
includeLinkedAccounts(Boolean includeLinkedAccounts)
If you are using this operation in a monitoring account, specify
true to include metrics from
source accounts in the returned data. |
ListMetricsRequest.Builder |
metricName(String metricName)
The name of the metric to filter against.
|
ListMetricsRequest.Builder |
namespace(String namespace)
The metric namespace to filter against.
|
ListMetricsRequest.Builder |
nextToken(String nextToken)
The token returned by a previous call to indicate that there is more data available.
|
ListMetricsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
ListMetricsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
ListMetricsRequest.Builder |
owningAccount(String owningAccount)
When you use this operation in a monitoring account, use this field to return metrics only from one source
account.
|
ListMetricsRequest.Builder |
recentlyActive(RecentlyActive recentlyActive)
To filter the results to show only metrics that have had data points published in the past three hours,
specify this parameter with a value of
PT3H . |
ListMetricsRequest.Builder |
recentlyActive(String recentlyActive)
To filter the results to show only metrics that have had data points published in the past three hours,
specify this parameter with a value of
PT3H . |
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListMetricsRequest.Builder namespace(String namespace)
The metric namespace to filter against. Only the namespace that matches exactly will be returned.
namespace
- The metric namespace to filter against. Only the namespace that matches exactly will be returned.ListMetricsRequest.Builder metricName(String metricName)
The name of the metric to filter against. Only the metrics with names that match exactly will be returned.
metricName
- The name of the metric to filter against. Only the metrics with names that match exactly will be
returned.ListMetricsRequest.Builder dimensions(Collection<DimensionFilter> dimensions)
The dimensions to filter against. Only the dimensions that match exactly will be returned.
dimensions
- The dimensions to filter against. Only the dimensions that match exactly will be returned.ListMetricsRequest.Builder dimensions(DimensionFilter... dimensions)
The dimensions to filter against. Only the dimensions that match exactly will be returned.
dimensions
- The dimensions to filter against. Only the dimensions that match exactly will be returned.ListMetricsRequest.Builder dimensions(Consumer<DimensionFilter.Builder>... dimensions)
The dimensions to filter against. Only the dimensions that match exactly will be returned.
This is a convenience method that creates an instance of theDimensionFilter.Builder
avoiding the need to create
one manually via DimensionFilter.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called
immediately and its result is passed to #dimensions(List
.
dimensions
- a consumer that will call methods on
DimensionFilter.Builder
#dimensions(java.util.Collection)
ListMetricsRequest.Builder nextToken(String nextToken)
The token returned by a previous call to indicate that there is more data available.
nextToken
- The token returned by a previous call to indicate that there is more data available.ListMetricsRequest.Builder recentlyActive(String recentlyActive)
To filter the results to show only metrics that have had data points published in the past three hours,
specify this parameter with a value of PT3H
. This is the only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
recentlyActive
- To filter the results to show only metrics that have had data points published in the past three
hours, specify this parameter with a value of PT3H
. This is the only valid value for this
parameter.
The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
RecentlyActive
,
RecentlyActive
ListMetricsRequest.Builder recentlyActive(RecentlyActive recentlyActive)
To filter the results to show only metrics that have had data points published in the past three hours,
specify this parameter with a value of PT3H
. This is the only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
recentlyActive
- To filter the results to show only metrics that have had data points published in the past three
hours, specify this parameter with a value of PT3H
. This is the only valid value for this
parameter.
The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
RecentlyActive
,
RecentlyActive
ListMetricsRequest.Builder includeLinkedAccounts(Boolean includeLinkedAccounts)
If you are using this operation in a monitoring account, specify true
to include metrics from
source accounts in the returned data.
The default is false
.
includeLinkedAccounts
- If you are using this operation in a monitoring account, specify true
to include metrics
from source accounts in the returned data.
The default is false
.
ListMetricsRequest.Builder owningAccount(String owningAccount)
When you use this operation in a monitoring account, use this field to return metrics only from one source
account. To do so, specify that source account ID in this field, and also specify true
for
IncludeLinkedAccounts
.
owningAccount
- When you use this operation in a monitoring account, use this field to return metrics only from one
source account. To do so, specify that source account ID in this field, and also specify
true
for IncludeLinkedAccounts
.ListMetricsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
ListMetricsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.