com.oracle.bmc.osubsubscription.requests

Class ListRateCardsRequest.Builder

java.lang.Object

com.oracle.bmc.osubsubscription.requests.ListRateCardsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListRateCardsRequest,Void>

Enclosing class:

ListRateCardsRequest

public static class ListRateCardsRequest.Builder
extends Object
implements BmcRequest.Builder<ListRateCardsRequest,Void>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListRateCardsRequest	build() Build the instance of ListRateCardsRequest as configured by this builder
ListRateCardsRequest	buildWithoutInvocationCallback() Build the instance of ListRateCardsRequest as configured by this builder
ListRateCardsRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment.
ListRateCardsRequest.Builder	copy(ListRateCardsRequest o) Copy method to populate the builder with values from the given instance.
ListRateCardsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListRateCardsRequest.Builder	limit(Integer limit) The maximum number of items to return in a paginated “List” call.
ListRateCardsRequest.Builder	opcRequestId(String opcRequestId) Unique Oracle-assigned identifier for the request.
ListRateCardsRequest.Builder	page(String page) The value of the opc-next-page response header from the previous “List” call.
ListRateCardsRequest.Builder	partNumber(String partNumber) This param is used to get the rate card(s) filterd by the partNumber
ListRateCardsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListRateCardsRequest.Builder	sortBy(ListRateCardsRequest.SortBy sortBy) The field to sort by.
ListRateCardsRequest.Builder	sortOrder(ListRateCardsRequest.SortOrder sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).
ListRateCardsRequest.Builder	subscriptionId(String subscriptionId) Line level Subscription Id
ListRateCardsRequest.Builder	timeFrom(Date timeFrom) This param is used to get the rate card(s) whose effective start date starts on or after a particular date
ListRateCardsRequest.Builder	timeTo(Date timeTo) This param is used to get the rate card(s) whose effective end date ends on or before a particular date
ListRateCardsRequest.Builder	xOneOriginRegion(String xOneOriginRegion) The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

subscriptionId

public ListRateCardsRequest.Builder subscriptionId(String subscriptionId)

Line level Subscription Id

Parameters:

subscriptionId - the value to set

Returns:

this builder instance

compartmentId

public ListRateCardsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

timeFrom

public ListRateCardsRequest.Builder timeFrom(Date timeFrom)

This param is used to get the rate card(s) whose effective start date starts on or after a particular date

Parameters:

timeFrom - the value to set

Returns:

this builder instance

timeTo

public ListRateCardsRequest.Builder timeTo(Date timeTo)

This param is used to get the rate card(s) whose effective end date ends on or before a particular date

Parameters:

timeTo - the value to set

Returns:

this builder instance

partNumber

public ListRateCardsRequest.Builder partNumber(String partNumber)

This param is used to get the rate card(s) filterd by the partNumber

Parameters:

partNumber - the value to set

Returns:

this builder instance

limit

public ListRateCardsRequest.Builder limit(Integer limit)

The maximum number of items to return in a paginated “List” call. Default: (50)

Example: 500

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListRateCardsRequest.Builder page(String page)

The value of the opc-next-page response header from the previous “List” call.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListRateCardsRequest.Builder sortOrder(ListRateCardsRequest.SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListRateCardsRequest.Builder sortBy(ListRateCardsRequest.SortBy sortBy)

The field to sort by. You can provide one sort order (sortOrder).

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListRateCardsRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

xOneOriginRegion

public ListRateCardsRequest.Builder xOneOriginRegion(String xOneOriginRegion)

The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

Parameters:

xOneOriginRegion - the value to set

Returns:

this builder instance

invocationCallback

public ListRateCardsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListRateCardsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListRateCardsRequest.Builder copy(ListRateCardsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListRateCardsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListRateCardsRequest build()

Build the instance of ListRateCardsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListRateCardsRequest,Void>

Returns:

instance of ListRateCardsRequest

buildWithoutInvocationCallback

public ListRateCardsRequest buildWithoutInvocationCallback()

Build the instance of ListRateCardsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListRateCardsRequest