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

Class CreateDocumentationPartRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.CreateDocumentationPartRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateDocumentationPartRequest.Builder,CreateDocumentationPartRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateDocumentationPartRequest
extends AmazonWebServiceRequest
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

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static CreateDocumentationPartRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
DocumentationPartLocation	location()	[Required] The location of the targeted API entity of the to-be-created documentation part.
String	properties()	[Required] The new documentation content map of the targeted API entity.
String	restApiId()	[Required] The identifier of an API of the to-be-created documentation part.
static Class<? extends CreateDocumentationPartRequest.Builder>	serializableBuilderClass()
CreateDocumentationPartRequest.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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

restApiId

public String restApiId()

[Required] The identifier of an API of the to-be-created documentation part.

Returns:

[Required] The identifier of an API of the to-be-created documentation part.

location

public DocumentationPartLocation location()

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

Returns:

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

properties

public String properties()

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

Returns:

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

toBuilder

public CreateDocumentationPartRequest.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<CreateDocumentationPartRequest.Builder,CreateDocumentationPartRequest>

Returns:

a builder for type T

builder

public static CreateDocumentationPartRequest.Builder builder()

serializableBuilderClass

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