Subscription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.greengrass.model.Subscription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Subscription
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about a subscription.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Subscription()

Constructors
Constructor and Description
`Subscription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Subscription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getId()` A descriptive or arbitrary ID for the subscription.
`String`	`getSource()` The source of the subscription.
`String`	`getSubject()` The MQTT topic used to route the message.
`String`	`getTarget()` Where the message is sent to.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setId(String id)` A descriptive or arbitrary ID for the subscription.
`void`	`setSource(String source)` The source of the subscription.
`void`	`setSubject(String subject)` The MQTT topic used to route the message.
`void`	`setTarget(String target)` Where the message is sent to.
`String`	`toString()` Returns a string representation of this object.
`Subscription`	`withId(String id)` A descriptive or arbitrary ID for the subscription.
`Subscription`	`withSource(String source)` The source of the subscription.
`Subscription`	`withSubject(String subject)` The MQTT topic used to route the message.
`Subscription`	`withTarget(String target)` Where the message is sent to.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Subscription
```
public Subscription()
```
- Method Detail
  - setId
```
public void setId(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:_-]+''.
    
    Parameters:
    
    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:_-]+''.
  - getId
```
public String getId()
```
    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:_-]+''.
  - withId
```
public Subscription withId(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:_-]+''.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSource
```
public void setSource(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'.
    
    Parameters:
    
    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'.
  - getSource
```
public String getSource()
```
    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'.
  - withSource
```
public Subscription withSource(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'.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubject
```
public void setSubject(String subject)
```
    The MQTT topic used to route the message.
    
    Parameters:
    
    subject - The MQTT topic used to route the message.
  - getSubject
```
public String getSubject()
```
    The MQTT topic used to route the message.
    
    Returns:
    
    The MQTT topic used to route the message.
  - withSubject
```
public Subscription withSubject(String subject)
```
    The MQTT topic used to route the message.
    
    Parameters:
    
    subject - The MQTT topic used to route the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTarget
```
public void setTarget(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'.
    
    Parameters:
    
    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'.
  - getTarget
```
public String getTarget()
```
    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'.
  - withTarget
```
public Subscription withTarget(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'.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Subscription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Subscription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Subscription

Method Detail

setId

getId

withId

setSource

getSource

withSource

setSubject

getSubject

withSubject

setTarget

getTarget

withTarget

toString

equals

hashCode

clone

marshall