Package software.amazon.awssdk.services.apigateway.model

Class GetResourcesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

software.amazon.awssdk.services.apigateway.model.GetResourcesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>

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

Request to list information about a collection of resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetResourcesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetResourcesRequest.Builder	builder()
List<String>	embed()	A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEmbed()	For responses, this returns true if the service returned a value for the Embed property.
int	hashCode()
Integer	limit()	The maximum number of returned results per page.
String	position()	The current pagination position in the paged result set.
String	restApiId()	The string identifier of the associated RestApi.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetResourcesRequest.Builder>	serializableBuilderClass()
GetResourcesRequest.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

restApiId

public final String restApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

position

public final String position()

The current pagination position in the paged result set.

Returns:

The current pagination position in the paged result set.

limit

public final Integer limit()

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

hasEmbed

public final boolean hasEmbed()

For responses, this returns true if the service returned a value for the Embed property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

embed

public final List<String> embed()

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

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 hasEmbed() method.

Returns:

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

toBuilder

public GetResourcesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static GetResourcesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetResourcesRequest.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