com.aliyun.openservices.log.common

Class OssShipperConfig

java.lang.Object

com.aliyun.openservices.log.common.OssShipperConfig

All Implemented Interfaces:

ShipperConfig

public class OssShipperConfig
extends Object
implements ShipperConfig

Constructor Summary

Constructors

Constructor and Description
OssShipperConfig()
OssShipperConfig(String ossBucket, String ossPrefix, String roleArn, int bufferInterval, int bufferMB)
OssShipperConfig(String ossBucket, String ossPrefix, String roleArn, int bufferInterval, int bufferMB, String compressType) create a oss shipper config
OssShipperConfig(String ossBucket, String ossPrefix, String roleArn, int bufferInterval, int bufferMB, String compressType, String pathFormat)
OssShipperConfig(String ossBucket, String ossPrefix, String roleArn, int bufferInterval, int bufferMB, String compressType, String pathFormat, String timeZone, OssShipperStorageDetail storageDetail, EncryptConfig encryptConf)
OssShipperConfig(String ossBucket, String ossPrefix, String roleArn, int bufferInterval, int bufferMB, String compressType, String pathFormat, String storageFormat, String timezone)

Method Summary

Modifier and Type	Method and Description
void	FromJsonObj(com.alibaba.fastjson.JSONObject obj)
int	getBufferInterval()
int	GetBufferInterval()
int	getBufferMB()
int	GetBufferMB()
String	getCompressType()
String	GetCompressType()
EncryptConfig	getEncryptConf()
com.alibaba.fastjson.JSONObject	GetJsonObj()
String	getOssBucket()
String	GetOssBucket()
String	getOssPrefix()
String	GetOssPrefix()
String	getPathFormat()
String	GetPathFormat()
String	GetRoleArm()
String	getRoleArn()
String	GetShipperType()
OssShipperStorageDetail	getStorageDetail()
OssShipperStorageDetail	GetStorageDetail()
String	getTimeZone()
void	setBufferInterval(int bufferInterval)
void	setBufferMB(int bufferMB)
void	setCompressType(String compressType)
void	setEncryptConf(EncryptConfig encryptConf)
void	setOssBucket(String ossBucket)
void	setOssPrefix(String ossPrefix)
void	setPathFormat(String pathFormat)
void	setRoleArn(String roleArn)
void	setStorageDetail(OssShipperStorageDetail storageDetail)
void	setTimeZone(String timeZone)

Methods inherited from class java.lang.Object

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

Constructor Detail

OssShipperConfig

public OssShipperConfig()

OssShipperConfig

public OssShipperConfig(String ossBucket,
                        String ossPrefix,
                        String roleArn,
                        int bufferInterval,
                        int bufferMB,
                        String compressType,
                        String pathFormat,
                        String timeZone,
                        OssShipperStorageDetail storageDetail,
                        EncryptConfig encryptConf)

OssShipperConfig

public OssShipperConfig(String ossBucket,
                        String ossPrefix,
                        String roleArn,
                        int bufferInterval,
                        int bufferMB)

OssShipperConfig

public OssShipperConfig(String ossBucket,
                        String ossPrefix,
                        String roleArn,
                        int bufferInterval,
                        int bufferMB,
                        String compressType)

create a oss shipper config

Parameters:

ossBucket - oss bucket name

ossPrefix - the prefix path in oss where to save the log data

roleArn - the ram arn used to get the temporary write permission to the oss bucket

bufferInterval - the time(seconds) to buffer before save to oss

bufferMB - the data size(MB) to buffer before save to oss

compressType - the compress type, only support 'snappy' or 'none'

OssShipperConfig

public OssShipperConfig(String ossBucket,
                        String ossPrefix,
                        String roleArn,
                        int bufferInterval,
                        int bufferMB,
                        String compressType,
                        String pathFormat)

OssShipperConfig

public OssShipperConfig(String ossBucket,
                        String ossPrefix,
                        String roleArn,
                        int bufferInterval,
                        int bufferMB,
                        String compressType,
                        String pathFormat,
                        String storageFormat,
                        String timezone)

Method Detail

GetStorageDetail

public OssShipperStorageDetail GetStorageDetail()

GetPathFormat

public String GetPathFormat()

GetOssBucket

public String GetOssBucket()

GetOssPrefix

public String GetOssPrefix()

GetRoleArm

public String GetRoleArm()

GetBufferInterval

public int GetBufferInterval()

GetBufferMB

public int GetBufferMB()

GetCompressType

public String GetCompressType()

getTimeZone

public String getTimeZone()

getEncryptConf

public EncryptConfig getEncryptConf()

setOssBucket

public void setOssBucket(String ossBucket)

setOssPrefix

public void setOssPrefix(String ossPrefix)

setRoleArn

public void setRoleArn(String roleArn)

setBufferInterval

public void setBufferInterval(int bufferInterval)

setBufferMB

public void setBufferMB(int bufferMB)

setCompressType

public void setCompressType(String compressType)

setPathFormat

public void setPathFormat(String pathFormat)

setTimeZone

public void setTimeZone(String timeZone)

setStorageDetail

public void setStorageDetail(OssShipperStorageDetail storageDetail)

setEncryptConf

public void setEncryptConf(EncryptConfig encryptConf)

getOssBucket

public String getOssBucket()

getOssPrefix

public String getOssPrefix()

getRoleArn

public String getRoleArn()

getBufferInterval

public int getBufferInterval()

getBufferMB

public int getBufferMB()

getCompressType

public String getCompressType()

getPathFormat

public String getPathFormat()

getStorageDetail

public OssShipperStorageDetail getStorageDetail()

FromJsonObj

public void FromJsonObj(com.alibaba.fastjson.JSONObject obj)
                 throws LogException

Specified by:

FromJsonObj in interface ShipperConfig

Throws:

LogException

GetShipperType

public String GetShipperType()

Specified by:

GetShipperType in interface ShipperConfig

GetJsonObj

public com.alibaba.fastjson.JSONObject GetJsonObj()

Specified by:

GetJsonObj in interface ShipperConfig