/*
 * WSO2 API Manager - Admin
 * This document specifies a **RESTful API** for WSO2 **API Manager** - **Admin Portal**. Please see [full OpenAPI Specification](https://raw.githubusercontent.com/wso2/carbon-apimgt/v6.7.206/components/apimgt/org.wso2.carbon.apimgt.rest.api.admin.v1/src/main/resources/admin-api.yaml) of the API which is written using [OAS 3.0](http://swagger.io/) specification.  # Authentication Our REST APIs are protected using OAuth2 and access control is achieved through scopes. Before you start invoking the the API you need to obtain an access token with the required scopes. This guide will walk you through the steps that you will need to follow to obtain an access token. First you need to obtain the consumer key/secret key pair by calling the dynamic client registration (DCR) endpoint. You can add your preferred grant types in the payload. A sample payload is shown below. ```   {   \"callbackUrl\":\"www.google.lk\",   \"clientName\":\"rest_api_admin\",   \"owner\":\"admin\",   \"grantType\":\"client_credentials password refresh_token\",   \"saasApp\":true   } ``` Create a file (payload.json) with the above sample payload, and use the cURL shown bellow to invoke the DCR endpoint. Authorization header of this should contain the base64 encoded admin username and password. **Format of the request** ```   curl -X POST -H \"Authorization: Basic Base64(admin_username:admin_password)\" -H \"Content-Type: application/json\"   \\ -d @payload.json https://<host>:<servlet_port>/client-registration/v0.17/register ``` **Sample request** ```   curl -X POST -H \"Authorization: Basic YWRtaW46YWRtaW4=\" -H \"Content-Type: application/json\"   \\ -d @payload.json https://localhost:9443/client-registration/v0.17/register ``` Following is a sample response after invoking the above curl. ``` { \"clientId\": \"fOCi4vNJ59PpHucC2CAYfYuADdMa\", \"clientName\": \"rest_api_admin\", \"callBackURL\": \"www.google.lk\", \"clientSecret\": \"a4FwHlq0iCIKVs2MPIIDnepZnYMa\", \"isSaasApplication\": true, \"appOwner\": \"admin\", \"jsonString\": \"{\\\"grant_types\\\":\\\"client_credentials password refresh_token\\\",\\\"redirect_uris\\\":\\\"www.google.lk\\\",\\\"client_name\\\":\\\"rest_api_admin\\\"}\", \"jsonAppAttribute\": \"{}\", \"tokenType\": null } ``` Next you must use the above client id and secret to obtain the access token. We will be using the password grant type for this, you can use any grant type you desire. You also need to add the proper **scope** when getting the access token. All possible scopes for Admin REST API can be viewed in **OAuth2 Security** section of this document and scope for each resource is given in **authorizations** section of resource documentation. Following is the format of the request if you are using the password grant type. ``` curl -k -d \"grant_type=password&username=<admin_username>&password=<admin_passowrd>&scope=<scopes seperated by space>\" \\ -H \"Authorization: Basic base64(cliet_id:client_secret)\" \\ https://<host>:<gateway_port>/token ``` **Sample request** ``` curl https://localhost:8243/token -k \\ -H \"Authorization: Basic Zk9DaTR2Tko1OVBwSHVjQzJDQVlmWXVBRGRNYTphNEZ3SGxxMGlDSUtWczJNUElJRG5lcFpuWU1h\" \\ -d \"grant_type=password&username=admin&password=admin&scope=apim:admin apim:tier_view\" ``` Shown below is a sample response to the above request. ``` { \"access_token\": \"e79bda48-3406-3178-acce-f6e4dbdcbb12\", \"refresh_token\": \"a757795d-e69f-38b8-bd85-9aded677a97c\", \"scope\": \"apim:admin apim:tier_view\", \"token_type\": \"Bearer\", \"expires_in\": 3600 } ``` Now you have a valid access token, which you can use to invoke an API. Navigate through the API descriptions to find the required API, obtain an access token as described above and invoke the API with the authentication header. If you use a different authentication mechanism, this process may change.  # Try out in Postman If you want to try-out the embedded postman collection with \"Run in Postman\" option, please follow the guidelines listed below. * All of the OAuth2 secured endpoints have been configured with an Authorization Bearer header with a parameterized access token. Before invoking any REST API resource make sure you run the `Register DCR Application` and `Generate Access Token` requests to fetch an access token with all required scopes. * Make sure you have an API Manager instance up and running. * Update the `basepath` parameter to match the hostname and port of the APIM instance.  [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/f5ac2ca9fb22afef6ed6) 
 *
 * The version of the OpenAPI document: v4
 * Contact: architecture@wso2.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package org.wso2.am.integration.clients.admin.api.dto;

import java.util.Objects;
import java.util.Arrays;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import com.fasterxml.jackson.annotation.JsonCreator;
/**
* ThrottlePolicyDetailsDTO
*/

public class ThrottlePolicyDetailsDTO {
        public static final String SERIALIZED_NAME_POLICY_ID = "policyId";
        @SerializedName(SERIALIZED_NAME_POLICY_ID)
            private Integer policyId;

        public static final String SERIALIZED_NAME_UUID = "uuid";
        @SerializedName(SERIALIZED_NAME_UUID)
            private String uuid;

        public static final String SERIALIZED_NAME_POLICY_NAME = "policyName";
        @SerializedName(SERIALIZED_NAME_POLICY_NAME)
            private String policyName;

        public static final String SERIALIZED_NAME_DISPLAY_NAME = "displayName";
        @SerializedName(SERIALIZED_NAME_DISPLAY_NAME)
            private String displayName;

        public static final String SERIALIZED_NAME_DESCRIPTION = "description";
        @SerializedName(SERIALIZED_NAME_DESCRIPTION)
            private String description;

        public static final String SERIALIZED_NAME_IS_DEPLOYED = "isDeployed";
        @SerializedName(SERIALIZED_NAME_IS_DEPLOYED)
            private Boolean isDeployed = false;

        public static final String SERIALIZED_NAME_TYPE = "type";
        @SerializedName(SERIALIZED_NAME_TYPE)
            private String type;


        public ThrottlePolicyDetailsDTO policyId(Integer policyId) {
        
        this.policyId = policyId;
        return this;
        }

    /**
        * Id of policy
    * @return policyId
    **/
        @javax.annotation.Nullable
      @ApiModelProperty(example = "3", value = "Id of policy")
    
    public Integer getPolicyId() {
        return policyId;
    }


    public void setPolicyId(Integer policyId) {
        this.policyId = policyId;
    }


        public ThrottlePolicyDetailsDTO uuid(String uuid) {
        
        this.uuid = uuid;
        return this;
        }

    /**
        * UUId of policy
    * @return uuid
    **/
        @javax.annotation.Nullable
      @ApiModelProperty(example = "0c6439fd-9b16-3c2e-be6e-1086e0b9aa93", value = "UUId of policy")
    
    public String getUuid() {
        return uuid;
    }


    public void setUuid(String uuid) {
        this.uuid = uuid;
    }


        public ThrottlePolicyDetailsDTO policyName(String policyName) {
        
        this.policyName = policyName;
        return this;
        }

    /**
        * Name of policy
    * @return policyName
    **/
      @ApiModelProperty(example = "30PerMin", required = true, value = "Name of policy")
    
    public String getPolicyName() {
        return policyName;
    }


    public void setPolicyName(String policyName) {
        this.policyName = policyName;
    }


        public ThrottlePolicyDetailsDTO displayName(String displayName) {
        
        this.displayName = displayName;
        return this;
        }

    /**
        * Display name of the policy
    * @return displayName
    **/
        @javax.annotation.Nullable
      @ApiModelProperty(example = "30PerMin", value = "Display name of the policy")
    
    public String getDisplayName() {
        return displayName;
    }


    public void setDisplayName(String displayName) {
        this.displayName = displayName;
    }


        public ThrottlePolicyDetailsDTO description(String description) {
        
        this.description = description;
        return this;
        }

    /**
        * Description of the policy
    * @return description
    **/
        @javax.annotation.Nullable
      @ApiModelProperty(example = "Allows 30 request per minute", value = "Description of the policy")
    
    public String getDescription() {
        return description;
    }


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


        public ThrottlePolicyDetailsDTO isDeployed(Boolean isDeployed) {
        
        this.isDeployed = isDeployed;
        return this;
        }

    /**
        * Indicates whether the policy is deployed successfully or not.
    * @return isDeployed
    **/
        @javax.annotation.Nullable
      @ApiModelProperty(value = "Indicates whether the policy is deployed successfully or not.")
    
    public Boolean isIsDeployed() {
        return isDeployed;
    }


    public void setIsDeployed(Boolean isDeployed) {
        this.isDeployed = isDeployed;
    }


        public ThrottlePolicyDetailsDTO type(String type) {
        
        this.type = type;
        return this;
        }

    /**
        * Indicates the type of throttle policy
    * @return type
    **/
        @javax.annotation.Nullable
      @ApiModelProperty(value = "Indicates the type of throttle policy")
    
    public String getType() {
        return type;
    }


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


    @Override
    public boolean equals(Object o) {
        if (this == o) {
        return true;
        }
        if (o == null || getClass() != o.getClass()) {
        return false;
        }
            ThrottlePolicyDetailsDTO throttlePolicyDetails = (ThrottlePolicyDetailsDTO) o;
            return Objects.equals(this.policyId, throttlePolicyDetails.policyId) &&
            Objects.equals(this.uuid, throttlePolicyDetails.uuid) &&
            Objects.equals(this.policyName, throttlePolicyDetails.policyName) &&
            Objects.equals(this.displayName, throttlePolicyDetails.displayName) &&
            Objects.equals(this.description, throttlePolicyDetails.description) &&
            Objects.equals(this.isDeployed, throttlePolicyDetails.isDeployed) &&
            Objects.equals(this.type, throttlePolicyDetails.type);
    }

    @Override
    public int hashCode() {
        return Objects.hash(policyId, uuid, policyName, displayName, description, isDeployed, type);
    }


@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class ThrottlePolicyDetailsDTO {\n");
    sb.append("    policyId: ").append(toIndentedString(policyId)).append("\n");
    sb.append("    uuid: ").append(toIndentedString(uuid)).append("\n");
    sb.append("    policyName: ").append(toIndentedString(policyName)).append("\n");
    sb.append("    displayName: ").append(toIndentedString(displayName)).append("\n");
    sb.append("    description: ").append(toIndentedString(description)).append("\n");
    sb.append("    isDeployed: ").append(toIndentedString(isDeployed)).append("\n");
    sb.append("    type: ").append(toIndentedString(type)).append("\n");
sb.append("}");
return sb.toString();
}

/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n    ");
}

}

