Package software.amazon.awssdk.services.secretsmanager.model

Class BatchGetSecretValueRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest
software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<BatchGetSecretValueRequest.Builder,BatchGetSecretValueRequest>
@Generated("software.amazon.awssdk:codegen") public final class BatchGetSecretValueRequest extends SecretsManagerRequest implements ToCopyableBuilder<BatchGetSecretValueRequest.Builder,BatchGetSecretValueRequest>

  • Method Details

    • hasSecretIdList

      public final boolean hasSecretIdList()
      For responses, this returns true if the service returned a value for the SecretIdList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • secretIdList

      public final List<String> secretIdList()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecretIdList() method.

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

    • hasFilters

      public final boolean hasFilters()
      For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • filters

      public final List<Filter> filters()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

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

    • maxResults

      public final 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.

      Returns:
      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.

    • nextToken

      public final 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.

      Returns:
      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.

    • toBuilder

      public BatchGetSecretValueRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<BatchGetSecretValueRequest.Builder,BatchGetSecretValueRequest>
      Specified by:
      toBuilder in class SecretsManagerRequest

    • builder

      public static BatchGetSecretValueRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BatchGetSecretValueRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo