com.amazonaws.services.elasticbeanstalk.model

## クラス DescribeEnvironmentsRequest

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

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

      public class DescribeEnvironmentsRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `DescribeEnvironments operation`.

  Returns descriptions for existing environments.

  関連項目:
    `AWSElasticBeanstalk.describeEnvironments(DescribeEnvironmentsRequest)`, 直列化された形式

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

    コンストラクタ
    コンストラクタと説明
    `DescribeEnvironmentsRequest()` Default constructor for a new DescribeEnvironmentsRequest object.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getApplicationName()` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
    `java.util.List<java.lang.String>` | `getEnvironmentIds()` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
    `java.util.List<java.lang.String>` | `getEnvironmentNames()` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
    `java.util.Date` | `getIncludedDeletedBackTo()` If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.
    `java.lang.Boolean` | `getIncludeDeleted()` Indicates whether to include deleted environments: `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.
    `java.lang.String` | `getVersionLabel()` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
    `int` | `hashCode()`
    `java.lang.Boolean` | `isIncludeDeleted()` Indicates whether to include deleted environments: `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.
    `void` | `setApplicationName(java.lang.String applicationName)` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
    `void` | `setEnvironmentIds(java.util.Collection<java.lang.String> environmentIds)` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
    `void` | `setEnvironmentNames(java.util.Collection<java.lang.String> environmentNames)` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
    `void` | `setIncludedDeletedBackTo(java.util.Date includedDeletedBackTo)` If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.
    `void` | `setIncludeDeleted(java.lang.Boolean includeDeleted)` Indicates whether to include deleted environments: `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.
    `void` | `setVersionLabel(java.lang.String versionLabel)` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `DescribeEnvironmentsRequest` | `withApplicationName(java.lang.String applicationName)` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
    `DescribeEnvironmentsRequest` | `withEnvironmentIds(java.util.Collection<java.lang.String> environmentIds)` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
    `DescribeEnvironmentsRequest` | `withEnvironmentIds(java.lang.String... environmentIds)` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
    `DescribeEnvironmentsRequest` | `withEnvironmentNames(java.util.Collection<java.lang.String> environmentNames)` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
    `DescribeEnvironmentsRequest` | `withEnvironmentNames(java.lang.String... environmentNames)` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
    `DescribeEnvironmentsRequest` | `withIncludedDeletedBackTo(java.util.Date includedDeletedBackTo)` If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.
    `DescribeEnvironmentsRequest` | `withIncludeDeleted(java.lang.Boolean includeDeleted)` Indicates whether to include deleted environments: `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.
    `DescribeEnvironmentsRequest` | `withVersionLabel(java.lang.String versionLabel)` If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### DescribeEnvironmentsRequest

          public DescribeEnvironmentsRequest()

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

  - ### メソッドの詳細

    - #### getApplicationName

          public java.lang.String getApplicationName()

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

      Constraints:
      Length: 1 - 100

      戻り値:
        If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

    - #### setApplicationName

          public void setApplicationName(java.lang.String applicationName)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

      Constraints:
      Length: 1 - 100

      パラメータ:
        `applicationName` - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

    - #### withApplicationName

          public DescribeEnvironmentsRequest withApplicationName(java.lang.String applicationName)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

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

      Constraints:
      Length: 1 - 100

      パラメータ:
        `applicationName` - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

    - #### getVersionLabel

          public java.lang.String getVersionLabel()

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

      Constraints:
      Length: 1 - 100

      戻り値:
        If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

    - #### setVersionLabel

          public void setVersionLabel(java.lang.String versionLabel)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

      Constraints:
      Length: 1 - 100

      パラメータ:
        `versionLabel` - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

    - #### withVersionLabel

          public DescribeEnvironmentsRequest withVersionLabel(java.lang.String versionLabel)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

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

      Constraints:
      Length: 1 - 100

      パラメータ:
        `versionLabel` - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

    - #### getEnvironmentIds

          public java.util.List<java.lang.String> getEnvironmentIds()

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
      戻り値:
        If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

    - #### setEnvironmentIds

          public void setEnvironmentIds(java.util.Collection<java.lang.String> environmentIds)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
      パラメータ:
        `environmentIds` - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

    - #### withEnvironmentIds

          public DescribeEnvironmentsRequest withEnvironmentIds(java.lang.String... environmentIds)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

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

      パラメータ:
        `environmentIds` - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

    - #### withEnvironmentIds

          public DescribeEnvironmentsRequest withEnvironmentIds(java.util.Collection<java.lang.String> environmentIds)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

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

      パラメータ:
        `environmentIds` - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

    - #### getEnvironmentNames

          public java.util.List<java.lang.String> getEnvironmentNames()

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
      戻り値:
        If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

    - #### setEnvironmentNames

          public void setEnvironmentNames(java.util.Collection<java.lang.String> environmentNames)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
      パラメータ:
        `environmentNames` - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

    - #### withEnvironmentNames

          public DescribeEnvironmentsRequest withEnvironmentNames(java.lang.String... environmentNames)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

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

      パラメータ:
        `environmentNames` - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

    - #### withEnvironmentNames

          public DescribeEnvironmentsRequest withEnvironmentNames(java.util.Collection<java.lang.String> environmentNames)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

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

      パラメータ:
        `environmentNames` - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

    - #### isIncludeDeleted

          public java.lang.Boolean isIncludeDeleted()

      Indicates whether to include deleted environments:

      `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.

      `false`: Do not include deleted environments.

      戻り値:
        Indicates whether to include deleted environments:

        `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.

        `false`: Do not include deleted environments.

    - #### setIncludeDeleted

          public void setIncludeDeleted(java.lang.Boolean includeDeleted)

      Indicates whether to include deleted environments:

      `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.

      `false`: Do not include deleted environments.

      パラメータ:
        `includeDeleted` - Indicates whether to include deleted environments:

        `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.

        `false`: Do not include deleted environments.

    - #### withIncludeDeleted

          public DescribeEnvironmentsRequest withIncludeDeleted(java.lang.Boolean includeDeleted)

      Indicates whether to include deleted environments:

      `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.

      `false`: Do not include deleted environments.

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

      パラメータ:
        `includeDeleted` - Indicates whether to include deleted environments:

        `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.

        `false`: Do not include deleted environments.

    - #### getIncludeDeleted

          public java.lang.Boolean getIncludeDeleted()

      Indicates whether to include deleted environments:

      `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.

      `false`: Do not include deleted environments.

      戻り値:
        Indicates whether to include deleted environments:

        `true`: Environments that have been deleted after `IncludedDeletedBackTo` are displayed.

        `false`: Do not include deleted environments.

    - #### getIncludedDeletedBackTo

          public java.util.Date getIncludedDeletedBackTo()

      If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.
      戻り値:
        If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.

    - #### setIncludedDeletedBackTo

          public void setIncludedDeletedBackTo(java.util.Date includedDeletedBackTo)

      If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.
      パラメータ:
        `includedDeletedBackTo` - If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.

    - #### withIncludedDeletedBackTo

          public DescribeEnvironmentsRequest withIncludedDeletedBackTo(java.util.Date includedDeletedBackTo)

      If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.

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

      パラメータ:
        `includedDeletedBackTo` - If specified when `IncludeDeleted` is set to `true`, then environments deleted after this date are displayed.

    - #### 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`