Package com.oracle.bmc.marketplacepublisher.requests

Class ListSupportDocsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.marketplacepublisher.requests.ListSupportDocsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20241201")
public class ListSupportDocsRequest
extends BmcRequest<Void>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/marketplacepublisher/ListSupportDocsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSupportDocsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListSupportDocsRequest.Builder
static class	ListSupportDocsRequest.SortBy	The field to sort by.

Constructor Summary

Constructors

Constructor	Description
ListSupportDocsRequest()

Method Summary

Modifier and Type	Method	Description
static ListSupportDocsRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId()	The ID of the compartment in which to list resources.
Integer	getLimit()	The maximum number of items to return.
String	getName()	A filter to return only resources that match the entire name given.
String	getOpcRequestId()	The client request ID for tracing.
String	getPage()	A token representing the position at which to start retrieving results.
ListSupportDocsRequest.SortBy	getSortBy()	The field to sort by.
SortOrder	getSortOrder()	The sort order to use, either ‘ASC’ or ‘DESC’.
String	getSupportDocGroup()	SupportDoc Group
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListSupportDocsRequest.Builder	toBuilder()	Return an instance of ListSupportDocsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListSupportDocsRequest

public ListSupportDocsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The ID of the compartment in which to list resources.

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.

getSortOrder

public SortOrder getSortOrder()

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

getSortBy

public ListSupportDocsRequest.SortBy getSortBy()

The field to sort by.

Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

getSupportDocGroup

public String getSupportDocGroup()

SupportDoc Group

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

getName

public String getName()

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

toBuilder

public ListSupportDocsRequest.Builder toBuilder()

Return an instance of ListSupportDocsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListSupportDocsRequest.Builder that allows you to modify request properties.

builder

public static ListSupportDocsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>