Package software.amazon.awssdk.services.cloudwatch.model

Interface ListMetricsRequest.Builder

    • Method Detail

      • namespace

        ListMetricsRequest.Builder namespace​(String namespace)

        The metric namespace to filter against. Only the namespace that matches exactly will be returned.

        Parameters:
        namespace - The metric namespace to filter against. Only the namespace that matches exactly will be returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metricName

        ListMetricsRequest.Builder metricName​(String metricName)

        The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

        Parameters:
        metricName - The name of the metric to filter against. Only the metrics with names that match exactly will be returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dimensions

        ListMetricsRequest.Builder dimensions​(Collection<DimensionFilter> dimensions)

        The dimensions to filter against. Only the dimensions that match exactly will be returned.

        Parameters:
        dimensions - The dimensions to filter against. Only the dimensions that match exactly will be returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dimensions

        ListMetricsRequest.Builder dimensions​(DimensionFilter... dimensions)

        The dimensions to filter against. Only the dimensions that match exactly will be returned.

        Parameters:
        dimensions - The dimensions to filter against. Only the dimensions that match exactly will be returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListMetricsRequest.Builder nextToken​(String nextToken)

        The token returned by a previous call to indicate that there is more data available.

        Parameters:
        nextToken - The token returned by a previous call to indicate that there is more data available.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • recentlyActive

        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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RecentlyActive, 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RecentlyActive, RecentlyActive

      • includeLinkedAccounts

        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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • owningAccount

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.