com.softlayer.api.service.security.certificate.request.Status 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.security.certificate.request;

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.Entity;
import java.util.List;
import java.util.concurrent.Future;

/**
 * Represents the status of an SSL certificate request. 
 *
 * @see SoftLayer_Security_Certificate_Request_Status
 */
@ApiType("SoftLayer_Security_Certificate_Request_Status")
public class Status extends Entity {

    /**
     * The description of a SSL certificate request status
     */
    @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 internal identifier of an SSL certificate request status
     */
    @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 status 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;
    }

    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_Security_Certificate_Request_Status indicates the status of your SSL certificate request. When you submit an SSL certificate order, the associated certificate request will be in the "Pending CA Approval" status. This is the only status in which can cancel your order. 

     * 

     * Once the certificate authority (CA) approves your order, the status will change to "Approved". Once your order is approved, you will receive your fulfillment email from the CA. The email will contain your SSL certificate. SoftLayer does not store your SSL certificate in our system. If you lose the email from your CA, you can have the fulfillment email sent again via the SoftLayer customer portal or by using [[SoftLayer_Security_Certificate_Request/resendEmail|resendEmail]]. Your approved order will be picked up by SoftLayer's billing system and it will complete the payment process. Finally, your order will change to "Complete" status when the payment process is successful. 

     * 

     * There might be a chance that your SSL certificate order could rejected by a CA. Our automated system will put a rejected order into "Canceled" status. You can contact SoftLayer Support for more details. 
     *
     * @see SoftLayer_Security_Certificate_Request_Status
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Security_Certificate_Request_Status")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * @see SoftLayer_Security_Certificate_Request_Status::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Status getObject();

        /**
         * Returns all SSL certificate request status objects 
         *
         * @see SoftLayer_Security_Certificate_Request_Status::getSslRequestStatuses
         */
        @ApiMethod
        public List getSslRequestStatuses();

    }

    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#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

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

        public Future getSslRequestStatuses(ResponseHandler> callback);

    }

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

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

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

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

    }

}