Interface ListMonitorsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListMonitorsRequest.Builder,ListMonitorsRequest>,ForecastRequest.Builder,SdkBuilder<ListMonitorsRequest.Builder,ListMonitorsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListMonitorsRequest
public static interface ListMonitorsRequest.Builder extends ForecastRequest.Builder, SdkPojo, CopyableBuilder<ListMonitorsRequest.Builder,ListMonitorsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListMonitorsRequest.Builderfilters(Collection<Filter> filters)An array of filters.ListMonitorsRequest.Builderfilters(Consumer<Filter.Builder>... filters)An array of filters.ListMonitorsRequest.Builderfilters(Filter... filters)An array of filters.ListMonitorsRequest.BuildermaxResults(Integer maxResults)The maximum number of monitors to include in the response.ListMonitorsRequest.BuildernextToken(String nextToken)If the result of the previous request was truncated, the response includes aNextToken.ListMonitorsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListMonitorsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)-
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.forecast.model.ForecastRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
nextToken
ListMonitorsRequest.Builder nextToken(String nextToken)
If the result of the previous request was truncated, the response includes a
NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.- Parameters:
nextToken- If the result of the previous request was truncated, the response includes aNextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
ListMonitorsRequest.Builder maxResults(Integer maxResults)
The maximum number of monitors to include in the response.
- Parameters:
maxResults- The maximum number of monitors to include in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
ListMonitorsRequest.Builder filters(Collection<Filter> filters)
An array of filters. For each filter, provide a condition and a match statement. The condition is either
ISorIS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.Filter properties
-
Condition- The condition to apply. Valid values areISandIS_NOT. -
Key- The name of the parameter to filter on. The only valid value isStatus. -
Value- The value to match.
For example, to list all monitors who's status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]- Parameters:
filters- An array of filters. For each filter, provide a condition and a match statement. The condition is eitherISorIS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.Filter properties
-
Condition- The condition to apply. Valid values areISandIS_NOT. -
Key- The name of the parameter to filter on. The only valid value isStatus. -
Value- The value to match.
For example, to list all monitors who's status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
ListMonitorsRequest.Builder filters(Filter... filters)
An array of filters. For each filter, provide a condition and a match statement. The condition is either
ISorIS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.Filter properties
-
Condition- The condition to apply. Valid values areISandIS_NOT. -
Key- The name of the parameter to filter on. The only valid value isStatus. -
Value- The value to match.
For example, to list all monitors who's status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]- Parameters:
filters- An array of filters. For each filter, provide a condition and a match statement. The condition is eitherISorIS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.Filter properties
-
Condition- The condition to apply. Valid values areISandIS_NOT. -
Key- The name of the parameter to filter on. The only valid value isStatus. -
Value- The value to match.
For example, to list all monitors who's status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
ListMonitorsRequest.Builder filters(Consumer<Filter.Builder>... filters)
An array of filters. For each filter, provide a condition and a match statement. The condition is either
ISorIS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.Filter properties
-
Condition- The condition to apply. Valid values areISandIS_NOT. -
Key- The name of the parameter to filter on. The only valid value isStatus. -
Value- The value to match.
For example, to list all monitors who's status is ACTIVE, you would specify:
This is a convenience method that creates an instance of the"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]Filter.Builderavoiding the need to create one manually viaFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#filters(List.) - Parameters:
filters- a consumer that will call methods onFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection)
-
-
overrideConfiguration
ListMonitorsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListMonitorsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-