Package com.oracle.bmc.fleetappsmanagement.requests

Class ListCatalogItemsRequest.Builder

java.lang.Object

com.oracle.bmc.fleetappsmanagement.requests.ListCatalogItemsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListCatalogItemsRequest,Void>

Enclosing class:

ListCatalogItemsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListCatalogItemsRequest	build()	Build the instance of ListCatalogItemsRequest as configured by this builder
ListCatalogItemsRequest	buildWithoutInvocationCallback()	Build the instance of ListCatalogItemsRequest as configured by this builder
ListCatalogItemsRequest.Builder	catalogListingId(String catalogListingId)	catalogListingId of the package.
ListCatalogItemsRequest.Builder	catalogListingVersionCriteria(CatalogListingVersionCriteriaEnum catalogListingVersionCriteria)	Parameter to list all catalog items only with latest version or list all catalog items with all versions.
ListCatalogItemsRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListCatalogItemsRequest.Builder	configSourceType(String configSourceType)	The ConfigSourceType Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, URL_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE.
ListCatalogItemsRequest.Builder	copy(ListCatalogItemsRequest o)	Copy method to populate the builder with values from the given instance.
ListCatalogItemsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListCatalogItemsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListCatalogItemsRequest.Builder	lifecycleState(CatalogItem.LifecycleState lifecycleState)	A filter to return only resources that match the given lifecycle state.
ListCatalogItemsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListCatalogItemsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListCatalogItemsRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListCatalogItemsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListCatalogItemsRequest.Builder	shouldListPublicItems(Boolean shouldListPublicItems)	The indicator to append Public Items from the root compartment to any query, when set to TRUE.
ListCatalogItemsRequest.Builder	sortBy(CatalogItemSortBy sortBy)	The field to sort by.
ListCatalogItemsRequest.Builder	sortOrder(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

compartmentId

public ListCatalogItemsRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

configSourceType

public ListCatalogItemsRequest.Builder configSourceType(String configSourceType)

The ConfigSourceType Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, URL_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE.

Parameters:

configSourceType - the value to set

Returns:

this builder instance

lifecycleState

public ListCatalogItemsRequest.Builder lifecycleState(CatalogItem.LifecycleState lifecycleState)

A filter to return only resources that match the given lifecycle state.

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

sortOrder

public ListCatalogItemsRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ‘ASC’ or ‘DESC’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListCatalogItemsRequest.Builder sortBy(CatalogItemSortBy sortBy)

The field to sort by.

You can provide only one sort by. Default value for timeCreated is descending. Default order for displayName is ascending

Parameters:

sortBy - the value to set

Returns:

this builder instance

displayName

public ListCatalogItemsRequest.Builder displayName(String displayName)

A filter to return only resources that match the entire display name given.

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

public ListCatalogItemsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListCatalogItemsRequest.Builder page(String page)

A token representing the position at which to start retrieving results.

This must come from the opc-next-page header field of a previous response.

Parameters:

page - the value to set

Returns:

this builder instance

opcRequestId

public ListCatalogItemsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

catalogListingId

public ListCatalogItemsRequest.Builder catalogListingId(String catalogListingId)

catalogListingId of the package.

This is an integer whose min and max length are specified.

Parameters:

catalogListingId - the value to set

Returns:

this builder instance

catalogListingVersionCriteria

public ListCatalogItemsRequest.Builder catalogListingVersionCriteria(CatalogListingVersionCriteriaEnum catalogListingVersionCriteria)

Parameter to list all catalog items only with latest version or list all catalog items with all versions.

Parameters:

catalogListingVersionCriteria - the value to set

Returns:

this builder instance

shouldListPublicItems

public ListCatalogItemsRequest.Builder shouldListPublicItems(Boolean shouldListPublicItems)

The indicator to append Public Items from the root compartment to any query, when set to TRUE.

Parameters:

shouldListPublicItems - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListCatalogItemsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListCatalogItemsRequest build()

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

Returns:

instance of ListCatalogItemsRequest

buildWithoutInvocationCallback

public ListCatalogItemsRequest buildWithoutInvocationCallback()

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