com.amazonaws.services.s3control.AWSS3ControlAsyncClientBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-s3control Show documentation
The AWS Java SDK for AWS S3 Control module holds the client classes that are used for communicating with AWS S3 Control Service
There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2019-2024 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 com.amazonaws.services.s3control;

import javax.annotation.Generated;

import com.amazonaws.ClientConfigurationFactory;
import com.amazonaws.annotation.NotThreadSafe;
import com.amazonaws.client.builder.AwsAsyncClientBuilder;
import com.amazonaws.client.AwsAsyncClientParams;

/**
 * Fluent builder for {@link com.amazonaws.services.s3control.AWSS3ControlAsync}. Use of the builder is preferred over
 * using constructors of the client class.
 **/
@NotThreadSafe
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public final class AWSS3ControlAsyncClientBuilder extends AwsAsyncClientBuilder {

    private static final ClientConfigurationFactory CLIENT_CONFIG_FACTORY = new ClientConfigurationFactory();;

    /**
     * @return Create new instance of builder with all defaults set.
     */
    public static AWSS3ControlAsyncClientBuilder standard() {
        return new AWSS3ControlAsyncClientBuilder();
    }

    /**
     * @return Default async client using the {@link com.amazonaws.auth.DefaultAWSCredentialsProviderChain} and
     *         {@link com.amazonaws.regions.DefaultAwsRegionProviderChain} chain
     */
    public static AWSS3ControlAsync defaultClient() {
        return standard().build();
    }

    private AWSS3ControlAsyncClientBuilder() {
        super(CLIENT_CONFIG_FACTORY);
    }

    /**
     * @returns The current setting for Dual-Stack endpoints (supports both IPv4 and IPv6) configured in the builder.
     * @see Using Amazon S3
     *      Dual-Stack Endpoints
     */
    public Boolean isDualstackEnabled() {
        return super.getAdvancedConfig(S3ControlClientOptions.DUALSTACK_ENABLED);
    }

    /**
     * Enables use of Dual-Stack endpoints (supports both IPv4 and IPv6) on clients built with this builder.
     * 
     * @see Using Amazon S3
     *      Dual-Stack Endpoints
     */
    public AWSS3ControlAsyncClientBuilder enableDualstack() {
        return withDualstackEnabled(true);
    }

    /**
     * Sets the status of Dual-Stack endpoints (supports both IPv4 and IPv6) for clients built with this builder. The
     * default is to not use Dual-Stack endpoints.
     *
     * @param dualstackEnabled
     *        True if Dual-Stack endpoints should be used, false if Dual-Stack endpoints should not be used.
     * @see Using Amazon S3
     *      Dual-Stack Endpoints
     */
    public void setDualstackEnabled(Boolean dualstackEnabled) {
        super.putAdvancedConfig(S3ControlClientOptions.DUALSTACK_ENABLED, dualstackEnabled);
    }

    /**
     * Sets the status of Dual-Stack endpoints (supports both IPv4 and IPv6) for clients built with this builder. The
     * default is to not use Dual-Stack endpoints.
     *
     * @param dualstackEnabled
     *        True if Dual-Stack endpoints should be used, false if Dual-Stack endpoints should not be used.
     * @returns This builder for method chaining.
     * @see Using Amazon S3
     *      Dual-Stack Endpoints
     */
    public AWSS3ControlAsyncClientBuilder withDualstackEnabled(Boolean dualstackEnabled) {
        setDualstackEnabled(dualstackEnabled);
        return this;
    }

    /**
     * @returns The current setting for FIPS enabled endpoints configured in the builder.
     * @see FIPS General Information
     */
    public Boolean isFipsEnabled() {
        return super.getAdvancedConfig(S3ControlClientOptions.FIPS_ENABLED);
    }

    /**
     * Enables use of FIPS endpoints on clients built with this builder.
     * 
     * @see FIPS General Information
     */
    public AWSS3ControlAsyncClientBuilder enableFips() {
        return withFipsEnabled(true);
    }

    /**
     * Sets the status of FIPS enabled endpoints for clients built with this builder. The default is to not use FIPS
     * endpoints.
     *
     * @param fipsEnabled
     *        True if FIPS endpoints should be used, false if FIPS endpoints should not be used.
     * @see FIPS General Information
     */
    public void setFipsEnabled(Boolean fipsEnabled) {
        super.putAdvancedConfig(S3ControlClientOptions.FIPS_ENABLED, fipsEnabled);
    }

    /**
     * Sets the status of FIPS enabled endpoints for clients built with this builder. The default is to not use FIPS
     * endpoints.
     *
     * @param fipsEnabled
     *        True if FIPS endpoints should be used, false if FIPS endpoints should not be used.
     * @returns This builder for method chaining.
     * @see FIPS General Information
     */
    public AWSS3ControlAsyncClientBuilder withFipsEnabled(Boolean fipsEnabled) {
        setFipsEnabled(fipsEnabled);
        return this;
    }

    /**
     * 
     * This setting will enable the client to make calls to a region specified in an ARN that represents an S3 resource
     * even if that region is different to the region the client was initialized with. This setting is disabled by
     * default.
     * 
     *
     * @return this Builder instance that can be used for method chaining
     */
    public AWSS3ControlAsyncClientBuilder enableUseArnRegion() {
        setUseArnRegionEnabled(true);
        return this;
    }

    /**
     * 
     * This setting will enable the client to make calls to a region specified in an ARN that represents an S3 resource
     * even if that region is different to the region the client was initialized with. This setting is disabled by
     * default.
     * 
     */
    public void setUseArnRegionEnabled(Boolean useArnRegionEnabled) {
        super.putAdvancedConfig(S3ControlClientOptions.USE_ARN_REGION_ENABLED, useArnRegionEnabled);
    }

    /**
     * 
     * This setting will enable the client to make calls to a region specified in an ARN that represents an S3 resource
     * even if that region is different to the region the client was initialized with. This setting is disabled by
     * default.
     * 
     *
     * @return this Builder instance that can be used for method chaining
     */
    public AWSS3ControlAsyncClientBuilder withUseArnRegionEnabled(Boolean useArnRegionEnabled) {
        setUseArnRegionEnabled(true);
        return this;
    }

    /**
     * Construct an asynchronous implementation of AWSS3ControlAsync using the current builder configuration.
     *
     * @param params
     *        Current builder configuration represented as a parameter object.
     * @return Fully configured implementation of AWSS3ControlAsync.
     */
    @Override
    protected AWSS3ControlAsync build(AwsAsyncClientParams params) {
        return new AWSS3ControlAsyncClient(params);
    }

}