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

Interface GetMetricStreamResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CloudWatchResponse.Builder, CopyableBuilder<GetMetricStreamResponse.Builder,GetMetricStreamResponse>, SdkBuilder<GetMetricStreamResponse.Builder,GetMetricStreamResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetMetricStreamResponse
public static interface GetMetricStreamResponse.Builder extends CloudWatchResponse.Builder, SdkPojo, CopyableBuilder<GetMetricStreamResponse.Builder,GetMetricStreamResponse>

  • Method Details

    • arn

      GetMetricStreamResponse.Builder arn(String arn)

      The ARN of the metric stream.

      Parameters:
      arn - The ARN of the metric stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetMetricStreamResponse.Builder name(String name)

      The name of the metric stream.

      Parameters:
      name - The name of the metric stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeFilters

      GetMetricStreamResponse.Builder includeFilters(Collection<MetricStreamFilter> includeFilters)

      If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

      Parameters:
      includeFilters - If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeFilters

      GetMetricStreamResponse.Builder includeFilters(MetricStreamFilter... includeFilters)

      If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

      Parameters:
      includeFilters - If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeFilters

      GetMetricStreamResponse.Builder includeFilters(Consumer<MetricStreamFilter.Builder>... includeFilters)

      If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

      This is a convenience method that creates an instance of the MetricStreamFilter.Builder avoiding the need to create one manually via MetricStreamFilter.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to includeFilters(List<MetricStreamFilter>).

      Parameters:
      includeFilters - a consumer that will call methods on MetricStreamFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • excludeFilters

      GetMetricStreamResponse.Builder excludeFilters(Collection<MetricStreamFilter> excludeFilters)

      If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.

      Parameters:
      excludeFilters - If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeFilters

      GetMetricStreamResponse.Builder excludeFilters(MetricStreamFilter... excludeFilters)

      If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.

      Parameters:
      excludeFilters - If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeFilters

      GetMetricStreamResponse.Builder excludeFilters(Consumer<MetricStreamFilter.Builder>... excludeFilters)

      If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.

      This is a convenience method that creates an instance of the MetricStreamFilter.Builder avoiding the need to create one manually via MetricStreamFilter.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to excludeFilters(List<MetricStreamFilter>).

      Parameters:
      excludeFilters - a consumer that will call methods on MetricStreamFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • firehoseArn

      GetMetricStreamResponse.Builder firehoseArn(String firehoseArn)

      The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.

      Parameters:
      firehoseArn - The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      GetMetricStreamResponse.Builder roleArn(String roleArn)

      The ARN of the IAM role that is used by this metric stream.

      Parameters:
      roleArn - The ARN of the IAM role that is used by this metric stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      GetMetricStreamResponse.Builder state(String state)

      The state of the metric stream. The possible values are running and stopped.

      Parameters:
      state - The state of the metric stream. The possible values are running and stopped.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationDate

      GetMetricStreamResponse.Builder creationDate(Instant creationDate)

      The date that the metric stream was created.

      Parameters:
      creationDate - The date that the metric stream was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdateDate

      GetMetricStreamResponse.Builder lastUpdateDate(Instant lastUpdateDate)

      The date of the most recent update to the metric stream's configuration.

      Parameters:
      lastUpdateDate - The date of the most recent update to the metric stream's configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputFormat

      GetMetricStreamResponse.Builder outputFormat(String outputFormat)

      The output format for the stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

      Parameters:
      outputFormat - The output format for the stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputFormat

      GetMetricStreamResponse.Builder outputFormat(MetricStreamOutputFormat outputFormat)

      The output format for the stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

      Parameters:
      outputFormat - The output format for the stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statisticsConfigurations

      GetMetricStreamResponse.Builder statisticsConfigurations(Collection<MetricStreamStatisticsConfiguration> statisticsConfigurations)

      Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.

      Parameters:
      statisticsConfigurations - Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statisticsConfigurations

      GetMetricStreamResponse.Builder statisticsConfigurations(MetricStreamStatisticsConfiguration... statisticsConfigurations)

      Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.

      Parameters:
      statisticsConfigurations - Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statisticsConfigurations

      GetMetricStreamResponse.Builder statisticsConfigurations(Consumer<MetricStreamStatisticsConfiguration.Builder>... statisticsConfigurations)

      Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.

      This is a convenience method that creates an instance of the MetricStreamStatisticsConfiguration.Builder avoiding the need to create one manually via MetricStreamStatisticsConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to statisticsConfigurations(List<MetricStreamStatisticsConfiguration>).

      Parameters:
      statisticsConfigurations - a consumer that will call methods on MetricStreamStatisticsConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includeLinkedAccountsMetrics

      GetMetricStreamResponse.Builder includeLinkedAccountsMetrics(Boolean includeLinkedAccountsMetrics)

      If this is true and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.

      Parameters:
      includeLinkedAccountsMetrics - If this is true and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.