com.oracle.bmc.osmanagementhub.requests

Class ListProfilesRequest

java.lang.Object

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

com.oracle.bmc.osmanagementhub.requests.ListProfilesRequest

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

Example: Click here to see how to use ListProfilesRequest.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ListProfilesRequest()

Method Summary

Modifier and Type	Method and Description
static ListProfilesRequest.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’.
ArchType	getArchType() A filter to return only profiles that match the given archType.
String	getCompartmentId() The OCID of the compartment that contains the resources to list.
List<String>	getDisplayName() A filter to return resources that match the given display names.
String	getDisplayNameContains() A filter to return resources that may partially match the given display name.
Boolean	getIsDefaultProfile() A boolean variable that is used to list only the default profile resources.
Boolean	getIsServiceProvidedProfile() A filter to return only service-provided profiles.
Profile.LifecycleState	getLifecycleState() A filter to return only registration profiles in the given state.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
OsFamily	getOsFamily() A filter to return only resources that match the given operating system family.
String	getPage() For list pagination.
String	getProfileId() The OCID of the registration profile.
List<ProfileType>	getProfileType() A filter to return registration profiles that match the given profile type.
List<Profile.RegistrationType>	getRegistrationType() A filter to return profiles that match the given instance type.
ListProfilesRequest.SortBy	getSortBy() The field to sort by.
SortOrder	getSortOrder() The sort order to use, either ‘ASC’ or ‘DESC’.
VendorName	getVendorName() A filter to return only resources that match the given vendor name.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListProfilesRequest.Builder	toBuilder() Return an instance of ListProfilesRequest.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

ListProfilesRequest

public ListProfilesRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.

getDisplayName

public List<String> getDisplayName()

A filter to return resources that match the given display names.

getDisplayNameContains

public String getDisplayNameContains()

A filter to return resources that may partially match the given display name.

getProfileType

public List<ProfileType> getProfileType()

A filter to return registration profiles that match the given profile type.

getProfileId

public String getProfileId()

The OCID of the registration profile. A filter used to return the specified profile.

getOsFamily

public OsFamily getOsFamily()

A filter to return only resources that match the given operating system family.

getArchType

public ArchType getArchType()

A filter to return only profiles that match the given archType.

getRegistrationType

public List<Profile.RegistrationType> getRegistrationType()

A filter to return profiles that match the given instance type.

getIsDefaultProfile

public Boolean getIsDefaultProfile()

A boolean variable that is used to list only the default profile resources.

getIsServiceProvidedProfile

public Boolean getIsServiceProvidedProfile()

A filter to return only service-provided profiles.

getVendorName

public VendorName getVendorName()

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

getLimit

public Integer getLimit()

For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

Example: 50

getPage

public String getPage()

For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

Example: 3

getLifecycleState

public Profile.LifecycleState getLifecycleState()

A filter to return only registration profiles in the given state.

getSortOrder

public SortOrder getSortOrder()

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

getSortBy

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

getOpcRequestId

public String getOpcRequestId()

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

toBuilder

public ListProfilesRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListProfilesRequest.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>