cascading.local.tap.aws.s3

Class S3TapProps

java.lang.Object

cascading.property.Props

cascading.local.tap.aws.s3.S3TapProps

public class S3TapProps
extends cascading.property.Props

Class S3TapProps provides S3 specific properties for overriding the AWS client endpoint and region.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	S3_ENDPOINT Field S3_ENDPOINT
static java.lang.String	S3_PATH_STYLE_ACCESS Field S3_PATH_STYLE_ACCESS
static java.lang.String	S3_PROXY_HOST Field S3_PROXY_HOST
static java.lang.String	S3_PROXY_PORT Field S3_PROXY_PORT
static java.lang.String	S3_REGION Field S3_REGION

Constructor Summary

Constructors

Constructor and Description
S3TapProps() Constructor S3TapProps creates a new S3TapProps instance.

Method Summary

Modifier and Type	Method and Description
protected void	addPropertiesTo(java.util.Properties properties)
java.lang.String	getEndpoint() Method getEndpoint returns the endpoint of this S3TapProps object.
java.lang.String	getProxyHost() Method getProxyHost returns the optional S3 proxy host of this S3TapProps object.
int	getProxyPort() Method getProxyPort returns the optional S3 proxy port this S3TapProps object will connect through
java.lang.String	getRegion() Method getRegion returns the region of this S3TapProps object.
boolean	isPathStyleAccess() Method isPathStyleAccess returns true if the underlying S3 client should use path style access to the S3 host.
S3TapProps	setEndpoint(java.lang.String endpoint) Method setEndpoint sets the endpoint of this S3TapProps object.
S3TapProps	setPathStyleAccess(boolean pathStyleAccess) Method setPathStyleAccess should be called if the underlying S3 client should use path style access to reach the target S3 host.
S3TapProps	setProxyHost(java.lang.String proxyHost) Method setProxyHost sets the optional proxy host this S3TapProps object will connect through.
S3TapProps	setProxyPort(int proxyPort) Method setProxyPort sets the optional proxy port this S3TapProps object will connect through.
S3TapProps	setRegion(java.lang.String region) Method setRegion sets the region of this S3TapProps object.

Methods inherited from class cascading.property.Props

buildProperties, buildProperties, buildProperties, buildProperties, setProperties, setProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

S3_ENDPOINT

public static final java.lang.String S3_ENDPOINT

Field S3_ENDPOINT

See Also:

Constant Field Values

S3_REGION

public static final java.lang.String S3_REGION

Field S3_REGION

See Also:

Constant Field Values

S3_PATH_STYLE_ACCESS

public static final java.lang.String S3_PATH_STYLE_ACCESS

Field S3_PATH_STYLE_ACCESS

See Also:

Constant Field Values

S3_PROXY_HOST

public static final java.lang.String S3_PROXY_HOST

Field S3_PROXY_HOST

See Also:

Constant Field Values

S3_PROXY_PORT

public static final java.lang.String S3_PROXY_PORT

Field S3_PROXY_PORT

See Also:

Constant Field Values

Constructor Detail

S3TapProps

public S3TapProps()

Constructor S3TapProps creates a new S3TapProps instance.

Method Detail

getEndpoint

public java.lang.String getEndpoint()

Method getEndpoint returns the endpoint of this S3TapProps object.

Returns:

the endpoint (type String) of this S3TapProps object.

setEndpoint

public S3TapProps setEndpoint(java.lang.String endpoint)

Method setEndpoint sets the endpoint of this S3TapProps object.

Parameters:

endpoint - the endpoint of this S3TapProps object.

Returns:

S3TapProps

getRegion

public java.lang.String getRegion()

Method getRegion returns the region of this S3TapProps object.

Returns:

the region (type String) of this S3TapProps object.

setRegion

public S3TapProps setRegion(java.lang.String region)

Method setRegion sets the region of this S3TapProps object.

Parameters:

region - the region of this S3TapProps object.

Returns:

S3TapProps

isPathStyleAccess

public boolean isPathStyleAccess()

Method isPathStyleAccess returns true if the underlying S3 client should use path style access to the S3 host.

Returns:

true if path style access should be used

setPathStyleAccess

public S3TapProps setPathStyleAccess(boolean pathStyleAccess)

Method setPathStyleAccess should be called if the underlying S3 client should use path style access to reach the target S3 host.

Parameters:

pathStyleAccess - true if path style access should be used.

Returns:

S3TapProps

See Also:

Virtual Hosting

getProxyHost

public java.lang.String getProxyHost()

Method getProxyHost returns the optional S3 proxy host of this S3TapProps object.

Returns:

the S3 proxy host (type String) of this S3TapProps object.

setProxyHost

public S3TapProps setProxyHost(java.lang.String proxyHost)

Method setProxyHost sets the optional proxy host this S3TapProps object will connect through.

Parameters:

proxyHost - the proxy host this S3TapProps object will connect through .

Returns:

S3TapProps

getProxyPort

public int getProxyPort()

Method getProxyPort returns the optional S3 proxy port this S3TapProps object will connect through

Returns:

the S3 proxy port (type int) this S3TapProps object will connect through.

setProxyPort

public S3TapProps setProxyPort(int proxyPort)

Method setProxyPort sets the optional proxy port this S3TapProps object will connect through.

Parameters:

proxyPort - the proxy host this S3TapProps object will connect through .

Returns:

S3TapProps

addPropertiesTo

protected void addPropertiesTo(java.util.Properties properties)

Specified by:

addPropertiesTo in class cascading.property.Props