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

Class ProtectedQuerySummary

java.lang.Object

software.amazon.awssdk.services.cleanrooms.model.ProtectedQuerySummary

All Implemented Interfaces:

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

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

The protected query summary for the objects listed by the request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProtectedQuerySummary.Builder

Method Summary

Modifier and Type	Method	Description
static ProtectedQuerySummary.Builder	builder()
Instant	createTime()	The time the protected query was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReceiverConfigurations()	For responses, this returns true if the service returned a value for the ReceiverConfigurations property.
String	id()	The unique ID of the protected query.
String	membershipArn()	The unique ARN for the membership that initiated the protected query.
String	membershipId()	The unique ID for the membership that initiated the protected query.
List<ReceiverConfiguration>	receiverConfigurations()	The receiver configuration.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ProtectedQuerySummary.Builder>	serializableBuilderClass()
ProtectedQueryStatus	status()	The status of the protected query.
String	statusAsString()	The status of the protected query.
ProtectedQuerySummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

id

public final String id()

The unique ID of the protected query.

Returns:

The unique ID of the protected query.

membershipId

public final String membershipId()

The unique ID for the membership that initiated the protected query.

Returns:

The unique ID for the membership that initiated the protected query.

membershipArn

public final String membershipArn()

The unique ARN for the membership that initiated the protected query.

Returns:

The unique ARN for the membership that initiated the protected query.

createTime

public final Instant createTime()

The time the protected query was created.

Returns:

The time the protected query was created.

status

public final ProtectedQueryStatus status()

The status of the protected query.

If the service returns an enum value that is not available in the current SDK version, status will return ProtectedQueryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the protected query.

See Also:

ProtectedQueryStatus

statusAsString

public final String statusAsString()

The status of the protected query.

If the service returns an enum value that is not available in the current SDK version, status will return ProtectedQueryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the protected query.

See Also:

ProtectedQueryStatus

hasReceiverConfigurations

public final boolean hasReceiverConfigurations()

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

receiverConfigurations

public final List<ReceiverConfiguration> receiverConfigurations()

The receiver configuration.

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

Returns:

The receiver configuration.

toBuilder

public ProtectedQuerySummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProtectedQuerySummary.Builder,ProtectedQuerySummary>

builder

public static ProtectedQuerySummary.Builder builder()

serializableBuilderClass

public static Class<? extends ProtectedQuerySummary.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)

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