Subscription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.shield.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 the Shield Advanced subscription for an account.

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`	`getAutoRenew()` If `ENABLED`, the subscription will be automatically renewed at the end of the existing subscription period.
`Date`	`getEndTime()` The date and time your subscription will end.
`List<Limit>`	`getLimits()` Specifies how many protections of a given type you can create.
`String`	`getProactiveEngagementStatus()` If `ENABLED`, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
`Date`	`getStartTime()` The start time of the subscription, in Unix time in seconds.
`String`	`getSubscriptionArn()` The ARN (Amazon Resource Name) of the subscription.
`SubscriptionLimits`	`getSubscriptionLimits()` Limits settings for your subscription.
`Long`	`getTimeCommitmentInSeconds()` The length, in seconds, of the Shield Advanced subscription for the account.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAutoRenew(String autoRenew)` If `ENABLED`, the subscription will be automatically renewed at the end of the existing subscription period.
`void`	`setEndTime(Date endTime)` The date and time your subscription will end.
`void`	`setLimits(Collection<Limit> limits)` Specifies how many protections of a given type you can create.
`void`	`setProactiveEngagementStatus(String proactiveEngagementStatus)` If `ENABLED`, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
`void`	`setStartTime(Date startTime)` The start time of the subscription, in Unix time in seconds.
`void`	`setSubscriptionArn(String subscriptionArn)` The ARN (Amazon Resource Name) of the subscription.
`void`	`setSubscriptionLimits(SubscriptionLimits subscriptionLimits)` Limits settings for your subscription.
`void`	`setTimeCommitmentInSeconds(Long timeCommitmentInSeconds)` The length, in seconds, of the Shield Advanced subscription for the account.
`String`	`toString()` Returns a string representation of this object.
`Subscription`	`withAutoRenew(AutoRenew autoRenew)` If `ENABLED`, the subscription will be automatically renewed at the end of the existing subscription period.
`Subscription`	`withAutoRenew(String autoRenew)` If `ENABLED`, the subscription will be automatically renewed at the end of the existing subscription period.
`Subscription`	`withEndTime(Date endTime)` The date and time your subscription will end.
`Subscription`	`withLimits(Collection<Limit> limits)` Specifies how many protections of a given type you can create.
`Subscription`	`withLimits(Limit... limits)` Specifies how many protections of a given type you can create.
`Subscription`	`withProactiveEngagementStatus(ProactiveEngagementStatus proactiveEngagementStatus)` If `ENABLED`, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
`Subscription`	`withProactiveEngagementStatus(String proactiveEngagementStatus)` If `ENABLED`, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
`Subscription`	`withStartTime(Date startTime)` The start time of the subscription, in Unix time in seconds.
`Subscription`	`withSubscriptionArn(String subscriptionArn)` The ARN (Amazon Resource Name) of the subscription.
`Subscription`	`withSubscriptionLimits(SubscriptionLimits subscriptionLimits)` Limits settings for your subscription.
`Subscription`	`withTimeCommitmentInSeconds(Long timeCommitmentInSeconds)` The length, in seconds, of the Shield Advanced subscription for the account.

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

- Constructor Detail
  - Subscription
```
public Subscription()
```
- Method Detail
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The start time of the subscription, in Unix time in seconds.
    
    Parameters:
    
    startTime - The start time of the subscription, in Unix time in seconds.
  - getStartTime
```
public Date getStartTime()
```
    The start time of the subscription, in Unix time in seconds.
    
    Returns:
    
    The start time of the subscription, in Unix time in seconds.
  - withStartTime
```
public Subscription withStartTime(Date startTime)
```
    The start time of the subscription, in Unix time in seconds.
    
    Parameters:
    
    startTime - The start time of the subscription, in Unix time in seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The date and time your subscription will end.
    
    Parameters:
    
    endTime - The date and time your subscription will end.
  - getEndTime
```
public Date getEndTime()
```
    The date and time your subscription will end.
    
    Returns:
    
    The date and time your subscription will end.
  - withEndTime
```
public Subscription withEndTime(Date endTime)
```
    The date and time your subscription will end.
    
    Parameters:
    
    endTime - The date and time your subscription will end.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeCommitmentInSeconds
```
public void setTimeCommitmentInSeconds(Long timeCommitmentInSeconds)
```
    The length, in seconds, of the Shield Advanced subscription for the account.
    
    Parameters:
    
    timeCommitmentInSeconds - The length, in seconds, of the Shield Advanced subscription for the account.
  - getTimeCommitmentInSeconds
```
public Long getTimeCommitmentInSeconds()
```
    The length, in seconds, of the Shield Advanced subscription for the account.
    
    Returns:
    
    The length, in seconds, of the Shield Advanced subscription for the account.
  - withTimeCommitmentInSeconds
```
public Subscription withTimeCommitmentInSeconds(Long timeCommitmentInSeconds)
```
    The length, in seconds, of the Shield Advanced subscription for the account.
    
    Parameters:
    
    timeCommitmentInSeconds - The length, in seconds, of the Shield Advanced subscription for the account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutoRenew
```
public void setAutoRenew(String autoRenew)
```
    If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
    
    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
    
    Parameters:
    
    autoRenew - If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
    
    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
    
    See Also:
    
    AutoRenew
  - getAutoRenew
```
public String getAutoRenew()
```
    If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
    
    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
    
    Returns:
    
    If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
    
    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
    
    See Also:
    
    AutoRenew
  - withAutoRenew
```
public Subscription withAutoRenew(String autoRenew)
```
    If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
    
    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
    
    Parameters:
    
    autoRenew - If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
    
    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoRenew
  - withAutoRenew
```
public Subscription withAutoRenew(AutoRenew autoRenew)
```
    If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
    
    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
    
    Parameters:
    
    autoRenew - If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
    
    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoRenew
  - getLimits
```
public List<Limit> getLimits()
```
    Specifies how many protections of a given type you can create.
    
    Returns:
    
    Specifies how many protections of a given type you can create.
  - setLimits
```
public void setLimits(Collection<Limit> limits)
```
    Specifies how many protections of a given type you can create.
    
    Parameters:
    
    limits - Specifies how many protections of a given type you can create.
  - withLimits
```
public Subscription withLimits(Limit... limits)
```
    Specifies how many protections of a given type you can create.
    
    NOTE: This method appends the values to the existing list (if any). Use setLimits(java.util.Collection) or withLimits(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    limits - Specifies how many protections of a given type you can create.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLimits
```
public Subscription withLimits(Collection<Limit> limits)
```
    Specifies how many protections of a given type you can create.
    
    Parameters:
    
    limits - Specifies how many protections of a given type you can create.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProactiveEngagementStatus
```
public void setProactiveEngagementStatus(String proactiveEngagementStatus)
```
    If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
    
    If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
    
    If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    
    Parameters:
    
    proactiveEngagementStatus - If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
    
    If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
    
    If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    
    See Also:
    
    ProactiveEngagementStatus
  - getProactiveEngagementStatus
```
public String getProactiveEngagementStatus()
```
    If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
    
    If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
    
    If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    
    Returns:
    
    If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
    
    If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
    
    If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    
    See Also:
    
    ProactiveEngagementStatus
  - withProactiveEngagementStatus
```
public Subscription withProactiveEngagementStatus(String proactiveEngagementStatus)
```
    If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
    
    If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
    
    If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    
    Parameters:
    
    proactiveEngagementStatus - If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
    
    If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
    
    If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProactiveEngagementStatus
  - withProactiveEngagementStatus
```
public Subscription withProactiveEngagementStatus(ProactiveEngagementStatus proactiveEngagementStatus)
```
    If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
    
    If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
    
    If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    
    Parameters:
    
    proactiveEngagementStatus - If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
    
    If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
    
    If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProactiveEngagementStatus
  - setSubscriptionLimits
```
public void setSubscriptionLimits(SubscriptionLimits subscriptionLimits)
```
    Limits settings for your subscription.
    
    Parameters:
    
    subscriptionLimits - Limits settings for your subscription.
  - getSubscriptionLimits
```
public SubscriptionLimits getSubscriptionLimits()
```
    Limits settings for your subscription.
    
    Returns:
    
    Limits settings for your subscription.
  - withSubscriptionLimits
```
public Subscription withSubscriptionLimits(SubscriptionLimits subscriptionLimits)
```
    Limits settings for your subscription.
    
    Parameters:
    
    subscriptionLimits - Limits settings for your subscription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubscriptionArn
```
public void setSubscriptionArn(String subscriptionArn)
```
    The ARN (Amazon Resource Name) of the subscription.
    
    Parameters:
    
    subscriptionArn - The ARN (Amazon Resource Name) of the subscription.
  - getSubscriptionArn
```
public String getSubscriptionArn()
```
    The ARN (Amazon Resource Name) of the subscription.
    
    Returns:
    
    The ARN (Amazon Resource Name) of the subscription.
  - withSubscriptionArn
```
public Subscription withSubscriptionArn(String subscriptionArn)
```
    The ARN (Amazon Resource Name) of the subscription.
    
    Parameters:
    
    subscriptionArn - The ARN (Amazon Resource Name) of the subscription.
    
    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.571

Class Subscription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Subscription

Method Detail

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setTimeCommitmentInSeconds

getTimeCommitmentInSeconds

withTimeCommitmentInSeconds

setAutoRenew

getAutoRenew

withAutoRenew

withAutoRenew

getLimits

setLimits

withLimits

withLimits

setProactiveEngagementStatus

getProactiveEngagementStatus

withProactiveEngagementStatus

withProactiveEngagementStatus

setSubscriptionLimits

getSubscriptionLimits

withSubscriptionLimits

setSubscriptionArn

getSubscriptionArn

withSubscriptionArn

toString

equals

hashCode

clone

marshall