Package software.amazon.awssdk.services.cloudtrail.model

Class GetChannelResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cloudtrail.model.CloudTrailResponse

software.amazon.awssdk.services.cloudtrail.model.GetChannelResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetChannelResponse.Builder,GetChannelResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetChannelResponse
extends CloudTrailResponse
implements ToCopyableBuilder<GetChannelResponse.Builder,GetChannelResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetChannelResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetChannelResponse.Builder	builder()
String	channelArn()	The ARN of an channel returned by a GetChannel request.
List<Destination>	destinations()	The destinations for the channel.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDestinations()	For responses, this returns true if the service returned a value for the Destinations property.
int	hashCode()
IngestionStatus	ingestionStatus()	A table showing information about the most recent successful and failed attempts to ingest events.
String	name()	The name of the CloudTrail channel.
List<SdkField<?>>	sdkFields()
static Class<? extends GetChannelResponse.Builder>	serializableBuilderClass()
String	source()	The source for the CloudTrail channel.
SourceConfig	sourceConfig()	Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all Regions or a single Region.
GetChannelResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cloudtrail.model.CloudTrailResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

channelArn

public final String channelArn()

The ARN of an channel returned by a GetChannel request.

Returns:

The ARN of an channel returned by a GetChannel request.

name

public final String name()

The name of the CloudTrail channel. For service-linked channels, the name is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix generated by the Amazon Web Services service.

Returns:

The name of the CloudTrail channel. For service-linked channels, the name is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix generated by the Amazon Web Services service.

source

public final String source()

The source for the CloudTrail channel.

Returns:

The source for the CloudTrail channel.

sourceConfig

public final SourceConfig sourceConfig()

Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all Regions or a single Region.

Returns:

Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all Regions or a single Region.

hasDestinations

public final boolean hasDestinations()

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

destinations

public final List<Destination> destinations()

The destinations for the channel. For channels created for integrations, the destinations are the event data stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.

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

Returns:

The destinations for the channel. For channels created for integrations, the destinations are the event data stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.

ingestionStatus

public final IngestionStatus ingestionStatus()

A table showing information about the most recent successful and failed attempts to ingest events.

Returns:

A table showing information about the most recent successful and failed attempts to ingest events.

toBuilder

public GetChannelResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetChannelResponse.Builder,GetChannelResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetChannelResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetChannelResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo