Class UpdateScheduledQueryRequest
- 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.UpdateScheduledQueryRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateScheduledQueryRequest.Builder,UpdateScheduledQueryRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateScheduledQueryRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<UpdateScheduledQueryRequest.Builder,UpdateScheduledQueryRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateScheduledQueryRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateScheduledQueryRequest.Builderbuilder()Stringdescription()An updated description for the scheduled query.DestinationConfigurationdestinationConfiguration()The updated configuration for where to deliver query results.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexecutionRoleArn()The updated ARN of the IAM role that grants permissions to execute the query and deliver results.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasLogGroupIdentifiers()For responses, this returns true if the service returned a value for the LogGroupIdentifiers property.Stringidentifier()The ARN or name of the scheduled query to update.List<String>logGroupIdentifiers()The updated array of log group names or ARNs to query.QueryLanguagequeryLanguage()The updated query language for the scheduled query.StringqueryLanguageAsString()The updated query language for the scheduled query.StringqueryString()The updated query string to execute.LongscheduleEndTime()The updated end time for the scheduled query in Unix epoch format.StringscheduleExpression()The updated cron expression that defines when the scheduled query runs.LongscheduleStartTime()The updated start time for the scheduled query in Unix epoch format.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends UpdateScheduledQueryRequest.Builder>serializableBuilderClass()LongstartTimeOffset()The updated time offset in seconds that defines the lookback period for the query.ScheduledQueryStatestate()The updated state of the scheduled query.StringstateAsString()The updated state of the scheduled query.Stringtimezone()The updated timezone for evaluating the schedule expression.UpdateScheduledQueryRequest.BuildertoBuilder()StringtoString()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
-
identifier
public final String identifier()
The ARN or name of the scheduled query to update.
- Returns:
- The ARN or name of the scheduled query to update.
-
description
public final String description()
An updated description for the scheduled query.
- Returns:
- An updated description for the scheduled query.
-
queryLanguage
public final QueryLanguage queryLanguage()
The updated query language for the scheduled query.
If the service returns an enum value that is not available in the current SDK version,
queryLanguagewill returnQueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromqueryLanguageAsString().- Returns:
- The updated query language for the scheduled query.
- See Also:
QueryLanguage
-
queryLanguageAsString
public final String queryLanguageAsString()
The updated query language for the scheduled query.
If the service returns an enum value that is not available in the current SDK version,
queryLanguagewill returnQueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromqueryLanguageAsString().- Returns:
- The updated query language for the scheduled query.
- See Also:
QueryLanguage
-
queryString
public final String queryString()
The updated query string to execute.
- Returns:
- The updated query string to execute.
-
hasLogGroupIdentifiers
public final boolean hasLogGroupIdentifiers()
For responses, this returns true if the service returned a value for the LogGroupIdentifiers 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.
-
logGroupIdentifiers
public final List<String> logGroupIdentifiers()
The updated array of log group names or ARNs to query.
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
hasLogGroupIdentifiers()method.- Returns:
- The updated array of log group names or ARNs to query.
-
scheduleExpression
public final String scheduleExpression()
The updated cron expression that defines when the scheduled query runs.
- Returns:
- The updated cron expression that defines when the scheduled query runs.
-
timezone
public final String timezone()
The updated timezone for evaluating the schedule expression.
- Returns:
- The updated timezone for evaluating the schedule expression.
-
startTimeOffset
public final Long startTimeOffset()
The updated time offset in seconds that defines the lookback period for the query.
- Returns:
- The updated time offset in seconds that defines the lookback period for the query.
-
destinationConfiguration
public final DestinationConfiguration destinationConfiguration()
The updated configuration for where to deliver query results.
- Returns:
- The updated configuration for where to deliver query results.
-
scheduleStartTime
public final Long scheduleStartTime()
The updated start time for the scheduled query in Unix epoch format.
- Returns:
- The updated start time for the scheduled query in Unix epoch format.
-
scheduleEndTime
public final Long scheduleEndTime()
The updated end time for the scheduled query in Unix epoch format.
- Returns:
- The updated end time for the scheduled query in Unix epoch format.
-
executionRoleArn
public final String executionRoleArn()
The updated ARN of the IAM role that grants permissions to execute the query and deliver results.
- Returns:
- The updated ARN of the IAM role that grants permissions to execute the query and deliver results.
-
state
public final ScheduledQueryState state()
The updated state of the scheduled query.
If the service returns an enum value that is not available in the current SDK version,
statewill returnScheduledQueryState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The updated state of the scheduled query.
- See Also:
ScheduledQueryState
-
stateAsString
public final String stateAsString()
The updated state of the scheduled query.
If the service returns an enum value that is not available in the current SDK version,
statewill returnScheduledQueryState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The updated state of the scheduled query.
- See Also:
ScheduledQueryState
-
toBuilder
public UpdateScheduledQueryRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateScheduledQueryRequest.Builder,UpdateScheduledQueryRequest>- Specified by:
toBuilderin classCloudWatchLogsRequest
-
builder
public static UpdateScheduledQueryRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateScheduledQueryRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-