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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GetMetricStreamResponse.Builder
arn(String arn)
The ARN of the metric stream.GetMetricStreamResponse.Builder
creationDate(Instant creationDate)
The date that the metric stream was created.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.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.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.GetMetricStreamResponse.Builder
firehoseArn(String firehoseArn)
The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.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.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.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.GetMetricStreamResponse.Builder
includeLinkedAccountsMetrics(Boolean includeLinkedAccountsMetrics)
If this istrue
and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.GetMetricStreamResponse.Builder
lastUpdateDate(Instant lastUpdateDate)
The date of the most recent update to the metric stream's configuration.GetMetricStreamResponse.Builder
name(String name)
The name of the metric stream.GetMetricStreamResponse.Builder
outputFormat(String outputFormat)
The output format for the stream.GetMetricStreamResponse.Builder
outputFormat(MetricStreamOutputFormat outputFormat)
The output format for the stream.GetMetricStreamResponse.Builder
roleArn(String roleArn)
The ARN of the IAM role that is used by this metric stream.GetMetricStreamResponse.Builder
state(String state)
The state of the metric stream.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.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.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.-
Methods inherited from interface software.amazon.awssdk.services.cloudwatch.model.CloudWatchResponse.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
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 theMetricStreamFilter.Builder
avoiding the need to create one manually viaMetricStreamFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#includeFilters(List
.) - Parameters:
includeFilters
- a consumer that will call methods onMetricStreamFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#includeFilters(java.util.Collection
)
-
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 theMetricStreamFilter.Builder
avoiding the need to create one manually viaMetricStreamFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#excludeFilters(List
.) - Parameters:
excludeFilters
- a consumer that will call methods onMetricStreamFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#excludeFilters(java.util.Collection
)
-
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
andstopped
.- Parameters:
state
- The state of the metric stream. The possible values arerunning
andstopped
.- 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
, andopentelemetry0.7
. For more information about metric stream output formats, see Metric streams output formats.- Parameters:
outputFormat
- The output format for the stream. Valid values arejson
,opentelemetry1.0
, andopentelemetry0.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:
MetricStreamOutputFormat
,MetricStreamOutputFormat
-
outputFormat
GetMetricStreamResponse.Builder outputFormat(MetricStreamOutputFormat outputFormat)
The output format for the stream. Valid values are
json
,opentelemetry1.0
, andopentelemetry0.7
. For more information about metric stream output formats, see Metric streams output formats.- Parameters:
outputFormat
- The output format for the stream. Valid values arejson
,opentelemetry1.0
, andopentelemetry0.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:
MetricStreamOutputFormat
,MetricStreamOutputFormat
-
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 theMetricStreamStatisticsConfiguration.Builder
avoiding the need to create one manually viaMetricStreamStatisticsConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#statisticsConfigurations(List
.) - Parameters:
statisticsConfigurations
- a consumer that will call methods onMetricStreamStatisticsConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#statisticsConfigurations(java.util.Collection
)
-
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 istrue
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.
-
-