All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateDocumentationPartResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable 

See Also:

Serialized Form

• Constructor Summary

  Constructors

  Constructor and Description
  UpdateDocumentationPartResult ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  UpdateDocumentationPartResult	clone ()
  boolean	equals (Object obj)
  String	getId () The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
  DocumentationPartLocation	getLocation () The location of the API entity to which the documentation applies.
  String	getProperties () A content map of API-specific key-value pairs describing the targeted API entity.
  int	hashCode ()
  void	setId (String id) The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
  void	setLocation (DocumentationPartLocation location) The location of the API entity to which the documentation applies.
  void	setProperties (String properties) A content map of API-specific key-value pairs describing the targeted API entity.
  String	toString () Returns a string representation of this object.
  UpdateDocumentationPartResult	withId (String id) The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
  UpdateDocumentationPartResult	withLocation (DocumentationPartLocation location) The location of the API entity to which the documentation applies.
  UpdateDocumentationPartResult	withProperties (String properties) A content map of API-specific key-value pairs describing the targeted API entity.

  • Methods inherited from class com.amazonaws.AmazonWebServiceResult

    getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • UpdateDocumentationPartResult

    public UpdateDocumentationPartResult()

• Method Detail

  • setId

    public void setId(String id)

    The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

    Parameters:

    id - The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

  • getId

    public String getId()

    The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

    Returns:

    The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

  • withId

    public UpdateDocumentationPartResult withId(String id)

    The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

    Parameters:

    id - The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

    Returns:

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

  • setLocation

    public void setLocation(DocumentationPartLocation location)

    The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

    Parameters:

    location - The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

  • getLocation

    public DocumentationPartLocation getLocation()

    The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

    Returns:

    The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

  • withLocation

    public UpdateDocumentationPartResult withLocation(DocumentationPartLocation location)

    The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

    Parameters:

    location - The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

    Returns:

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

  • setProperties

    public void setProperties(String properties)

    A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

    Parameters:

    properties - A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

  • getProperties

    public String getProperties()

    A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

    Returns:

    A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

  • withProperties

    public UpdateDocumentationPartResult withProperties(String properties)

    A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

    Parameters:

    properties - A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

    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 UpdateDocumentationPartResult clone()

    Overrides:

    clone in class Object