Class ListCatalogItemsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.fleetappsmanagement.requests.ListCatalogItemsRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20250228") public class ListCatalogItemsRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.0/fleetappsmanagement/ListCatalogItemsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCatalogItemsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListCatalogItemsRequest.Builder
-
Constructor Summary
Constructors Constructor Description ListCatalogItemsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListCatalogItemsRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetCatalogListingId()catalogListingId of the package.CatalogListingVersionCriteriaEnumgetCatalogListingVersionCriteria()Parameter to list all catalog items only with latest version or list all catalog items with all versions.StringgetCompartmentId()The ID of the compartment in which to list resources.StringgetConfigSourceType()The ConfigSourceType Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, URL_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE.StringgetDisplayName()A filter to return only resources that match the entire display name given.CatalogItem.LifecycleStategetLifecycleState()A filter to return only resources that match the given lifecycle state.IntegergetLimit()The maximum number of items to return.StringgetOpcRequestId()The client request ID for tracing.CatalogItem.PackageTypegetPackageType()A filter to return only resources that match the given package type.StringgetPage()A token representing the position at which to start retrieving results.BooleangetShouldListPublicItems()The indicator to append Public Items from the root compartment to any query, when set to TRUE.CatalogItemSortBygetSortBy()The field to sort by.SortOrdergetSortOrder()The sort order to use, either ‘ASC’ or ‘DESC’.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListCatalogItemsRequest.BuildertoBuilder()Return an instance ofListCatalogItemsRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
Method Detail
-
getCompartmentId
public String getCompartmentId()
The ID of the compartment in which to list resources.
-
getConfigSourceType
public String getConfigSourceType()
The ConfigSourceType Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, URL_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE.
-
getLifecycleState
public CatalogItem.LifecycleState getLifecycleState()
A filter to return only resources that match the given lifecycle state.The state value is case-insensitive.
-
getSortOrder
public SortOrder getSortOrder()
The sort order to use, either ‘ASC’ or ‘DESC’.
-
getSortBy
public CatalogItemSortBy getSortBy()
The field to sort by.You can provide only one sort by. Default value for timeCreated is descending. Default order for displayName is ascending
-
getDisplayName
public String getDisplayName()
A filter to return only resources that match the entire display name given.
-
getLimit
public Integer getLimit()
The maximum number of items to return.
-
getPage
public String getPage()
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.
-
getOpcRequestId
public String getOpcRequestId()
The client request ID for tracing.
-
getCatalogListingId
public String getCatalogListingId()
catalogListingId of the package.This is an integer whose min and max length are specified.
-
getCatalogListingVersionCriteria
public CatalogListingVersionCriteriaEnum getCatalogListingVersionCriteria()
Parameter to list all catalog items only with latest version or list all catalog items with all versions.
-
getPackageType
public CatalogItem.PackageType getPackageType()
A filter to return only resources that match the given package type.The state value is case-insensitive.
-
getShouldListPublicItems
public Boolean getShouldListPublicItems()
The indicator to append Public Items from the root compartment to any query, when set to TRUE.
-
toBuilder
public ListCatalogItemsRequest.Builder toBuilder()
Return an instance ofListCatalogItemsRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListCatalogItemsRequest.Builderthat allows you to modify request properties.
-
builder
public static ListCatalogItemsRequest.Builder builder()
Return a new builder for this request object.- Returns:
- builder for the request object
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-