@Generated(value="software.amazon.awssdk:codegen") public final class GetResourcesRequest extends ApiGatewayRequest implements ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>
Request to list information about a collection of resources.
Modifier and Type | Class and Description |
---|---|
static interface |
GetResourcesRequest.Builder |
Modifier and Type | Method and 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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.
|
static Class<? extends GetResourcesRequest.Builder> |
serializableBuilderClass() |
GetResourcesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String restApiId()
The string identifier of the associated RestApi.
public String position()
The current pagination position in the paged result set.
public Integer limit()
The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
public 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.
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
.public GetResourcesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetResourcesRequest.Builder,GetResourcesRequest>
toBuilder
in class ApiGatewayRequest
public static GetResourcesRequest.Builder builder()
public static Class<? extends GetResourcesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.