software.amazon.awssdk.services.apigateway.model

Class UpdateDocumentationVersionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateDocumentationVersionRequest.Builder,UpdateDocumentationVersionRequest>

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

Updates an existing documentation version of an API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateDocumentationVersionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateDocumentationVersionRequest.Builder	builder()
String	documentationVersion() The version identifier of the to-be-updated documentation version.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPatchOperations() For responses, this returns true if the service returned a value for the PatchOperations property.
List<PatchOperation>	patchOperations() For more information about supported patch operations, see Patch Operations.
String	restApiId() The string identifier of the associated RestApi.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDocumentationVersionRequest.Builder>	serializableBuilderClass()
UpdateDocumentationVersionRequest.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.

documentationVersion

public final String documentationVersion()

The version identifier of the to-be-updated documentation version.

Returns:

The version identifier of the to-be-updated documentation version.

hasPatchOperations

public final boolean hasPatchOperations()

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

patchOperations

public final List<PatchOperation> patchOperations()

For more information about supported patch operations, see Patch Operations.

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

Returns:

For more information about supported patch operations, see Patch Operations.

toBuilder

public UpdateDocumentationVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDocumentationVersionRequest.Builder,UpdateDocumentationVersionRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static UpdateDocumentationVersionRequest.Builder builder()

serializableBuilderClass

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