com.vmware.avi.sdk.model.RateLimiterAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of avisdk Show documentation
Avi SDK is a java API which creates a session with controller and perform CRUD operations.
There is a newer version: 31.1.1.RELEASE
/*
 * Copyright 2021 VMware, Inc.
 * SPDX-License-Identifier: Apache License 2.0
 */

package com.vmware.avi.sdk.model;

import java.util.*;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;

/**
 * The RateLimiterAction is a POJO class extends AviRestResource that used for creating
 * RateLimiterAction.
 *
 * @version 1.0
 * @since 
 *
 */
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class RateLimiterAction  {
    @JsonProperty("file")
    private HTTPLocalFile file;

    @JsonProperty("redirect")
    private HTTPRedirectAction redirect;

    @JsonProperty("status_code")
    private String statusCode = "HTTP_LOCAL_RESPONSE_STATUS_CODE_429";

    @JsonProperty("type")
    private String type = "RL_ACTION_NONE";



    /**
     * This is the getter method this will return the attribute value.
     * File to be used for http local response rate limit action.
     * Allowed in enterprise edition with any value, essentials, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return file
     */
    public HTTPLocalFile getFile() {
        return file;
    }

    /**
     * This is the setter method to the attribute.
     * File to be used for http local response rate limit action.
     * Allowed in enterprise edition with any value, essentials, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param file set the file.
     */
    public void setFile(HTTPLocalFile file) {
        this.file = file;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Parameters for http redirect rate limit action.
     * Allowed in enterprise edition with any value, essentials, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return redirect
     */
    public HTTPRedirectAction getRedirect() {
        return redirect;
    }

    /**
     * This is the setter method to the attribute.
     * Parameters for http redirect rate limit action.
     * Allowed in enterprise edition with any value, essentials, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param redirect set the redirect.
     */
    public void setRedirect(HTTPRedirectAction redirect) {
        this.redirect = redirect;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Http status code for local response rate limit action.
     * Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403,
     * HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501.
     * Allowed in enterprise edition with any value, basic edition(allowed values- http_local_response_status_code_429), essentials, enterprise with
     * cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as "HTTP_LOCAL_RESPONSE_STATUS_CODE_429".
     * @return statusCode
     */
    public String getStatusCode() {
        return statusCode;
    }

    /**
     * This is the setter method to the attribute.
     * Http status code for local response rate limit action.
     * Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403,
     * HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501.
     * Allowed in enterprise edition with any value, basic edition(allowed values- http_local_response_status_code_429), essentials, enterprise with
     * cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as "HTTP_LOCAL_RESPONSE_STATUS_CODE_429".
     * @param statusCode set the statusCode.
     */
    public void setStatusCode(String  statusCode) {
        this.statusCode = statusCode;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Type of action to be enforced upon hitting the rate limit.
     * Enum options - RL_ACTION_NONE, RL_ACTION_DROP_CONN, RL_ACTION_RESET_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_REDIRECT.
     * Allowed in enterprise edition with any value, basic edition(allowed values- rl_action_none,rl_action_drop_conn), essentials, enterprise with
     * cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as "RL_ACTION_NONE".
     * @return type
     */
    public String getType() {
        return type;
    }

    /**
     * This is the setter method to the attribute.
     * Type of action to be enforced upon hitting the rate limit.
     * Enum options - RL_ACTION_NONE, RL_ACTION_DROP_CONN, RL_ACTION_RESET_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_REDIRECT.
     * Allowed in enterprise edition with any value, basic edition(allowed values- rl_action_none,rl_action_drop_conn), essentials, enterprise with
     * cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as "RL_ACTION_NONE".
     * @param type set the type.
     */
    public void setType(String  type) {
        this.type = type;
    }


    @Override
    public boolean equals(java.lang.Object o) {
      if (this == o) {
          return true;
      }
      if (o == null || getClass() != o.getClass()) {
          return false;
      }
      RateLimiterAction objRateLimiterAction = (RateLimiterAction) o;
      return   Objects.equals(this.type, objRateLimiterAction.type)&&
  Objects.equals(this.redirect, objRateLimiterAction.redirect)&&
  Objects.equals(this.statusCode, objRateLimiterAction.statusCode)&&
  Objects.equals(this.file, objRateLimiterAction.file);
    }

    @Override
    public String toString() {
      StringBuilder sb = new StringBuilder();
      sb.append("class RateLimiterAction {\n");
                  sb.append("    file: ").append(toIndentedString(file)).append("\n");
                        sb.append("    redirect: ").append(toIndentedString(redirect)).append("\n");
                        sb.append("    statusCode: ").append(toIndentedString(statusCode)).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(java.lang.Object o) {
      if (o == null) {
          return "null";
      }
      return o.toString().replace("\n", "\n    ");
    }
}