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

Class BatchGetSecretValueResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse

software.amazon.awssdk.services.secretsmanager.model.BatchGetSecretValueResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchGetSecretValueResponse.Builder,BatchGetSecretValueResponse>

@Generated("software.amazon.awssdk:codegen")
public final class BatchGetSecretValueResponse
extends SecretsManagerResponse
implements ToCopyableBuilder<BatchGetSecretValueResponse.Builder,BatchGetSecretValueResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchGetSecretValueResponse.Builder

Method Summary

Modifier and Type	Method	Description
static BatchGetSecretValueResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<APIErrorType>	errors()	A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasErrors()	For responses, this returns true if the service returned a value for the Errors property.
int	hashCode()
boolean	hasSecretValues()	For responses, this returns true if the service returned a value for the SecretValues property.
String	nextToken()	Secrets Manager includes this value if there's more output available than what is included in the current response.
List<SdkField<?>>	sdkFields()
List<SecretValueEntry>	secretValues()	A list of secret values.
static Class<? extends BatchGetSecretValueResponse.Builder>	serializableBuilderClass()
BatchGetSecretValueResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasSecretValues

public final boolean hasSecretValues()

For responses, this returns true if the service returned a value for the SecretValues 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.

secretValues

public final List<SecretValueEntry> secretValues()

A list of secret values.

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 hasSecretValues() method.

Returns:

A list of secret values.

nextToken

public final String nextToken()

Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call BatchGetSecretValue again with this value.

Returns:

Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call BatchGetSecretValue again with this value.

hasErrors

public final boolean hasErrors()

For responses, this returns true if the service returned a value for the Errors 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.

errors

public final List<APIErrorType> errors()

A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.

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 hasErrors() method.

Returns:

A list of errors Secrets Manager encountered while attempting to retrieve individual secrets.

toBuilder

public BatchGetSecretValueResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchGetSecretValueResponse.Builder,BatchGetSecretValueResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static BatchGetSecretValueResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo