Package com.qiniu.storage.model

Class BucketEventRule

  • public class BucketEventRule
extends java.lang.Object
    BucketEnventRule 定义了存储空间发生事件时候的通知规则
    比如调用了存储的"delete"删除接口删除文件， 这个是一个事件；
    当这个事件发生的时候， 我们要对哪些文件，做什么处理，是否要作回调，
    都可以通过这个结构体配置

    注意：事件通知功能会根据文件的前缀和后缀依次匹配，只对第一个匹配成功的事件发送通知。

    • Constructor Summary

      Constructors 
      Constructor Description
      BucketEventRule​(java.lang.String name, java.lang.String[] events, java.lang.String[] callbackUrls)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String asQueryString()
      编码成 query 参数格式
      java.lang.String getAccessKey()
      获取为了签名设置好的 accessKey
      java.lang.String[] getCallbackUrls()
      获取通知 URL，可以有多个
      java.lang.String[] getEvents()
      获取事件类型，可以有多个
      java.lang.String getHost()
      获取通知请求的 host
      java.lang.String getName()
      获取规则名称，在设置的bucket中规则名称是唯一的
      java.lang.String getPrefix()
      获取前缀，以该前缀开头的文件应用此规则
      java.lang.String getSuffix()
      获取后缀，以该后缀结尾的文件应用此规则
      BucketEventRule setAccessKey​(java.lang.String accessKey)
      可选，设置的话会对通知请求用对应的ak、sk进行签名
      BucketEventRule setCallbackUrls​(java.lang.String[] callbackUrls)
      设置通知 URL，可以指定多个，失败依次重试
      BucketEventRule setEvents​(java.lang.String[] events)
      设置事件类型，可以指定多个
      包括 put,mkfile,delete,copy,move,append,disable,enable,deleteMarkerCreate
      BucketEventRule setHost​(java.lang.String host)
      可选，通知请求的host
      BucketEventRule setName​(java.lang.String name)
      规则名称，在设置的bucket中规则名称需要是唯一的
      BucketEventRule setPrefix​(java.lang.String prefix)
      设置前缀，以该前缀开头的文件应用此规则
      BucketEventRule setSuffix​(java.lang.String suffix)
      设置后缀，以该后缀结尾的文件应用此规则

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BucketEventRule

        public BucketEventRule​(java.lang.String name,
                       java.lang.String[] events,
                       java.lang.String[] callbackUrls)

    • Method Detail

      • getName

        public java.lang.String getName()
        获取规则名称，在设置的bucket中规则名称是唯一的
        Returns:
        规则名称

      • setName

        public BucketEventRule setName​(java.lang.String name)
        规则名称，在设置的bucket中规则名称需要是唯一的
        Parameters:
        name - 规则名称
        Returns:
        规则信息

      • getPrefix

        public java.lang.String getPrefix()
        获取前缀，以该前缀开头的文件应用此规则
        Returns:
        前缀

      • setPrefix

        public BucketEventRule setPrefix​(java.lang.String prefix)
        设置前缀，以该前缀开头的文件应用此规则
        Parameters:
        prefix - 前缀
        Returns:
        规则信息

      • getSuffix

        public java.lang.String getSuffix()
        获取后缀，以该后缀结尾的文件应用此规则
        Returns:
        后缀

      • setSuffix

        public BucketEventRule setSuffix​(java.lang.String suffix)
        设置后缀，以该后缀结尾的文件应用此规则
        Parameters:
        suffix - 后缀
        Returns:
        规则信息

      • getEvents

        public java.lang.String[] getEvents()
        获取事件类型，可以有多个
        Returns:
        事件类型

      • setEvents

        public BucketEventRule setEvents​(java.lang.String[] events)
        设置事件类型，可以指定多个
        包括 put,mkfile,delete,copy,move,append,disable,enable,deleteMarkerCreate
        Parameters:
        events - 事件类型
        Returns:
        规则信息

      • getCallbackUrls

        public java.lang.String[] getCallbackUrls()
        获取通知 URL，可以有多个
        Returns:
        通知 URL

      • setCallbackUrls

        public BucketEventRule setCallbackUrls​(java.lang.String[] callbackUrls)
        设置通知 URL，可以指定多个，失败依次重试
        Parameters:
        callbackUrls - 通知 URL
        Returns:
        规则信息

      • getAccessKey

        public java.lang.String getAccessKey()
        获取为了签名设置好的 accessKey
        Returns:
        accessKey

      • setAccessKey

        public BucketEventRule setAccessKey​(java.lang.String accessKey)
        可选，设置的话会对通知请求用对应的ak、sk进行签名
        Parameters:
        accessKey - accessKey
        Returns:
        规则信息

      • getHost

        public java.lang.String getHost()
        获取通知请求的 host
        Returns:
        host

      • setHost

        public BucketEventRule setHost​(java.lang.String host)
        可选，通知请求的host
        Parameters:
        host - host
        Returns:
        规则信息

      • asQueryString

        public java.lang.String asQueryString()
        编码成 query 参数格式
        Returns:
        query