Interface ListResourcesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListResourcesRequest.Builder,ListResourcesRequest>,ResourceExplorer2Request.Builder,SdkBuilder<ListResourcesRequest.Builder,ListResourcesRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListResourcesRequest
public static interface ListResourcesRequest.Builder extends ResourceExplorer2Request.Builder, SdkPojo, CopyableBuilder<ListResourcesRequest.Builder,ListResourcesRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ListResourcesRequest.Builderfilters(Consumer<SearchFilter.Builder> filters)Sets the value of the Filters property for this object.ListResourcesRequest.Builderfilters(SearchFilter filters)Sets the value of the Filters property for this object.ListResourcesRequest.BuildermaxResults(Integer maxResults)The maximum number of results that you want included on each page of the response.ListResourcesRequest.BuildernextToken(String nextToken)The parameter for receiving additional results if you receive aNextTokenresponse in a previous request.ListResourcesRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListResourcesRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)ListResourcesRequest.BuilderviewArn(String viewArn)Specifies the Amazon resource name (ARN) of the view to use for the query.-
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.resourceexplorer2.model.ResourceExplorer2Request.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
-
filters
ListResourcesRequest.Builder filters(SearchFilter filters)
Sets the value of the Filters property for this object.- Parameters:
filters- The new value for the Filters property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
default ListResourcesRequest.Builder filters(Consumer<SearchFilter.Builder> filters)
Sets the value of the Filters property for this object. This is a convenience method that creates an instance of theSearchFilter.Builderavoiding the need to create one manually viaSearchFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilters(SearchFilter).- Parameters:
filters- a consumer that will call methods onSearchFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
filters(SearchFilter)
-
maxResults
ListResourcesRequest.Builder maxResults(Integer maxResults)
The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the
NextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest parameter in the next call to the operation to get the next part of the results.An API operation can return fewer results than the maximum even when there are more results available. You should check
NextTokenafter every operation to ensure that you receive all of the results.- Parameters:
maxResults- The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, theNextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest parameter in the next call to the operation to get the next part of the results.An API operation can return fewer results than the maximum even when there are more results available. You should check
NextTokenafter every operation to ensure that you receive all of the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
ListResourcesRequest.Builder nextToken(String nextToken)
The parameter for receiving additional results if you receive a
NextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value of the previous call'sNextTokenresponse to indicate where the output should continue from. The pagination tokens expire after 24 hours.- Parameters:
nextToken- The parameter for receiving additional results if you receive aNextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value of the previous call'sNextTokenresponse to indicate where the output should continue from. The pagination tokens expire after 24 hours.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
viewArn
ListResourcesRequest.Builder viewArn(String viewArn)
Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.
- Parameters:
viewArn- Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListResourcesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListResourcesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-