software.amazon.awssdk.services.quicksight.model

Class SnapshotJobResult

java.lang.Object

software.amazon.awssdk.services.quicksight.model.SnapshotJobResult

All Implemented Interfaces:

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

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

An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SnapshotJobResult.Builder

Method Summary

Modifier and Type	Method and Description
List<AnonymousUserSnapshotJobResult>	anonymousUsers() A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations.
static SnapshotJobResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAnonymousUsers() For responses, this returns true if the service returned a value for the AnonymousUsers property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SnapshotJobResult.Builder>	serializableBuilderClass()
SnapshotJobResult.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

hasAnonymousUsers

public final boolean hasAnonymousUsers()

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

anonymousUsers

public final List<AnonymousUserSnapshotJobResult> anonymousUsers()

A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.

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

Returns:

A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.

toBuilder

public SnapshotJobResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SnapshotJobResult.Builder,SnapshotJobResult>

builder

public static SnapshotJobResult.Builder builder()

serializableBuilderClass

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