com.obs.services.model.fs.TruncateFileRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of esdk-obs-android Show documentation

The HuaweiCloud OBS SDK for Android used for accessing Object Storage Service

There is a newer version: 3.24.9

/**
 * Copyright 2019 Huawei Technologies Co.,Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License.  You may obtain a copy of the
 * License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations under the License.
 */

package com.obs.services.model.fs;

import com.obs.services.model.BaseObjectRequest;
import com.obs.services.model.HttpMethodEnum;

/**
 * Parameters in a request for truncating a file
 *
 */
public class TruncateFileRequest extends BaseObjectRequest {

    {
        httpMethod = HttpMethodEnum.PUT;
    }

    private long newLength;

    public TruncateFileRequest() {
    }

    /**
     * Constructor
     * 
     * @param bucketName
     *            Bucket name
     * @param objectKey
     *            File name
     * @param newLength
     *            File size after the truncation
     */
    public TruncateFileRequest(String bucketName, String objectKey, long newLength) {
        this.bucketName = bucketName;
        this.objectKey = objectKey;
        this.newLength = newLength;
    }

    /**
     * Obtain the file size after the truncation.
     * 
     * @return File size after the truncation
     */
    public long getNewLength() {
        return newLength;
    }

    /**
     * Set the post-truncation file size.
     * 
     * @param newLength
     *            File size after the truncation
     */
    public void setNewLength(long newLength) {
        this.newLength = newLength;
    }
}