Package software.amazon.awssdk.services.resourceexplorer2.model

Class ListResourcesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.resourceexplorer2.model.ResourceExplorer2Request

software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListResourcesRequest.Builder,ListResourcesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListResourcesRequest
extends ResourceExplorer2Request
implements ToCopyableBuilder<ListResourcesRequest.Builder,ListResourcesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListResourcesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListResourcesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
SearchFilter	filters()	Returns the value of the Filters property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results that you want included on each page of the response.
String	nextToken()	The parameter for receiving additional results if you receive a NextToken response in a previous request.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListResourcesRequest.Builder>	serializableBuilderClass()
ListResourcesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	viewArn()	Specifies the Amazon resource name (ARN) of the view to use for the query.

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

filters

public final SearchFilter filters()

Returns the value of the Filters property for this object.

Returns:

The value of the Filters property for this object.

maxResults

public final 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 NextToken response element is present and has a value (is not null). Include that value as the NextToken request 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 NextToken after every operation to ensure that you receive all of the results.

Returns:

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 NextToken response element is present and has a value (is not null). Include that value as the NextToken request 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 NextToken after every operation to ensure that you receive all of the results.

nextToken

public final String nextToken()

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.

Returns:

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.

viewArn

public final 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.

Returns:

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.

toBuilder

public ListResourcesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListResourcesRequest.Builder,ListResourcesRequest>

Specified by:

toBuilder in class ResourceExplorer2Request

builder

public static ListResourcesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListResourcesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo