com.amazonaws.services.apigateway.model

Class CreateDocumentationPartRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.CreateDocumentationPartRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDocumentationPartRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Creates a new documentation part of a given API.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDocumentationPartRequest()

Method Summary

Modifier and Type	Method and Description
CreateDocumentationPartRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
DocumentationPartLocation	getLocation() [Required] The location of the targeted API entity of the to-be-created documentation part.
String	getProperties() [Required] The new documentation content map of the targeted API entity.
String	getRestApiId() [Required] The string identifier of the associated RestApi.
int	hashCode()
void	setLocation(DocumentationPartLocation location) [Required] The location of the targeted API entity of the to-be-created documentation part.
void	setProperties(String properties) [Required] The new documentation content map of the targeted API entity.
void	setRestApiId(String restApiId) [Required] The string identifier of the associated RestApi.
String	toString() Returns a string representation of this object.
CreateDocumentationPartRequest	withLocation(DocumentationPartLocation location) [Required] The location of the targeted API entity of the to-be-created documentation part.
CreateDocumentationPartRequest	withProperties(String properties) [Required] The new documentation content map of the targeted API entity.
CreateDocumentationPartRequest	withRestApiId(String restApiId) [Required] The string identifier of the associated RestApi.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDocumentationPartRequest

public CreateDocumentationPartRequest()

Method Detail

setRestApiId

public void setRestApiId(String restApiId)

[Required] The string identifier of the associated RestApi.

Parameters:

restApiId - [Required] The string identifier of the associated RestApi.

getRestApiId

public String getRestApiId()

[Required] The string identifier of the associated RestApi.

Returns:

[Required] The string identifier of the associated RestApi.

withRestApiId

public CreateDocumentationPartRequest withRestApiId(String restApiId)

[Required] The string identifier of the associated RestApi.

Parameters:

restApiId - [Required] The string identifier of the associated RestApi.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLocation

public void setLocation(DocumentationPartLocation location)

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

Parameters:

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

getLocation

public DocumentationPartLocation getLocation()

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

withLocation

public CreateDocumentationPartRequest withLocation(DocumentationPartLocation location)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setProperties

public void setProperties(String properties)

[Required] 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.

Parameters:

properties - [Required] 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.

getProperties

public String getProperties()

[Required] 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:

[Required] 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.

withProperties

public CreateDocumentationPartRequest withProperties(String properties)

[Required] 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.

Parameters:

properties - [Required] 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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDocumentationPartRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()