java.lang.Object
- software.amazon.awssdk.services.appsync.model.ChannelNamespace

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ChannelNamespace.Builder,ChannelNamespace>
```
@Generated("software.amazon.awssdk:codegen")
public final class ChannelNamespace
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ChannelNamespace.Builder,ChannelNamespace>
```
Describes a channel namespace associated with an Api. The ChannelNamespace contains the definitions for code handlers for the Api.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ChannelNamespace.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`apiId()`	The `Api` ID.
`static ChannelNamespace.Builder`	`builder()`
`String`	`channelNamespaceArn()`	The Amazon Resource Name (ARN) for the `ChannelNamespace`.
`String`	`codeHandlers()`	The event handler functions that run custom business logic to process published events and subscribe requests.
`Instant`	`created()`	The date and time that the `ChannelNamespace` was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPublishAuthModes()`	For responses, this returns true if the service returned a value for the PublishAuthModes property.
`boolean`	`hasSubscribeAuthModes()`	For responses, this returns true if the service returned a value for the SubscribeAuthModes property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`Instant`	`lastModified()`	The date and time that the `ChannelNamespace` was last changed.
`String`	`name()`	The name of the channel namespace.
`List<AuthMode>`	`publishAuthModes()`	The authorization mode to use for publishing messages on the channel namespace.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ChannelNamespace.Builder>`	`serializableBuilderClass()`
`List<AuthMode>`	`subscribeAuthModes()`	The authorization mode to use for subscribing to messages on the channel namespace.
`Map<String,String>`	`tags()`	Returns the value of the Tags property for this object.
`ChannelNamespace.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
  - apiId
```
public final String apiId()
```
    The Api ID.
    
    Returns:
    
    The Api ID.
  - name
```
public final String name()
```
    The name of the channel namespace. This name must be unique within the Api.
    
    Returns:
    
    The name of the channel namespace. This name must be unique within the Api.
  - hasSubscribeAuthModes
```
public final boolean hasSubscribeAuthModes()
```
    For responses, this returns true if the service returned a value for the SubscribeAuthModes 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.
  - subscribeAuthModes
```
public final List<AuthMode> subscribeAuthModes()
```
    The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.
    
    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 hasSubscribeAuthModes() method.
    
    Returns:
    
    The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.
  - hasPublishAuthModes
```
public final boolean hasPublishAuthModes()
```
    For responses, this returns true if the service returned a value for the PublishAuthModes 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.
  - publishAuthModes
```
public final List<AuthMode> publishAuthModes()
```
    The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.
    
    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 hasPublishAuthModes() method.
    
    Returns:
    
    The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.
  - codeHandlers
```
public final String codeHandlers()
```
    The event handler functions that run custom business logic to process published events and subscribe requests.
    
    Returns:
    
    The event handler functions that run custom business logic to process published events and subscribe requests.
  - 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()
```
    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.
  - channelNamespaceArn
```
public final String channelNamespaceArn()
```
    The Amazon Resource Name (ARN) for the ChannelNamespace.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the ChannelNamespace.
  - created
```
public final Instant created()
```
    The date and time that the ChannelNamespace was created.
    
    Returns:
    
    The date and time that the ChannelNamespace was created.
  - lastModified
```
public final Instant lastModified()
```
    The date and time that the ChannelNamespace was last changed.
    
    Returns:
    
    The date and time that the ChannelNamespace was last changed.
  - toBuilder
```
public ChannelNamespace.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ChannelNamespace.Builder,ChannelNamespace>
  - builder
```
public static ChannelNamespace.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ChannelNamespace.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

Class ChannelNamespace

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

apiId

name

hasSubscribeAuthModes

subscribeAuthModes

hasPublishAuthModes

publishAuthModes

codeHandlers

hasTags

tags

channelNamespaceArn

created

lastModified

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField