com.amazonaws.services.elasticbeanstalk.model

## クラス DescribeConfigurationSettingsRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class DescribeConfigurationSettingsRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `DescribeConfigurationSettings operation`.

  Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

  When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

  Related Topics

  - DeleteEnvironmentConfiguration
  関連項目:
    `AWSElasticBeanstalk.describeConfigurationSettings(DescribeConfigurationSettingsRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `DescribeConfigurationSettingsRequest()` Default constructor for a new DescribeConfigurationSettingsRequest object.
    `DescribeConfigurationSettingsRequest(java.lang.String applicationName)` Constructs a new DescribeConfigurationSettingsRequest object.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getApplicationName()` The application for the environment or configuration template.
    `java.lang.String` | `getEnvironmentName()` The name of the environment to describe.
    `java.lang.String` | `getTemplateName()` The name of the configuration template to describe.
    `int` | `hashCode()`
    `void` | `setApplicationName(java.lang.String applicationName)` The application for the environment or configuration template.
    `void` | `setEnvironmentName(java.lang.String environmentName)` The name of the environment to describe.
    `void` | `setTemplateName(java.lang.String templateName)` The name of the configuration template to describe.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `DescribeConfigurationSettingsRequest` | `withApplicationName(java.lang.String applicationName)` The application for the environment or configuration template.
    `DescribeConfigurationSettingsRequest` | `withEnvironmentName(java.lang.String environmentName)` The name of the environment to describe.
    `DescribeConfigurationSettingsRequest` | `withTemplateName(java.lang.String templateName)` The name of the configuration template to describe.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### DescribeConfigurationSettingsRequest

          public DescribeConfigurationSettingsRequest()

      Default constructor for a new DescribeConfigurationSettingsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

    - #### DescribeConfigurationSettingsRequest

          public DescribeConfigurationSettingsRequest(java.lang.String applicationName)

      Constructs a new DescribeConfigurationSettingsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      パラメータ:
        `applicationName` - The application for the environment or configuration template.

  - ### メソッドの詳細

    - #### getApplicationName

          public java.lang.String getApplicationName()

      The application for the environment or configuration template.

      Constraints:
      Length: 1 - 100

      戻り値:
        The application for the environment or configuration template.

    - #### setApplicationName

          public void setApplicationName(java.lang.String applicationName)

      The application for the environment or configuration template.

      Constraints:
      Length: 1 - 100

      パラメータ:
        `applicationName` - The application for the environment or configuration template.

    - #### withApplicationName

          public DescribeConfigurationSettingsRequest withApplicationName(java.lang.String applicationName)

      The application for the environment or configuration template.

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

      Constraints:
      Length: 1 - 100

      パラメータ:
        `applicationName` - The application for the environment or configuration template.

    - #### getTemplateName

          public java.lang.String getTemplateName()

      The name of the configuration template to describe.

      Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns a `MissingRequiredParameter` error.

      Constraints:
      Length: 1 - 100

      戻り値:
        The name of the configuration template to describe.

        Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns a `MissingRequiredParameter` error.

    - #### setTemplateName

          public void setTemplateName(java.lang.String templateName)

      The name of the configuration template to describe.

      Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns a `MissingRequiredParameter` error.

      Constraints:
      Length: 1 - 100

      パラメータ:
        `templateName` - The name of the configuration template to describe.

        Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns a `MissingRequiredParameter` error.

    - #### withTemplateName

          public DescribeConfigurationSettingsRequest withTemplateName(java.lang.String templateName)

      The name of the configuration template to describe.

      Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns a `MissingRequiredParameter` error.

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

      Constraints:
      Length: 1 - 100

      パラメータ:
        `templateName` - The name of the configuration template to describe.

        Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns a `MissingRequiredParameter` error.

    - #### getEnvironmentName

          public java.lang.String getEnvironmentName()

      The name of the environment to describe.

      Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.

      Constraints:
      Length: 4 - 23

      戻り値:
        The name of the environment to describe.

        Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.

    - #### setEnvironmentName

          public void setEnvironmentName(java.lang.String environmentName)

      The name of the environment to describe.

      Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.

      Constraints:
      Length: 4 - 23

      パラメータ:
        `environmentName` - The name of the environment to describe.

        Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.

    - #### withEnvironmentName

          public DescribeConfigurationSettingsRequest withEnvironmentName(java.lang.String environmentName)

      The name of the environment to describe.

      Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.

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

      Constraints:
      Length: 4 - 23

      パラメータ:
        `environmentName` - The name of the environment to describe.

        Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an `InvalidParameterCombination` error. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`