Class PutMetricDataQueryDefinitionRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<PutMetricDataQueryDefinitionRequest.Builder,PutMetricDataQueryDefinitionRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final StringThe query expression, in the language thatTypespecifies.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final Stringid()The ID of the metric data query definition to update.final Stringpath()The name of the metric data query definition.static Class<? extends PutMetricDataQueryDefinitionRequest.Builder> tags()A list of key-value pairs to associate with the metric data query definition.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final QueryTypetype()The language of the expression.final StringThe language of the expression.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID of the metric data query definition to update. Omit this parameter to create a definition. CloudWatch then generates the ID and returns it in the response.
- Returns:
- The ID of the metric data query definition to update. Omit this parameter to create a definition. CloudWatch then generates the ID and returns it in the response.
-
path
The name of the metric data query definition. Use slashes (
/) to organize definitions into folders, for exampleteam/web/latency. The path must meet the following requirements:-
It must be unique in your account and Region.
-
It can't start or end with a slash.
-
It can't contain an empty folder name (
//). -
It can be at most 1,015 bytes when encoded as UTF-8.
- Returns:
- The name of the metric data query definition. Use slashes (
/) to organize definitions into folders, for exampleteam/web/latency. The path must meet the following requirements:-
It must be unique in your account and Region.
-
It can't start or end with a slash.
-
It can't contain an empty folder name (
//). -
It can be at most 1,015 bytes when encoded as UTF-8.
-
-
-
expression
The query expression, in the language that
Typespecifies. CloudWatch doesn't validate or run the expression when you save it.- Returns:
- The query expression, in the language that
Typespecifies. CloudWatch doesn't validate or run the expression when you save it.
-
type
The language of the expression. Valid values are the following:
-
PROMQL– A PromQL query. -
SQL– A CloudWatch Metrics Insights query. -
METRIC_MATH– A metric math expression.
If the service returns an enum value that is not available in the current SDK version,
typewill returnQueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The language of the expression. Valid values are the following:
-
PROMQL– A PromQL query. -
SQL– A CloudWatch Metrics Insights query. -
METRIC_MATH– A metric math expression.
-
- See Also:
-
-
typeAsString
The language of the expression. Valid values are the following:
-
PROMQL– A PromQL query. -
SQL– A CloudWatch Metrics Insights query. -
METRIC_MATH– A metric math expression.
If the service returns an enum value that is not available in the current SDK version,
typewill returnQueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The language of the expression. Valid values are the following:
-
PROMQL– A PromQL query. -
SQL– A CloudWatch Metrics Insights query. -
METRIC_MATH– A metric math expression.
-
- See Also:
-
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
A list of key-value pairs to associate with the metric data query definition. You can use tags to categorize definitions and to control access to them. Tags are applied only when the request creates a definition, that is, when you omit
Id. To change the tags of an existing definition, useTagResourceandUntagResource.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- A list of key-value pairs to associate with the metric data query definition. You can use tags to
categorize definitions and to control access to them. Tags are applied only when the request creates a
definition, that is, when you omit
Id. To change the tags of an existing definition, useTagResourceandUntagResource.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<PutMetricDataQueryDefinitionRequest.Builder,PutMetricDataQueryDefinitionRequest> - Specified by:
toBuilderin classCloudWatchRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends PutMetricDataQueryDefinitionRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-