info.freelibrary.vertx.s3.Endpoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-s3-service Show documentation

An S3 client library for the Vert.x toolkit

There is a newer version: 2.0.0-alpha-2


package info.freelibrary.vertx.s3;

/**
 * A public interface for S3 endpoints.
 */
public interface Endpoint {

    /**
     * Returns the URL (in string form) of the endpoint.
     *
     * @return The URL (in string form) of the endpoint
     */
    @Override
    String toString();

    /**
     * Gets the dual-stack version of the endpoint.
     *
     * @return The dual-stack version of the endpoint
     */
    String getDualStack();

    /**
     * Gets the region string for the endpoint.
     *
     * @return The region string for the endpoint
     */
    String getRegion();

    /**
     * Gets the host name for the endpoint.
     *
     * @return The host name for the endpoint
     */
    String getHost();

    /**
     * Gets the port for the endpoint.
     *
     * @return The port for the endpoint
     */
    int getPort();

    /**
     * Gets a human-friendly name for the endpoint.
     *
     * @return The human-friendly name for the endpoint
     */
    String getLabel();
}