com.oracle.bmc.osmanagementhub.requests

Class ListProfilesRequest.Builder

java.lang.Object

com.oracle.bmc.osmanagementhub.requests.ListProfilesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListProfilesRequest,Void>

Enclosing class:

ListProfilesRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListProfilesRequest.Builder	archType(ArchType archType) A filter to return only profiles that match the given archType.
ListProfilesRequest	build() Build the instance of ListProfilesRequest as configured by this builder
ListProfilesRequest	buildWithoutInvocationCallback() Build the instance of ListProfilesRequest as configured by this builder
ListProfilesRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment that contains the resources to list.
ListProfilesRequest.Builder	copy(ListProfilesRequest o) Copy method to populate the builder with values from the given instance.
ListProfilesRequest.Builder	displayName(List<String> displayName) A filter to return resources that match the given display names.
ListProfilesRequest.Builder	displayName(String singularValue) Singular setter.
ListProfilesRequest.Builder	displayNameContains(String displayNameContains) A filter to return resources that may partially match the given display name.
ListProfilesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListProfilesRequest.Builder	isDefaultProfile(Boolean isDefaultProfile) A boolean variable that is used to list only the default profile resources.
ListProfilesRequest.Builder	isServiceProvidedProfile(Boolean isServiceProvidedProfile) A filter to return only service-provided profiles.
ListProfilesRequest.Builder	lifecycleState(Profile.LifecycleState lifecycleState) A filter to return only registration profiles in the given state.
ListProfilesRequest.Builder	limit(Integer limit) For list pagination.
ListProfilesRequest.Builder	opcRequestId(String opcRequestId) Unique Oracle-assigned identifier for the request.
ListProfilesRequest.Builder	osFamily(OsFamily osFamily) A filter to return only resources that match the given operating system family.
ListProfilesRequest.Builder	page(String page) For list pagination.
ListProfilesRequest.Builder	profileId(String profileId) The OCID of the registration profile.
ListProfilesRequest.Builder	profileType(List<ProfileType> profileType) A filter to return registration profiles that match the given profile type.
ListProfilesRequest.Builder	profileType(ProfileType singularValue) Singular setter.
ListProfilesRequest.Builder	registrationType(List<Profile.RegistrationType> registrationType) A filter to return profiles that match the given instance type.
ListProfilesRequest.Builder	registrationType(Profile.RegistrationType singularValue) Singular setter.
ListProfilesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListProfilesRequest.Builder	sortBy(ListProfilesRequest.SortBy sortBy) The field to sort by.
ListProfilesRequest.Builder	sortOrder(SortOrder sortOrder) The sort order to use, either ‘ASC’ or ‘DESC’.
ListProfilesRequest.Builder	vendorName(VendorName vendorName) A filter to return only resources that match the given vendor name.

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 ListProfilesRequest.Builder compartmentId(String compartmentId)

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

Parameters:

compartmentId - the value to set

Returns:

this builder instance

displayName

public ListProfilesRequest.Builder displayName(List<String> displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

displayName

public ListProfilesRequest.Builder displayName(String singularValue)

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

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

displayNameContains

public ListProfilesRequest.Builder displayNameContains(String displayNameContains)

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

Parameters:

displayNameContains - the value to set

Returns:

this builder instance

profileType

public ListProfilesRequest.Builder profileType(List<ProfileType> profileType)

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

Parameters:

profileType - the value to set

Returns:

this builder instance

profileType

public ListProfilesRequest.Builder profileType(ProfileType singularValue)

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

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

profileId

public ListProfilesRequest.Builder profileId(String profileId)

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

Parameters:

profileId - the value to set

Returns:

this builder instance

osFamily

public ListProfilesRequest.Builder osFamily(OsFamily osFamily)

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

Parameters:

osFamily - the value to set

Returns:

this builder instance

archType

public ListProfilesRequest.Builder archType(ArchType archType)

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

Parameters:

archType - the value to set

Returns:

this builder instance

registrationType

public ListProfilesRequest.Builder registrationType(List<Profile.RegistrationType> registrationType)

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

Parameters:

registrationType - the value to set

Returns:

this builder instance

registrationType

public ListProfilesRequest.Builder registrationType(Profile.RegistrationType singularValue)

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

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

isDefaultProfile

public ListProfilesRequest.Builder isDefaultProfile(Boolean isDefaultProfile)

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

Parameters:

isDefaultProfile - the value to set

Returns:

this builder instance

isServiceProvidedProfile

public ListProfilesRequest.Builder isServiceProvidedProfile(Boolean isServiceProvidedProfile)

A filter to return only service-provided profiles.

Parameters:

isServiceProvidedProfile - the value to set

Returns:

this builder instance

vendorName

public ListProfilesRequest.Builder vendorName(VendorName vendorName)

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

Parameters:

vendorName - the value to set

Returns:

this builder instance

limit

public ListProfilesRequest.Builder limit(Integer limit)

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

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListProfilesRequest.Builder page(String page)

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

Parameters:

page - the value to set

Returns:

this builder instance

lifecycleState

public ListProfilesRequest.Builder lifecycleState(Profile.LifecycleState lifecycleState)

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

sortOrder

public ListProfilesRequest.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 ListProfilesRequest.Builder sortBy(ListProfilesRequest.SortBy sortBy)

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

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

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListProfilesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListProfilesRequest build()

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

Returns:

instance of ListProfilesRequest

buildWithoutInvocationCallback

public ListProfilesRequest buildWithoutInvocationCallback()

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