Package com.oracle.bmc.marketplace.requests

Class ListPackagesRequest.Builder

java.lang.Object

com.oracle.bmc.marketplace.requests.ListPackagesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListPackagesRequest,Void>

Enclosing class:

ListPackagesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListPackagesRequest	build()	Build the instance of ListPackagesRequest as configured by this builder
ListPackagesRequest	buildWithoutInvocationCallback()	Build the instance of ListPackagesRequest as configured by this builder
ListPackagesRequest.Builder	compartmentId(String compartmentId)	The unique identifier for the compartment.
ListPackagesRequest.Builder	copy(ListPackagesRequest o)	Copy method to populate the builder with values from the given instance.
ListPackagesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListPackagesRequest.Builder	limit(Integer limit)	How many records to return.
ListPackagesRequest.Builder	listingId(String listingId)	The unique identifier for the listing.
ListPackagesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListPackagesRequest.Builder	packageType(String packageType)	A filter to return only packages that match the given package type exactly.
ListPackagesRequest.Builder	packageVersion(String packageVersion)	The version of the package.
ListPackagesRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous “List” call.
ListPackagesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListPackagesRequest.Builder	sortBy(ListPackagesRequest.SortBy sortBy)	The field to use to sort listed results.
ListPackagesRequest.Builder	sortOrder(ListPackagesRequest.SortOrder sortOrder)	The sort order to use, either ASC or DESC.

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

listingId

public ListPackagesRequest.Builder listingId(String listingId)

The unique identifier for the listing.

Parameters:

listingId - the value to set

Returns:

this builder instance

packageVersion

public ListPackagesRequest.Builder packageVersion(String packageVersion)

The version of the package.

Package versions are unique within a listing.

Parameters:

packageVersion - the value to set

Returns:

this builder instance

packageType

public ListPackagesRequest.Builder packageType(String packageType)

A filter to return only packages that match the given package type exactly.

Parameters:

packageType - the value to set

Returns:

this builder instance

opcRequestId

public ListPackagesRequest.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

limit

public ListPackagesRequest.Builder limit(Integer limit)

How many records to return.

Specify a value greater than zero and less than or equal to 1000. The default is 30.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListPackagesRequest.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

sortBy

public ListPackagesRequest.Builder sortBy(ListPackagesRequest.SortBy sortBy)

The field to use to sort listed results.

You can only specify one field to sort by. TIMERELEASED displays results in descending order by default. You can change your preference by specifying a different sort order.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListPackagesRequest.Builder sortOrder(ListPackagesRequest.SortOrder sortOrder)

The sort order to use, either ASC or DESC.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

compartmentId

public ListPackagesRequest.Builder compartmentId(String compartmentId)

The unique identifier for the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

invocationCallback

public ListPackagesRequest.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 ListPackagesRequest.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 ListPackagesRequest.Builder copy(ListPackagesRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListPackagesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListPackagesRequest build()

Build the instance of ListPackagesRequest 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<ListPackagesRequest,Void>

Returns:

instance of ListPackagesRequest

buildWithoutInvocationCallback

public ListPackagesRequest buildWithoutInvocationCallback()

Build the instance of ListPackagesRequest 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 ListPackagesRequest