PhoneNumberReservation Class

  • java.lang.Object
    • com.azure.communication.administration.models.PhoneNumberReservation

public final class PhoneNumberReservation

The PhoneNumberReservation model.

Constructor Summary

Constructor Description
PhoneNumberReservation()

Method Summary

Modifier and Type Method and Description
String getAreaCode()

Get the areaCode property: The area code of the search.

OffsetDateTime getCreatedAt()

Get the createdAt property: The creation time of the search.

String getDescription()

Get the description property: The description of the search.

String getDisplayName()

Get the displayName property: The name of the search.

Integer getErrorCode()

Get the errorCode property: The error code of the search.

List<LocationOptionsDetails> getLocationOptions()

Get the locationOptions property: The location options of the search.

List<String> getPhoneNumbers()

Get the phoneNumbers property: The list of phone numbers in the search, in the case the status is reserved or success.

List<String> getPhonePlanIds()

Get the phonePlanIds property: The phone plan ids of the search.

Integer getQuantity()

Get the quantity property: The quantity of phone numbers in the search.

OffsetDateTime getReservationExpiryDate()

Get the reservationExpiryDate property: The date that search expires and the numbers become available.

String getReservationId()

Get the reservationId property: The id of the search.

SearchStatus getStatus()

Get the status property: The status of the search.

PhoneNumberReservation setAreaCode(String areaCode)

Set the areaCode property: The area code of the search.

PhoneNumberReservation setCreatedAt(OffsetDateTime createdAt)

Set the createdAt property: The creation time of the search.

PhoneNumberReservation setDescription(String description)

Set the description property: The description of the search.

PhoneNumberReservation setDisplayName(String displayName)

Set the displayName property: The name of the search.

PhoneNumberReservation setErrorCode(Integer errorCode)

Set the errorCode property: The error code of the search.

PhoneNumberReservation setLocationOptions(List<LocationOptionsDetails> locationOptions)

Set the locationOptions property: The location options of the search.

PhoneNumberReservation setPhoneNumbers(List<String> phoneNumbers)

Set the phoneNumbers property: The list of phone numbers in the search, in the case the status is reserved or success.

PhoneNumberReservation setPhonePlanIds(List<String> phonePlanIds)

Set the phonePlanIds property: The phone plan ids of the search.

PhoneNumberReservation setQuantity(Integer quantity)

Set the quantity property: The quantity of phone numbers in the search.

PhoneNumberReservation setReservationExpiryDate(OffsetDateTime reservationExpiryDate)

Set the reservationExpiryDate property: The date that search expires and the numbers become available.

PhoneNumberReservation setReservationId(String reservationId)

Set the reservationId property: The id of the search.

PhoneNumberReservation setStatus(SearchStatus status)

Set the status property: The status of the search.

Methods inherited from java.lang.Object

Constructor Details

PhoneNumberReservation

public PhoneNumberReservation()

Method Details

getAreaCode

public String getAreaCode()

Get the areaCode property: The area code of the search.

Returns:

the areaCode value.

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: The creation time of the search.

Returns:

the createdAt value.

getDescription

public String getDescription()

Get the description property: The description of the search.

Returns:

the description value.

getDisplayName

public String getDisplayName()

Get the displayName property: The name of the search.

Returns:

the displayName value.

getErrorCode

public Integer getErrorCode()

Get the errorCode property: The error code of the search.

Returns:

the errorCode value.

getLocationOptions

public List<LocationOptionsDetails> getLocationOptions()

Get the locationOptions property: The location options of the search.

Returns:

the locationOptions value.

getPhoneNumbers

public List<String> getPhoneNumbers()

Get the phoneNumbers property: The list of phone numbers in the search, in the case the status is reserved or success.

Returns:

the phoneNumbers value.

getPhonePlanIds

public List<String> getPhonePlanIds()

Get the phonePlanIds property: The phone plan ids of the search.

Returns:

the phonePlanIds value.

getQuantity

public Integer getQuantity()

Get the quantity property: The quantity of phone numbers in the search.

Returns:

the quantity value.

getReservationExpiryDate

public OffsetDateTime getReservationExpiryDate()

Get the reservationExpiryDate property: The date that search expires and the numbers become available.

Returns:

the reservationExpiryDate value.

getReservationId

public String getReservationId()

Get the reservationId property: The id of the search.

Returns:

the reservationId value.

getStatus

public SearchStatus getStatus()

Get the status property: The status of the search.

Returns:

the status value.

setAreaCode

public PhoneNumberReservation setAreaCode(String areaCode)

Set the areaCode property: The area code of the search.

Parameters:

areaCode - the areaCode value to set.

Returns:

the PhoneNumberReservation object itself.

setCreatedAt

public PhoneNumberReservation setCreatedAt(OffsetDateTime createdAt)

Set the createdAt property: The creation time of the search.

Parameters:

createdAt - the createdAt value to set.

Returns:

the PhoneNumberReservation object itself.

setDescription

public PhoneNumberReservation setDescription(String description)

Set the description property: The description of the search.

Parameters:

description - the description value to set.

Returns:

the PhoneNumberReservation object itself.

setDisplayName

public PhoneNumberReservation setDisplayName(String displayName)

Set the displayName property: The name of the search.

Parameters:

displayName - the displayName value to set.

Returns:

the PhoneNumberReservation object itself.

setErrorCode

public PhoneNumberReservation setErrorCode(Integer errorCode)

Set the errorCode property: The error code of the search.

Parameters:

errorCode - the errorCode value to set.

Returns:

the PhoneNumberReservation object itself.

setLocationOptions

public PhoneNumberReservation setLocationOptions(List<LocationOptionsDetails> locationOptions)

Set the locationOptions property: The location options of the search.

Parameters:

locationOptions - the locationOptions value to set.

Returns:

the PhoneNumberReservation object itself.

setPhoneNumbers

public PhoneNumberReservation setPhoneNumbers(List<String> phoneNumbers)

Set the phoneNumbers property: The list of phone numbers in the search, in the case the status is reserved or success.

Parameters:

phoneNumbers - the phoneNumbers value to set.

Returns:

the PhoneNumberReservation object itself.

setPhonePlanIds

public PhoneNumberReservation setPhonePlanIds(List<String> phonePlanIds)

Set the phonePlanIds property: The phone plan ids of the search.

Parameters:

phonePlanIds - the phonePlanIds value to set.

Returns:

the PhoneNumberReservation object itself.

setQuantity

public PhoneNumberReservation setQuantity(Integer quantity)

Set the quantity property: The quantity of phone numbers in the search.

Parameters:

quantity - the quantity value to set.

Returns:

the PhoneNumberReservation object itself.

setReservationExpiryDate

public PhoneNumberReservation setReservationExpiryDate(OffsetDateTime reservationExpiryDate)

Set the reservationExpiryDate property: The date that search expires and the numbers become available.

Parameters:

reservationExpiryDate - the reservationExpiryDate value to set.

Returns:

the PhoneNumberReservation object itself.

setReservationId

public PhoneNumberReservation setReservationId(String reservationId)

Set the reservationId property: The id of the search.

Parameters:

reservationId - the reservationId value to set.

Returns:

the PhoneNumberReservation object itself.

setStatus

public PhoneNumberReservation setStatus(SearchStatus status)

Set the status property: The status of the search.

Parameters:

status - the status value to set.

Returns:

the PhoneNumberReservation object itself.

Applies to