• Home
• com.softlayer.api
• softlayer-api-client
• 0.3.2
• source code
• Media.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.softlayer.api.service.account.Media Maven / Gradle / Ivy

package com.softlayer.api.service.account;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Location;
import com.softlayer.api.service.account.media.Type;
import com.softlayer.api.service.account.media.data.transfer.Request;
import com.softlayer.api.service.network.Storage;
import com.softlayer.api.service.user.Customer;
import com.softlayer.api.service.user.Employee;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Account_Media data type contains information on a single piece of media associated with a Data Transfer Service request. 
 *
 * @see SoftLayer_Account_Media
 */
@ApiType("SoftLayer_Account_Media")
public class Media extends Entity {

    /**
     * The account to which the media belongs.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

    public void setAccount(Account account) {
        this.account = account;
    }

    /**
     * The customer user who created the media object.
     */
    @ApiProperty
    protected Customer createUser;

    public Customer getCreateUser() {
        return createUser;
    }

    public void setCreateUser(Customer createUser) {
        this.createUser = createUser;
    }

    /**
     * The datacenter where the media resides.
     */
    @ApiProperty
    protected Location datacenter;

    public Location getDatacenter() {
        return datacenter;
    }

    public void setDatacenter(Location datacenter) {
        this.datacenter = datacenter;
    }

    /**
     * The employee who last modified the media.
     */
    @ApiProperty
    protected Employee modifyEmployee;

    public Employee getModifyEmployee() {
        return modifyEmployee;
    }

    public void setModifyEmployee(Employee modifyEmployee) {
        this.modifyEmployee = modifyEmployee;
    }

    /**
     * The customer user who last modified the media.
     */
    @ApiProperty
    protected Customer modifyUser;

    public Customer getModifyUser() {
        return modifyUser;
    }

    public void setModifyUser(Customer modifyUser) {
        this.modifyUser = modifyUser;
    }

    /**
     * The request to which the media belongs.
     */
    @ApiProperty
    protected Request request;

    public Request getRequest() {
        return request;
    }

    public void setRequest(Request request) {
        this.request = request;
    }

    /**
     * The media's type.
     */
    @ApiProperty
    protected Type type;

    public Type getType() {
        return type;
    }

    public void setType(Type type) {
        this.type = type;
    }

    /**
     * A guest's associated EVault network storage service account.
     */
    @ApiProperty
    protected Storage volume;

    public Storage getVolume() {
        return volume;
    }

    public void setVolume(Storage volume) {
        this.volume = volume;
    }

    /**
     * The description of the media.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String description;

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        descriptionSpecified = true;
        this.description = description;
    }

    protected boolean descriptionSpecified;

    public boolean isDescriptionSpecified() {
        return descriptionSpecified;
    }

    public void unsetDescription() {
        description = null;
        descriptionSpecified = false;
    }

    /**
     * The unique id of the media.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

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

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

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

    /**
     * The request id of the media.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long requestId;

    public Long getRequestId() {
        return requestId;
    }

    public void setRequestId(Long requestId) {
        requestIdSpecified = true;
        this.requestId = requestId;
    }

    protected boolean requestIdSpecified;

    public boolean isRequestIdSpecified() {
        return requestIdSpecified;
    }

    public void unsetRequestId() {
        requestId = null;
        requestIdSpecified = false;
    }

    /**
     * The manufacturer's serial number of the media.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serialNumber;

    public String getSerialNumber() {
        return serialNumber;
    }

    public void setSerialNumber(String serialNumber) {
        serialNumberSpecified = true;
        this.serialNumber = serialNumber;
    }

    protected boolean serialNumberSpecified;

    public boolean isSerialNumberSpecified() {
        return serialNumberSpecified;
    }

    public void unsetSerialNumber() {
        serialNumber = null;
        serialNumberSpecified = false;
    }

    /**
     * The type id of the media.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long typeId;

    public Long getTypeId() {
        return typeId;
    }

    public void setTypeId(Long typeId) {
        typeIdSpecified = true;
        this.typeId = typeId;
    }

    protected boolean typeIdSpecified;

    public boolean isTypeIdSpecified() {
        return typeIdSpecified;
    }

    public void unsetTypeId() {
        typeId = null;
        typeIdSpecified = false;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * SoftLayer's data transfer request media service allows users to access and manage their media devices that they have submitted through SoftLayer's Data Transfer Service. 
     *
     * @see SoftLayer_Account_Media
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Account_Media")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Edit the properties of a media record by passing in a modified instance of a SoftLayer_Account_Media object. 
         *
         * @see SoftLayer_Account_Media::editObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean editObject(Media templateObject);

        /**
         * Retrieve a list supported media types for SoftLayer's Data Transfer Service.
         *
         * @see SoftLayer_Account_Media::getAllMediaTypes
         */
        @ApiMethod
        public List getAllMediaTypes();

        /**
         * @see SoftLayer_Account_Media::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Media getObject();

        /**
         * Remove a media from a SoftLayer account's list of media. The media record is not deleted. 
         *
         * @see SoftLayer_Account_Media::removeMediaFromList
         */
        @ApiMethod
        public Long removeMediaFromList(Media mediaTemplate);

        /**
         * The account to which the media belongs.
         *
         * @see SoftLayer_Account_Media::getAccount
         */
        @ApiMethod(instanceRequired = true)
        public Account getAccount();

        /**
         * The customer user who created the media object.
         *
         * @see SoftLayer_Account_Media::getCreateUser
         */
        @ApiMethod(instanceRequired = true)
        public Customer getCreateUser();

        /**
         * The datacenter where the media resides.
         *
         * @see SoftLayer_Account_Media::getDatacenter
         */
        @ApiMethod(instanceRequired = true)
        public Location getDatacenter();

        /**
         * The employee who last modified the media.
         *
         * @see SoftLayer_Account_Media::getModifyEmployee
         */
        @ApiMethod(instanceRequired = true)
        public Employee getModifyEmployee();

        /**
         * The customer user who last modified the media.
         *
         * @see SoftLayer_Account_Media::getModifyUser
         */
        @ApiMethod(instanceRequired = true)
        public Customer getModifyUser();

        /**
         * The request to which the media belongs.
         *
         * @see SoftLayer_Account_Media::getRequest
         */
        @ApiMethod(instanceRequired = true)
        public Request getRequest();

        /**
         * The media's type.
         *
         * @see SoftLayer_Account_Media::getType
         */
        @ApiMethod(instanceRequired = true)
        public Type getType();

        /**
         * A guest's associated EVault network storage service account.
         *
         * @see SoftLayer_Account_Media::getVolume
         */
        @ApiMethod(instanceRequired = true)
        public Storage getVolume();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#editObject}
         */
        public Future editObject(Media templateObject);

        public Future editObject(Media templateObject, ResponseHandler callback);

        /**
         * Async version of {@link Service#getAllMediaTypes}
         */
        public Future> getAllMediaTypes();

        public Future getAllMediaTypes(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#removeMediaFromList}
         */
        public Future removeMediaFromList(Media mediaTemplate);

        public Future removeMediaFromList(Media mediaTemplate, ResponseHandler callback);

        /**
         * Async version of {@link Service#getAccount}
         */
        public Future getAccount();

        /**
         * Async callback version of {@link Service#getAccount}
         */
        public Future getAccount(ResponseHandler callback);

        /**
         * Async version of {@link Service#getCreateUser}
         */
        public Future getCreateUser();

        /**
         * Async callback version of {@link Service#getCreateUser}
         */
        public Future getCreateUser(ResponseHandler callback);

        /**
         * Async version of {@link Service#getDatacenter}
         */
        public Future getDatacenter();

        /**
         * Async callback version of {@link Service#getDatacenter}
         */
        public Future getDatacenter(ResponseHandler callback);

        /**
         * Async version of {@link Service#getModifyEmployee}
         */
        public Future getModifyEmployee();

        /**
         * Async callback version of {@link Service#getModifyEmployee}
         */
        public Future getModifyEmployee(ResponseHandler callback);

        /**
         * Async version of {@link Service#getModifyUser}
         */
        public Future getModifyUser();

        /**
         * Async callback version of {@link Service#getModifyUser}
         */
        public Future getModifyUser(ResponseHandler callback);

        /**
         * Async version of {@link Service#getRequest}
         */
        public Future getRequest();

        /**
         * Async callback version of {@link Service#getRequest}
         */
        public Future getRequest(ResponseHandler callback);

        /**
         * Async version of {@link Service#getType}
         */
        public Future getType();

        /**
         * Async callback version of {@link Service#getType}
         */
        public Future getType(ResponseHandler callback);

        /**
         * Async version of {@link Service#getVolume}
         */
        public Future getVolume();

        /**
         * Async callback version of {@link Service#getVolume}
         */
        public Future getVolume(ResponseHandler callback);

    }

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

        public com.softlayer.api.service.Account.Mask account() {
            return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
        }

        public com.softlayer.api.service.user.Customer.Mask createUser() {
            return withSubMask("createUser", com.softlayer.api.service.user.Customer.Mask.class);
        }

        public com.softlayer.api.service.Location.Mask datacenter() {
            return withSubMask("datacenter", com.softlayer.api.service.Location.Mask.class);
        }

        public com.softlayer.api.service.user.Employee.Mask modifyEmployee() {
            return withSubMask("modifyEmployee", com.softlayer.api.service.user.Employee.Mask.class);
        }

        public com.softlayer.api.service.user.Customer.Mask modifyUser() {
            return withSubMask("modifyUser", com.softlayer.api.service.user.Customer.Mask.class);
        }

        public com.softlayer.api.service.account.media.data.transfer.Request.Mask request() {
            return withSubMask("request", com.softlayer.api.service.account.media.data.transfer.Request.Mask.class);
        }

        public com.softlayer.api.service.account.media.Type.Mask type() {
            return withSubMask("type", com.softlayer.api.service.account.media.Type.Mask.class);
        }

        public com.softlayer.api.service.network.Storage.Mask volume() {
            return withSubMask("volume", com.softlayer.api.service.network.Storage.Mask.class);
        }

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

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

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

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

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

    }

}