Package software.amazon.awssdk.services.codeguruprofiler.model

Class Channel

java.lang.Object

software.amazon.awssdk.services.codeguruprofiler.model.Channel

All Implemented Interfaces:

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

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

Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Channel.Builder

Method Summary

Modifier and Type	Method	Description
static Channel.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<EventPublisher>	eventPublishers()	List of publishers for different type of events that may be detected in an application from the profile.
List<String>	eventPublishersAsStrings()	List of publishers for different type of events that may be detected in an application from the profile.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventPublishers()	For responses, this returns true if the service returned a value for the EventPublishers property.
int	hashCode()
String	id()	Unique identifier for each Channel in the notification configuration of a Profiling Group.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Channel.Builder>	serializableBuilderClass()
Channel.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	uri()	Unique arn of the resource to be used for notifications.

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

eventPublishers

public final List<EventPublisher> eventPublishers()

List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.

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

Returns:

List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.

hasEventPublishers

public final boolean hasEventPublishers()

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

eventPublishersAsStrings

public final List<String> eventPublishersAsStrings()

List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.

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

Returns:

List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.

id

public final String id()

Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.

Returns:

Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.

uri

public final String uri()

Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.

Returns:

Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.

toBuilder

public Channel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Channel.Builder,Channel>

builder

public static Channel.Builder builder()

serializableBuilderClass

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