github.com/qiniu/go-sdk/v7@v7.27.0/storagev2/apis/set_bucket_remark/api.go (about)

     1  // THIS FILE IS GENERATED BY api-generator, DO NOT EDIT DIRECTLY!
     2  
     3  // 设置空间备注
     4  package set_bucket_remark
     5  
     6  import (
     7  	"encoding/json"
     8  
     9  	credentials "github.com/qiniu/go-sdk/v7/storagev2/credentials"
    10  	errors "github.com/qiniu/go-sdk/v7/storagev2/errors"
    11  )
    12  
    13  // 调用 API 所用的请求
    14  type Request struct {
    15  	Bucket      string                          // 空间名称
    16  	Credentials credentials.CredentialsProvider // 鉴权参数，用于生成鉴权凭证，如果为空，则使用 HTTPClientOptions 中的 CredentialsProvider
    17  	Remark      string                          // 空间备注信息, 字符长度不能超过 100, 允许为空
    18  }
    19  
    20  // 空间备注信息
    21  type (
    22  	BucketRemark = Request
    23  	jsonRequest  struct {
    24  		Remark string `json:"remark"` // 空间备注信息, 字符长度不能超过 100, 允许为空
    25  	}
    26  )
    27  
    28  func (j *Request) MarshalJSON() ([]byte, error) {
    29  	if err := j.validate(); err != nil {
    30  		return nil, err
    31  	}
    32  	return json.Marshal(&jsonRequest{Remark: j.Remark})
    33  }
    34  
    35  func (j *Request) UnmarshalJSON(data []byte) error {
    36  	var nj jsonRequest
    37  	if err := json.Unmarshal(data, &nj); err != nil {
    38  		return err
    39  	}
    40  	j.Remark = nj.Remark
    41  	return nil
    42  }
    43  
    44  func (j *Request) validate() error {
    45  	if j.Remark == "" {
    46  		return errors.MissingRequiredFieldError{Name: "Remark"}
    47  	}
    48  	return nil
    49  }
    50  
    51  // 获取 API 所用的响应
    52  type Response struct{}