Interface GetConfigurationRequest.Builder

All Superinterfaces:
AppConfigRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<GetConfigurationRequest.Builder,GetConfigurationRequest>, SdkBuilder<GetConfigurationRequest.Builder,GetConfigurationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetConfigurationRequest
public static interface GetConfigurationRequest.Builder extends AppConfigRequest.Builder, SdkPojo, CopyableBuilder<GetConfigurationRequest.Builder,GetConfigurationRequest>

  • Method Details

    • application

      GetConfigurationRequest.Builder application(String application)

      The application to get. Specify either the application name or the application ID.

      Parameters:
      application - The application to get. Specify either the application name or the application ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environment

      GetConfigurationRequest.Builder environment(String environment)

      The environment to get. Specify either the environment name or the environment ID.

      Parameters:
      environment - The environment to get. Specify either the environment name or the environment ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      GetConfigurationRequest.Builder configuration(String configuration)

      The configuration to get. Specify either the configuration name or the configuration ID.

      Parameters:
      configuration - The configuration to get. Specify either the configuration name or the configuration ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientId

      GetConfigurationRequest.Builder clientId(String clientId)

      The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

      Parameters:
      clientId - The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientConfigurationVersion

      GetConfigurationRequest.Builder clientConfigurationVersion(String clientConfigurationVersion)

      The configuration version returned in the most recent GetConfiguration response.

      AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

      To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using GetConfiguration, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration.

      For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.

      Parameters:
      clientConfigurationVersion - The configuration version returned in the most recent GetConfiguration response.

      AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

      To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using GetConfiguration, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration.

      For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.