Interface BatchGetSecretValueRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<BatchGetSecretValueRequest.Builder,BatchGetSecretValueRequest>, SdkBuilder<BatchGetSecretValueRequest.Builder,BatchGetSecretValueRequest>, SdkPojo, SdkRequest.Builder, SecretsManagerRequest.Builder
Enclosing class:
BatchGetSecretValueRequest
@Mutable @NotThreadSafe public static interface BatchGetSecretValueRequest.Builder extends SecretsManagerRequest.Builder, SdkPojo, CopyableBuilder<BatchGetSecretValueRequest.Builder,BatchGetSecretValueRequest>

  • Method Details

    • secretIdList

      BatchGetSecretValueRequest.Builder secretIdList(Collection<String> secretIdList)

      The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

      Parameters:
      secretIdList - The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretIdList

      BatchGetSecretValueRequest.Builder secretIdList(String... secretIdList)

      The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

      Parameters:
      secretIdList - The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      BatchGetSecretValueRequest.Builder filters(Collection<Filter> filters)

      The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

      Parameters:
      filters - The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      BatchGetSecretValueRequest.Builder filters(Filter... filters)

      The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

      Parameters:
      filters - The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      BatchGetSecretValueRequest.Builder filters(Consumer<Filter.Builder>... filters)

      The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

      This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      BatchGetSecretValueRequest.Builder maxResults(Integer maxResults)

      The number of results to include in the response.

      If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

      Parameters:
      maxResults - The number of results to include in the response.

      If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

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

    • nextToken

      BatchGetSecretValueRequest.Builder nextToken(String nextToken)

      A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call BatchGetSecretValue again with this value.

      Parameters:
      nextToken - A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call BatchGetSecretValue again with this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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