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

Class CreateDocumentationPartRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDocumentationPartRequest.Builder,CreateDocumentationPartRequest>

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

Creates a new documentation part of a given API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDocumentationPartRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateDocumentationPartRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DocumentationPartLocation	location()	The location of the targeted API entity of the to-be-created documentation part.
String	properties()	The new documentation content map of the targeted API entity.
String	restApiId()	The string identifier of the associated RestApi.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDocumentationPartRequest.Builder>	serializableBuilderClass()
CreateDocumentationPartRequest.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.

location

public final DocumentationPartLocation location()

The location of the targeted API entity of the to-be-created documentation part.

Returns:

The location of the targeted API entity of the to-be-created documentation part.

properties

public final String properties()

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Returns:

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

toBuilder

public CreateDocumentationPartRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDocumentationPartRequest.Builder,CreateDocumentationPartRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static CreateDocumentationPartRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo