java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest
    - - software.amazon.awssdk.services.cloudwatchlogs.model.PutQueryDefinitionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PutQueryDefinitionRequest.Builder,PutQueryDefinitionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutQueryDefinitionRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<PutQueryDefinitionRequest.Builder,PutQueryDefinitionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PutQueryDefinitionRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PutQueryDefinitionRequest.Builder`	`builder()`
`String`	`clientToken()`	Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLogGroupNames()`	For responses, this returns true if the service returned a value for the LogGroupNames property.
`List<String>`	`logGroupNames()`	Use this parameter to include specific log groups as part of your query definition.
`String`	`name()`	A name for the query definition.
`String`	`queryDefinitionId()`	If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update.
`QueryLanguage`	`queryLanguage()`	Specify the query language to use for this query.
`String`	`queryLanguageAsString()`	Specify the query language to use for this query.
`String`	`queryString()`	The query string to use for this definition.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutQueryDefinitionRequest.Builder>`	`serializableBuilderClass()`
`PutQueryDefinitionRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - queryLanguage
```
public final QueryLanguage queryLanguage()
```
    Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
    
    If the service returns an enum value that is not available in the current SDK version, queryLanguage will return QueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryLanguageAsString().
    
    Returns:
    
    Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
    
    See Also:
    
    QueryLanguage
  - queryLanguageAsString
```
public final String queryLanguageAsString()
```
    Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
    
    If the service returns an enum value that is not available in the current SDK version, queryLanguage will return QueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryLanguageAsString().
    
    Returns:
    
    Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
    
    See Also:
    
    QueryLanguage
  - name
```
public final String name()
```
    A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.
    
    Returns:
    
    A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.
  - queryDefinitionId
```
public final String queryDefinitionId()
```
    If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.
    
    If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.
    
    Returns:
    
    If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.
    
    If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.
  - hasLogGroupNames
```
public final boolean hasLogGroupNames()
```
    For responses, this returns true if the service returned a value for the LogGroupNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - logGroupNames
```
public final List<String> logGroupNames()
```
    Use this parameter to include specific log groups as part of your query definition. If your query uses the OpenSearch Service query language, you specify the log group names inside the querystring instead of here.
    
    If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated definition will contain no log groups.
    
    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 hasLogGroupNames() method.
    
    Returns:
    
    Use this parameter to include specific log groups as part of your query definition. If your query uses the OpenSearch Service query language, you specify the log group names inside the querystring instead of here.
    
    If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated definition will contain no log groups.
  - queryString
```
public final String queryString()
```
    The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
    
    Returns:
    
    The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
  - clientToken
```
public final String clientToken()
```
    Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
    
    Returns:
    
    Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
  - toBuilder
```
public PutQueryDefinitionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutQueryDefinitionRequest.Builder,PutQueryDefinitionRequest>
    
    Specified by:
    
    toBuilder in class CloudWatchLogsRequest
  - builder
```
public static PutQueryDefinitionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutQueryDefinitionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class PutQueryDefinitionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

queryLanguage

queryLanguageAsString

name

queryDefinitionId

hasLogGroupNames

logGroupNames

queryString

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField