Class DescribeScheduledActionsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.redshift.model.RedshiftRequest
-
- software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeScheduledActionsRequest.Builder,DescribeScheduledActionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeScheduledActionsRequest extends RedshiftRequest implements ToCopyableBuilder<DescribeScheduledActionsRequest.Builder,DescribeScheduledActionsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeScheduledActionsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
active()
If true, retrieve only active scheduled actions.static DescribeScheduledActionsRequest.Builder
builder()
Instant
endTime()
The end time in UTC of the scheduled action to retrieve.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<ScheduledActionFilter>
filters()
List of scheduled action filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
String
marker()
An optional parameter that specifies the starting point to return a set of response records.Integer
maxRecords()
The maximum number of response records to return in each call.String
scheduledActionName()
The name of the scheduled action to retrieve.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeScheduledActionsRequest.Builder>
serializableBuilderClass()
Instant
startTime()
The start time in UTC of the scheduled actions to retrieve.ScheduledActionTypeValues
targetActionType()
The type of the scheduled actions to retrieve.String
targetActionTypeAsString()
The type of the scheduled actions to retrieve.DescribeScheduledActionsRequest.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
-
scheduledActionName
public final String scheduledActionName()
The name of the scheduled action to retrieve.
- Returns:
- The name of the scheduled action to retrieve.
-
targetActionType
public final ScheduledActionTypeValues targetActionType()
The type of the scheduled actions to retrieve.
If the service returns an enum value that is not available in the current SDK version,
targetActionType
will returnScheduledActionTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetActionTypeAsString()
.- Returns:
- The type of the scheduled actions to retrieve.
- See Also:
ScheduledActionTypeValues
-
targetActionTypeAsString
public final String targetActionTypeAsString()
The type of the scheduled actions to retrieve.
If the service returns an enum value that is not available in the current SDK version,
targetActionType
will returnScheduledActionTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetActionTypeAsString()
.- Returns:
- The type of the scheduled actions to retrieve.
- See Also:
ScheduledActionTypeValues
-
startTime
public final Instant startTime()
The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
- Returns:
- The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
-
endTime
public final Instant endTime()
The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
- Returns:
- The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
-
active
public final Boolean active()
If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
- Returns:
- If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters 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.
-
filters
public final List<ScheduledActionFilter> filters()
List of scheduled action filters.
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
hasFilters()
method.- Returns:
- List of scheduled action filters.
-
marker
public final String marker()
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in
MaxRecords
, Amazon Web Services returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.- Returns:
- An optional parameter that specifies the starting point to return a set of response records. When the
results of a DescribeScheduledActions request exceed the value specified in
MaxRecords
, Amazon Web Services returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.
-
maxRecords
public final Integer maxRecords()
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified
MaxRecords
value, a value is returned in amarker
field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.Default:
100
Constraints: minimum 20, maximum 100.
- Returns:
- The maximum number of response records to return in each call. If the number of remaining response
records exceeds the specified
MaxRecords
value, a value is returned in amarker
field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.Default:
100
Constraints: minimum 20, maximum 100.
-
toBuilder
public DescribeScheduledActionsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeScheduledActionsRequest.Builder,DescribeScheduledActionsRequest>
- Specified by:
toBuilder
in classRedshiftRequest
-
builder
public static DescribeScheduledActionsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeScheduledActionsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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:
getValueForField
in classSdkRequest
-
-