Package software.amazon.awssdk.services.greengrass.model

Class Subscription

java.lang.Object

software.amazon.awssdk.services.greengrass.model.Subscription

All Implemented Interfaces:

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

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

Information about a subscription.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Subscription.Builder

Method Summary

Modifier and Type	Method	Description
static Subscription.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	A descriptive or arbitrary ID for the subscription.
List<SdkField<?>>	sdkFields()
static Class<? extends Subscription.Builder>	serializableBuilderClass()
String	source()	The source of the subscription.
String	subject()	The MQTT topic used to route the message.
String	target()	Where the message is sent to.
Subscription.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

id

public final String id()

A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.

Returns:

A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.

source

public final String source()

The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.

Returns:

The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.

subject

public final String subject()

The MQTT topic used to route the message.

Returns:

The MQTT topic used to route the message.

target

public final String target()

Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.

Returns:

Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.

toBuilder

public Subscription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Subscription.Builder,Subscription>

builder

public static Subscription.Builder builder()

serializableBuilderClass

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