ReservationsClient Interface

public interface ReservationsClient

An instance of this class provides access to all the operations defined in ReservationsClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<ReservationInner>,ReservationInner> beginUpdateByBillingAccount(String billingAccountName, String reservationOrderId, String reservationId, PatchModel body)

Update reservation by billing account.

abstract SyncPoller<PollResult<ReservationInner>,ReservationInner> beginUpdateByBillingAccount(String billingAccountName, String reservationOrderId, String reservationId, PatchModel body, Context context)

Update reservation by billing account.

abstract ReservationInner getByReservationOrder(String billingAccountName, String reservationOrderId, String reservationId)

Get Reservation details in the billing account.

abstract Response<ReservationInner> getByReservationOrderWithResponse(String billingAccountName, String reservationOrderId, String reservationId, String expand, Context context)

Get Reservation details in the billing account.

abstract PagedIterable<ReservationInner> listByBillingAccount(String billingAccountName)

Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.

abstract PagedIterable<ReservationInner> listByBillingAccount(String billingAccountName, String filter, String orderBy, Float skiptoken, String refreshSummary, String selectedState, Float take, Context context)

Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.

abstract PagedIterable<ReservationInner> listByBillingProfile(String billingAccountName, String billingProfileName)

Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.

abstract PagedIterable<ReservationInner> listByBillingProfile(String billingAccountName, String billingProfileName, String filter, String orderBy, Float skiptoken, String refreshSummary, String selectedState, Float take, Context context)

Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.

abstract PagedIterable<ReservationInner> listByReservationOrder(String billingAccountName, String reservationOrderId)

Get Reservations in a given reservation Order in the billing account List Reservations within a single ReservationOrder in the billing account.

abstract PagedIterable<ReservationInner> listByReservationOrder(String billingAccountName, String reservationOrderId, Context context)

Get Reservations in a given reservation Order in the billing account List Reservations within a single ReservationOrder in the billing account.

abstract ReservationInner updateByBillingAccount(String billingAccountName, String reservationOrderId, String reservationId, PatchModel body)

Update reservation by billing account.

abstract ReservationInner updateByBillingAccount(String billingAccountName, String reservationOrderId, String reservationId, PatchModel body, Context context)

Update reservation by billing account.

Method Details

beginUpdateByBillingAccount

public abstract SyncPoller<PollResult<ReservationInner>,ReservationInner> beginUpdateByBillingAccount(String billingAccountName, String reservationOrderId, String reservationId, PatchModel body)

Update reservation by billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
reservationOrderId - Order Id of the reservation.
reservationId - Id of the reservation item.
body - Request body for patching a reservation.

Returns:

the SyncPoller<T,U> for polling of the definition of the reservation.

beginUpdateByBillingAccount

public abstract SyncPoller<PollResult<ReservationInner>,ReservationInner> beginUpdateByBillingAccount(String billingAccountName, String reservationOrderId, String reservationId, PatchModel body, Context context)

Update reservation by billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
reservationOrderId - Order Id of the reservation.
reservationId - Id of the reservation item.
body - Request body for patching a reservation.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the definition of the reservation.

getByReservationOrder

public abstract ReservationInner getByReservationOrder(String billingAccountName, String reservationOrderId, String reservationId)

Get Reservation details in the billing account. Get specific Reservation details in the billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
reservationOrderId - Order Id of the reservation.
reservationId - Id of the reservation item.

Returns:

specific Reservation details in the billing account.

getByReservationOrderWithResponse

public abstract Response<ReservationInner> getByReservationOrderWithResponse(String billingAccountName, String reservationOrderId, String reservationId, String expand, Context context)

Get Reservation details in the billing account. Get specific Reservation details in the billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
reservationOrderId - Order Id of the reservation.
reservationId - Id of the reservation item.
expand - May be used to expand the detail information of some properties.
context - The context to associate with this operation.

Returns:

specific Reservation details in the billing account along with Response<T>.

listByBillingAccount

public abstract PagedIterable<ReservationInner> listByBillingAccount(String billingAccountName)

Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

Returns:

the list of reservations and summary of roll out count of reservations in each state as paginated response with PagedIterable<T>.

listByBillingAccount

public abstract PagedIterable<ReservationInner> listByBillingAccount(String billingAccountName, String filter, String orderBy, Float skiptoken, String refreshSummary, String selectedState, Float take, Context context)

Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
orderBy - The orderby query option allows clients to request resources in a particular order.
skiptoken - The number of reservations to skip from the list before returning results.
refreshSummary - To indicate whether to refresh the roll up counts of the reservations group by provisioning states.
selectedState - The selected provisioning state.
take - The number of reservations to return in API response.
context - The context to associate with this operation.

Returns:

the list of reservations and summary of roll out count of reservations in each state as paginated response with PagedIterable<T>.

listByBillingProfile

public abstract PagedIterable<ReservationInner> listByBillingProfile(String billingAccountName, String billingProfileName)

Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.

Returns:

the list of reservations and summary of roll out count of reservations in each state as paginated response with PagedIterable<T>.

listByBillingProfile

public abstract PagedIterable<ReservationInner> listByBillingProfile(String billingAccountName, String billingProfileName, String filter, String orderBy, Float skiptoken, String refreshSummary, String selectedState, Float take, Context context)

Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
filter - The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
orderBy - The orderby query option allows clients to request resources in a particular order.
skiptoken - The number of reservations to skip from the list before returning results.
refreshSummary - To indicate whether to refresh the roll up counts of the reservations group by provisioning states.
selectedState - The selected provisioning state.
take - The number of reservations to return in API response.
context - The context to associate with this operation.

Returns:

the list of reservations and summary of roll out count of reservations in each state as paginated response with PagedIterable<T>.

listByReservationOrder

public abstract PagedIterable<ReservationInner> listByReservationOrder(String billingAccountName, String reservationOrderId)

Get Reservations in a given reservation Order in the billing account List Reservations within a single ReservationOrder in the billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
reservationOrderId - Order Id of the reservation.

Returns:

list of `Reservations as paginated response with PagedIterable<T>.

listByReservationOrder

public abstract PagedIterable<ReservationInner> listByReservationOrder(String billingAccountName, String reservationOrderId, Context context)

Get Reservations in a given reservation Order in the billing account List Reservations within a single ReservationOrder in the billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
reservationOrderId - Order Id of the reservation.
context - The context to associate with this operation.

Returns:

list of `Reservations as paginated response with PagedIterable<T>.

updateByBillingAccount

public abstract ReservationInner updateByBillingAccount(String billingAccountName, String reservationOrderId, String reservationId, PatchModel body)

Update reservation by billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
reservationOrderId - Order Id of the reservation.
reservationId - Id of the reservation item.
body - Request body for patching a reservation.

Returns:

the definition of the reservation.

updateByBillingAccount

public abstract ReservationInner updateByBillingAccount(String billingAccountName, String reservationOrderId, String reservationId, PatchModel body, Context context)

Update reservation by billing account.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
reservationOrderId - Order Id of the reservation.
reservationId - Id of the reservation item.
body - Request body for patching a reservation.
context - The context to associate with this operation.

Returns:

the definition of the reservation.

Applies to