Interface DescribeScheduledActionsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeScheduledActionsRequest.Builder,
,DescribeScheduledActionsRequest> RedshiftRequest.Builder
,SdkBuilder<DescribeScheduledActionsRequest.Builder,
,DescribeScheduledActionsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeScheduledActionsRequest
-
Method Summary
Modifier and TypeMethodDescriptionIf true, retrieve only active scheduled actions.The end time in UTC of the scheduled action to retrieve.filters
(Collection<ScheduledActionFilter> filters) List of scheduled action filters.filters
(Consumer<ScheduledActionFilter.Builder>... filters) List of scheduled action filters.filters
(ScheduledActionFilter... filters) List of scheduled action filters.An optional parameter that specifies the starting point to return a set of response records.maxRecords
(Integer maxRecords) The maximum number of response records to return in each call.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.scheduledActionName
(String scheduledActionName) The name of the scheduled action to retrieve.The start time in UTC of the scheduled actions to retrieve.targetActionType
(String targetActionType) The type of the scheduled actions to retrieve.targetActionType
(ScheduledActionTypeValues targetActionType) The type of the scheduled actions to retrieve.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.redshift.model.RedshiftRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
scheduledActionName
The name of the scheduled action to retrieve.
- Parameters:
scheduledActionName
- The name of the scheduled action to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetActionType
The type of the scheduled actions to retrieve.
- Parameters:
targetActionType
- The type of the scheduled actions to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
targetActionType
DescribeScheduledActionsRequest.Builder targetActionType(ScheduledActionTypeValues targetActionType) The type of the scheduled actions to retrieve.
- Parameters:
targetActionType
- The type of the scheduled actions to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
startTime
The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
active
If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
- Parameters:
active
- If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
List of scheduled action filters.
- Parameters:
filters
- List of scheduled action filters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
List of scheduled action filters.
- Parameters:
filters
- List of scheduled action filters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
List of scheduled action filters.
This is a convenience method that creates an instance of theScheduledActionFilter.Builder
avoiding the need to create one manually viaScheduledActionFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<ScheduledActionFilter>)
.- Parameters:
filters
- a consumer that will call methods onScheduledActionFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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 inMaxRecords
, 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
maxRecords
- The maximum number of response records to return in each call. If the number of remaining response records exceeds the specifiedMaxRecords
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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeScheduledActionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeScheduledActionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-