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

Class CreateChannelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudtrail.model.CloudTrailRequest

software.amazon.awssdk.services.cloudtrail.model.CreateChannelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateChannelRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateChannelRequest.Builder	builder()
List<Destination>	destinations()	One or more event data stores to which events arriving through a channel will be logged.
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()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	The name of the channel.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateChannelRequest.Builder>	serializableBuilderClass()
String	source()	The name of the partner or external event source.
List<Tag>	tags()	Returns the value of the Tags property for this object.
CreateChannelRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

The name of the channel.

Returns:

The name of the channel.

source

public final String source()

The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source.

A source can be either Custom for all valid non-Amazon Web Services events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.

Returns:

The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source.

A source can be either Custom for all valid non-Amazon Web Services events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.

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()

One or more event data stores to which events arriving through a channel will be logged.

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:

One or more event data stores to which events arriving through a channel will be logged.

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 List<Tag> tags()

Returns the value of the Tags property for this object.

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 value of the Tags property for this object.

toBuilder

public CreateChannelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Specified by:

toBuilder in class CloudTrailRequest

builder

public static CreateChannelRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo