software.amazon.awssdk.services.apigateway.model

Class GetResourceRequest

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.GetResourceRequest

All Implemented Interfaces:

ToCopyableBuilder<GetResourceRequest.Builder,GetResourceRequest>

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

Request to list information about a resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetResourceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetResourceRequest.Builder	builder()
List<String>	embed() A query parameter to retrieve the specified resources embedded in the returned Resource representation 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()
String	resourceId() The identifier for the Resource resource.
String	restApiId() The string identifier of the associated RestApi.
static Class<? extends GetResourceRequest.Builder>	serializableBuilderClass()
GetResourceRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

restApiId

public String restApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

resourceId

public String resourceId()

The identifier for the Resource resource.

Returns:

The identifier for the Resource resource.

embed

public List<String> embed()

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

toBuilder

public GetResourceRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetResourceRequest.Builder,GetResourceRequest>

Specified by:

toBuilder in class ApiGatewayRequest

Returns:

a builder for type T

builder

public static GetResourceRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value