类 CopyObjectRequest

    • 嵌套类概要

      嵌套类 
      修饰符和类型 类 说明
      static class  CopyObjectRequest.CopySourceStruct
      复制源结构体
      • 从类继承的嵌套类/接口 com.tencent.cos.xml.model.CosXmlRequest

        com.tencent.cos.xml.model.CosXmlRequest.OnRequestWeightListener, com.tencent.cos.xml.model.CosXmlRequest.RequestNetworkType
    • 字段概要

      • 从类继承的字段 com.tencent.cos.xml.model.object.ObjectRequest

        cosPath
      • 从类继承的字段 com.tencent.cos.xml.model.CosXmlRequest

        bucket, noSignHeaders, noSignParams, priority, qCloudTaskStateListener, queryParameters, region, requestHeaders, requestURL, signSourceProvider
    • 方法概要

      所有方法 实例方法 具体方法 
      修饰符和类型 方法 说明
      void checkParameters()  
      CopyObjectRequest.CopySourceStruct getCopySource()
      获取源对象结构体
      java.lang.String getCosPath()
      获取复制的目标cos路径
      java.lang.String getMethod()  
      com.tencent.qcloud.core.http.RequestBodySerializer getRequestBody()  
      com.tencent.qcloud.core.auth.STSCredentialScope[] getSTSCredentialScope​(com.tencent.cos.xml.CosXmlServiceConfig config)  
      void setCopyIfMatch​(java.lang.String eTag)
      当对象的 ETag 与指定的值一致,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed)
      void setCopyIfModifiedSince​(java.lang.String sourceIfModifiedSince)
      当对象在指定时间后被修改,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed)
      void setCopyIfNoneMatch​(java.lang.String eTag)
      当对象的 ETag 与指定的值不一致,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed)
      void setCopyIfUnmodifiedSince​(java.lang.String sourceIfUnmodifiedSince)
      当对象在指定时间后未被修改,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed)
      void setCopyMetaDataDirective​(MetaDataDirective metaDataDirective)
      是否复制源对象的元数据信息,枚举值:Copy,Replaced,默认为 Copy: 如果标记为 Copy,则复制源对象的元数据信息 如果标记为 Replaced,则按本次请求的请求头中的元数据信息作为目标对象的元数据信息 当目标对象和源对象为同一对象时,即用户试图修改元数据时,则标记必须为 Replaced
      void setCopySource​(CopyObjectRequest.CopySourceStruct copySource, com.tencent.cos.xml.CosXmlServiceConfig config)
      设置复制源对象信息
      void setCopySourceServerSideEncryptionCustomerKey​(java.lang.String sourceKey)
      源对象SSE-C服务端加密配置
      void setCopySourceServerSideEncryptionKMS​(java.lang.String customerKeyID, java.lang.String json)
      源对象SSE-KMS服务端加密配置
      void setCosPath​(java.lang.String cosPath)
      设置复制的目标cos路径
      void setCosStorageClass​(COSStorageClass cosStorageClass)
      目标对象的存储类型。
      void setXCOSACL​(COSACL cosacl)
      定义目标对象的访问控制列表(ACL)属性。
      void setXCOSACL​(java.lang.String cosacl)
      void setXCOSGrantRead​(ACLAccount aclAccount)
      赋予被授权者操作目标对象的读取权限
      void setXCOSGrantWrite​(ACLAccount aclAccount)
      赋予被授权者操作目标对象的写入权限
      void setXCOSMeta​(java.lang.String key, java.lang.String value)
      设置用户自定义头部信息
      void setXCOSReadWrite​(ACLAccount aclAccount)
      赋予被授权者操作目标对象的所有权限
      • 从类继承的方法 com.tencent.cos.xml.model.object.ObjectRequest

        getContentType, getPath, setCOSServerSideEncryption, setCOSServerSideEncryptionWithCustomerKey, setCOSServerSideEncryptionWithKMS
      • 从类继承的方法 com.tencent.cos.xml.model.CosXmlRequest

        addHeader, addNoSignHeader, addNoSignHeader, addNoSignParams, addQuery, attachMetrics, getBucket, getClientTraceId, getCredentialProvider, getHost, getHttpTask, getKeyTime, getMetrics, getNetworkType, getNoSignHeaders, getNoSignParams, getPriority, getQueryEncodedString, getQueryString, getRegion, getRequestHeaders, getRequestHost, getRequestURL, getSignSourceProvider, getWeight, headersHasUnsafeNonAscii, isNeedMD5, isSignInUrl, isSupportAccelerate, isSupportAccelerate, setClientTraceId, setCredential, setCredentialProvider, setHost, setNeedMD5, setNetworkType, setOnRequestWeightListener, setQueryEncodedString, setQueryParameters, setRegion, setRequestHeaders, setRequestHeaders, setRequestHeaders, setRequestURL, setSign, setSign, setSign, setSign, setSign, setSign, setSignInUrl, setSignKeyTime, setSignParamsAndHeaders, setSignSourceProvider, setTask, setTaskStateListener, xmlBuilder
      • 从类继承的方法 java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • 方法详细资料

      • getMethod

        public java.lang.String getMethod()
        指定者:
        getMethod 在类中 com.tencent.cos.xml.model.CosXmlRequest
      • getRequestBody

        public com.tencent.qcloud.core.http.RequestBodySerializer getRequestBody()
                                                                          throws com.tencent.cos.xml.exception.CosXmlClientException
        覆盖:
        getRequestBody 在类中 com.tencent.cos.xml.model.CosXmlRequest
        抛出:
        com.tencent.cos.xml.exception.CosXmlClientException
      • checkParameters

        public void checkParameters()
                             throws com.tencent.cos.xml.exception.CosXmlClientException
        覆盖:
        checkParameters 在类中 com.tencent.cos.xml.model.object.ObjectRequest
        抛出:
        com.tencent.cos.xml.exception.CosXmlClientException
      • setCosPath

        public void setCosPath​(java.lang.String cosPath)
        设置复制的目标cos路径
        覆盖:
        setCosPath 在类中 com.tencent.cos.xml.model.object.ObjectRequest
        参数:
        cosPath - 复制的目标cos路径
      • getCosPath

        public java.lang.String getCosPath()
        获取复制的目标cos路径
        覆盖:
        getCosPath 在类中 com.tencent.cos.xml.model.object.ObjectRequest
        返回:
        复制的目标cos路径
      • getSTSCredentialScope

        public com.tencent.qcloud.core.auth.STSCredentialScope[] getSTSCredentialScope​(com.tencent.cos.xml.CosXmlServiceConfig config)
        覆盖:
        getSTSCredentialScope 在类中 com.tencent.cos.xml.model.CosXmlRequest
      • setCopySource

        public void setCopySource​(CopyObjectRequest.CopySourceStruct copySource,
                                  com.tencent.cos.xml.CosXmlServiceConfig config)
                           throws com.tencent.cos.xml.exception.CosXmlClientException
        设置复制源对象信息
        参数:
        copySource - 源对象结构体
        config - 服务配置信息,用于获取源对象的 URL
        抛出:
        com.tencent.cos.xml.exception.CosXmlClientException - 客户端异常
      • setCopyMetaDataDirective

        public void setCopyMetaDataDirective​(MetaDataDirective metaDataDirective)
        是否复制源对象的元数据信息,枚举值:Copy,Replaced,默认为 Copy: 如果标记为 Copy,则复制源对象的元数据信息 如果标记为 Replaced,则按本次请求的请求头中的元数据信息作为目标对象的元数据信息 当目标对象和源对象为同一对象时,即用户试图修改元数据时,则标记必须为 Replaced
        参数:
        metaDataDirective - 是否拷贝元数据
      • setCopyIfModifiedSince

        public void setCopyIfModifiedSince​(java.lang.String sourceIfModifiedSince)
        当对象在指定时间后被修改,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed)
        参数:
        sourceIfModifiedSince - 指定的时间
      • setCopyIfUnmodifiedSince

        public void setCopyIfUnmodifiedSince​(java.lang.String sourceIfUnmodifiedSince)
        当对象在指定时间后未被修改,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed)
        参数:
        sourceIfUnmodifiedSince - 指定的时间
      • setCopyIfMatch

        public void setCopyIfMatch​(java.lang.String eTag)
        当对象的 ETag 与指定的值一致,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed)
        参数:
        eTag - 指定eTag
      • setCopyIfNoneMatch

        public void setCopyIfNoneMatch​(java.lang.String eTag)
        当对象的 ETag 与指定的值不一致,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed)
        参数:
        eTag - 指定eTag
      • setCopySourceServerSideEncryptionCustomerKey

        public void setCopySourceServerSideEncryptionCustomerKey​(java.lang.String sourceKey)
                                                          throws com.tencent.cos.xml.exception.CosXmlClientException
        源对象SSE-C服务端加密配置
        参数:
        sourceKey - 服务端加密密钥
        抛出:
        com.tencent.cos.xml.exception.CosXmlClientException - 客户端异常
      • setCopySourceServerSideEncryptionKMS

        public void setCopySourceServerSideEncryptionKMS​(java.lang.String customerKeyID,
                                                         java.lang.String json)
                                                  throws com.tencent.cos.xml.exception.CosXmlClientException
        源对象SSE-KMS服务端加密配置
        参数:
        customerKeyID - 用于指定 KMS 的用户主密钥 CMK,如不指定,则使用 COS 默认创建的 CMK
        json - 用于指定加密上下文,值为 JSON 格式加密上下文键值对的 Base64 编码
        抛出:
        com.tencent.cos.xml.exception.CosXmlClientException - 客户端代理
      • setCosStorageClass

        public void setCosStorageClass​(COSStorageClass cosStorageClass)
        目标对象的存储类型。 枚举值请参见 存储类型 文档,例如 STANDARD_IA,ARCHIVE。默认值:STANDARD
        参数:
        cosStorageClass - COS存储类型
      • setXCOSACL

        public void setXCOSACL​(COSACL cosacl)
        定义目标对象的访问控制列表(ACL)属性。 枚举值请参见 ACL 概述 文档中对象的预设 ACL 部分,例如 default,private,public-read 等,默认为 default
        参数:
        cosacl - COS 访问权限
      • setXCOSACL

        public void setXCOSACL​(java.lang.String cosacl)
        参数:
        cosacl - COS 访问权限
      • setXCOSGrantRead

        public void setXCOSGrantRead​(ACLAccount aclAccount)
        赋予被授权者操作目标对象的读取权限
        参数:
        aclAccount - ACL授权账号列表
      • setXCOSGrantWrite

        public void setXCOSGrantWrite​(ACLAccount aclAccount)
        赋予被授权者操作目标对象的写入权限
        参数:
        aclAccount - ACL授权账号列表
      • setXCOSReadWrite

        public void setXCOSReadWrite​(ACLAccount aclAccount)
        赋予被授权者操作目标对象的所有权限
        参数:
        aclAccount - ACL授权账号列表
      • setXCOSMeta

        public void setXCOSMeta​(java.lang.String key,
                                java.lang.String value)
        设置用户自定义头部信息
        参数:
        key - 自定义头部信息的key值,需要以 x-cos-meta- 开头
        value - 自定义头部信息的value值。