com.oracle.bmc.apigateway.model.ApiSpecificationRoute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oci-java-sdk-shaded-full Show documentation
This project contains the SDK distribution used for Oracle Cloud Infrastructure, and all the dependencies that can be shaded. It also has Maven dependencies that cannot be shaded. Therefore, use this module to depend on the shaded distribution via Maven -- it will shade everything that can be shaded, and automatically pull in the other dependencies.
There is a newer version: 3.55.2
Show newest version
/**
 * Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
 * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 */
package com.oracle.bmc.apigateway.model;

/**
 * A single route that forwards requests to a particular backend and may contain some additional
 * policies. 

 * Note: Objects should always be created or deserialized using the {@link Builder}. This model
 * distinguishes fields that are {@code null} because they are unset from fields that are explicitly
 * set to {@code null}. This is done in the setter methods of the {@link Builder}, which maintain a
 * set of all explicitly set fields called {@link Builder#__explicitlySet__}. The {@link
 * #hashCode()} and {@link #equals(Object)} methods are implemented to take the explicitly set
 * fields into account. The constructor, on the other hand, does not take the explicitly set fields
 * into account (since the constructor cannot distinguish explicit {@code null} from unset {@code
 * null}).
 */
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20190501")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(
        builder = ApiSpecificationRoute.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
        com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class ApiSpecificationRoute
        extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
    @Deprecated
    @java.beans.ConstructorProperties({
        "path",
        "methods",
        "requestPolicies",
        "responsePolicies",
        "loggingPolicies",
        "backend"
    })
    public ApiSpecificationRoute(
            String path,
            java.util.List methods,
            ApiSpecificationRouteRequestPolicies requestPolicies,
            ApiSpecificationRouteResponsePolicies responsePolicies,
            ApiSpecificationLoggingPolicies loggingPolicies,
            ApiSpecificationRouteBackend backend) {
        super();
        this.path = path;
        this.methods = methods;
        this.requestPolicies = requestPolicies;
        this.responsePolicies = responsePolicies;
        this.loggingPolicies = loggingPolicies;
        this.backend = backend;
    }

    @com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
    public static class Builder {
        /**
         * A URL path pattern that must be matched on this route. The path pattern may contain a
         * subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
         */
        @com.fasterxml.jackson.annotation.JsonProperty("path")
        private String path;

        /**
         * A URL path pattern that must be matched on this route. The path pattern may contain a
         * subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
         *
         * @param path the value to set
         * @return this builder
         */
        public Builder path(String path) {
            this.path = path;
            this.__explicitlySet__.add("path");
            return this;
        }
        /** A list of allowed methods on this route. */
        @com.fasterxml.jackson.annotation.JsonProperty("methods")
        private java.util.List methods;

        /**
         * A list of allowed methods on this route.
         *
         * @param methods the value to set
         * @return this builder
         */
        public Builder methods(java.util.List methods) {
            this.methods = methods;
            this.__explicitlySet__.add("methods");
            return this;
        }

        @com.fasterxml.jackson.annotation.JsonProperty("requestPolicies")
        private ApiSpecificationRouteRequestPolicies requestPolicies;

        public Builder requestPolicies(ApiSpecificationRouteRequestPolicies requestPolicies) {
            this.requestPolicies = requestPolicies;
            this.__explicitlySet__.add("requestPolicies");
            return this;
        }

        @com.fasterxml.jackson.annotation.JsonProperty("responsePolicies")
        private ApiSpecificationRouteResponsePolicies responsePolicies;

        public Builder responsePolicies(ApiSpecificationRouteResponsePolicies responsePolicies) {
            this.responsePolicies = responsePolicies;
            this.__explicitlySet__.add("responsePolicies");
            return this;
        }

        @com.fasterxml.jackson.annotation.JsonProperty("loggingPolicies")
        private ApiSpecificationLoggingPolicies loggingPolicies;

        public Builder loggingPolicies(ApiSpecificationLoggingPolicies loggingPolicies) {
            this.loggingPolicies = loggingPolicies;
            this.__explicitlySet__.add("loggingPolicies");
            return this;
        }

        @com.fasterxml.jackson.annotation.JsonProperty("backend")
        private ApiSpecificationRouteBackend backend;

        public Builder backend(ApiSpecificationRouteBackend backend) {
            this.backend = backend;
            this.__explicitlySet__.add("backend");
            return this;
        }

        @com.fasterxml.jackson.annotation.JsonIgnore
        private final java.util.Set __explicitlySet__ = new java.util.HashSet();

        public ApiSpecificationRoute build() {
            ApiSpecificationRoute model =
                    new ApiSpecificationRoute(
                            this.path,
                            this.methods,
                            this.requestPolicies,
                            this.responsePolicies,
                            this.loggingPolicies,
                            this.backend);
            for (String explicitlySetProperty : this.__explicitlySet__) {
                model.markPropertyAsExplicitlySet(explicitlySetProperty);
            }
            return model;
        }

        @com.fasterxml.jackson.annotation.JsonIgnore
        public Builder copy(ApiSpecificationRoute model) {
            if (model.wasPropertyExplicitlySet("path")) {
                this.path(model.getPath());
            }
            if (model.wasPropertyExplicitlySet("methods")) {
                this.methods(model.getMethods());
            }
            if (model.wasPropertyExplicitlySet("requestPolicies")) {
                this.requestPolicies(model.getRequestPolicies());
            }
            if (model.wasPropertyExplicitlySet("responsePolicies")) {
                this.responsePolicies(model.getResponsePolicies());
            }
            if (model.wasPropertyExplicitlySet("loggingPolicies")) {
                this.loggingPolicies(model.getLoggingPolicies());
            }
            if (model.wasPropertyExplicitlySet("backend")) {
                this.backend(model.getBackend());
            }
            return this;
        }
    }

    /** Create a new builder. */
    public static Builder builder() {
        return new Builder();
    }

    public Builder toBuilder() {
        return new Builder().copy(this);
    }

    /**
     * A URL path pattern that must be matched on this route. The path pattern may contain a subset
     * of RFC 6570 identifiers to allow wildcard and parameterized matching.
     */
    @com.fasterxml.jackson.annotation.JsonProperty("path")
    private final String path;

    /**
     * A URL path pattern that must be matched on this route. The path pattern may contain a subset
     * of RFC 6570 identifiers to allow wildcard and parameterized matching.
     *
     * @return the value
     */
    public String getPath() {
        return path;
    }

    /** */
    public enum Methods implements com.oracle.bmc.http.internal.BmcEnum {
        Any("ANY"),
        Head("HEAD"),
        Get("GET"),
        Post("POST"),
        Put("PUT"),
        Patch("PATCH"),
        Delete("DELETE"),
        Options("OPTIONS"),

        /**
         * This value is used if a service returns a value for this enum that is not recognized by
         * this version of the SDK.
         */
        UnknownEnumValue(null);

        private static final org.slf4j.Logger LOG =
                org.slf4j.LoggerFactory.getLogger(Methods.class);

        private final String value;
        private static java.util.Map map;

        static {
            map = new java.util.HashMap<>();
            for (Methods v : Methods.values()) {
                if (v != UnknownEnumValue) {
                    map.put(v.getValue(), v);
                }
            }
        }

        Methods(String value) {
            this.value = value;
        }

        @com.fasterxml.jackson.annotation.JsonValue
        public String getValue() {
            return value;
        }

        @com.fasterxml.jackson.annotation.JsonCreator
        public static Methods create(String key) {
            if (map.containsKey(key)) {
                return map.get(key);
            }
            LOG.warn(
                    "Received unknown value '{}' for enum 'Methods', returning UnknownEnumValue",
                    key);
            return UnknownEnumValue;
        }
    };
    /** A list of allowed methods on this route. */
    @com.fasterxml.jackson.annotation.JsonProperty("methods")
    private final java.util.List methods;

    /**
     * A list of allowed methods on this route.
     *
     * @return the value
     */
    public java.util.List getMethods() {
        return methods;
    }

    @com.fasterxml.jackson.annotation.JsonProperty("requestPolicies")
    private final ApiSpecificationRouteRequestPolicies requestPolicies;

    public ApiSpecificationRouteRequestPolicies getRequestPolicies() {
        return requestPolicies;
    }

    @com.fasterxml.jackson.annotation.JsonProperty("responsePolicies")
    private final ApiSpecificationRouteResponsePolicies responsePolicies;

    public ApiSpecificationRouteResponsePolicies getResponsePolicies() {
        return responsePolicies;
    }

    @com.fasterxml.jackson.annotation.JsonProperty("loggingPolicies")
    private final ApiSpecificationLoggingPolicies loggingPolicies;

    public ApiSpecificationLoggingPolicies getLoggingPolicies() {
        return loggingPolicies;
    }

    @com.fasterxml.jackson.annotation.JsonProperty("backend")
    private final ApiSpecificationRouteBackend backend;

    public ApiSpecificationRouteBackend getBackend() {
        return backend;
    }

    @Override
    public String toString() {
        return this.toString(true);
    }

    /**
     * Return a string representation of the object.
     *
     * @param includeByteArrayContents true to include the full contents of byte arrays
     * @return string representation
     */
    public String toString(boolean includeByteArrayContents) {
        java.lang.StringBuilder sb = new java.lang.StringBuilder();
        sb.append("ApiSpecificationRoute(");
        sb.append("super=").append(super.toString());
        sb.append("path=").append(String.valueOf(this.path));
        sb.append(", methods=").append(String.valueOf(this.methods));
        sb.append(", requestPolicies=").append(String.valueOf(this.requestPolicies));
        sb.append(", responsePolicies=").append(String.valueOf(this.responsePolicies));
        sb.append(", loggingPolicies=").append(String.valueOf(this.loggingPolicies));
        sb.append(", backend=").append(String.valueOf(this.backend));
        sb.append(")");
        return sb.toString();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof ApiSpecificationRoute)) {
            return false;
        }

        ApiSpecificationRoute other = (ApiSpecificationRoute) o;
        return java.util.Objects.equals(this.path, other.path)
                && java.util.Objects.equals(this.methods, other.methods)
                && java.util.Objects.equals(this.requestPolicies, other.requestPolicies)
                && java.util.Objects.equals(this.responsePolicies, other.responsePolicies)
                && java.util.Objects.equals(this.loggingPolicies, other.loggingPolicies)
                && java.util.Objects.equals(this.backend, other.backend)
                && super.equals(other);
    }

    @Override
    public int hashCode() {
        final int PRIME = 59;
        int result = 1;
        result = (result * PRIME) + (this.path == null ? 43 : this.path.hashCode());
        result = (result * PRIME) + (this.methods == null ? 43 : this.methods.hashCode());
        result =
                (result * PRIME)
                        + (this.requestPolicies == null ? 43 : this.requestPolicies.hashCode());
        result =
                (result * PRIME)
                        + (this.responsePolicies == null ? 43 : this.responsePolicies.hashCode());
        result =
                (result * PRIME)
                        + (this.loggingPolicies == null ? 43 : this.loggingPolicies.hashCode());
        result = (result * PRIME) + (this.backend == null ? 43 : this.backend.hashCode());
        result = (result * PRIME) + super.hashCode();
        return result;
    }
}