DescribeReservationResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.medialive.model.DescribeReservationResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeReservationResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Placeholder documentation for DescribeReservationResponse

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeReservationResult()

Constructors
Constructor and Description
`DescribeReservationResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeReservationResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`DescribeReservationResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`DescribeReservationResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` Unique reservation ARN, e.g.
`Integer`	`getCount()` Number of reserved resources
`String`	`getCurrencyCode()` Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g.
`Integer`	`getDuration()` Lease duration, e.g.
`String`	`getDurationUnits()` Units for duration, e.g.
`String`	`getEnd()` Reservation UTC end date and time in ISO-8601 format, e.g.
`Double`	`getFixedPrice()` One-time charge for each reserved resource, e.g.
`String`	`getName()` User specified reservation name
`String`	`getOfferingDescription()` Offering description, e.g.
`String`	`getOfferingId()` Unique offering ID, e.g.
`String`	`getOfferingType()` Offering type, e.g.
`String`	`getRegion()` AWS region, e.g.
`RenewalSettings`	`getRenewalSettings()` Renewal settings for the reservation
`String`	`getReservationId()` Unique reservation ID, e.g.
`ReservationResourceSpecification`	`getResourceSpecification()` Resource configuration details
`String`	`getStart()` Reservation UTC start date and time in ISO-8601 format, e.g.
`String`	`getState()` Current state of reservation, e.g.
`Map<String,String>`	`getTags()` A collection of key-value pairs
`Double`	`getUsagePrice()` Recurring usage charge for each reserved resource, e.g.
`int`	`hashCode()`
`void`	`setArn(String arn)` Unique reservation ARN, e.g.
`void`	`setCount(Integer count)` Number of reserved resources
`void`	`setCurrencyCode(String currencyCode)` Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g.
`void`	`setDuration(Integer duration)` Lease duration, e.g.
`void`	`setDurationUnits(String durationUnits)` Units for duration, e.g.
`void`	`setEnd(String end)` Reservation UTC end date and time in ISO-8601 format, e.g.
`void`	`setFixedPrice(Double fixedPrice)` One-time charge for each reserved resource, e.g.
`void`	`setName(String name)` User specified reservation name
`void`	`setOfferingDescription(String offeringDescription)` Offering description, e.g.
`void`	`setOfferingId(String offeringId)` Unique offering ID, e.g.
`void`	`setOfferingType(String offeringType)` Offering type, e.g.
`void`	`setRegion(String region)` AWS region, e.g.
`void`	`setRenewalSettings(RenewalSettings renewalSettings)` Renewal settings for the reservation
`void`	`setReservationId(String reservationId)` Unique reservation ID, e.g.
`void`	`setResourceSpecification(ReservationResourceSpecification resourceSpecification)` Resource configuration details
`void`	`setStart(String start)` Reservation UTC start date and time in ISO-8601 format, e.g.
`void`	`setState(String state)` Current state of reservation, e.g.
`void`	`setTags(Map<String,String> tags)` A collection of key-value pairs
`void`	`setUsagePrice(Double usagePrice)` Recurring usage charge for each reserved resource, e.g.
`String`	`toString()` Returns a string representation of this object.
`DescribeReservationResult`	`withArn(String arn)` Unique reservation ARN, e.g.
`DescribeReservationResult`	`withCount(Integer count)` Number of reserved resources
`DescribeReservationResult`	`withCurrencyCode(String currencyCode)` Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g.
`DescribeReservationResult`	`withDuration(Integer duration)` Lease duration, e.g.
`DescribeReservationResult`	`withDurationUnits(OfferingDurationUnits durationUnits)` Units for duration, e.g.
`DescribeReservationResult`	`withDurationUnits(String durationUnits)` Units for duration, e.g.
`DescribeReservationResult`	`withEnd(String end)` Reservation UTC end date and time in ISO-8601 format, e.g.
`DescribeReservationResult`	`withFixedPrice(Double fixedPrice)` One-time charge for each reserved resource, e.g.
`DescribeReservationResult`	`withName(String name)` User specified reservation name
`DescribeReservationResult`	`withOfferingDescription(String offeringDescription)` Offering description, e.g.
`DescribeReservationResult`	`withOfferingId(String offeringId)` Unique offering ID, e.g.
`DescribeReservationResult`	`withOfferingType(OfferingType offeringType)` Offering type, e.g.
`DescribeReservationResult`	`withOfferingType(String offeringType)` Offering type, e.g.
`DescribeReservationResult`	`withRegion(String region)` AWS region, e.g.
`DescribeReservationResult`	`withRenewalSettings(RenewalSettings renewalSettings)` Renewal settings for the reservation
`DescribeReservationResult`	`withReservationId(String reservationId)` Unique reservation ID, e.g.
`DescribeReservationResult`	`withResourceSpecification(ReservationResourceSpecification resourceSpecification)` Resource configuration details
`DescribeReservationResult`	`withStart(String start)` Reservation UTC start date and time in ISO-8601 format, e.g.
`DescribeReservationResult`	`withState(ReservationState state)` Current state of reservation, e.g.
`DescribeReservationResult`	`withState(String state)` Current state of reservation, e.g.
`DescribeReservationResult`	`withTags(Map<String,String> tags)` A collection of key-value pairs
`DescribeReservationResult`	`withUsagePrice(Double usagePrice)` Recurring usage charge for each reserved resource, e.g.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeReservationResult
```
public DescribeReservationResult()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
    
    Parameters:
    
    arn - Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
  - getArn
```
public String getArn()
```
    Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
    
    Returns:
    
    Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
  - withArn
```
public DescribeReservationResult withArn(String arn)
```
    Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
    
    Parameters:
    
    arn - Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCount
```
public void setCount(Integer count)
```
    Number of reserved resources
    
    Parameters:
    
    count - Number of reserved resources
  - getCount
```
public Integer getCount()
```
    Number of reserved resources
    
    Returns:
    
    Number of reserved resources
  - withCount
```
public DescribeReservationResult withCount(Integer count)
```
    Number of reserved resources
    
    Parameters:
    
    count - Number of reserved resources
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrencyCode
```
public void setCurrencyCode(String currencyCode)
```
    Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
    
    Parameters:
    
    currencyCode - Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
  - getCurrencyCode
```
public String getCurrencyCode()
```
    Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
    
    Returns:
    
    Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
  - withCurrencyCode
```
public DescribeReservationResult withCurrencyCode(String currencyCode)
```
    Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
    
    Parameters:
    
    currencyCode - Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDuration
```
public void setDuration(Integer duration)
```
    Lease duration, e.g. '12'
    
    Parameters:
    
    duration - Lease duration, e.g. '12'
  - getDuration
```
public Integer getDuration()
```
    Lease duration, e.g. '12'
    
    Returns:
    
    Lease duration, e.g. '12'
  - withDuration
```
public DescribeReservationResult withDuration(Integer duration)
```
    Lease duration, e.g. '12'
    
    Parameters:
    
    duration - Lease duration, e.g. '12'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDurationUnits
```
public void setDurationUnits(String durationUnits)
```
    Units for duration, e.g. 'MONTHS'
    
    Parameters:
    
    durationUnits - Units for duration, e.g. 'MONTHS'
    
    See Also:
    
    OfferingDurationUnits
  - getDurationUnits
```
public String getDurationUnits()
```
    Units for duration, e.g. 'MONTHS'
    
    Returns:
    
    Units for duration, e.g. 'MONTHS'
    
    See Also:
    
    OfferingDurationUnits
  - withDurationUnits
```
public DescribeReservationResult withDurationUnits(String durationUnits)
```
    Units for duration, e.g. 'MONTHS'
    
    Parameters:
    
    durationUnits - Units for duration, e.g. 'MONTHS'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OfferingDurationUnits
  - withDurationUnits
```
public DescribeReservationResult withDurationUnits(OfferingDurationUnits durationUnits)
```
    Units for duration, e.g. 'MONTHS'
    
    Parameters:
    
    durationUnits - Units for duration, e.g. 'MONTHS'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OfferingDurationUnits
  - setEnd
```
public void setEnd(String end)
```
    Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
    
    Parameters:
    
    end - Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
  - getEnd
```
public String getEnd()
```
    Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
    
    Returns:
    
    Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
  - withEnd
```
public DescribeReservationResult withEnd(String end)
```
    Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
    
    Parameters:
    
    end - Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFixedPrice
```
public void setFixedPrice(Double fixedPrice)
```
    One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
    
    Parameters:
    
    fixedPrice - One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
  - getFixedPrice
```
public Double getFixedPrice()
```
    One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
    
    Returns:
    
    One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
  - withFixedPrice
```
public DescribeReservationResult withFixedPrice(Double fixedPrice)
```
    One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
    
    Parameters:
    
    fixedPrice - One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    User specified reservation name
    
    Parameters:
    
    name - User specified reservation name
  - getName
```
public String getName()
```
    User specified reservation name
    
    Returns:
    
    User specified reservation name
  - withName
```
public DescribeReservationResult withName(String name)
```
    User specified reservation name
    
    Parameters:
    
    name - User specified reservation name
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOfferingDescription
```
public void setOfferingDescription(String offeringDescription)
```
    Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
    
    Parameters:
    
    offeringDescription - Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
  - getOfferingDescription
```
public String getOfferingDescription()
```
    Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
    
    Returns:
    
    Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
  - withOfferingDescription
```
public DescribeReservationResult withOfferingDescription(String offeringDescription)
```
    Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
    
    Parameters:
    
    offeringDescription - Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOfferingId
```
public void setOfferingId(String offeringId)
```
    Unique offering ID, e.g. '87654321'
    
    Parameters:
    
    offeringId - Unique offering ID, e.g. '87654321'
  - getOfferingId
```
public String getOfferingId()
```
    Unique offering ID, e.g. '87654321'
    
    Returns:
    
    Unique offering ID, e.g. '87654321'
  - withOfferingId
```
public DescribeReservationResult withOfferingId(String offeringId)
```
    Unique offering ID, e.g. '87654321'
    
    Parameters:
    
    offeringId - Unique offering ID, e.g. '87654321'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOfferingType
```
public void setOfferingType(String offeringType)
```
    Offering type, e.g. 'NO_UPFRONT'
    
    Parameters:
    
    offeringType - Offering type, e.g. 'NO_UPFRONT'
    
    See Also:
    
    OfferingType
  - getOfferingType
```
public String getOfferingType()
```
    Offering type, e.g. 'NO_UPFRONT'
    
    Returns:
    
    Offering type, e.g. 'NO_UPFRONT'
    
    See Also:
    
    OfferingType
  - withOfferingType
```
public DescribeReservationResult withOfferingType(String offeringType)
```
    Offering type, e.g. 'NO_UPFRONT'
    
    Parameters:
    
    offeringType - Offering type, e.g. 'NO_UPFRONT'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OfferingType
  - withOfferingType
```
public DescribeReservationResult withOfferingType(OfferingType offeringType)
```
    Offering type, e.g. 'NO_UPFRONT'
    
    Parameters:
    
    offeringType - Offering type, e.g. 'NO_UPFRONT'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OfferingType
  - setRegion
```
public void setRegion(String region)
```
    AWS region, e.g. 'us-west-2'
    
    Parameters:
    
    region - AWS region, e.g. 'us-west-2'
  - getRegion
```
public String getRegion()
```
    AWS region, e.g. 'us-west-2'
    
    Returns:
    
    AWS region, e.g. 'us-west-2'
  - withRegion
```
public DescribeReservationResult withRegion(String region)
```
    AWS region, e.g. 'us-west-2'
    
    Parameters:
    
    region - AWS region, e.g. 'us-west-2'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRenewalSettings
```
public void setRenewalSettings(RenewalSettings renewalSettings)
```
    Renewal settings for the reservation
    
    Parameters:
    
    renewalSettings - Renewal settings for the reservation
  - getRenewalSettings
```
public RenewalSettings getRenewalSettings()
```
    Renewal settings for the reservation
    
    Returns:
    
    Renewal settings for the reservation
  - withRenewalSettings
```
public DescribeReservationResult withRenewalSettings(RenewalSettings renewalSettings)
```
    Renewal settings for the reservation
    
    Parameters:
    
    renewalSettings - Renewal settings for the reservation
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReservationId
```
public void setReservationId(String reservationId)
```
    Unique reservation ID, e.g. '1234567'
    
    Parameters:
    
    reservationId - Unique reservation ID, e.g. '1234567'
  - getReservationId
```
public String getReservationId()
```
    Unique reservation ID, e.g. '1234567'
    
    Returns:
    
    Unique reservation ID, e.g. '1234567'
  - withReservationId
```
public DescribeReservationResult withReservationId(String reservationId)
```
    Unique reservation ID, e.g. '1234567'
    
    Parameters:
    
    reservationId - Unique reservation ID, e.g. '1234567'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceSpecification
```
public void setResourceSpecification(ReservationResourceSpecification resourceSpecification)
```
    Resource configuration details
    
    Parameters:
    
    resourceSpecification - Resource configuration details
  - getResourceSpecification
```
public ReservationResourceSpecification getResourceSpecification()
```
    Resource configuration details
    
    Returns:
    
    Resource configuration details
  - withResourceSpecification
```
public DescribeReservationResult withResourceSpecification(ReservationResourceSpecification resourceSpecification)
```
    Resource configuration details
    
    Parameters:
    
    resourceSpecification - Resource configuration details
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStart
```
public void setStart(String start)
```
    Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
    
    Parameters:
    
    start - Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
  - getStart
```
public String getStart()
```
    Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
    
    Returns:
    
    Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
  - withStart
```
public DescribeReservationResult withStart(String start)
```
    Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
    
    Parameters:
    
    start - Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    Current state of reservation, e.g. 'ACTIVE'
    
    Parameters:
    
    state - Current state of reservation, e.g. 'ACTIVE'
    
    See Also:
    
    ReservationState
  - getState
```
public String getState()
```
    Current state of reservation, e.g. 'ACTIVE'
    
    Returns:
    
    Current state of reservation, e.g. 'ACTIVE'
    
    See Also:
    
    ReservationState
  - withState
```
public DescribeReservationResult withState(String state)
```
    Current state of reservation, e.g. 'ACTIVE'
    
    Parameters:
    
    state - Current state of reservation, e.g. 'ACTIVE'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReservationState
  - withState
```
public DescribeReservationResult withState(ReservationState state)
```
    Current state of reservation, e.g. 'ACTIVE'
    
    Parameters:
    
    state - Current state of reservation, e.g. 'ACTIVE'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReservationState
  - getTags
```
public Map<String,String> getTags()
```
    A collection of key-value pairs
    
    Returns:
    
    A collection of key-value pairs
  - setTags
```
public void setTags(Map<String,String> tags)
```
    A collection of key-value pairs
    
    Parameters:
    
    tags - A collection of key-value pairs
  - withTags
```
public DescribeReservationResult withTags(Map<String,String> tags)
```
    A collection of key-value pairs
    
    Parameters:
    
    tags - A collection of key-value pairs
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public DescribeReservationResult addTagsEntry(String key,
                                              String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public DescribeReservationResult clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsagePrice
```
public void setUsagePrice(Double usagePrice)
```
    Recurring usage charge for each reserved resource, e.g. '157.0'
    
    Parameters:
    
    usagePrice - Recurring usage charge for each reserved resource, e.g. '157.0'
  - getUsagePrice
```
public Double getUsagePrice()
```
    Recurring usage charge for each reserved resource, e.g. '157.0'
    
    Returns:
    
    Recurring usage charge for each reserved resource, e.g. '157.0'
  - withUsagePrice
```
public DescribeReservationResult withUsagePrice(Double usagePrice)
```
    Recurring usage charge for each reserved resource, e.g. '157.0'
    
    Parameters:
    
    usagePrice - Recurring usage charge for each reserved resource, e.g. '157.0'
    
    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 DescribeReservationResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.793

Class DescribeReservationResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeReservationResult

Method Detail

setArn

getArn

withArn

setCount

getCount

withCount

setCurrencyCode

getCurrencyCode

withCurrencyCode

setDuration

getDuration

withDuration

setDurationUnits

getDurationUnits

withDurationUnits

withDurationUnits

setEnd

getEnd

withEnd

setFixedPrice

getFixedPrice

withFixedPrice

setName

getName

withName

setOfferingDescription

getOfferingDescription

withOfferingDescription

setOfferingId

getOfferingId

withOfferingId

setOfferingType

getOfferingType

withOfferingType

withOfferingType

setRegion

getRegion

withRegion

setRenewalSettings

getRenewalSettings

withRenewalSettings

setReservationId

getReservationId

withReservationId

setResourceSpecification

getResourceSpecification

withResourceSpecification

setStart

getStart

withStart

setState

getState

withState

withState

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setUsagePrice

getUsagePrice

withUsagePrice

toString

equals

hashCode

clone