software.amazon.awssdk.services.apigateway.model

Class CreateDocumentationVersionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDocumentationVersionRequest.Builder,CreateDocumentationVersionRequest>

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

Creates a new documentation version of a given API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDocumentationVersionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDocumentationVersionRequest.Builder	builder()
String	description() A description about the new documentation snapshot.
String	documentationVersion() [Required] The version identifier of the new snapshot.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	restApiId() [Required] The string identifier of the associated RestApi.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDocumentationVersionRequest.Builder>	serializableBuilderClass()
String	stageName() The stage name to be associated with the new documentation snapshot.
CreateDocumentationVersionRequest.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()

[Required] The string identifier of the associated RestApi.

Returns:

[Required] The string identifier of the associated RestApi.

documentationVersion

public final String documentationVersion()

[Required] The version identifier of the new snapshot.

Returns:

[Required] The version identifier of the new snapshot.

stageName

public final String stageName()

The stage name to be associated with the new documentation snapshot.

Returns:

The stage name to be associated with the new documentation snapshot.

description

public final String description()

A description about the new documentation snapshot.

Returns:

A description about the new documentation snapshot.

toBuilder

public CreateDocumentationVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDocumentationVersionRequest.Builder,CreateDocumentationVersionRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static CreateDocumentationVersionRequest.Builder builder()

serializableBuilderClass

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