Class GetExportRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.apigateway.model.GetExportRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class GetExportRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Request a new export of a RestApi for a particular Stage.

See Also:
  • Constructor Details

    • GetExportRequest

      public GetExportRequest()
  • Method Details

    • setRestApiId

      public void setRestApiId(String restApiId)

      The identifier of the RestApi to be exported.

      Parameters:
      restApiId - The identifier of the RestApi to be exported.
    • getRestApiId

      public String getRestApiId()

      The identifier of the RestApi to be exported.

      Returns:
      The identifier of the RestApi to be exported.
    • withRestApiId

      public GetExportRequest withRestApiId(String restApiId)

      The identifier of the RestApi to be exported.

      Parameters:
      restApiId - The identifier of the RestApi to be exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStageName

      public void setStageName(String stageName)

      The name of the Stage that will be exported.

      Parameters:
      stageName - The name of the Stage that will be exported.
    • getStageName

      public String getStageName()

      The name of the Stage that will be exported.

      Returns:
      The name of the Stage that will be exported.
    • withStageName

      public GetExportRequest withStageName(String stageName)

      The name of the Stage that will be exported.

      Parameters:
      stageName - The name of the Stage that will be exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setExportType

      public void setExportType(String exportType)

      The type of export. Currently only 'swagger' is supported.

      Parameters:
      exportType - The type of export. Currently only 'swagger' is supported.
    • getExportType

      public String getExportType()

      The type of export. Currently only 'swagger' is supported.

      Returns:
      The type of export. Currently only 'swagger' is supported.
    • withExportType

      public GetExportRequest withExportType(String exportType)

      The type of export. Currently only 'swagger' is supported.

      Parameters:
      exportType - The type of export. Currently only 'swagger' is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getParameters

      public Map<String,String> getParameters()

      A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType 'swagger', any combination of the following parameters are supported: 'integrations' will export x-amazon-apigateway-integration extensions 'authorizers' will export x-amazon-apigateway-authorizer extensions 'postman' will export with Postman extensions, allowing for import to the Postman tool

      Returns:
      A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType 'swagger', any combination of the following parameters are supported: 'integrations' will export x-amazon-apigateway-integration extensions 'authorizers' will export x-amazon-apigateway-authorizer extensions 'postman' will export with Postman extensions, allowing for import to the Postman tool
    • setParameters

      public void setParameters(Map<String,String> parameters)

      A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType 'swagger', any combination of the following parameters are supported: 'integrations' will export x-amazon-apigateway-integration extensions 'authorizers' will export x-amazon-apigateway-authorizer extensions 'postman' will export with Postman extensions, allowing for import to the Postman tool

      Parameters:
      parameters - A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType 'swagger', any combination of the following parameters are supported: 'integrations' will export x-amazon-apigateway-integration extensions 'authorizers' will export x-amazon-apigateway-authorizer extensions 'postman' will export with Postman extensions, allowing for import to the Postman tool
    • withParameters

      public GetExportRequest withParameters(Map<String,String> parameters)

      A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType 'swagger', any combination of the following parameters are supported: 'integrations' will export x-amazon-apigateway-integration extensions 'authorizers' will export x-amazon-apigateway-authorizer extensions 'postman' will export with Postman extensions, allowing for import to the Postman tool

      Parameters:
      parameters - A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType 'swagger', any combination of the following parameters are supported: 'integrations' will export x-amazon-apigateway-integration extensions 'authorizers' will export x-amazon-apigateway-authorizer extensions 'postman' will export with Postman extensions, allowing for import to the Postman tool
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • addParametersEntry

      public GetExportRequest addParametersEntry(String key, String value)
    • clearParametersEntries

      public GetExportRequest clearParametersEntries()
      Removes all the entries added into Parameters. <p> Returns a reference to this object so that method calls can be chained together.
    • setAccepts

      public void setAccepts(String accepts)

      The content-type of the export, for example 'application/json'. Currently 'application/json' and 'application/yaml' are supported for exportType 'swagger'. Should be specifed in the 'Accept' header for direct API requests.

      Parameters:
      accepts - The content-type of the export, for example 'application/json'. Currently 'application/json' and 'application/yaml' are supported for exportType 'swagger'. Should be specifed in the 'Accept' header for direct API requests.
    • getAccepts

      public String getAccepts()

      The content-type of the export, for example 'application/json'. Currently 'application/json' and 'application/yaml' are supported for exportType 'swagger'. Should be specifed in the 'Accept' header for direct API requests.

      Returns:
      The content-type of the export, for example 'application/json'. Currently 'application/json' and 'application/yaml' are supported for exportType 'swagger'. Should be specifed in the 'Accept' header for direct API requests.
    • withAccepts

      public GetExportRequest withAccepts(String accepts)

      The content-type of the export, for example 'application/json'. Currently 'application/json' and 'application/yaml' are supported for exportType 'swagger'. Should be specifed in the 'Accept' header for direct API requests.

      Parameters:
      accepts - The content-type of the export, for example 'application/json'. Currently 'application/json' and 'application/yaml' are supported for exportType 'swagger'. Should be specifed in the 'Accept' header for direct API requests.
      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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public GetExportRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: