Interface DescribeEnvironmentsRequest.Builder

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

  • Method Details

    • applicationName

      DescribeEnvironmentsRequest.Builder applicationName(String applicationName)

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

      Parameters:
      applicationName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionLabel

      DescribeEnvironmentsRequest.Builder versionLabel(String versionLabel)

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

      Parameters:
      versionLabel - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentIds

      DescribeEnvironmentsRequest.Builder environmentIds(Collection<String> environmentIds)

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

      Parameters:
      environmentIds - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentIds

      DescribeEnvironmentsRequest.Builder environmentIds(String... environmentIds)

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

      Parameters:
      environmentIds - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentNames

      DescribeEnvironmentsRequest.Builder environmentNames(Collection<String> environmentNames)

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

      Parameters:
      environmentNames - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentNames

      DescribeEnvironmentsRequest.Builder environmentNames(String... environmentNames)

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

      Parameters:
      environmentNames - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeDeleted

      DescribeEnvironmentsRequest.Builder includeDeleted(Boolean includeDeleted)

      Indicates whether to include deleted environments:

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

      false: Do not include deleted environments.

      Parameters:
      includeDeleted - Indicates whether to include deleted environments:

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

      false: Do not include deleted environments.

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

    • includedDeletedBackTo

      DescribeEnvironmentsRequest.Builder includedDeletedBackTo(Instant includedDeletedBackTo)

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

      Parameters:
      includedDeletedBackTo - If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxRecords

      DescribeEnvironmentsRequest.Builder maxRecords(Integer maxRecords)

      For a paginated request. Specify a maximum number of environments to include in each response.

      If no MaxRecords is specified, all available environments are retrieved in a single response.

      Parameters:
      maxRecords - For a paginated request. Specify a maximum number of environments to include in each response.

      If no MaxRecords is specified, all available environments are retrieved in a single response.

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

    • nextToken

      DescribeEnvironmentsRequest.Builder nextToken(String nextToken)

      For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

      If no NextToken is specified, the first page is retrieved.

      Parameters:
      nextToken - For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

      If no NextToken is specified, the first page is retrieved.

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

    • overrideConfiguration

      DescribeEnvironmentsRequest.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

      DescribeEnvironmentsRequest.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.