Class PutRestApiRequest

    • Constructor Detail

      • PutRestApiRequest

        public PutRestApiRequest()
    • Method Detail

      • setRestApiId

        public void setRestApiId​(String restApiId)

        The identifier of the RestApi to be updated.

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

        public String getRestApiId()

        The identifier of the RestApi to be updated.

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

        public PutRestApiRequest withRestApiId​(String restApiId)

        The identifier of the RestApi to be updated.

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

        public void setMode​(String mode)

        The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

        Parameters:
        mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
        See Also:
        PutMode
      • getMode

        public String getMode()

        The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

        Returns:
        The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
        See Also:
        PutMode
      • withMode

        public PutRestApiRequest withMode​(String mode)

        The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

        Parameters:
        mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PutMode
      • setMode

        public void setMode​(PutMode mode)

        The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

        Parameters:
        mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
        See Also:
        PutMode
      • withMode

        public PutRestApiRequest withMode​(PutMode mode)

        The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

        Parameters:
        mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PutMode
      • setFailOnWarnings

        public void setFailOnWarnings​(Boolean failOnWarnings)

        A query parameter to indicate whether to rollback the API update ( true) or not (false) when a warning is encountered. The default value is false.

        Parameters:
        failOnWarnings - A query parameter to indicate whether to rollback the API update ( true) or not (false) when a warning is encountered. The default value is false.
      • getFailOnWarnings

        public Boolean getFailOnWarnings()

        A query parameter to indicate whether to rollback the API update ( true) or not (false) when a warning is encountered. The default value is false.

        Returns:
        A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
      • withFailOnWarnings

        public PutRestApiRequest withFailOnWarnings​(Boolean failOnWarnings)

        A query parameter to indicate whether to rollback the API update ( true) or not (false) when a warning is encountered. The default value is false.

        Parameters:
        failOnWarnings - A query parameter to indicate whether to rollback the API update ( true) or not (false) when a warning is encountered. The default value is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isFailOnWarnings

        public Boolean isFailOnWarnings()

        A query parameter to indicate whether to rollback the API update ( true) or not (false) when a warning is encountered. The default value is false.

        Returns:
        A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
      • getParameters

        public Map<String,​String> getParameters()

        Custom headers supplied as part of the request.

        Returns:
        Custom headers supplied as part of the request.
      • setParameters

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

        Custom headers supplied as part of the request.

        Parameters:
        parameters - Custom headers supplied as part of the request.
      • withParameters

        public PutRestApiRequest withParameters​(Map<String,​String> parameters)

        Custom headers supplied as part of the request.

        Parameters:
        parameters - Custom headers supplied as part of the request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clearParametersEntries

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

        public void setBody​(ByteBuffer body)

        The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.

        AWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.

        Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

        Parameters:
        body - The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
      • getBody

        public ByteBuffer getBody()

        The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.

        ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position .

        Returns:
        The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
      • withBody

        public PutRestApiRequest withBody​(ByteBuffer body)

        The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.

        Parameters:
        body - The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
        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:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object