software.amazon.awssdk.services.customerprofiles.model

Class EventStreamSummary

java.lang.Object

software.amazon.awssdk.services.customerprofiles.model.EventStreamSummary

All Implemented Interfaces:

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

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

An instance of EventStream in a list of EventStreams.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventStreamSummary.Builder

Method Summary

Modifier and Type	Method and Description
static EventStreamSummary.Builder	builder()
DestinationSummary	destinationSummary() Summary information about the Kinesis data stream.
String	domainName() The unique name of the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventStreamArn() A unique identifier for the event stream.
String	eventStreamName() The name of the event stream.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends EventStreamSummary.Builder>	serializableBuilderClass()
EventStreamState	state() The operational state of destination stream for export.
String	stateAsString() The operational state of destination stream for export.
Instant	stoppedSince() The timestamp when the State changed to STOPPED.
Map<String,String>	tags() The tags used to organize, track, or control access for this resource.
EventStreamSummary.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

domainName

public final String domainName()

The unique name of the domain.

Returns:

The unique name of the domain.

eventStreamName

public final String eventStreamName()

The name of the event stream.

Returns:

The name of the event stream.

eventStreamArn

public final String eventStreamArn()

A unique identifier for the event stream.

Returns:

A unique identifier for the event stream.

state

public final EventStreamState state()

The operational state of destination stream for export.

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

Returns:

The operational state of destination stream for export.

See Also:

EventStreamState

stateAsString

public final String stateAsString()

The operational state of destination stream for export.

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

Returns:

The operational state of destination stream for export.

See Also:

EventStreamState

stoppedSince

public final Instant stoppedSince()

The timestamp when the State changed to STOPPED.

Returns:

The timestamp when the State changed to STOPPED.

destinationSummary

public final DestinationSummary destinationSummary()

Summary information about the Kinesis data stream.

Returns:

Summary information about the Kinesis data stream.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

The tags used to organize, track, or control access for this resource.

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

Returns:

The tags used to organize, track, or control access for this resource.

toBuilder

public EventStreamSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EventStreamSummary.Builder,EventStreamSummary>

builder

public static EventStreamSummary.Builder builder()

serializableBuilderClass

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