• Home
• software.amazon.awssdk
• apigateway
• 2.16.29
• source code
• CreateUsagePlanKeyRequest.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.

software.amazon.awssdk.services.apigateway.model.CreateUsagePlanKeyRequest Maven / Gradle / Ivy

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

package software.amazon.awssdk.services.apigateway.model;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 

 * The POST request to create a usage plan key for adding an existing API key to a usage plan.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class CreateUsagePlanKeyRequest extends ApiGatewayRequest implements
        ToCopyableBuilder {
    private static final SdkField USAGE_PLAN_ID_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("usagePlanId").getter(getter(CreateUsagePlanKeyRequest::usagePlanId))
            .setter(setter(Builder::usagePlanId))
            .traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("usageplanId").build()).build();

    private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("keyId")
            .getter(getter(CreateUsagePlanKeyRequest::keyId)).setter(setter(Builder::keyId))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("keyId").build()).build();

    private static final SdkField KEY_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("keyType").getter(getter(CreateUsagePlanKeyRequest::keyType)).setter(setter(Builder::keyType))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("keyType").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(USAGE_PLAN_ID_FIELD,
            KEY_ID_FIELD, KEY_TYPE_FIELD));

    private final String usagePlanId;

    private final String keyId;

    private final String keyType;

    private CreateUsagePlanKeyRequest(BuilderImpl builder) {
        super(builder);
        this.usagePlanId = builder.usagePlanId;
        this.keyId = builder.keyId;
        this.keyType = builder.keyType;
    }

    /**
     * 

     * [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created
     * UsagePlanKey resource representing a plan customer.
     * 
     * 
     * @return [Required] The Id of the UsagePlan resource representing the usage plan containing the
     *         to-be-created UsagePlanKey resource representing a plan customer.
     */
    public final String usagePlanId() {
        return usagePlanId;
    }

    /**
     * 

     * [Required] The identifier of a UsagePlanKey resource for a plan customer.
     * 
     * 
     * @return [Required] The identifier of a UsagePlanKey resource for a plan customer.
     */
    public final String keyId() {
        return keyId;
    }

    /**
     * 

     * [Required] The type of a UsagePlanKey resource for a plan customer.
     * 
     * 
     * @return [Required] The type of a UsagePlanKey resource for a plan customer.
     */
    public final String keyType() {
        return keyType;
    }

    @Override
    public Builder toBuilder() {
        return new BuilderImpl(this);
    }

    public static Builder builder() {
        return new BuilderImpl();
    }

    public static Class serializableBuilderClass() {
        return BuilderImpl.class;
    }

    @Override
    public final int hashCode() {
        int hashCode = 1;
        hashCode = 31 * hashCode + super.hashCode();
        hashCode = 31 * hashCode + Objects.hashCode(usagePlanId());
        hashCode = 31 * hashCode + Objects.hashCode(keyId());
        hashCode = 31 * hashCode + Objects.hashCode(keyType());
        return hashCode;
    }

    @Override
    public final boolean equals(Object obj) {
        return super.equals(obj) && equalsBySdkFields(obj);
    }

    @Override
    public final boolean equalsBySdkFields(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof CreateUsagePlanKeyRequest)) {
            return false;
        }
        CreateUsagePlanKeyRequest other = (CreateUsagePlanKeyRequest) obj;
        return Objects.equals(usagePlanId(), other.usagePlanId()) && Objects.equals(keyId(), other.keyId())
                && Objects.equals(keyType(), other.keyType());
    }

    /**
     * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
     * redacted from this string using a placeholder value.
     */
    @Override
    public final String toString() {
        return ToString.builder("CreateUsagePlanKeyRequest").add("UsagePlanId", usagePlanId()).add("KeyId", keyId())
                .add("KeyType", keyType()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "usagePlanId":
            return Optional.ofNullable(clazz.cast(usagePlanId()));
        case "keyId":
            return Optional.ofNullable(clazz.cast(keyId()));
        case "keyType":
            return Optional.ofNullable(clazz.cast(keyType()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((CreateUsagePlanKeyRequest) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder {
        /**
         * 

         * [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created
         * UsagePlanKey resource representing a plan customer.
         * 
         * 
         * @param usagePlanId
         *        [Required] The Id of the UsagePlan resource representing the usage plan containing the
         *        to-be-created UsagePlanKey resource representing a plan customer.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder usagePlanId(String usagePlanId);

        /**
         * 

         * [Required] The identifier of a UsagePlanKey resource for a plan customer.
         * 
         * 
         * @param keyId
         *        [Required] The identifier of a UsagePlanKey resource for a plan customer.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder keyId(String keyId);

        /**
         * 

         * [Required] The type of a UsagePlanKey resource for a plan customer.
         * 
         * 
         * @param keyType
         *        [Required] The type of a UsagePlanKey resource for a plan customer.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder keyType(String keyType);

        @Override
        Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);

        @Override
        Builder overrideConfiguration(Consumer builderConsumer);
    }

    static final class BuilderImpl extends ApiGatewayRequest.BuilderImpl implements Builder {
        private String usagePlanId;

        private String keyId;

        private String keyType;

        private BuilderImpl() {
        }

        private BuilderImpl(CreateUsagePlanKeyRequest model) {
            super(model);
            usagePlanId(model.usagePlanId);
            keyId(model.keyId);
            keyType(model.keyType);
        }

        public final String getUsagePlanId() {
            return usagePlanId;
        }

        @Override
        public final Builder usagePlanId(String usagePlanId) {
            this.usagePlanId = usagePlanId;
            return this;
        }

        public final void setUsagePlanId(String usagePlanId) {
            this.usagePlanId = usagePlanId;
        }

        public final String getKeyId() {
            return keyId;
        }

        @Override
        public final Builder keyId(String keyId) {
            this.keyId = keyId;
            return this;
        }

        public final void setKeyId(String keyId) {
            this.keyId = keyId;
        }

        public final String getKeyType() {
            return keyType;
        }

        @Override
        public final Builder keyType(String keyType) {
            this.keyType = keyType;
            return this;
        }

        public final void setKeyType(String keyType) {
            this.keyType = keyType;
        }

        @Override
        public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
            super.overrideConfiguration(overrideConfiguration);
            return this;
        }

        @Override
        public Builder overrideConfiguration(Consumer builderConsumer) {
            super.overrideConfiguration(builderConsumer);
            return this;
        }

        @Override
        public CreateUsagePlanKeyRequest build() {
            return new CreateUsagePlanKeyRequest(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}