@Generated(value="software.amazon.awssdk:codegen") public final class PutMetricStreamRequest extends CloudWatchRequest implements ToCopyableBuilder<PutMetricStreamRequest.Builder,PutMetricStreamRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutMetricStreamRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static PutMetricStreamRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<MetricStreamFilter> |
excludeFilters()
If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that
you specify here.
|
String |
firehoseArn()
The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasExcludeFilters()
Returns true if the ExcludeFilters property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasIncludeFilters()
Returns true if the IncludeFilters property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
List<MetricStreamFilter> |
includeFilters()
If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify
here.
|
String |
name()
If you are creating a new metric stream, this is the name for the new stream.
|
MetricStreamOutputFormat |
outputFormat()
The output format for the stream.
|
String |
outputFormatAsString()
The output format for the stream.
|
String |
roleArn()
The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutMetricStreamRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
A list of key-value pairs to associate with the metric stream.
|
PutMetricStreamRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String name()
If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.
If you are updating a metric stream, specify the name of that stream here.
Valid characters are A-Z, a-z, 0-9, "-" and "_".
If you are updating a metric stream, specify the name of that stream here.
Valid characters are A-Z, a-z, 0-9, "-" and "_".
public final boolean hasIncludeFilters()
public final List<MetricStreamFilter> includeFilters()
If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
You cannot include IncludeFilters
and ExcludeFilters
in the same operation.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasIncludeFilters()
to see if a value was sent in this field.
You cannot include IncludeFilters
and ExcludeFilters
in the same operation.
public final boolean hasExcludeFilters()
public final List<MetricStreamFilter> excludeFilters()
If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
You cannot include ExcludeFilters
and IncludeFilters
in the same operation.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasExcludeFilters()
to see if a value was sent in this field.
You cannot include ExcludeFilters
and IncludeFilters
in the same operation.
public final String firehoseArn()
The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
public final String roleArn()
The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:
firehose:PutRecord
firehose:PutRecordBatch
firehose:PutRecord
firehose:PutRecordBatch
public final MetricStreamOutputFormat outputFormat()
The output format for the stream. Valid values are json
and opentelemetry0.7
. For more
information about metric stream output formats, see
Metric streams output formats.
If the service returns an enum value that is not available in the current SDK version, outputFormat
will
return MetricStreamOutputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from outputFormatAsString()
.
json
and opentelemetry0.7
.
For more information about metric stream output formats, see
Metric streams output formats.MetricStreamOutputFormat
public final String outputFormatAsString()
The output format for the stream. Valid values are json
and opentelemetry0.7
. For more
information about metric stream output formats, see
Metric streams output formats.
If the service returns an enum value that is not available in the current SDK version, outputFormat
will
return MetricStreamOutputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from outputFormatAsString()
.
json
and opentelemetry0.7
.
For more information about metric stream output formats, see
Metric streams output formats.MetricStreamOutputFormat
public final boolean hasTags()
public final List<Tag> tags()
A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
public PutMetricStreamRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<PutMetricStreamRequest.Builder,PutMetricStreamRequest>
toBuilder
in class CloudWatchRequest
public static PutMetricStreamRequest.Builder builder()
public static Class<? extends PutMetricStreamRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2021. All rights reserved.