Class Channel
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Channel.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<EventPublisher> List of publishers for different type of events that may be detected in an application from the profile.List of publishers for different type of events that may be detected in an application from the profile.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the EventPublishers property.final int
hashCode()
final String
id()
Unique identifier for eachChannel
in the notification configuration of a Profiling Group.static Class
<? extends Channel.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
uri()
Unique arn of the resource to be used for notifications.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Channel.Builder,
Channel> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-