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

Class Resource

java.lang.Object

software.amazon.awssdk.services.apigateway.model.Resource

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Resource.Builder,Resource>

@Generated("software.amazon.awssdk:codegen")
public final class Resource
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Resource.Builder,Resource>

Represents an API resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Resource.Builder

Method Summary

Modifier and Type	Method	Description
static Resource.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceMethods()	For responses, this returns true if the service returned a value for the ResourceMethods property.
String	id()	The resource's identifier.
String	parentId()	The parent resource's identifier.
String	path()	The full path for this resource.
String	pathPart()	The last path segment for this resource.
Map<String,Method>	resourceMethods()	Gets an API resource's method of a given HTTP verb.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Resource.Builder>	serializableBuilderClass()
Resource.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

id

public final String id()

The resource's identifier.

Returns:

The resource's identifier.

parentId

public final String parentId()

The parent resource's identifier.

Returns:

The parent resource's identifier.

pathPart

public final String pathPart()

The last path segment for this resource.

Returns:

The last path segment for this resource.

path

public final String path()

The full path for this resource.

Returns:

The full path for this resource.

hasResourceMethods

public final boolean hasResourceMethods()

For responses, this returns true if the service returned a value for the ResourceMethods 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.

resourceMethods

public final Map<String,Method> resourceMethods()

Gets an API resource's method of a given HTTP verb.

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

Returns:

Gets an API resource's method of a given HTTP verb.

toBuilder

public Resource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Resource.Builder,Resource>

builder

public static Resource.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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