com.softlayer.api.service.container.utility.file.Entity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.container.utility.file;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import java.util.GregorianCalendar;

/**
 * SoftLayer_Container_Utility_File_Entity data type models a single entity on a storage resource. Entities can include anything within a storage volume including files, folders, directories, and CloudLayer storage projects. 
 *
 * @see SoftLayer_Container_Utility_File_Entity
 */
@ApiType("SoftLayer_Container_Utility_File_Entity")
public class Entity extends com.softlayer.api.service.Entity {

    /**
     * A file entity's raw content.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected byte[] content;

    public byte[] getContent() {
        return content;
    }

    public void setContent(byte[] content) {
        contentSpecified = true;
        this.content = content;
    }

    protected boolean contentSpecified;

    public boolean isContentSpecified() {
        return contentSpecified;
    }

    public void unsetContent() {
        content = null;
        contentSpecified = false;
    }

    /**
     * A file entity's MIME content type.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String contentType;

    public String getContentType() {
        return contentType;
    }

    public void setContentType(String contentType) {
        contentTypeSpecified = true;
        this.contentType = contentType;
    }

    protected boolean contentTypeSpecified;

    public boolean isContentTypeSpecified() {
        return contentTypeSpecified;
    }

    public void unsetContentType() {
        contentType = null;
        contentTypeSpecified = false;
    }

    /**
     * The date a file entity was created.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar createDate;

    public GregorianCalendar getCreateDate() {
        return createDate;
    }

    public void setCreateDate(GregorianCalendar createDate) {
        createDateSpecified = true;
        this.createDate = createDate;
    }

    protected boolean createDateSpecified;

    public boolean isCreateDateSpecified() {
        return createDateSpecified;
    }

    public void unsetCreateDate() {
        createDate = null;
        createDateSpecified = false;
    }

    /**
     * The date a CloudLayer storage file entity was moved into the recycle bin. This field applies to files that are pending deletion in the recycle bin.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar deleteDate;

    public GregorianCalendar getDeleteDate() {
        return deleteDate;
    }

    public void setDeleteDate(GregorianCalendar deleteDate) {
        deleteDateSpecified = true;
        this.deleteDate = deleteDate;
    }

    protected boolean deleteDateSpecified;

    public boolean isDeleteDateSpecified() {
        return deleteDateSpecified;
    }

    public void unsetDeleteDate() {
        deleteDate = null;
        deleteDateSpecified = false;
    }

    /**
     * Unique identifier for the file. This can be either a number or guid.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String id;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * Whether a CloudLayer storage file entity is shared with another CloudLayer user.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long isShared;

    public Long getIsShared() {
        return isShared;
    }

    public void setIsShared(Long isShared) {
        isSharedSpecified = true;
        this.isShared = isShared;
    }

    protected boolean isSharedSpecified;

    public boolean isIsSharedSpecified() {
        return isSharedSpecified;
    }

    public void unsetIsShared() {
        isShared = null;
        isSharedSpecified = false;
    }

    /**
     * The date a file entity was last changed.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar modifyDate;

    public GregorianCalendar getModifyDate() {
        return modifyDate;
    }

    public void setModifyDate(GregorianCalendar modifyDate) {
        modifyDateSpecified = true;
        this.modifyDate = modifyDate;
    }

    protected boolean modifyDateSpecified;

    public boolean isModifyDateSpecified() {
        return modifyDateSpecified;
    }

    public void unsetModifyDate() {
        modifyDate = null;
        modifyDateSpecified = false;
    }

    /**
     * A file entity's name.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        nameSpecified = true;
        this.name = name;
    }

    protected boolean nameSpecified;

    public boolean isNameSpecified() {
        return nameSpecified;
    }

    public void unsetName() {
        name = null;
        nameSpecified = false;
    }

    /**
     * The owner is usually the account who first upload or created the file on the resource or the account who is responsible for the file at the moment. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String owner;

    public String getOwner() {
        return owner;
    }

    public void setOwner(String owner) {
        ownerSpecified = true;
        this.owner = owner;
    }

    protected boolean ownerSpecified;

    public boolean isOwnerSpecified() {
        return ownerSpecified;
    }

    public void unsetOwner() {
        owner = null;
        ownerSpecified = false;
    }

    /**
     * The size of a file entity in bytes.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long size;

    public Long getSize() {
        return size;
    }

    public void setSize(Long size) {
        sizeSpecified = true;
        this.size = size;
    }

    protected boolean sizeSpecified;

    public boolean isSizeSpecified() {
        return sizeSpecified;
    }

    public void unsetSize() {
        size = null;
        sizeSpecified = false;
    }

    /**
     * A CloudLayer storage file entity's type. Types can include "file", "folder", "dir", and "project". 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String type;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        typeSpecified = true;
        this.type = type;
    }

    protected boolean typeSpecified;

    public boolean isTypeSpecified() {
        return typeSpecified;
    }

    public void unsetType() {
        type = null;
        typeSpecified = false;
    }

    /**
     * The latest revision of a file on a CloudLayer storage volume. This number increments each time a new revision of the file is uploaded. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long version;

    public Long getVersion() {
        return version;
    }

    public void setVersion(Long version) {
        versionSpecified = true;
        this.version = version;
    }

    protected boolean versionSpecified;

    public boolean isVersionSpecified() {
        return versionSpecified;
    }

    public void unsetVersion() {
        version = null;
        versionSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public Mask content() {
            withLocalProperty("content");
            return this;
        }

        public Mask contentType() {
            withLocalProperty("contentType");
            return this;
        }

        public Mask createDate() {
            withLocalProperty("createDate");
            return this;
        }

        public Mask deleteDate() {
            withLocalProperty("deleteDate");
            return this;
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask isShared() {
            withLocalProperty("isShared");
            return this;
        }

        public Mask modifyDate() {
            withLocalProperty("modifyDate");
            return this;
        }

        public Mask name() {
            withLocalProperty("name");
            return this;
        }

        public Mask owner() {
            withLocalProperty("owner");
            return this;
        }

        public Mask size() {
            withLocalProperty("size");
            return this;
        }

        public Mask type() {
            withLocalProperty("type");
            return this;
        }

        public Mask version() {
            withLocalProperty("version");
            return this;
        }

    }

}