Package software.amazon.awssdk.services.cleanrooms.model

Class ProtectedQueryOutput

java.lang.Object

software.amazon.awssdk.services.cleanrooms.model.ProtectedQueryOutput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProtectedQueryOutput.Builder,ProtectedQueryOutput>

@Generated("software.amazon.awssdk:codegen")
public final class ProtectedQueryOutput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ProtectedQueryOutput.Builder,ProtectedQueryOutput>

Contains details about the protected query output.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProtectedQueryOutput.Builder
static class	ProtectedQueryOutput.Type

Method Summary

Modifier and Type	Method	Description
static ProtectedQueryOutput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static ProtectedQueryOutput	fromMemberList(List<ProtectedQuerySingleMemberOutput> memberList)	Create an instance of this class with memberList() initialized to the given value.
static ProtectedQueryOutput	fromS3(Consumer<ProtectedQueryS3Output.Builder> s3)	Create an instance of this class with s3() initialized to the given value.
static ProtectedQueryOutput	fromS3(ProtectedQueryS3Output s3)	Create an instance of this class with s3() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMemberList()	For responses, this returns true if the service returned a value for the MemberList property.
List<ProtectedQuerySingleMemberOutput>	memberList()	The list of member Amazon Web Services account(s) that received the results of the query.
ProtectedQueryS3Output	s3()	If present, the output for a protected query with an `S3` output type.
List<SdkField<?>>	sdkFields()
static Class<? extends ProtectedQueryOutput.Builder>	serializableBuilderClass()
ProtectedQueryOutput.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ProtectedQueryOutput.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

s3

public final ProtectedQueryS3Output s3()

If present, the output for a protected query with an `S3` output type.

Returns:

If present, the output for a protected query with an `S3` output type.

hasMemberList

public final boolean hasMemberList()

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

memberList

public final List<ProtectedQuerySingleMemberOutput> memberList()

The list of member Amazon Web Services account(s) that received the results of the query.

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

Returns:

The list of member Amazon Web Services account(s) that received the results of the query.

toBuilder

public ProtectedQueryOutput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProtectedQueryOutput.Builder,ProtectedQueryOutput>

builder

public static ProtectedQueryOutput.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

fromS3

public static ProtectedQueryOutput fromS3(ProtectedQueryS3Output s3)

Create an instance of this class with s3() initialized to the given value.

If present, the output for a protected query with an `S3` output type.

Parameters:

s3 - If present, the output for a protected query with an `S3` output type.

fromS3

public static ProtectedQueryOutput fromS3(Consumer<ProtectedQueryS3Output.Builder> s3)

Create an instance of this class with s3() initialized to the given value.

If present, the output for a protected query with an `S3` output type.

Parameters:

s3 - If present, the output for a protected query with an `S3` output type.

fromMemberList

public static ProtectedQueryOutput fromMemberList(List<ProtectedQuerySingleMemberOutput> memberList)

Create an instance of this class with memberList() initialized to the given value.

The list of member Amazon Web Services account(s) that received the results of the query.

Parameters:

memberList - The list of member Amazon Web Services account(s) that received the results of the query.

type

public ProtectedQueryOutput.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ProtectedQueryOutput.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ProtectedQueryOutput.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

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

Specified by:

sdkFields in interface SdkPojo